diff --git a/README.md b/README.md index 701006992..2ae36827e 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,10 @@ At the module level, Qlib is a platform that consists of the above components. T This quick start guide tries to demonstrate 1. It's very easy to build a complete Quant research workflow and try your ideas with _Qlib_. -1. Though with *public data* and *simple models*, machine learning technologies **work very well** in practical Quant investment. +2. Though with *public data* and *simple models*, machine learning technologies **work very well** in practical Quant investment. + +Here is a quick **[demo](https://terminalizer.com/view/3f24561a4470)** shows how to install ``Qlib``, and run LightGBM with ``qrun``. **But**, please make sure you have already prepared the data following the [instruction](#data-preparation). + ## Installation @@ -303,4 +306,4 @@ provided by the bot. You will only need to do this once across all repos using o This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file diff --git a/docs/_static/demo.sh b/docs/_static/demo.sh new file mode 100644 index 000000000..bd2367a92 --- /dev/null +++ b/docs/_static/demo.sh @@ -0,0 +1,12 @@ +#!/bin/sh +git clone https://github.com/microsoft/qlib.git +cd qlib +ls +pip install pyqlib +# or +# pip install numpy +# pip install --upgrade cython +# python setup.py install +cd examples +ls +qrun benchmarks/LightGBM/workflow_config_lightgbm_Alpha158.yaml \ No newline at end of file