快速入门

介绍

这个“快速入门”指南试图证明：

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

量化研究工作流程:

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

cd examples  # 避免在包含 `qlib` 的目录下运行程序
qrun benchmarks/LightGBM/workflow_config_lightgbm.yaml

工作流程结果

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

                                                  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

要了解有关“工作流程”和“qrun”的更多信息，请参阅工作流程管理。

图形报告分析:
- 使用jupyter notebook运行 examples/workflow_by_code.ipynb
  用户可以通过运行 examples/workflow_by_code.ipynb 进行投资组合分析或预测结果（模型预测）分析。
- 图形报告
  用户可以获得有关分析的图形报告，请参阅评估和结果分析获取更多详细信息。

自定义模型集成

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