mirror of
https://github.com/microsoft/qlib.git
synced 2026-07-14 16:26:55 +08:00
Update docs and support Python 3.9
This commit is contained in:
2
.github/workflows/python-publish.yml
vendored
2
.github/workflows/python-publish.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [windows-latest, macos-latest]
|
os: [windows-latest, macos-latest]
|
||||||
python-version: [3.6, 3.7, 3.8]
|
python-version: [3.6, 3.7, 3.8, 3.9]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|||||||
2
.github/workflows/test.yml
vendored
2
.github/workflows/test.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [windows-latest, ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-latest]
|
os: [windows-latest, ubuntu-16.04, ubuntu-18.04, ubuntu-20.04, macos-latest]
|
||||||
python-version: [3.6, 3.7, 3.8]
|
python-version: [3.6, 3.7, 3.8, 3.9]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v2
|
||||||
|
|||||||
@@ -149,6 +149,10 @@ Qlib provides a tool named `qrun` to run the whole workflow automatically (inclu
|
|||||||
cd examples # Avoid running program under the directory contains `qlib`
|
cd examples # Avoid running program under the directory contains `qlib`
|
||||||
qrun benchmarks/LightGBM/workflow_config_lightgbm_Alpha158.yaml
|
qrun benchmarks/LightGBM/workflow_config_lightgbm_Alpha158.yaml
|
||||||
```
|
```
|
||||||
|
If users want to use `qrun` under debug mode, please use the following command:
|
||||||
|
```bash
|
||||||
|
python -m pdb qlib/workflow/cli.py examples/benchmarks/LightGBM/workflow_config_lightgbm_Alpha158.yaml
|
||||||
|
```
|
||||||
The result of `qrun` is as follows, please refer to [Intraday Trading](https://qlib.readthedocs.io/en/latest/component/backtest.html) for more details about the result.
|
The result of `qrun` is as follows, please refer to [Intraday Trading](https://qlib.readthedocs.io/en/latest/component/backtest.html) for more details about the result.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
@@ -34,8 +34,9 @@ Here is a general view of the structure of the system:
|
|||||||
- Recorder 2
|
- Recorder 2
|
||||||
- ...
|
- ...
|
||||||
- ...
|
- ...
|
||||||
This experiment management system defines a set of interface and provided a concrete implementation based on the machine learning platform: ``MLFlow`` (`link <https://mlflow.org/>`_).
|
This experiment management system defines a set of interface and provided a concrete implementation ``MLflowExpManager``, which is based on the machine learning platform: ``MLFlow`` (`link <https://mlflow.org/>`_).
|
||||||
|
|
||||||
|
If users set the implementation of ``ExpManager`` to be ``MLflowExpManager``, they can use the command `mlflow ui` to visualize and check the experiment results. For more information, pleaes refer to the related documents `here <https://www.mlflow.org/docs/latest/cli.html#mlflow-ui>`_.
|
||||||
|
|
||||||
Qlib Recorder
|
Qlib Recorder
|
||||||
===================
|
===================
|
||||||
|
|||||||
@@ -103,6 +103,12 @@ After saving the config into `configuration.yaml`, users could start the workflo
|
|||||||
|
|
||||||
qrun configuration.yaml
|
qrun configuration.yaml
|
||||||
|
|
||||||
|
If users want to use ``qrun`` under debug mode, please use the following command:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
python -m pdb qlib/workflow/cli.py examples/benchmarks/LightGBM/workflow_config_lightgbm_Alpha158.yaml
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
`qrun` will be placed in your $PATH directory when installing ``Qlib``.
|
`qrun` will be placed in your $PATH directory when installing ``Qlib``.
|
||||||
|
|||||||
3
setup.py
3
setup.py
@@ -46,7 +46,7 @@ REQUIRED = [
|
|||||||
"statsmodels",
|
"statsmodels",
|
||||||
"xlrd>=1.0.0",
|
"xlrd>=1.0.0",
|
||||||
"plotly==4.12.0",
|
"plotly==4.12.0",
|
||||||
"matplotlib==3.1.3",
|
"matplotlib==3.3.3",
|
||||||
"tables>=3.6.1",
|
"tables>=3.6.1",
|
||||||
"pyyaml>=5.3.1",
|
"pyyaml>=5.3.1",
|
||||||
"mlflow>=1.12.1",
|
"mlflow>=1.12.1",
|
||||||
@@ -119,5 +119,6 @@ setup(
|
|||||||
"Programming Language :: Python :: 3.6",
|
"Programming Language :: Python :: 3.6",
|
||||||
"Programming Language :: Python :: 3.7",
|
"Programming Language :: Python :: 3.7",
|
||||||
"Programming Language :: Python :: 3.8",
|
"Programming Language :: Python :: 3.8",
|
||||||
|
"Programming Language :: Python :: 3.9",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user