快速开始

介绍

本Quick Start指南试图演示

使用Qlib构建完整的量化研究工作流程并尝试用户的想法非常容易。
尽管使用公开数据和简单模型，机器学习技术在实际量化投资中表现非常出色。

安装

用户可以按照以下步骤轻松安装 Qlib：

在从源代码安装Qlib之前，用户需要安装一些依赖项：
pip install numpy pip install --upgrade cython

克隆仓库并安装 Qlib

git clone https://github.com/microsoft/qlib.git && cd qlib
python setup.py install

要了解更多关于安装的信息，请参考Qlib 安装。

准备数据

通过运行以下代码加载并准备数据：

python scripts/get_data.py qlib_data --target_dir ~/.qlib/qlib_data/cn_data --region cn

该数据集是通过在scripts/data_collector/中收集的公共数据创建的，这些数据已在同一仓库中发布。用户可以使用它创建相同的数据集。

要了解更多关于准备数据的信息，请参考数据准备。

自动量化研究工作流程

Qlib 提供了一个名为 qrun 的工具，用于自动运行整个工作流程（包括构建数据集、训练模型、回测和评估）。用户可以根据以下步骤启动自动量化研究工作流程，并获得图形化的报告分析：

Quant Research Workflow:

使用LightGBM模型的配置文件workflow_config_lightgbm.yaml运行qrun，如下所示。

cd examples  # Avoid running program under the directory contains `qlib`
qrun benchmarks/LightGBM/workflow_config_lightgbm.yaml

Workflow result

qrun 的结果如下，这也是 Forecast model(alpha) 的典型结果。有关结果的更多详细信息，请参阅 Intraday Trading。

                                                  risk
excess_return_without_cost mean               0.000605
                           std                0.005481
                           annualized_return  0.152373
                           information_ratio  1.751319
                           max_drawdown      -0.059055
excess_return_with_cost    mean               0.000410
                           std                0.005478
                           annualized_return  0.103265
                           information_ratio  1.187411
                           max_drawdown      -0.075024

要了解更多关于workflow和qrun的信息，请参考Workflow: Workflow Management。

Graphical Reports Analysis:
- Run examples/workflow_by_code.ipynb with jupyter notebook
  用户可以通过运行examples/workflow_by_code.ipynb来进行投资组合分析或预测分数（模型预测）分析。
- Graphical Reports
  用户可以获取关于分析的图形报告，更多详情请参阅分析：评估与结果分析。

自定义模型集成

Qlib 提供了一批模型（例如 lightGBM 和 MLP 模型）作为 Forecast Model 的示例。除了默认模型外，用户还可以将他们自己的自定义模型集成到 Qlib 中。如果用户对自定义模型感兴趣，请参考自定义模型集成。