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

Improve the style of documentation (#1132)

Browse Source 
This commit improves the documentation (rst files) only in the
following three ways:

* Aligned section headers with their underline/overline punctuation characters

* Deleted all trailling whitespaces in rst files

* Deleted a few trailling newlines at the end of the rst files

Co-authored-by: Bingyao Liu <Bingyao.Liu@sofund.com>
This commit is contained in:
YaOzI
2022-07-07 19:42:27 +08:00
committed by GitHub
parent e62684eddf
commit 1dededa33f
29 changed files with 400 additions and 411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/reference/api.rst
View File

@@ -1,7 +1,7 @@
.. _api:
================================
=============
API Reference
================================
=============
@@ -9,32 +9,32 @@ Here you can find all ``Qlib`` interfaces.
Data
====================
====
Provider
--------------------
--------
.. automodule:: qlib.data.data
:members:
Filter
--------------------
------
.. automodule:: qlib.data.filter
:members:
Class
--------------------
-----
.. automodule:: qlib.data.base
:members:
Operator
--------------------
--------
.. automodule:: qlib.data.ops
:members:
Cache
----------------
-----
.. autoclass:: qlib.data.cache.MemCacheUnit
:members:
@@ -55,7 +55,7 @@ Cache
Storage
-------------
-------
.. autoclass:: qlib.data.storage.storage.BaseStorage
:members:
@@ -82,52 +82,52 @@ Storage
Dataset
---------------
-------
Dataset Class
~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~
.. automodule:: qlib.data.dataset.__init__
:members:
Data Loader
~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~
.. automodule:: qlib.data.dataset.loader
:members:
Data Handler
~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~
.. automodule:: qlib.data.dataset.handler
:members:
Processor
~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~
.. automodule:: qlib.data.dataset.processor
:members:
Contrib
====================
=======
Model
--------------------
-----
.. automodule:: qlib.model.base
:members:
Strategy
-------------------
--------
.. automodule:: qlib.contrib.strategy.strategy
:members:
Evaluate
-----------------
--------
.. automodule:: qlib.contrib.evaluate
:members:
Report
-----------------
------
.. automodule:: qlib.contrib.report.analysis_position.report
:members:
@@ -159,103 +159,100 @@ Report
Workflow
====================
========
Experiment Manager
--------------------
------------------
.. autoclass:: qlib.workflow.expm.ExpManager
:members:
Experiment
--------------------
----------
.. autoclass:: qlib.workflow.exp.Experiment
:members:
Recorder
--------------------
--------
.. autoclass:: qlib.workflow.recorder.Recorder
:members:
Record Template
--------------------
---------------
.. automodule:: qlib.workflow.record_temp
:members:
Task Management
====================
===============
TaskGen
--------------------
-------
.. automodule:: qlib.workflow.task.gen
:members:
TaskManager
--------------------
-----------
.. automodule:: qlib.workflow.task.manage
:members:
Trainer
--------------------
-------
.. automodule:: qlib.model.trainer
:members:
Collector
--------------------
---------
.. automodule:: qlib.workflow.task.collect
:members:
Group
--------------------
-----
.. automodule:: qlib.model.ens.group
:members:
Ensemble
--------------------
--------
.. automodule:: qlib.model.ens.ensemble
:members:
Utils
--------------------
-----
.. automodule:: qlib.workflow.task.utils
:members:
Online Serving
====================
==============
Online Manager
--------------------
--------------
.. automodule:: qlib.workflow.online.manager
:members:
Online Strategy
--------------------
---------------
.. automodule:: qlib.workflow.online.strategy
:members:
Online Tool
--------------------
-----------
.. automodule:: qlib.workflow.online.utils
:members:
RecordUpdater
--------------------
-------------
.. automodule:: qlib.workflow.online.update
:members:
Utils
====================
=====
Serializable
--------------------
------------
.. automodule:: qlib.utils.serial.Serializable
:members: