From a6021d3f433bd9f77e0083facc1b7bcd1218da66 Mon Sep 17 00:00:00 2001 From: Jiaming Yuan Date: Tue, 6 Dec 2022 00:56:17 +0800 Subject: [PATCH] [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] --- doc/parameter.rst | 12 ++++-------- doc/python/python_api.rst | 5 +---- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/doc/parameter.rst b/doc/parameter.rst index 837a7d1b0b7a..361847501357 100644 --- a/doc/parameter.rst +++ b/doc/parameter.rst @@ -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] @@ -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. diff --git a/doc/python/python_api.rst b/doc/python/python_api.rst index a5ddd7831006..03b431c77d41 100644 --- a/doc/python/python_api.rst +++ b/doc/python/python_api.rst @@ -25,9 +25,6 @@ Core Data Structure .. autoclass:: xgboost.QuantileDMatrix :show-inheritance: -.. autoclass:: xgboost.DeviceQuantileDMatrix - :show-inheritance: - .. autoclass:: xgboost.Booster :members: :show-inheritance: @@ -115,7 +112,7 @@ Dask API :inherited-members: :show-inheritance: -.. autoclass:: xgboost.dask.DaskDeviceQuantileDMatrix +.. autoclass:: xgboost.dask.DaskQuantileDMatrix :members: :inherited-members: :show-inheritance: