Skip to content

Commit

Permalink
[doc] Fix outdated document [skip ci] (dmlc#8527)
Browse files Browse the repository at this point in the history
* [doc] Fix document around categorical parameters. [skip ci]

* note on validate parameter [skip ci]

* Fix dask doc as well [skip ci]
  • Loading branch information
trivialfis committed Dec 6, 2022
1 parent 67b657d commit a6021d3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 12 deletions.
12 changes: 4 additions & 8 deletions doc/parameter.rst
Expand Up @@ -44,8 +44,7 @@ General Parameters
* ``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
a parameter is used or not. The feature is still experimental. It's expected to have
some false positives.
a parameter is used or not.

* ``nthread`` [default to maximum number of threads available if not set]

Expand Down Expand Up @@ -233,24 +232,21 @@ Parameters for Categorical Feature
These parameters are only used for training with categorical data. See
:doc:`/tutorials/categorical` for more information.

.. note:: These parameters are experimental. ``exact`` tree method is not yet supported.


* ``max_cat_to_onehot``

.. 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
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.
Only relevant for regression and binary classification. Also, ``exact`` tree method is
not supported

* ``max_cat_threshold``

.. 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
splits for preventing over-fitting.

Expand Down
5 changes: 1 addition & 4 deletions doc/python/python_api.rst
Expand Up @@ -25,9 +25,6 @@ Core Data Structure
.. autoclass:: xgboost.QuantileDMatrix
:show-inheritance:

.. autoclass:: xgboost.DeviceQuantileDMatrix
:show-inheritance:

.. autoclass:: xgboost.Booster
:members:
:show-inheritance:
Expand Down Expand Up @@ -115,7 +112,7 @@ Dask API
:inherited-members:
:show-inheritance:

.. autoclass:: xgboost.dask.DaskDeviceQuantileDMatrix
.. autoclass:: xgboost.dask.DaskQuantileDMatrix
:members:
:inherited-members:
:show-inheritance:
Expand Down

0 comments on commit a6021d3

Please sign in to comment.