From d976391a745602fb042ba3ffcea025aa43c86e52 Mon Sep 17 00:00:00 2001 From: bxdd Date: Wed, 30 Sep 2020 13:13:30 +0800 Subject: [PATCH] update installation README.md & docs --- README.md | 8 +++++++- docs/start/installation.rst | 10 ++++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index be65cd950..d88f81b3d 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,13 @@ This quick start guide tries to demonstrate ## Installation -Users can easily intsall ``Qlib`` according to the following steps: +Users can easily install ``Qlib`` by pip according to the following command + +```bash + pip install pyqlib +``` + +Also, Users can install ``Qlib`` by the source code according to the following steps: * Before installing ``Qlib`` from source, users need to install some dependencies: diff --git a/docs/start/installation.rst b/docs/start/installation.rst index 063363766..2ac3dda77 100644 --- a/docs/start/installation.rst +++ b/docs/start/installation.rst @@ -12,7 +12,14 @@ Installation `Qlib` supports both `Windows` and `Linux`. It's recommended to use `Qlib` in `Linux`. ``Qlib`` supports Python3, which is up to Python3.8. -Please follow the steps below to install ``Qlib``: +Users can easily install ``Qlib`` by pip according to the following command: + +.. code-block:: bash + + pip install pyqlib + + +Also, Users can install ``Qlib`` by the source code according to the following steps: - Enter the root directory of ``Qlib``, in which the file ``setup.py`` exists. - Then, please execute the following command to install the environment dependencies and install ``Qlib``: @@ -24,7 +31,6 @@ Please follow the steps below to install ``Qlib``: $ git clone https://github.com/microsoft/qlib.git && cd qlib $ python setup.py install - .. note:: It's recommended to use anaconda/miniconda to setup the environment. ``Qlib`` needs lightgbm and pytorch packages, use pip to install them.