Blame: doc/python/python_api.rst - dmlc/xgboost

dmlc / xgboost UNCLAIMED

Scalable, Portable and Distributed Gradient Boosting (GBDT, GBRT or GBM) Library, for Python, R, Java, Scala, C++ and more. Runs on single machine, Hadoop, Spark, Dask, Flink and DataFlow

28215 0 1 C++

Normal View History Raw

enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`Python API Reference`
			`====================`
Fix spelling in documents (#6948) * Update roxygen2 doc. Co-authored-by: fis <jm.yuan@outlook.com> 2021-05-11 06:44:36 -06:00			`This page gives the Python API reference of xgboost, please also refer to Python Package Introduction for more information about the Python package.`
Document refactor change badge 2015-08-01 13:47:41 -07:00
Update Python API doc (#3619) * Add XGBRanker to Python API doc * Show inherited members of XGBRegressor in API doc, since XGBRegressor uses default methods from XGBModel * Add table of contents to Python API doc * Skip JVM doc download if not available * Show inherited members for XGBRegressor and XGBRanker * Expose XGBRanker to Python XGBoost module directory * Add docstring to XGBRegressor.predict() and XGBRanker.predict() * Fix rendering errors in Python docstrings * Fix lint 2018-08-22 18:59:30 -07:00			`.. contents::`
			`:backlinks: none`
			`:local:`

Add global configuration (#6414) * Add management functions for global configuration: XGBSetGlobalConfig(), XGBGetGlobalConfig(). * Add Python interface: set_config(), get_config(), and config_context(). * Add unit tests for Python * Add R interface: xgb.set.config(), xgb.get.config() * Add unit tests for R Co-authored-by: Jiaming Yuan <jm.yuan@outlook.com> 2020-12-03 00:05:18 -08:00			`Global Configuration`
			`--------------------`
			`.. autofunction:: xgboost.config_context`

			`.. autofunction:: xgboost.set_config`

			`.. autofunction:: xgboost.get_config`

[doc] Add `build_info` to autodoc. [skip ci] (#10551) 2024-07-10 04:05:20 +08:00			`.. autofunction:: xgboost.build_info`

enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`Core Data Structure`
			`-------------------`
			`.. automodule:: xgboost.core`

			`.. autoclass:: xgboost.DMatrix`
			`:members:`
			`:show-inheritance:`

Quantile DMatrix for CPU. (#8130) - Add a new `QuantileDMatrix` that works for both CPU and GPU. - Deprecate `DeviceQuantileDMatrix`. 2022-08-02 15:51:23 +08:00			`.. autoclass:: xgboost.QuantileDMatrix`
Use `weakref` instead of `id` for `DataIter` cache. (#9445) - Fix case where Python reuses id from freed objects. - Small optimization to column matrix with QDM by using `realloc` instead of copying data. 2023-08-10 00:40:06 +08:00			`:members:`
[EM] Make page concatenation optional. (#10826) This PR introduces a new parameter `extmem_concat_pages` to make the page concatenation optional for GPU hist. In addition, the document is updated for the new GPU-based external memory. 2024-09-24 06:19:28 +08:00			`:inherited-members:`
			`:show-inheritance:`

			`.. autoclass:: xgboost.ExtMemQuantileDMatrix`
			`:members:`
			`:inherited-members:`
Quantile DMatrix for CPU. (#8130) - Add a new `QuantileDMatrix` that works for both CPU and GPU. - Deprecate `DeviceQuantileDMatrix`. 2022-08-02 15:51:23 +08:00			`:show-inheritance:`

enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`.. autoclass:: xgboost.Booster`
			`:members:`
			`:show-inheritance:`
Remove deprecated `feval`. (#11051) --------- Co-authored-by: Philip Hyunsu Cho <chohyu01@cs.washington.edu> 2024-12-06 16:48:17 +08:00			`:special-members: __getitem__`
enable basic sphinx doc 2015-08-01 11:27:13 -07:00
Use `weakref` instead of `id` for `DataIter` cache. (#9445) - Fix case where Python reuses id from freed objects. - Small optimization to column matrix with QDM by using `realloc` instead of copying data. 2023-08-10 00:40:06 +08:00			`.. autoclass:: xgboost.DataIter`
			`:members:`
			`:show-inheritance:`
enable basic sphinx doc 2015-08-01 11:27:13 -07:00
[enc] Support trianing continuation. (#11598) - Use the `__arrow_c_device_array__` in cuDF 25.06. - Reuse the `feature_types` for reference encoding. - Change the columnar schema to include a handle to the cat container. - Support training continuation through re-coding the `DMatrix`. - Handle invalid input type. - Support all integer types. 2025-08-01 04:56:52 +08:00			`.. autoclass:: xgboost.core.Categories`

enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`Learning API`
			`------------`
			`.. automodule:: xgboost.training`

			`.. autofunction:: xgboost.train`

			`.. autofunction:: xgboost.cv`


			`Scikit-Learn API`
			`----------------`
[doc] Add introduction and notes for the sklearn interface. (#8948) 2023-03-23 13:30:42 +08:00
enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`.. automodule:: xgboost.sklearn`
			`.. autoclass:: xgboost.XGBRegressor`
			`:members:`
Update Python API doc (#3619) * Add XGBRanker to Python API doc * Show inherited members of XGBRegressor in API doc, since XGBRegressor uses default methods from XGBModel * Add table of contents to Python API doc * Skip JVM doc download if not available * Show inherited members for XGBRegressor and XGBRanker * Expose XGBRanker to Python XGBoost module directory * Add docstring to XGBRegressor.predict() and XGBRanker.predict() * Fix rendering errors in Python docstrings * Fix lint 2018-08-22 18:59:30 -07:00			`:inherited-members:`
enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`:show-inheritance:`
			`.. autoclass:: xgboost.XGBClassifier`
			`:members:`
Update Python API doc (#3619) * Add XGBRanker to Python API doc * Show inherited members of XGBRegressor in API doc, since XGBRegressor uses default methods from XGBModel * Add table of contents to Python API doc * Skip JVM doc download if not available * Show inherited members for XGBRegressor and XGBRanker * Expose XGBRanker to Python XGBoost module directory * Add docstring to XGBRegressor.predict() and XGBRanker.predict() * Fix rendering errors in Python docstrings * Fix lint 2018-08-22 18:59:30 -07:00			`:inherited-members:`
			`:show-inheritance:`
			`.. autoclass:: xgboost.XGBRanker`
			`:members:`
			`:inherited-members:`
enable basic sphinx doc 2015-08-01 11:27:13 -07:00			`:show-inheritance:`
Add python RF documentation (#4500) 2019-05-25 18:30:24 +12:00			`.. autoclass:: xgboost.XGBRFRegressor`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
			`.. autoclass:: xgboost.XGBRFClassifier`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
ENH: Add visualization to python package 2015-08-11 16:40:09 +09:00
			`Plotting API`
			`------------`
			`.. automodule:: xgboost.plotting`

			`.. autofunction:: xgboost.plot_importance`

			`.. autofunction:: xgboost.plot_tree`

			`.. autofunction:: xgboost.to_graphviz`
Fix #3663: Allow sklearn API to use callbacks (#3682) * Fix #3663: Allow sklearn API to use callbacks * Fix lint * Add Callback API to Python API doc 2018-09-07 23:51:26 +03:00
			`.. _callback_api:`

			`Callback API`
			`------------`
[doc] Use cross references in sphinx doc. (#7522) * Use cross references instead of URL. * Fix auto doc for callback. 2022-01-05 03:21:25 +08:00			`.. automodule:: xgboost.callback`
			`.. autoclass:: xgboost.callback.TrainingCallback`
			`:members:`
Fix #3663: Allow sklearn API to use callbacks (#3682) * Fix #3663: Allow sklearn API to use callbacks * Fix lint * Add Callback API to Python API doc 2018-09-07 23:51:26 +03:00
[doc] Use cross references in sphinx doc. (#7522) * Use cross references instead of URL. * Fix auto doc for callback. 2022-01-05 03:21:25 +08:00			`.. autoclass:: xgboost.callback.EvaluationMonitor`
			`:members:`
			`:show-inheritance:`
Fix #3663: Allow sklearn API to use callbacks (#3682) * Fix #3663: Allow sklearn API to use callbacks * Fix lint * Add Callback API to Python API doc 2018-09-07 23:51:26 +03:00
[doc] Use cross references in sphinx doc. (#7522) * Use cross references instead of URL. * Fix auto doc for callback. 2022-01-05 03:21:25 +08:00			`.. autoclass:: xgboost.callback.EarlyStopping`
			`:members:`
			`:show-inheritance:`
Fix #3663: Allow sklearn API to use callbacks (#3682) * Fix #3663: Allow sklearn API to use callbacks * Fix lint * Add Callback API to Python API doc 2018-09-07 23:51:26 +03:00
[doc] Use cross references in sphinx doc. (#7522) * Use cross references instead of URL. * Fix auto doc for callback. 2022-01-05 03:21:25 +08:00			`.. autoclass:: xgboost.callback.LearningRateScheduler`
			`:members:`
			`:show-inheritance:`
Update Python documents. (#6376) 2020-11-12 17:51:32 +08:00
[doc] Use cross references in sphinx doc. (#7522) * Use cross references instead of URL. * Fix auto doc for callback. 2022-01-05 03:21:25 +08:00			`.. autoclass:: xgboost.callback.TrainingCheckPoint`
			`:members:`
			`:show-inheritance:`
Add native support for Dask (#4473) * Add native support for Dask * Add multi-GPU demo * Add sklearn example 2019-05-27 13:29:28 +12:00
Fix dask API sphinx docstrings (#4507) * Fix dask API sphinx docstrings * Update GPU docs page 2019-05-28 16:39:26 +12:00			`.. _dask_api:`

Add native support for Dask (#4473) * Add native support for Dask * Add multi-GPU demo * Add sklearn example 2019-05-27 13:29:28 +12:00			`Dask API`
			`--------`
			`.. automodule:: xgboost.dask`

[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`.. autoclass:: xgboost.dask.DaskDMatrix`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
Add native support for Dask (#4473) * Add native support for Dask * Add multi-GPU demo * Add sklearn example 2019-05-27 13:29:28 +12:00
[doc] Fix outdated document [skip ci] (#8527) * [doc] Fix document around categorical parameters. [skip ci] * note on validate parameter [skip ci] * Fix dask doc as well [skip ci] 2022-12-06 00:56:17 +08:00			`.. autoclass:: xgboost.dask.DaskQuantileDMatrix`
[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
Export DaskDeviceQuantileDMatrix in doc. [skip ci] (#5975) 2020-08-05 00:48:10 +08:00
Note for `DaskDMatrix`. (#5144) * Brief introduction to `DaskDMatrix`. * Add xgboost.dask.train to API doc 2019-12-23 18:55:32 +08:00			`.. autofunction:: xgboost.dask.train`

Rewrite Dask interface. (#4819) 2019-09-25 01:30:14 -04:00			`.. autofunction:: xgboost.dask.predict`
Add native support for Dask (#4473) * Add native support for Dask * Add multi-GPU demo * Add sklearn example 2019-05-27 13:29:28 +12:00
Update Python documents. (#6376) 2020-11-12 17:51:32 +08:00			`.. autofunction:: xgboost.dask.inplace_predict`

[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`.. autoclass:: xgboost.dask.DaskXGBClassifier`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
Fix dask API sphinx docstrings (#4507) * Fix dask API sphinx docstrings * Update GPU docs page 2019-05-28 16:39:26 +12:00
[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`.. autoclass:: xgboost.dask.DaskXGBRegressor`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
[dask] Random forest estimators (#6602) 2021-01-13 20:59:20 +08:00
[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`.. autoclass:: xgboost.dask.DaskXGBRanker`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
[dask] Random forest estimators (#6602) 2021-01-13 20:59:20 +08:00
[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`.. autoclass:: xgboost.dask.DaskXGBRFRegressor`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
[dask] Random forest estimators (#6602) 2021-01-13 20:59:20 +08:00
[dask] Improve documents. (#6687) * Add tag for versions. * use autoclass in sphinx build. Made some class methods to be private to avoid exporting documents. 2021-02-09 09:20:58 +08:00			`.. autoclass:: xgboost.dask.DaskXGBRFClassifier`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
[doc] Integrate pyspark module into sphinx doc [skip ci] (#8066) 2022-07-17 10:46:09 +08:00

			`PySpark API`
			`-----------`

			`.. automodule:: xgboost.spark`

			`.. autoclass:: xgboost.spark.SparkXGBClassifier`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`

			`.. autoclass:: xgboost.spark.SparkXGBClassifierModel`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`

			`.. autoclass:: xgboost.spark.SparkXGBRegressor`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`

			`.. autoclass:: xgboost.spark.SparkXGBRegressorModel`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
[doc] Add missing document for pyspark ranker. [skip ci] (#8692) 2023-01-18 07:52:18 +08:00
			`.. autoclass:: xgboost.spark.SparkXGBRanker`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`

			`.. autoclass:: xgboost.spark.SparkXGBRankerModel`
			`:members:`
			`:inherited-members:`
			`:show-inheritance:`
[coll] Expose configuration. (#10983) 2024-11-15 18:23:32 +08:00

			`Collective`
			`----------`

			`.. automodule:: xgboost.collective`

			`.. autoclass:: xgboost.collective.Config`

			`.. autofunction:: xgboost.collective.init`

[enc][dask] Support training continuation. (#11609) 2025-08-07 18:12:43 +08:00			`.. autofunction:: xgboost.collective.finalize`

			`.. autofunction:: xgboost.collective.get_rank`

			`.. autofunction:: xgboost.collective.get_world_size`

			`.. autoclass:: xgboost.collective.CommunicatorContext`

[coll] Expose configuration. (#10983) 2024-11-15 18:23:32 +08:00			`.. automodule:: xgboost.tracker`

			`.. autoclass:: xgboost.tracker.RabitTracker`