Skip to content

Commit 0596174

Browse files
authored
Update task_management.rst (#654)
* Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Update task_management.rst * Add files via upload
1 parent 779b178 commit 0596174

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

docs/_static/img/Task-Gen-Recorder-Collector.svg

Lines changed: 4 additions & 0 deletions
Loading

docs/advanced/task_management.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,11 @@ Introduction
1111

1212
The `Workflow <../component/introduction.html>`_ part introduces how to run research workflow in a loosely-coupled way. But it can only execute one ``task`` when you use ``qrun``.
1313
To automatically generate and execute different tasks, ``Task Management`` provides a whole process including `Task Generating`_, `Task Storing`_, `Task Training`_ and `Task Collecting`_.
14-
With this module, users can run their ``task`` automatically at different periods, in different losses, or even by different models.
14+
With this module, users can run their ``task`` automatically at different periods, in different losses, or even by different models.The processes of task generation, model training and combine and collect data are shown in the following figure.
15+
16+
<div style="align: center">
17+
<img src="https://github.com/microsoft/qlib/blob/main/docs/_static/img/Task-Gen-Recorder-Collector.svg" />
18+
</div>
1519

1620
This whole process can be used in `Online Serving <../component/online.html>`_.
1721

@@ -74,6 +78,8 @@ If you do not want to use ``Task Manager`` to manage tasks, then use TrainerR to
7478

7579
Task Collecting
7680
===============
81+
Before collecting model training results, you need to use the ``qlib.init`` to specify the path of mlruns.
82+
7783
To collect the results of ``task`` after training, ``Qlib`` provides `Collector <../reference/api.html#Collector>`_, `Group <../reference/api.html#Group>`_ and `Ensemble <../reference/api.html#Ensemble>`_ to collect the results in a readable, expandable and loosely-coupled way.
7884

7985
`Collector <../reference/api.html#Collector>`_ can collect objects from everywhere and process them such as merging, grouping, averaging and so on. It has 2 step action including ``collect`` (collect anything in a dict) and ``process_collect`` (process collected dict).
@@ -82,8 +88,10 @@ To collect the results of ``task`` after training, ``Qlib`` provides `Collector
8288
For example: {(A,B,C1): object, (A,B,C2): object} ---``group``---> {(A,B): {C1: object, C2: object}} ---``reduce``---> {(A,B): object}
8389

8490
`Ensemble <../reference/api.html#Ensemble>`_ can merge the objects in an ensemble.
85-
For example: {C1: object, C2: object} ---``Ensemble``---> object
91+
For example: {C1: object, C2: object} ---``Ensemble``---> object.
92+
You can set the ensembles you want in the ``Collector``'s process_list.
93+
Common ensembles include ``AverageEnsemble`` and ``RollingEnsemble``. Average ensemble is used to ensemble the results of different models in the same time period. Rollingensemble is used to ensemble the results of different models in the same time period
8694

8795
So the hierarchy is ``Collector``'s second step corresponds to ``Group``. And ``Group``'s second step correspond to ``Ensemble``.
8896

89-
For more information, please see `Collector <../reference/api.html#Collector>`_, `Group <../reference/api.html#Group>`_ and `Ensemble <../reference/api.html#Ensemble>`_, or the `example <https://github.com/microsoft/qlib/tree/main/examples/model_rolling/task_manager_rolling.py>`_.
97+
For more information, please see `Collector <../reference/api.html#Collector>`_, `Group <../reference/api.html#Group>`_ and `Ensemble <../reference/api.html#Ensemble>`_, or the `example <https://github.com/microsoft/qlib/tree/main/examples/model_rolling/task_manager_rolling.py>`_.

0 commit comments

Comments
 (0)