.. _installation:

============
安装
============

.. currentmodule:: qlib


``Qlib`` 安装
=====================
.. note::

   `Qlib` 同时支持 `Windows` 和 `Linux` 系统。建议在 `Linux` 环境下使用 `Qlib`。``Qlib`` 支持 Python3，最高兼容 Python3.8。

用户可以通过以下pip命令轻松安装 ``Qlib``：

.. code-block:: bash

   pip install pyqlib


此外，用户可以通过以下步骤从源代码安装 ``Qlib``：

- 进入 ``Qlib`` 的根目录（该目录包含 ``setup.py`` 文件）
- 执行以下命令安装环境依赖并安装 ``Qlib``：

   .. code-block:: bash

      $ pip install numpy
      $ pip install --upgrade cython
      $ git clone https://github.com/microsoft/qlib.git && cd qlib
      $ python setup.py install

.. note::
   建议使用 anaconda/miniconda 配置环境。``Qlib`` 需要 lightgbm 和 pytorch 包，请使用 pip 安装它们。



使用以下代码确保安装成功：

.. code-block:: python

   >>> import qlib
   >>> qlib.__version__
   <LATEST VERSION>