2.1.4 Patch Release (2025 Feb 6) — xgboost 3.1.0-dev documentation (original) (raw)

The 2.1.4 patch release incorporates the following fixes on top of the 2.1.3 release:

• XGBoost is now compatible with scikit-learn 1.6 (#11021, #11162)
• Build wheels with CUDA 12.8 and enable Blackwell support (#11187, #11202)
• Adapt to RMM 25.02 logger changes (#11153)

2.1.3 Patch Release (2024 Nov 26)

The 2.1.3 patch release makes the following bug fixes:

• [pyspark] Support large model size (#10984).
• Fix rng for the column sampler (#10998).
• Handle cudf.pandas proxy objects properly (#11014).

2.1.2 Patch Release (2024 Oct 23)

The 2.1.2 patch release makes the following bug fixes:

• Clean up and modernize release-artifacts.py (#10818)
• Fix ellpack categorical feature with missing values. (#10906)
• Fix unbiased ltr with training continuation. (#10908)
• Fix potential race in feature constraint. (#10719)
• Fix boolean array for arrow-backed DF. (#10527)
• Ensure that pip check does not fail due to a bad platform tag (#10755)
• Check cub errors (#10721)
• Limit the maximum number of threads. (#10872)
• Fixes for large size clusters. (#10880)
• POSIX compliant poll.h and mmap (#10767)

2.1.1 Patch Release (2024 Jul 31)

The 2.1.1 patch release makes the following bug fixes:

• [Dask] Disable broadcast in the scatter call so that predict function won’t hang (#10632)
• [Dask] Handle empty partitions correctly (#10559)
• Fix federated learning for the encrypted GRPC backend (#10503)
• Fix a race condition in column splitter (#10572)
• Gracefully handle cases where system files like /sys/fs/cgroup/cpu.max are not readable by the user (#10623)
• Fix build and C++ tests for FreeBSD (#10480)
• Clarify the requirement Pandas 1.2+ (#10476)
• More robust endianness detection in R package build (#10642)

In addition, it contains several enhancements:

• Publish JVM packages targeting Linux ARM64 (#10487)
• Publish a CPU-only wheel under name xgboost-cpu (#10603)
• Support building with CUDA Toolkit 12.5 and latest CCCL (#10624, #10633, #10574)

2.1.0 (2024 Jun 20)

We are thrilled to announce the XGBoost 2.1 release. This note will start by summarizing some general changes and then highlighting specific package updates. As we are working on a new R interface, this release will not include the R package. We’ll update the R package as soon as it’s ready. Stay tuned!

• Networking Improvements
• NCCL is now fetched from PyPI
• Parts of the Python package now require glibc 2.28+
• Multi-output
• Federated Learning
• Ongoing work for SYCL support
• Optimizations
• Deprecation and breaking changes
• Features
• Bug fixes
• Document
• Python package
  • Dask
  • PySpark
  • Breaking changes
  • Features
  • Fixes
  • Document
  • Maintenance
• JVM packages
  • Features and related documents
  • Bug Fixes
• Maintenance
• CI

Networking Improvements

An important ongoing work for XGBoost, which we’ve been collaborating on, is to support resilience for improved scaling and federated learning on various platforms. The existing networking library in XGBoost, adopted from the RABIT project, can no longer meet the feature demand. We’ve revamped the RABIT module in this release to pave the way for future development. The choice of using an in-house version instead of an existing library is due to the active development status with frequent new feature requests like loading extra plugins for federated learning. The new implementation features:

• Both CPU and GPU communication (based on NCCL).
• A reusable tracker for both the Python package and JVM packages. With the new release, the JVM packages no longer require Python as a runtime dependency.
• Supports federated communication patterns for both CPU and GPU.
• Supports timeout. The high-level interface parameter is currently hard-coded to 30 minutes, which we plan to improve.
• Supports significantly more data types.
• Supports thread-based workers.
• Improved handling for worker errors, including better error messages when one of the peers dies during training.
• Work with IPv6. Currently, this is only supported by the dask interface.
• Built-in support for various operations like broadcast, allgatherV, allreduce, etc.

Related PRs (#9597, #9576, #9523, #9524, #9593, #9596, #9661, #10319, #10152, #10125, #10332, #10306, #10208, #10203, #10199, #9784, #9777, #9773, #9772, #9759, #9745, #9695, #9738, #9732, #9726, #9688, #9681, #9679, #9659, #9650, #9644, #9649, #9917, #9990, #10313, #10315, #10112, #9531, #10075, #9805, #10198, #10414).

The existing option of using MPI in RABIT is removed in the release. (#9525)

NCCL is now fetched from PyPI

In the previous version, XGBoost statically linked NCCL, which significantly increased the binary size and led to hitting the PyPI repository limit. With the new release, we have made a significant improvement. The new release can now dynamically load NCCL from an external source, reducing the binary size. For the PyPI package, the nvidia-nccl-cu12 package will be fetched during installation. With more downstream packages reusing NCCL, we expect the user environments to be slimmer in the future as well. (#9796, #9804, #10447)

Parts of the Python package now require glibc 2.28+

Starting from 2.1.0, XGBoost Python package will be distributed in two variants:

• manylinux_2_28: for recent Linux distros with glibc 2.28 or newer. This variant comes with all features enabled.
• manylinux2014: for old Linux distros with glibc older than 2.28. This variant does not support GPU algorithms or federated learning.

The pip package manager will automatically choose the correct variant depending on your system.

Starting from May 31, 2025, we will stop distributing the manylinux2014 variant and exclusively distribute the manylinux_2_28 variant. We made this decision so that our CI/CD pipeline won’t have depend on software components that reached end-of-life (such as CentOS 7). We strongly encourage everyone to migrate to recent Linux distros in order to use future versions of XGBoost.

Note. If you want to use GPU algorithms or federated learning on an older Linux distro, you have two alternatives:

1. Upgrade to a recent Linux distro with glibc 2.28+. OR
2. Build XGBoost from the source.

Multi-output

We continue the work on multi-target and vector leaf in this release:

• Revise the support for custom objectives with a new API, XGBoosterTrainOneIter. This new function supports strided matrices and CUDA inputs. In addition, custom objectives now return the correct shape for prediction. (#9508)
• The hinge objective now supports multi-target regression (#9850)
• Fix the gain calculation with vector leaf (#9978)
• Support graphviz plot for multi-target tree. (#10093)
• Fix multi-output with alternating strategies. (#9933)

Please note that the feature is still in progress and not suitable for production use.

Federated Learning

Progress has been made on federated learning with improved support for column-split, including the following updates:

• Column split work for both CPU and GPU. In addition, categorical data is now compatible with column split. (#9562, #9609, #9611, #9628, #9539, #9578, #9685, #9623, #9613, #9511, #9384, #9595)
• The use of UBJson to serialize split entries for column split has been implemented, aiding vector-leaf with column-based data split. (#10059, #10055, #9702)
• Documentation and small fixes. (#9610, #9552, #9614, #9867)

Ongoing work for SYCL support

XGBoost is developing a SYCL plugin for SYCL devices, starting with the hist tree method. (#10216, #9800, #10311, #9691, #10269, #10251, #10222, #10174, #10080, #10057, #10011, #10138, #10119, #10045, #9876, #9846, #9682) XGBoost now supports launchable inference on SYCL devices, and that work on adding SYCL support for training is ongoing.

Looking ahead, we plan to complete the training in coming releases and then focus on improving test coverage for SYCL, particularly for Python tests.

Optimizations

• Implement column sampler in CUDA for GPU-based tree methods. This helps us get faster training time when column sampling is employed (#9785)
• CMake LTO and CUDA arch (#9677)
• Small optimization to external memory with a thread pool. This reduces the number of threads launched during iteration. (#9605, #10288, #10374)

Deprecation and breaking changes

Package-specific breaking changes are outlined in respective sections. Here we list general breaking changes in this release:

• The command line interface is deprecated due to the increasing complexity of the machine learning ecosystem. Building a machine learning model using a command shell is no longer feasible and could mislead newcomers. (#9485)
• Universal binary JSON is now the default format for saving models (#9947, #9958, #9954, #9955). See https://github.com/dmlc/xgboost/issues/7547 for more info.
• The XGBoosterGetModelRaw is now removed after deprecation in 1.6. (#9617)
• Drop support for loading remote files. This feature lacks any test. Users are encouraged to use dedicated libraries to fetch remote content. (#9504)
• Remove the dense libsvm parser plugin. This plugin is never tested or documented (#9799)
• XGDMatrixSetDenseInfo and XGDMatrixSetUIntInfo are now deprecated. Use the array interface based alternatives instead.

Features

This section lists some new features that are general to all language bindings. For package-specific changes, please visit respective sections.

• Adopt a new XGBoost logo (#10270)
• Now supports dataframe data format in native XGBoost. This improvement enhances performance and reduces memory usage when working with dataframe-based structures such as pandas, arrow, and R dataframe. (#9828, #9616, #9905)
• Change default metric for gamma regression to deviance. (#9757)
• Normalization for learning to rank is now optional with the introduction of the new lambdarank_normalization parameter. (#10094)
• Contribution prediction with QuantileDMatrix on CPU. (#10043)
• XGBoost on macos no longer bundles OpenMP runtime. Users can install the latest runtime from their dependency manager of choice. (#10440). Along with which, JVM packages on MacoOS are now built with OpenMP support (#10449).

Bug fixes

• Fix training with categorical data from external memory. (#10433)
• Fix compilation with CTK-12. (#10123)
• Fix inconsistent runtime library on Windows. (#10404)
• Fix default metric configuration. (#9575)
• Fix feature names with special characters. (#9923)
• Fix global configuration for external memory training. (#10173)
• Disable column sample by node for the exact tree method. (#10083)
• Fix the FieldEntry constructor specialization syntax error (#9980)
• Fix pairwise objective with NDCG metric along with custom gain. (#10100)
• Fix the default value for lambdarank_pair_method. (#10098)
• Fix UBJSON with boolean values. No existing code is affected by this fix. (#10054)
• Be more lenient on floating point errors for AUC. This prevents the AUC > 1.0 error. (#10264)
• Check support status for categorical features. This prevents gblinear from treating categorical features as numerical. (#9946)

Document

Here is a list of documentation changes not specific to any XGBoost package.

• A new coarse map for XGBoost features to assist development. (#10310)
• New language binding consistency guideline. (#9755, #9866)
• Fixes, cleanups, small updates (#9501, #9988, #10023, #10013, #10143, #9904, #10179, #9781, #10340, #9658, #10182, #9822)
• Update document for parameters (#9900)
• Brief introduction to base_score. (#9882)
• Mention data consistency for categorical features. (#9678)

Python package

Dask

Other than the changes in networking, we have some optimizations and document updates in dask:

• Filter models on workers instead of clients; this prevents an OOM error on the client machine. (#9518)
• Users are now encouraged to use from xgboost import dask instead of import xgboost.dask to avoid drawing in unnecessary dependencies for non-dask users. (#9742)
• Add seed to demos. (#10009)
• New document for using dask XGBoost with k8s. (#10271)
• Workaround potentially unaligned pointer from an empty partition. (#10418)
• Workaround a race condition in the latest dask. (#10419)
• [doc] Add typing to dask demos. (#10207)

PySpark

PySpark has several new features along with some small fixes:

• Support stage-level scheduling for training on various platforms, including yarn/k8s. (#9519, #10209, #9786, #9727)
• Support GPU-based transform methods (#9542)
• Avoid expensive repartition when appropriate. (#10408)
• Refactor the logging and the GPU code path (#10077, 9724)
• Sort workers by task ID. This helps the PySpark interface obtain deterministic results. (#10220)
• Fix PySpark with verbosity=3. (#10172)
• Fix spark estimator doc. (#10066)
• Rework transform for improved code reusing. (#9292)

Breaking changes

For the Python package, eval_metric, early_stopping_rounds, and callbacks from now removed from the fit method in the sklearn interface. They were deprecated in 1.6. Use the parameters with the same name in constructors instead. (#9986)

Features

Following is a list of new features in the Python package:

• Support sample weight in sklearn custom objective. (#10050)
• New supported data types, including cudf.pandas (#9602), torch.Tensor (#9971), and more scipy types (#9881).
• Support pandas 2.2 and numpy 2.0. (#10266, #9557, #10252, #10175)
• Support the latest rapids including rmm. (#10435)
• Improved data cache option in data iterator. (#10286)
• Accept numpy generators as random_state (#9743)
• Support returning base score as intercept in the sklearn interface. (#9486)
• Support arrow through pandas ext types. This is built on top of the new DataFrame API in XGBoost. See general features for more info. (#9612)
• Handle np integer in model slice and prediction. (#10007)
• Improved sklearn tags support. (#10230)
• The base image for building Linux binary wheels is updated to rockylinux8. (#10399)
• Improved handling for float128. (#10322)

Fixes

• Fix DMatrix with None input. (#10052)
• Fix native library discovery logic. (#9712, #9860)
• Fix using categorical data with the score function for the ranker. (#9753)

Document

• Clarify the effect of enable_categorical (#9877, #9884)
• Update the Python introduction. (#10033)
• Fixes. (#10058, #9991, #9573)

Maintenance

• Use array interface in Python prediction return. (#9855)
• Synthesize the AMES housing dataset for tests. (#9963)
• linter, formatting, etc. (#10296, #10014)
• Tests. (#9962, #10285, #9997, #9943, #9934)

JVM packages

Here is a list of JVM-specific changes. Like the PySpark package, the JVM package also gains stage-level scheduling.

Features and related documents

• Support stage-level scheduling (#9775)
• Allow JVM-Package to access inplace predict method (#9167)
• Support JDK 17 for test (#9959)
• Various dependency updates.(#10211, #10210, #10217, #10156, #10070, #9809, #9517, #10235, #10276, #9331, #10335, #10309, #10240, #10244, #10260, #9489, #9326, #10294, #10197, #10196, #10193, #10202, #10191, #10188, #9328, #9311, #9951, #10151, #9827, #9820, #10253)
• Update and fixes for document. (#9752, #10385)
• Remove rabit checkpoint. (#9599)

Bug Fixes

• Fixes memory leak in error handling. (#10307)
• Fixes group col for GPU packages (#10254)

Maintenance

• Add formatting and linting requirements to the CMake script. (#9653, #9641, #9637, #9728, #9674)
• Refactors and cleanups (#10085, #10120, #10074, #9645, #9992, #9568, #9731, #9527).
• Update nvtx. (#10227)
• Tests. (#9499, #9553, #9737)
• Throw error for 32-bit architectures (#10005)
• Helpers. (#9505, #9572, #9750, #9541, #9983, #9714)
• Fix mingw hanging on regex in context (#9729)
• Linters. (#10010, #9634)

CI

• Meta info about the Python package is uploaded for easier parsing (#10295)
• Various dependency updates (#10274, #10280, #10278, #10275, #10320, #10305, #10267, #9544, #10228, #10133, #10187, #9857, #10042, #10268, #9654, #9835)
• GitHub Action fixes (#10067, #10134, #10064)
• Improved support for Apple devices. (#10225, #9886, #9699, #9748, #9704, #9749)
• Stop Windows pipeline upon a failing pytest (#10003)
• Cancel GH Action job if a newer commit is published (#10088)
• CI images. (#9666, #10201, #9932)
• Test R package with CMake (#10087)
• Test building for the 32-bit arch (#10021)
• Test federated plugin using GitHub action. (#10336)