1
0
mirror of https://github.com/microsoft/qlib.git synced 2026-06-06 05:51:17 +08:00
Files
qlib/docs/reference/api.rst
you-n-g de9e13b171 release-0.5.0 (#1)
* init commit

* change the version number

* rich the docs&fix cache docs

* update index readme

* Modify cache class name

* Modify sharpe to information_ratio

* Modify Group- to Group

* add the description of graphical results & fix the backtest docs

* fix docs in details

* update docs

* Update introduction.rst

* Update README.md

* Update introduction.rst

* Update introduction.rst

* Update introduction.rst

* Update installation.rst

* Update installation.rst

* Update initialization.rst

* Update getdata.rst

* Update integration.rst

* Update initialization.rst

* Update getdata.rst

* Update estimator.rst

Modify some typos.

* Update README.md

Modify the typos.

* Update initialization.rst

* Update data.rst

* Update report.rst

* Update estimator.rst

* Update cumulative_return.py

* Update model.rst

* Update rank_label.py

* Update cumulative_return.py

* Update strategy.rst

* Update getdata.rst

* Update backtest.rst

* Update integration.rst

* Update getdata.rst

* Update introduction.rst

* Update introduction.rst

* Update README.md

* Update report.rst

* Update integration.rst

Fix typos

* Update installation.rst

Fix typos

* Update getdata.rst

* Update initialization.rst

Fix typos.

* add quick start docs&fix detials

* fix estimator docs & fix strategy docs

* fix the cahce in data.rst

* update documents

* Fix Corr && Rsquare

* fix data retrival example to csi300 & fix a data bug

* fix filter bug

* Fix data collector

* Modift model args

* add the log & fix README.md\quick.rst

* add enviroment depend & add intoduction of qlib-server online mode

* fix image center fomat & set log_only of docs is True

* fix README.md format

* update data preparation & readme logo image

* get_data support version

* Modify analysis names

* Modify analysis graph

* update report.rst & data.rst

* commmit estimator for merge

* minimal requirements

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update READEME.md

* Update READEME.md

* update estimator

* Fix doc urls

* fix get_data.py docstring

* update test_get_data.py

* Upate docs

* Upate docs

* Upate docs

Co-authored-by: bxdd <bxddream@gmail.com>
Co-authored-by: zhupr <zhu.pengrong@foxmail.com>
Co-authored-by: Wendi Li <wendili.academic@qq.com>
Co-authored-by: Dingsu Wang <dingsu.wang@gmail.com>
Co-authored-by: bxdd <45119470+bxdd@users.noreply.github.com>
Co-authored-by: cslwqxx <cslwqxx@users.noreply.github.com>
2020-09-24 12:01:39 +08:00

119 lines
1.8 KiB
ReStructuredText

.. _api:
================================
API Reference
================================
Here you can find all ``Qlib`` interfaces.
Data
====================
Provider
--------------------
.. automodule:: qlib.data.data
:members:
Filter
--------------------
.. automodule:: qlib.data.filter
:members:
Feature
--------------------
Class
~~~~~~~~~~~~~~~~~~~~
.. automodule:: qlib.data.base
:members:
Operator
~~~~~~~~~~~~~~~~~~~~
.. automodule:: qlib.data.ops
:members:
Cache
----------------
.. autoclass:: qlib.data.cache.MemCacheUnit
:members:
.. autoclass:: qlib.data.cache.MemCache
:members:
.. autoclass:: qlib.data.cache.ExpressionCache
:members:
.. autoclass:: qlib.data.cache.DatasetCache
:members:
.. autoclass:: qlib.data.cache.DiskExpressionCache
:members:
.. autoclass:: qlib.data.cache.DiskDatasetCache
:members:
Contrib
====================
Data Handler
---------------
.. automodule:: qlib.contrib.estimator.handler
:members:
Model
--------------------
.. automodule:: qlib.contrib.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:
.. automodule:: qlib.contrib.report.analysis_position.score_ic
:members:
.. automodule:: qlib.contrib.report.analysis_position.cumulative_return
:members:
.. automodule:: qlib.contrib.report.analysis_position.risk_analysis
:members:
.. automodule:: qlib.contrib.report.analysis_position.rank_label
:members:
.. automodule:: qlib.contrib.report.analysis_model.analysis_model_performance
:members: