init commit

docs/reference/api.rst

@@ -0,0 +1,117 @@
+================================
+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.ServerExpressionCache
+    :members:
+
+.. autoclass:: qlib.data.cache.ServerDatasetCache
+    :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:
+
+