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

refine docs

Browse Source
This commit is contained in:
Young
2020-11-30 04:21:33 +00:00
committed by you-n-g
parent 4caddb24ad
commit 1877ad8c39
8 changed files with 47 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/component/recorder.rst
View File

@@ -7,7 +7,7 @@ Qlib Recorder: Experiment Management
Introduction
===================
``Qlib`` contains an experiment management system named ``QlibRecorder``, which is designed to help users handle experiment and analysis results in an efficient way.
``Qlib`` contains an experiment management system named ``QlibRecorder``, which is designed to help users handle experiment and analyse results in an efficient way.
There are three components of the system:
@@ -34,8 +34,7 @@ Here is a general view of the structure of the system:
- Recorder 2
- ...
- ...
Currently, the components of this experiment management system are implemented using the machine learning platform: ``MLFlow`` (`link <https://mlflow.org/>`_).
This experiment management system defines a set of interface and provided a concrete implementation based on the machine learning platform: ``MLFlow`` (`link <https://mlflow.org/>`_).
Qlib Recorder
@@ -94,4 +93,4 @@ The ``RecordTemp`` class is a class that enables generate experiment results suc
- ``SigAnaRecord``: This class generates the `IC`, `ICIR`, `Rank IC` and `Rank ICIR` of the model.
- ``PortAnaRecord``: This class generates the results of `backtest`. The detailed information about `backtest` as well as the available `strategy`, users can refer to `Strategy <../component/strategy.html>`_ and `Backtest <../component/backtest.html>`_.
For more information about the APIs, please refer to `Record Template API <../reference/api.html#module-qlib.workflow.record_temp>`_.
For more information about the APIs, please refer to `Record Template API <../reference/api.html#module-qlib.workflow.record_temp>`_.