快速入门¶

简介¶

本 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 的工具来自动运行整个工作流程（包括构建数据集、训练模型、回测和评估）。用户可以通过以下步骤启动自动化量化研究流程并获取图形化报告分析：

量化研究流程：

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

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

工作流结果

qrun 的结果如下，这也是 预测模型(alpha) 的典型结果。有关结果的更多详细信息，请参阅日内交易。

                                                  risk
无成本超额收益 均值               0.000605
           标准差                0.005481
           年化收益率            0.152373
           信息比率              1.751319
           最大回撤             -0.059055

含成本超额收益均值 0.000410: 标准差 0.005478 年化收益率 0.103265 信息比率 1.187411 最大回撤 -0.075024

要了解更多关于`工作流`和`qrun`的信息，请参阅工作流：工作流管理。

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

自定义模型集成¶

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