Hendrik/xgboost
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[doc] Fix outdated document [skip ci] (#8527)

Browse Source 
* [doc] Fix document around categorical parameters. [skip ci]

* note on validate parameter [skip ci]

* Fix dask doc as well [skip ci]
This commit is contained in:
Jiaming Yuan 2022-12-06 00:56:17 +08:00 committed by GitHub
parent e143a4dd7e
commit 8afcecc025
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/parameter.rst
View File

@ -44,8 +44,7 @@ General Parameters
* ``validate_parameters`` [default to ``false``, except for Python, R and CLI interface] * ``validate_parameters`` [default to ``false``, except for Python, R and CLI interface]
- When set to True, XGBoost will perform validation of input parameters to check whether - When set to True, XGBoost will perform validation of input parameters to check whether
a parameter is used or not. The feature is still experimental. It's expected to have a parameter is used or not.
some false positives.
* ``nthread`` [default to maximum number of threads available if not set] * ``nthread`` [default to maximum number of threads available if not set]
@ -233,24 +232,21 @@ Parameters for Categorical Feature
These parameters are only used for training with categorical data. See These parameters are only used for training with categorical data. See
:doc:`/tutorials/categorical` for more information. :doc:`/tutorials/categorical` for more information.
.. note:: These parameters are experimental. ``exact`` tree method is not yet supported.
* ``max_cat_to_onehot`` * ``max_cat_to_onehot``
.. versionadded:: 1.6.0 .. versionadded:: 1.6.0
.. note:: This parameter is experimental. ``exact`` tree method is not yet supported.
- A threshold for deciding whether XGBoost should use one-hot encoding based split for - A threshold for deciding whether XGBoost should use one-hot encoding based split for
categorical data. When number of categories is lesser than the threshold then one-hot categorical data. When number of categories is lesser than the threshold then one-hot
encoding is chosen, otherwise the categories will be partitioned into children nodes. encoding is chosen, otherwise the categories will be partitioned into children nodes.
Only relevant for regression and binary classification. Also, ``exact`` tree method is
not supported
* ``max_cat_threshold`` * ``max_cat_threshold``
.. versionadded:: 1.7.0 .. versionadded:: 1.7.0
.. note:: This parameter is experimental. ``exact`` tree method is not yet supported.
- Maximum number of categories considered for each split. Used only by partition-based - Maximum number of categories considered for each split. Used only by partition-based
splits for preventing over-fitting. splits for preventing over-fitting.

5
doc/python/python_api.rst
View File

@ -25,9 +25,6 @@ Core Data Structure
.. autoclass:: xgboost.QuantileDMatrix .. autoclass:: xgboost.QuantileDMatrix
:show-inheritance: :show-inheritance:
.. autoclass:: xgboost.DeviceQuantileDMatrix
:show-inheritance:
.. autoclass:: xgboost.Booster .. autoclass:: xgboost.Booster
:members: :members:
:show-inheritance: :show-inheritance:
@ -115,7 +112,7 @@ Dask API
:inherited-members: :inherited-members:
:show-inheritance: :show-inheritance:
.. autoclass:: xgboost.dask.DaskDeviceQuantileDMatrix .. autoclass:: xgboost.dask.DaskQuantileDMatrix
:members: :members:
:inherited-members: :inherited-members:
:show-inheritance: :show-inheritance: