mirror of
https://github.com/microsoft/qlib.git
synced 2026-06-06 05:51:17 +08:00
de9e13b171
* 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>
62 lines
1.6 KiB
ReStructuredText
62 lines
1.6 KiB
ReStructuredText
============================================================
|
|
``Qlib`` Documentation
|
|
============================================================
|
|
|
|
``Qlib`` is an AI-oriented quantitative investment platform, which aims to realize the potential, empower the research, and create the value of AI technologies in quantitative investment.
|
|
|
|
.. _user_guide:
|
|
|
|
Document Structure
|
|
====================
|
|
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
Home <self>
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: GETTING STARTED:
|
|
|
|
Introduction <introduction/introduction.rst>
|
|
Quick Start <introduction/quick.rst>
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: FIRST STEPS:
|
|
|
|
Installation <start/installation.rst>
|
|
Initialization <start/initialization.rst>
|
|
Data Retrieval <start/getdata.rst>
|
|
Custom Model Integration <start/integration.rst>
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: COMPONENTS:
|
|
|
|
Estimator: Workflow Management <component/estimator.rst>
|
|
Data Layer: Data Framework&Usage <component/data.rst>
|
|
Interday Model: Model Training & Prediction <component/model.rst>
|
|
Interday Strategy: Portfolio Management <component/strategy.rst>
|
|
Intraday Trading: Model&Strategy Testing <component/backtest.rst>
|
|
Aanalysis: Evaluation & Results Analysis <component/report.rst>
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: ADVANCED TOPICS:
|
|
|
|
Building Formulaic Alphas <advanced/alpha.rst>
|
|
Online & Offline mode <advanced/server.rst>
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: REFERENCE:
|
|
|
|
API <reference/api.rst>
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
:caption: Change Log:
|
|
|
|
Change Log <changelog/changelog.rst>
|