============================================================
``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:

   Workflow: Workflow Management <component/workflow.rst>
   Data Layer: Data Framework&Usage <component/data.rst>
   Forecast Model: Model Training & Prediction <component/model.rst>
   Strategy: Portfolio Management <component/strategy.rst>
   Intraday Trading: Model&Strategy Testing <component/backtest.rst>
   Qlib Recorder: Experiment Management <component/recorder.rst>
   Analysis: Evaluation & Results Analysis <component/report.rst>

.. toctree::
   :maxdepth: 3
   :caption: ADVANCED TOPICS:
   
   Building Formulaic Alphas <advanced/alpha.rst>
   Online & Offline mode <advanced/server.rst>
   Serialization <advanced/serial.rst>
   Task Management <advanced/task_management.rst>

.. toctree::
   :maxdepth: 3
   :caption: REFERENCE:

   API <reference/api.rst>

.. toctree::
   :maxdepth: 3

   FAQ <FAQ/FAQ.rst>

.. toctree::
   :maxdepth: 3
   :caption: Change Log:

   Change Log <changelog/changelog.rst>
