liuyu/qlib
1
0
Fork 0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-12 15:26:54 +08:00
Code Activity

update installation README.md & docs

Browse Source
This commit is contained in:
bxdd
2020-09-30 13:13:30 +08:00
committed by you-n-g
parent 76137308ab
commit d976391a74
2 changed files with 15 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -60,7 +60,13 @@ This quick start guide tries to demonstrate
## Installation ## 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: * Before installing ``Qlib`` from source, users need to install some dependencies:

10
docs/start/installation.rst
View File

@@ -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. `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. - 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``: - 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 $ git clone https://github.com/microsoft/qlib.git && cd qlib
$ python setup.py install $ python setup.py install
.. note:: .. note::
It's recommended to use anaconda/miniconda to setup the environment. ``Qlib`` needs lightgbm and pytorch packages, use pip to install them. It's recommended to use anaconda/miniconda to setup the environment. ``Qlib`` needs lightgbm and pytorch packages, use pip to install them.