Use the offer code 20offearlybird to get 20% off.

# How to Best Tune Multithreading Support for XGBoost in Python

Last Updated on August 27, 2020

The XGBoost library for gradient boosting uses is designed for efficient multi-core parallel processing.

This allows it to efficiently use all of the CPU cores in your system when training.

In this post you will discover the parallel processing capabilities of the XGBoost in Python.

After reading this post you will know:

• How to confirm that XGBoost multi-threading support is working on your system.
• How to evaluate the effect of increasing the number of threads on XGBoost.
• How to get the most out of multithreaded XGBoost when using cross validation and grid search.

Kick-start your project with my new book XGBoost With Python, including step-by-step tutorials and the Python source code files for all examples.

Let’s get started.

• Update Jan/2017: Updated to reflect changes in scikit-learn API version 0.18.1.

How to Best Tune Multithreading Support for XGBoost in Python
Photo by Nicholas A. Tonelli, some rights reserved.

### Need help with XGBoost in Python?

Take my free 7-day email course and discover xgboost (with sample code).

Click to sign-up now and also get a free PDF Ebook version of the course.

## Problem Description: Otto Dataset

In this tutorial we will use the Otto Group Product Classification Challenge dataset.

This dataset is available from Kaggle (you will need to sign-up to Kaggle to be able to download this dataset). You can download the training dataset train.zip from the Data page and place the unzipped trian.csv file into your working directory.

This dataset describes the 93 obfuscated details of more than 61,000 products grouped into 10 product categories (e.g. fashion, electrons, etc.). Input attributes are counts of different events of some kind.

The goal is to make predictions for new products as an array of probabilities for each of the 10 categories and models are evaluated using multiclass logarithmic loss (also called cross entropy).

This competition completed in May 2015 and this dataset is a good challenge for XGBoost because of the nontrivial number of examples and the difficulty of the problem and the fact that little data preparation is required (other than encoding the string class variables as integers).

## Impact of the Number of Threads

XGBoost is implemented in C++ to explicitly make use of the OpenMP API for parallel processing.

The parallelism in gradient boosting can be implemented in the construction of individual trees, rather than in creating trees in parallel like random forest. This is because in boosting, trees are added to the model sequentially. The speed of XGBoost is both in adding parallelism in the construction of individual trees, and in the efficient preparation of the input data to aid in the speed up in the construction of trees.

Depending on your platform, you may need to compile XGBoost specifically to support multithreading. See the XGBoost installation instructions for more details.

The XGBClassifier and XGBRegressor wrapper classes for XGBoost for use in scikit-learn provide the nthread parameter to specify the number of threads that XGBoost can use during training.

By default this parameter is set to -1 to make use of all of the cores in your system.

Generally, you should get multithreading support for your XGBoost installation without any extra work.

Depending on your Python environment (e.g. Python 3) you may need to explicitly enable multithreading support for XGBoost. The XGBoost library provides an example if you need help.

You can confirm that XGBoost multi-threading support is working by building a number of different XGBoost models, specifying the number of threads and timing how long it takes to build each model. The trend will both show you that multi-threading support is enabled and give you an indication of the effect it has when building models.

For example, if your system has 4 cores, you can train 8 different models and time how long in seconds it takes to create each, then compare the times.

We can use this approach on the Otto dataset. The full example is provided below for completeness.

You can change the num_threads array to meet the number of cores on your system.

Note: Your results may vary given the stochastic nature of the algorithm or evaluation procedure, or differences in numerical precision. Consider running the example a few times and compare the average outcome.

Running this example summarizes the execution time in seconds for each configuration.

A plot of these timings is provided below.

XGBoost Tune Number of Threads for Single Model

We can see a nice trend in the decrease in execution time as the number of threads is increased.

If you do not see an improvement in running time for each new thread, you may want to investigate how to enable multithreading support in XGBoost as part of your install or at runtime.

We can run the same code on a machine with a lot more cores. The large Amazon Web Services EC2 instance is reported to have 32 cores. We can adapt the above code to time how long it takes to train the model with 1 to 32 cores. The results are plotted below.

XGBoost Time to Train Model on 1 to 32 Cores

It is interesting to note that we do not see much improvement beyond 16 threads (at about 7 seconds). I expect the reason for this is that the Amazon instance only provides 16 cores in hardware and the additional 16 cores are available by hyperthreading. The results suggest that if you have a machine with hyperthreading, you may want to set num_threads to equal the number of physical CPU cores in your machine.

The low-level optimized implementation of XGBoost with OpenMP squeezes every last cycle out of a large machine like this.

## Parallelism When Cross Validating XGBoost Models

The k-fold cross validation support in scikit-learn also supports multithreading.

For example, the n_jobs argument on the cross_val_score() function used to evaluate a model on a dataset using k-fold cross validation allows you to specify the number of parallel jobs to run.

By default, this is set to 1, but can be set to -1 to use all of the CPU cores on your system, which is good practice. For example:

This raises the question as to how cross validation should be configured:

• Disable multi-threading support in XGBoost and allow cross validation to run on all cores.
• Disable multi-threading support in cross validation and allow XGBoost to run on all cores.
• Enable multi-threading support for both XGBoost and Cross validation.

We can get an answer to this question by simply timing how long it takes to evaluate the model in each circumstance.

In the example below we use 10 fold cross validation to evaluate the default XGBoost model on the Otto training dataset. Each of the above scenarios is evaluated and the time taken to evaluate the model is reported.

The full code example is provided below.

Note: Your results may vary given the stochastic nature of the algorithm or evaluation procedure, or differences in numerical precision. Consider running the example a few times and compare the average outcome.

Running the example prints the following results.

We can see that there is a benefit from parallelizing XGBoost over the cross validation folds. This makes sense as 10 sequential fast tasks is better than (10 divided by num_cores) slow tasks.

Interestingly we can see that the best result is achieved by enabling both multi-threading within XGBoost and in cross validation. This is surprising because it means that num_cores number of parallel XGBoost models are competing for the same num_cores in the construction of their models. Nevertheless, this achieves the fastest results and is the suggested usage of XGBoost for cross validation.

Because grid search uses the same underlying approach to parallelism, we expect the same finding to hold for optimizing the hyperparameters for XGBoost.

## Summary

In this post you discovered the multi-threading capability of XGBoost.

You learned:

• How to check that the multi-threading support in XGBoost is enabled on your system.
• How increasing the number of threads affects the performance of training XGBoost models.
• How to best configure XGBoost and Cross Validation in Python for minimum running time.

## Discover The Algorithm Winning Competitions!

#### Develop Your Own XGBoost Models in Minutes

...with just a few lines of Python

Discover how in my new Ebook:
XGBoost With Python

It covers self-study tutorials like:
Algorithm Fundamentals, Scaling, Hyperparameters, and much more...

### 30 Responses to How to Best Tune Multithreading Support for XGBoost in Python

1. Mate Benyo November 7, 2016 at 4:25 am #

Good one, thanks, really interesting!

• Jason Brownlee November 7, 2016 at 7:19 am #

Thanks Mate, I’m glad you found it interesting.

2. David Urpani November 28, 2016 at 12:12 pm #

Hi Jason, am running this code, the first batch on n umber of threads using the XGB book. It hangs up on model.fit(X, label_encoded_y) … am running in Jupyter Notebook using Python 3+ …. has anyone come across this issue before?

Thanks

• Jason Brownlee November 29, 2016 at 8:47 am #

Hi David, perhaps try on the command line outside of a notebook?

3. Ruiye Ni December 1, 2016 at 2:34 am #

Hi Jason, are nthread = -1 and nthread = 4 the same for a computer with 4 cores? With regard to the parallelism in cross validation, it took forever to run for paralleling both XGBoost and CV on my laptop, while the first two scenarios completed within reasonable time. Any idea? Thanks!

• Jason Brownlee December 1, 2016 at 7:30 am #

That is correct Ruiye.

The scenarios are aggressive in ram and cpu. It might have just clobbered your hardware – sorry.

4. Shir December 2, 2016 at 6:36 am #

Hi,
From some reasoh XGboost doesn’t parallel on mac os on Python 3 for me.

I installed xgboost like this:

git clone –recursive https://github.com/dmlc/xgboost cd xgboost; cp make/minimum.mk ./config.mk; make -j4 workon riskvenv cd python-package sudo python setup.py install

But the xgboost doesn’t use all the 4 cores when running even when I specify the number of threads and when I don’t.

Do any one have a clue how to solve this issue?

• Jason Brownlee December 2, 2016 at 8:20 am #

Perhaps it’s a Python 3 issue?

I can confirm that I can all 4 cores with Python 2.7 with xgboost.

5. Peter May 2, 2017 at 1:49 am #

I honestly think this article misleading since the default procedure is to use all threads, so tuning on this parameter will not give you any gain if you want to use all threads which is by far the most common.
I only think there is a reason to tune this if you know you have 4 different models and want only to use one thread for each otherwise I not think this article have en purpose.

• Jason Brownlee May 2, 2017 at 6:01 am #

Thnaks Peter.

I wanted to show the speed-up offered by using more cores – e.g. jumping on big AWS instances can help speed up your model.

• Druce June 10, 2018 at 7:39 am #

FWIW, in my config (conda, python 3.6.5, xgboost 0.71), the default does not seem to multithread if nthread is not specified. See results below. I would specify nthread=-1 or test as described in this post to determine which nthread value works best.

-1 3.9046308994293213
not set 6.836001396179199
1 6.832951545715332
2 5.142981767654419
3 4.339038848876953
4 3.99072265625
5 3.7604596614837646
6 3.6778457164764404
7 3.56015944480896
8 3.5151889324188232

6. Dele May 15, 2017 at 12:08 am #

Helli sir,

You are doing a good job. I have tuned XGBoost Hyper parameter like Gamma, Learning_rate, reg_lambda, max_depth, min_child_weight, subsample etc. I now used the values I got from the tuning to see if the accuracy will change, but it stays the same as the untuned accuracy. What can I do to increase the accuracy sir? Kind regards.

7. Kapil July 19, 2017 at 7:37 am #

Thanks Jason for the post.

So, in training time the code runs in parallel. I am trying to figure out does the parallelism happens at run time too?
If I have 50 trees does the output of each tree is done in parallel or sequentially?

• Jason Brownlee July 19, 2017 at 8:32 am #

It is not that clean as there is a dependence between the trees.

I believe the construction of the trees themselves is parallelized.

8. Kevin December 22, 2017 at 8:37 am #

Hi Jason,

Really appreciate this post. I’m still quite confused about the last scenario. If you use, nthreads=-1 and njobs=-1, is it using all cores to run XGBoost fitting and all cores in parallel for CV? So, let’s say I have 32 cores, then 32 cores are being used for XGBoost, and then 32 XGBoost jobs are being launched for CV? I have no idea how those 2 parameters are competing for compute time. Have you gotten more insight on that? I imagine if you have a total of 32 cores, then n_threads x n_jobs would have to equal 32?

Thanks!

• Jason Brownlee December 22, 2017 at 4:14 pm #

Perhaps you could run CV with 1 thread and run xgboost with the remaining 31?

Perhaps try 16/16 spit? experiment and see what works best.

9. Michael January 13, 2018 at 2:02 pm #

HI Jason, I dont know what happens but i got this result:

Parallel Thread XGBoost and CV: 16.646298

I’m using Python 3.6

Thanks

• Jason Brownlee January 14, 2018 at 6:35 am #

Your installation of xgboost might not be setup to use multiple threads.

• Larry January 6, 2019 at 6:33 am #

Further considerations for XGB performance, look at the “xgboost Exact speed” chart here. Beyond the physical core count (36), the performance gets worse. https://github.com/dmlc/xgboost/issues/3810

10. Eran November 6, 2018 at 8:24 pm #

XGBClassifier deprecated nthread, now it is n_jobs and the default is 1.

To check if XGBoost is working, I would also recommend simply checking the CPUs % using htop, you should see all of them well around 100%

11. mkjjo January 31, 2019 at 6:52 pm #

I am learning an ensemble model using XGBoost algorithm

When I printed base_learners, it seems to be stored as a dictionary type. like this :

{‘dnn’: , ‘random forest’: RandomForestClassifier(bootstrap=True, class_weight=None, criterion=’gini’,
max_depth=4, max_features=’sqrt’, max_leaf_nodes=None,
min_impurity_decrease=0.0, min_impurity_split=None,
min_samples_leaf=2, min_samples_split=2,
min_weight_fraction_leaf=0.0, n_estimators=100, n_jobs=-1,
oob_score=False, random_state=42, verbose=0, warm_start=False), ‘extra trees’: ExtraTreesClassifier(bootstrap=False, class_weight=None, criterion=’gini’,
max_depth=4, max_features=’auto’, max_leaf_nodes=None,
min_impurity_decrease=0.0, min_impurity_split=None,
min_samples_leaf=2, min_samples_split=2,
min_weight_fraction_leaf=0.0, n_estimators=100, n_jobs=-1,
oob_score=False, random_state=42, verbose=0, warm_start=False)}

To use ‘base_learner’ in another file, How can I save that? I can’t use save_model(). because that is not model

And, also I can’t using pickle module. I don’t know why.

But I think multithreaded error problems.

When I using pickle module, I got the following error message:

pickle.dump(base_learners, open(‘./models/base_learners.pkl’, ‘wb’))

Do you know the solution?

• Jason Brownlee February 1, 2019 at 5:34 am #

I don’t have an example of changing the base learner in xgboost.

Sorry, I have not seen that error, perhaps try posting to stackoverflow?

12. Vinu March 30, 2019 at 4:28 am #

Hi Jason,

I have a problem with the multithreading of scikit wrapper XGBClassifier. I was using n_jobs=4 for XGBClassifier in a 4 cored machine and the CPU usage shows only ~100%. However, I expected a usage of ~400% which was in the case of XGBoost alone. Could you have any clue why this is happening?

• Jason Brownlee March 30, 2019 at 6:33 am #

I don’t know, sorry.

• Vinu March 30, 2019 at 6:59 am #