liuyu/qlib
1
0
Fork 0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-13 07:46:53 +08:00
Code Activity

Fix the Warnings with duplicate object description when building Qlib's documentation (#1353)

Browse Source 
* Add :noindex: to docs/advanced/task_management.rst

* Add :noindex: to docs/component/data.rst

* Add :noindex: to docs/component/model.rst

* Add :noindex: to docs/component/online.rst

* Add :noindex: to docs/component/recorder.rst

* Add :noindex: to docs/component/report.rst

* Retest
This commit is contained in:
Maxim Smolskiy
2022-11-14 13:53:25 +03:00
committed by GitHub
parent 82afd6a67a
commit 8802653bb9
6 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/component/recorder.rst
View File

@@ -61,6 +61,7 @@ The ``ExpManager`` module in ``Qlib`` is responsible for managing different expe
.. autoclass:: qlib.workflow.expm.ExpManager
:members: get_exp, list_experiments
:noindex:
For other interfaces such as `create_exp`, `delete_exp`, please refer to `Experiment Manager API <../reference/api.html#experiment-manager>`_.
@@ -71,6 +72,7 @@ The ``Experiment`` class is solely responsible for a single experiment, and it w
.. autoclass:: qlib.workflow.exp.Experiment
:members: get_recorder, list_recorders
:noindex:
For other interfaces such as `search_records`, `delete_recorder`, please refer to `Experiment API <../reference/api.html#experiment>`_.
@@ -85,6 +87,7 @@ Here are some important APIs that are not included in the ``QlibRecorder``:
.. autoclass:: qlib.workflow.recorder.Recorder
:members: list_artifacts, list_metrics, list_params, list_tags
:noindex:
For other interfaces such as `save_objects`, `load_object`, please refer to `Recorder API <../reference/api.html#recorder>`_.