From 680e8f9260c763c7ef30442984d8616f95e308f3 Mon Sep 17 00:00:00 2001 From: Jactus Date: Sat, 28 Nov 2020 16:36:51 +0800 Subject: [PATCH] Update docs --- README.md | 4 +++- docs/component/data.rst | 2 +- docs/component/model.rst | 2 +- docs/introduction/quick.rst | 2 +- docs/start/integration.rst | 2 +- examples/run_all_model.py | 8 ++++---- 6 files changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 123134319..35028328f 100644 --- a/README.md +++ b/README.md @@ -207,10 +207,12 @@ Here is a list of models built on `Qlib`. Your PR of new Quant models is highly welcomed. ## Run a single model +All the models listed above are runnable with ``Qlib``. Users can find the config files we provide and some details about the model through the [benchmarks](examples/benchmarks) folder. More information can be retrieved at the model files listed above. + `Qlib` provides three different ways to run a single model, users can pick the one that fits their cases best: - User can use the tool `qrun` mentioned above to run a model's workflow based from a config file. - User can create a `workflow_by_code` python script based on the [one](examples/workflow_by_code.py) listed in the `examples` folder. -- User can use the script [`run_all_model.py`](examples/run_all_model.py) listed in the `examples` folder to run a model. Here is an example of the specific shell command to be used: `python run_all_model.py --models=lightgbm`. For more use cases, please refer to the file's [docstrings](examples/run_all_model.py). +- User can use the script [`run_all_model.py`](examples/run_all_model.py) listed in the `examples` folder to run a model. Here is an example of the specific shell command to be used: `python run_all_model.py --models=lightgbm`, where the `--models` arguments can take any number of models listed above. For more use cases, please refer to the file's [docstrings](examples/run_all_model.py). ## Run multiple models `Qlib` also provides a script [`run_all_model.py`](examples/run_all_model.py) which can run multiple models for several iterations. (**Note**: the script only supprots *Linux* now. Other OS will be supported in the future.) diff --git a/docs/component/data.rst b/docs/component/data.rst index aa01fe226..55d6c7207 100644 --- a/docs/component/data.rst +++ b/docs/component/data.rst @@ -321,7 +321,7 @@ Dataset The ``Dataset`` module in ``Qlib`` aims to prepare data for model training and inferencing. -The motivation of this module is that we want to maximize the flexibility of of different models to handle data that are suitable for themselves. This module gives the model the rights to process their data in an unique way. For instance, models such as ``GBDT`` may work well on data that contains `nan` or `None` value, while neural networks such as ``DNN`` will break down on such data. +The motivation of this module is that we want to maximize the flexibility of of different models to handle data that are suitable for themselves. This module gives the model the rights to process their data in an unique way. For instance, models such as ``GBDT`` may work well on data that contains `nan` or `None` value, while neural networks such as ``MLP`` will break down on such data. The ``DatasetH`` class is the `dataset` with `Data Handler`. Here is the most important interface of the class: diff --git a/docs/component/model.rst b/docs/component/model.rst index b4e341df8..e4aa4ca91 100644 --- a/docs/component/model.rst +++ b/docs/component/model.rst @@ -63,7 +63,7 @@ For other interfaces such as `finetune`, please refer to `Model API <../referenc Example ================== -``Qlib``'s `Model Zoo` includes models such as ``LightGBM``, ``DNN``, ``LSTM``, etc.. These models are treated as the baselines of ``Interday Model``. The following steps show how to run`` LightGBM`` as an independent module. +``Qlib``'s `Model Zoo` includes models such as ``LightGBM``, ``MLP``, ``LSTM``, etc.. These models are treated as the baselines of ``Interday Model``. The following steps show how to run`` LightGBM`` as an independent module. - Initialize ``Qlib`` with `qlib.init` first, please refer to `Initialization <../start/initialization.html>`_. - Run the following code to get the `prediction score` `pred_score` diff --git a/docs/introduction/quick.rst b/docs/introduction/quick.rst index 32752fd83..55835b970 100644 --- a/docs/introduction/quick.rst +++ b/docs/introduction/quick.rst @@ -91,4 +91,4 @@ Auto Quant Research Workflow Custom Model Integration =============================================== -``Qlib`` provides several models such as ``lightGBM`` and ``DNN`` model as the baseline of ``Interday Model``. In addition to the default model, users can integrate their own custom models into ``Qlib``. If users are interested in the custom model, please refer to `Custom Model Integration <../start/integration.html>`_. +``Qlib`` provides several models such as ``lightGBM`` and ``MLP`` model as the baseline of ``Interday Model``. In addition to the default model, users can integrate their own custom models into ``Qlib``. If users are interested in the custom model, please refer to `Custom Model Integration <../start/integration.html>`_. diff --git a/docs/start/integration.rst b/docs/start/integration.rst index 102d88425..437c5ef6a 100644 --- a/docs/start/integration.rst +++ b/docs/start/integration.rst @@ -5,7 +5,7 @@ Custom Model Integration Introduction =================== -``Qlib``'s `Model Zoo` includes models such as ``LightGBM``, ``DNN``, ``LSTM``, etc.. These models are treated as the baselines of ``Interday Model``. In addition to the default models ``Qlib`` provide, users can integrate their own custom models into ``Qlib``. +``Qlib``'s `Model Zoo` includes models such as ``LightGBM``, ``MLP``, ``LSTM``, etc.. These models are treated as the baselines of ``Interday Model``. In addition to the default models ``Qlib`` provide, users can integrate their own custom models into ``Qlib``. Users can integrate their own custom models according to the following steps. diff --git a/examples/run_all_model.py b/examples/run_all_model.py index 05839a125..8843573ab 100644 --- a/examples/run_all_model.py +++ b/examples/run_all_model.py @@ -204,16 +204,16 @@ def run(times=1, models=None, exclude=False): python run_all_model.py 3 # Case 2 - run specific models multiple times - python run_all_model.py 3 dnn + python run_all_model.py 3 mlp # Case 3 - run other models except those are given as arguments for multiple times - python run_all_model.py 3 [dnn,tft,lstm] True + python run_all_model.py 3 [mlp,tft,lstm] True # Case 4 - run specific models for one time - python run_all_model.py --models=[dnn,lightgbm] + python run_all_model.py --models=[mlp,lightgbm] # Case 5 - run other models except those are given as aruments for one time - python run_all_model.py --models=[dnn,tft,sfm] --exclude=True + python run_all_model.py --models=[mlp,tft,sfm] --exclude=True """ # get all folders