ayo/ipex-llm
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Nano docs: add hpo api docs (#4901)

Browse source 
fix hpo api docs
This commit is contained in:
Shane Huang 2022-07-04 14:37:13 +08:00 committed by GitHub
parent 501505af0d
commit 3f576e5ffa
3 changed files with 51 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/readthedocs/requirements-doc.txt
View file

@ -31,4 +31,6 @@ xgboost
torchmetrics==0.7.2 torchmetrics==0.7.2
pickle5==0.0.12 pickle5==0.0.12
protobuf~=3.19.0 protobuf~=3.19.0
sphinx-tabs==3.4 sphinx-tabs==3.4
optuna==2.10.0
ConfigSpace==0.5.0

42
docs/readthedocs/source/doc/PythonAPI/Nano/hpo_api.rst Normal file
View file

@ -0,0 +1,42 @@
Nano HPO API
==================
Search Space
---------------------------
.. autoclass:: bigdl.nano.automl.hpo.space.Categorical
.. autoclass:: bigdl.nano.automl.hpo.space.Real
.. autoclass:: bigdl.nano.automl.hpo.space.Int
.. autoclass:: bigdl.nano.automl.hpo.space.Bool
HPO for Tensorflow
---------------------------
bigdl.nano.automl.tf.keras.Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: bigdl.nano.automl.tf.keras.Model.Model
:members: search, search_summary
bigdl.nano.automl.tf.keras.Sequential
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: bigdl.nano.automl.tf.keras.Sequential.Sequential
:members: search, search_summary
HPO for PyTorch
---------------------------
bigdl.nano.pytorch.Trainer
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autoclass:: bigdl.nano.pytorch.Trainer
:members: search, search_summary
:undoc-members:

6
docs/readthedocs/source/doc/PythonAPI/Nano/index.rst
View file

@ -5,3 +5,9 @@ Nano API
:maxdepth: 2 :maxdepth: 2
pytorch.rst pytorch.rst
.. toctree::
:maxdepth: 3
hpo_api.rst