From e43a06b13a330eac3791720a824a178ea748d41a Mon Sep 17 00:00:00 2001 From: liangs6212 <80952198+liangs6212@users.noreply.github.com> Date: Thu, 4 Nov 2021 14:41:34 +0800 Subject: [PATCH] Add AutoXGBoost API Guide (#3376) * add auxo-xgb api guide * add example code * change description * add "\n" * fix paragraph --- docs/readthedocs/requirements-doc.txt | 3 ++- .../source/doc/PythonAPI/AutoML/automl.rst | 13 ++++++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/readthedocs/requirements-doc.txt b/docs/readthedocs/requirements-doc.txt index bc500b6b..98228188 100644 --- a/docs/readthedocs/requirements-doc.txt +++ b/docs/readthedocs/requirements-doc.txt @@ -26,4 +26,5 @@ pystan==2.19.1.1 prophet pmdarima sphinx_markdown_tables -numpy==1.21.2 \ No newline at end of file +numpy==1.21.2 +xgboost \ No newline at end of file diff --git a/docs/readthedocs/source/doc/PythonAPI/AutoML/automl.rst b/docs/readthedocs/source/doc/PythonAPI/AutoML/automl.rst index dfbd9254..cd0ff64c 100644 --- a/docs/readthedocs/source/doc/PythonAPI/AutoML/automl.rst +++ b/docs/readthedocs/source/doc/PythonAPI/AutoML/automl.rst @@ -20,7 +20,7 @@ Sampling specs to be used in search space configuration. :members: :show-inheritance: -automl.metrics +orca.automl.metrics ---------------------------- Evaluate unscaled metrics between y true value and y predicted value. @@ -28,3 +28,14 @@ Evaluate unscaled metrics between y true value and y predicted value. .. automodule:: bigdl.orca.automl.metrics :members: :show-inheritance: + +orca.automl.auto_xgb +--------------------------- + +Automatic hyperparameter optimization for XGBoost models. + +AutoXGBoost is inherited from AutoEstimator. You could refer to `AutoEstimator API Guide `__ for more APIs. + +.. automodule:: bigdl.orca.automl.xgboost.auto_xgb + :members: + :show-inheritance: