1
0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-16 17:12:20 +08:00

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

* 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

View File

@@ -31,6 +31,7 @@ Here is the base class of ``TaskGen``:
.. autoclass:: qlib.workflow.task.gen.TaskGen .. autoclass:: qlib.workflow.task.gen.TaskGen
:members: :members:
:noindex:
``Qlib`` provides a class `RollingGen <https://github.com/microsoft/qlib/tree/main/qlib/workflow/task/gen.py>`_ to generate a list of ``task`` of the dataset in different date segments. ``Qlib`` provides a class `RollingGen <https://github.com/microsoft/qlib/tree/main/qlib/workflow/task/gen.py>`_ to generate a list of ``task`` of the dataset in different date segments.
This class allows users to verify the effect of data from different periods on the model in one experiment. More information is `here <../reference/api.html#TaskGen>`__. This class allows users to verify the effect of data from different periods on the model in one experiment. More information is `here <../reference/api.html#TaskGen>`__.
@@ -53,6 +54,7 @@ Users need to provide the MongoDB URL and database name for using ``TaskManager`
.. autoclass:: qlib.workflow.task.manage.TaskManager .. autoclass:: qlib.workflow.task.manage.TaskManager
:members: :members:
:noindex:
More information of ``Task Manager`` can be found in `here <../reference/api.html#TaskManager>`__. More information of ``Task Manager`` can be found in `here <../reference/api.html#TaskManager>`__.
@@ -64,11 +66,13 @@ An easy way to get the ``task_func`` is using ``qlib.model.trainer.task_train``
It will run the whole workflow defined by ``task``, which includes *Model*, *Dataset*, *Record*. It will run the whole workflow defined by ``task``, which includes *Model*, *Dataset*, *Record*.
.. autofunction:: qlib.workflow.task.manage.run_task .. autofunction:: qlib.workflow.task.manage.run_task
:noindex:
Meanwhile, ``Qlib`` provides a module called ``Trainer``. Meanwhile, ``Qlib`` provides a module called ``Trainer``.
.. autoclass:: qlib.model.trainer.Trainer .. autoclass:: qlib.model.trainer.Trainer
:members: :members:
:noindex:
``Trainer`` will train a list of tasks and return a list of model recorders. ``Trainer`` will train a list of tasks and return a list of model recorders.
``Qlib`` offer two kinds of Trainer, TrainerR is the simplest way and TrainerRM is based on TaskManager to help manager tasks lifecycle automatically. ``Qlib`` offer two kinds of Trainer, TrainerR is the simplest way and TrainerRM is based on TaskManager to help manager tasks lifecycle automatically.

View File

@@ -332,6 +332,7 @@ Here are some interfaces of the ``QlibDataLoader`` class:
.. autoclass:: qlib.data.dataset.loader.DataLoader .. autoclass:: qlib.data.dataset.loader.DataLoader
:members: :members:
:noindex:
API API
--- ---
@@ -361,6 +362,7 @@ Here are some important interfaces that ``DataHandlerLP`` provides:
.. autoclass:: qlib.data.dataset.handler.DataHandlerLP .. autoclass:: qlib.data.dataset.handler.DataHandlerLP
:members: __init__, fetch, get_cols :members: __init__, fetch, get_cols
:noindex:
If users want to load features and labels by config, users can define a new handler and call the static method `parse_config_to_fields` of ``qlib.contrib.data.handler.Alpha158``. If users want to load features and labels by config, users can define a new handler and call the static method `parse_config_to_fields` of ``qlib.contrib.data.handler.Alpha158``.
@@ -451,6 +453,7 @@ The ``DatasetH`` class is the `dataset` with `Data Handler`. Here is the most im
.. autoclass:: qlib.data.dataset.__init__.DatasetH .. autoclass:: qlib.data.dataset.__init__.DatasetH
:members: :members:
:noindex:
API API
--- ---
@@ -470,9 +473,11 @@ Global Memory Cache
.. autoclass:: qlib.data.cache.MemCacheUnit .. autoclass:: qlib.data.cache.MemCacheUnit
:members: :members:
:noindex:
.. autoclass:: qlib.data.cache.MemCache .. autoclass:: qlib.data.cache.MemCache
:members: :members:
:noindex:
ExpressionCache ExpressionCache
@@ -487,6 +492,7 @@ The following shows the details about the interfaces:
.. autoclass:: qlib.data.cache.ExpressionCache .. autoclass:: qlib.data.cache.ExpressionCache
:members: :members:
:noindex:
``Qlib`` has currently provided implemented disk cache `DiskExpressionCache` which inherits from `ExpressionCache` . The expressions data will be stored in the disk. ``Qlib`` has currently provided implemented disk cache `DiskExpressionCache` which inherits from `ExpressionCache` . The expressions data will be stored in the disk.
@@ -502,6 +508,7 @@ The following shows the details about the interfaces:
.. autoclass:: qlib.data.cache.DatasetCache .. autoclass:: qlib.data.cache.DatasetCache
:members: :members:
:noindex:
``Qlib`` has currently provided implemented disk cache `DiskDatasetCache` which inherits from `DatasetCache` . The datasets' data will be stored in the disk. ``Qlib`` has currently provided implemented disk cache `DiskDatasetCache` which inherits from `DatasetCache` . The datasets' data will be stored in the disk.

View File

@@ -20,6 +20,7 @@ The base class provides the following interfaces:
.. autoclass:: qlib.model.base.Model .. autoclass:: qlib.model.base.Model
:members: :members:
:noindex:
``Qlib`` also provides a base class `qlib.model.base.ModelFT <../reference/api.html#qlib.model.base.ModelFT>`_, which includes the method for finetuning the model. ``Qlib`` also provides a base class `qlib.model.base.ModelFT <../reference/api.html#qlib.model.base.ModelFT>`_, which includes the method for finetuning the model.

View File

@@ -32,21 +32,25 @@ Online Manager
.. automodule:: qlib.workflow.online.manager .. automodule:: qlib.workflow.online.manager
:members: :members:
:noindex:
Online Strategy Online Strategy
=============== ===============
.. automodule:: qlib.workflow.online.strategy .. automodule:: qlib.workflow.online.strategy
:members: :members:
:noindex:
Online Tool Online Tool
=========== ===========
.. automodule:: qlib.workflow.online.utils .. automodule:: qlib.workflow.online.utils
:members: :members:
:noindex:
Updater Updater
======= =======
.. automodule:: qlib.workflow.online.update .. automodule:: qlib.workflow.online.update
:members: :members:
:noindex:

View File

@@ -61,6 +61,7 @@ The ``ExpManager`` module in ``Qlib`` is responsible for managing different expe
.. autoclass:: qlib.workflow.expm.ExpManager .. autoclass:: qlib.workflow.expm.ExpManager
:members: get_exp, list_experiments :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>`_. 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 .. autoclass:: qlib.workflow.exp.Experiment
:members: get_recorder, list_recorders :members: get_recorder, list_recorders
:noindex:
For other interfaces such as `search_records`, `delete_recorder`, please refer to `Experiment API <../reference/api.html#experiment>`_. 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 .. autoclass:: qlib.workflow.recorder.Recorder
:members: list_artifacts, list_metrics, list_params, list_tags :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>`_. For other interfaces such as `save_objects`, `load_object`, please refer to `Recorder API <../reference/api.html#recorder>`_.

View File

@@ -51,6 +51,7 @@ API
.. automodule:: qlib.contrib.report.analysis_position.report .. automodule:: qlib.contrib.report.analysis_position.report
:members: :members:
:noindex:
Graphical Result Graphical Result
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@@ -93,6 +94,7 @@ API
.. automodule:: qlib.contrib.report.analysis_position.score_ic .. automodule:: qlib.contrib.report.analysis_position.score_ic
:members: :members:
:noindex:
Graphical Result Graphical Result
@@ -151,6 +153,7 @@ API
.. automodule:: qlib.contrib.report.analysis_position.risk_analysis .. automodule:: qlib.contrib.report.analysis_position.risk_analysis
:members: :members:
:noindex:
Graphical Result Graphical Result
@@ -270,6 +273,7 @@ API
.. automodule:: qlib.contrib.report.analysis_model.analysis_model_performance .. automodule:: qlib.contrib.report.analysis_model.analysis_model_performance
:members: :members:
:noindex:
Graphical Results Graphical Results