1
0
mirror of https://github.com/microsoft/qlib.git synced 2026-06-06 14:01:28 +08:00
Files
qlib/docs/reference/api.rst
2020-11-26 00:55:26 +08:00

155 lines
2.4 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 Loader
---------------
.. automodule:: qlib.data.dataset.loader
:members:
Data Handler
---------------
.. automodule:: qlib.data.dataset.handler
:members:
Processor
---------------
.. automodule:: qlib.data.dataset.processor
:members:
Dataset
---------------
.. automodule:: qlib.data.dataset.__init__
:members:
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:
.. 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:
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: