From 054ffa29f6ae255c027bc86410cb4a38ae68d588 Mon Sep 17 00:00:00 2001 From: Jactus Date: Wed, 13 Jan 2021 12:09:14 +0800 Subject: [PATCH] Update readme --- .github/workflows/python-publish.yml | 2 +- README.md | 17 +++++++++++++++-- setup.py | 3 +-- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index 8b94a2d3b..08d41d198 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -13,7 +13,7 @@ jobs: strategy: matrix: os: [windows-latest, macos-latest] - python-version: [3.6, 3.7, 3.8, 3.9] + python-version: [3.6, 3.7, 3.8] steps: - uses: actions/checkout@v2 diff --git a/README.md b/README.md index 25090fc01..60e04091c 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,20 @@ Here is a quick **[demo](https://terminalizer.com/view/3f24561a4470)** shows how ## Installation -Users can easily install ``Qlib`` by pip according to the following command(Currently, Qlib only support Python 3.6, 3.7 and 3.8). +This table demonstrates the supported Python version of `Qlib`: +| | install with pip | install from source | plot | +| ------------- |:---------------------:|:--------------------:|:----:| +| Python 3.6 | :heavy_check_mark: | :heavy_check_mark: (only with `Anaconda`) | :heavy_check_mark: | +| Python 3.7 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Python 3.8 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | +| Python 3.9 | :x: | :heavy_check_mark: | :x: | + +**Note**: +1. Please pay attention that installing cython in Python 3.6 will raise some error when installing ``Qlib`` from source. If users use Python 3.6 on their machines, it is recommended to *upgrade* Python to version 3.7 or use `conda`'s Python to install ``Qlib`` from source. +2. For Python 3.9, `Qlib` only supports running workflows such as training models and doing backtest. However, plotting are not supported for now and we will fix this when the dependent packages are upgraded in the future. + +### Install with pip +Users can easily install ``Qlib`` by pip according to the following command. ```bash pip install pyqlib @@ -77,6 +90,7 @@ Users can easily install ``Qlib`` by pip according to the following command(Curr **Note**: pip will install the latest stable qlib. However, the main branch of qlib is in active development. If you want to test the latest scripts or functions in the main branch. Please install qlib with the methods below. +### Install from source Also, users can install the latest dev version ``Qlib`` by the source code according to the following steps: * Before installing ``Qlib`` from source, users need to install some dependencies: @@ -85,7 +99,6 @@ Also, users can install the latest dev version ``Qlib`` by the source code accor pip install numpy pip install --upgrade cython ``` - **Note**: Please pay attention that installing cython in Python 3.6 will raise some error when installing ``Qlib`` from source. If users use Python 3.6 on their machines, it is recommended to *upgrade* Python to version 3.7 or use `conda`'s Python to install ``Qlib`` from source. * Clone the repository and install ``Qlib`` as follows. * If you haven't installed qlib by the command ``pip install pyqlib`` before: diff --git a/setup.py b/setup.py index b959f6c1c..109a6b032 100644 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ REQUIRED = [ "statsmodels", "xlrd>=1.0.0", "plotly==4.12.0", - "matplotlib==3.3.3", + "matplotlib==3.1.3", "tables>=3.6.1", "pyyaml>=5.3.1", "mlflow>=1.12.1", @@ -119,6 +119,5 @@ setup( "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", ], )