Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for qlib.rl #1322

Merged
merged 45 commits into from
Nov 10, 2022
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
ddbbcc6
Add docs for qlib.rl
lwwang1995 Oct 19, 2022
9dd860c
Update docs for qlib.rl
lwwang1995 Oct 19, 2022
c7b68b1
Add homepage introduct to RL framework
you-n-g Oct 20, 2022
d13262f
Update index Link
you-n-g Oct 20, 2022
8cacc96
Fix Icon
you-n-g Oct 20, 2022
c3577e1
typo
you-n-g Oct 20, 2022
b139e7d
Merge remote-tracking branch 'origin/main' into HEAD
you-n-g Oct 20, 2022
a0d3621
Update catelog
you-n-g Oct 20, 2022
1a62af9
Update docs for qlib.rl
lwwang1995 Oct 20, 2022
c9b2198
Update docs for qlib.rl
lwwang1995 Oct 21, 2022
5a75c9d
Update figure
lwwang1995 Oct 21, 2022
77fbb16
Update docs for qlib.rl
lwwang1995 Oct 21, 2022
5d2f21f
Update setup.py
you-n-g Oct 22, 2022
160f951
Merge remote-tracking branch 'origin/main' into HEAD
you-n-g Oct 22, 2022
4b705a9
FIx setup.py
you-n-g Oct 22, 2022
145414b
Update docs and fix some typos
lwwang1995 Oct 24, 2022
f215418
Fix the reference to RL docs
lwwang1995 Oct 24, 2022
b688db7
Update framework.svg
you-n-g Oct 24, 2022
5035af1
Update framework.svg
you-n-g Oct 24, 2022
3b182e1
Update framework.svg
you-n-g Oct 24, 2022
834c4f4
Update docs for qlibrl.
lwwang1995 Oct 27, 2022
0b17397
Update docs for qlibrl.
lwwang1995 Oct 27, 2022
7bfc937
Update docs for Qlibrl.
lwwang1995 Oct 27, 2022
21b765d
Update docs for qlibrl.
lwwang1995 Oct 27, 2022
1703492
Update docs for qlibrl.
lwwang1995 Oct 27, 2022
4d73676
Update docs for qlibrl.
lwwang1995 Oct 27, 2022
f7713e2
Add new framework
you-n-g Oct 27, 2022
a59f844
Update jpg
you-n-g Oct 27, 2022
47667a7
Update framework.svg
you-n-g Oct 28, 2022
129c1a8
Update framework.svg
you-n-g Oct 28, 2022
db543fc
Update Qlib framework and description
you-n-g Oct 28, 2022
34e2bc4
Update grammar
you-n-g Oct 28, 2022
8d7df20
Update README.md
you-n-g Oct 28, 2022
b3eec1c
Update README.md
you-n-g Oct 28, 2022
946177d
Update docs/component/rl.rst
lwwang1995 Oct 28, 2022
04a9b8f
Update docs/component/rl.rst
lwwang1995 Oct 28, 2022
e248066
Update docs for qlib.rl
lwwang1995 Nov 2, 2022
6020b86
Change theme for docs.
lwwang1995 Nov 3, 2022
5db5ea9
Update docs for qlib.rl
lwwang1995 Nov 4, 2022
7b84f49
Update docs for qlib.rl
lwwang1995 Nov 7, 2022
c47a460
Update docs for qlib.rl
lwwang1995 Nov 7, 2022
cf3642d
Update docs for qlib.rl.
lwwang1995 Nov 7, 2022
d723685
Update docs for qlib.rl
lwwang1995 Nov 8, 2022
6484cfa
Update docs for qlib.rl
lwwang1995 Nov 8, 2022
0db199c
Update docs for qlib.rl
lwwang1995 Nov 8, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 7 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,22 +107,16 @@ Your feedbacks about the features are very important.
# Framework of Qlib

<div style="align: center">
<img src="docs/_static/img/framework.svg" />
<img src="docs/_static/img/framework-abstract.jpg" />
</div>

At the module level, Qlib is a platform that consists of the above components. The components are designed as loose-coupled modules, and each component could be used stand-alone.
The high-level framework of Qlib can be found above(users can find the [detailed framework](https://qlib.readthedocs.io/en/latest/introduction/introduction.html#framework) of Qlib's design when getting into nitty gritty).
The components are designed as loose-coupled modules, and each component could be used stand-alone.

| Name | Description |
| ------ | ----- |
| `Infrastructure` layer | `Infrastructure` layer provides underlying support for Quant research. `DataServer` provides a high-performance infrastructure for users to manage and retrieve raw data. `Trainer` provides a flexible interface to control the training process of models, which enable algorithms to control the training process. |
| `Workflow` layer | `Workflow` layer covers the whole workflow of quantitative investment. `Information Extractor` extracts data for models. `Forecast Model` focuses on producing all kinds of forecast signals (e.g. _alpha_, risk) for other modules. With these signals `Decision Generator` will generate the target trading decisions(i.e. portfolio, orders) to be executed by `Execution Env` (i.e. the trading market). There may be multiple levels of `Trading Agent` and `Execution Env` (e.g. an _order executor trading agent and intraday order execution environment_ could behave like an interday trading environment and nested in _daily portfolio management trading agent and interday trading environment_ ) |
| `Learning Framework` layer| The `Forecast Model` and `Trading Agent` are learnable. They are learned based on the `Learning Framework` layer and then applied to multiple scenarios in `Workflow` layer. The supported learning paradigms can be categorized into reinforcement learning and supervised learning. The learning framework leverages the `Workflow` layer as well(e.g. sharing `Information Extractor`, creating environments based on `Execution Env`). |
| `Interface` layer | `Interface` layer tries to present a user-friendly interface for the underlying system. `Analyser` module will provide users detailed analysis reports of forecasting signals, portfolios and execution results |

* The modules with hand-drawn style are under development and will be released in the future.
* The modules with dashed borders are highly user-customizable and extendible.

(p.s. framework image is created with https://draw.io/)
Qlib provides a strong infrastructure to support Quant research. [Data](https://qlib.readthedocs.io/en/latest/component/data.html) is always an important part.
A strong learning framework is designed to support diverse learning paradigms (e.g. [reinforcement learning](https://qlib.readthedocs.io/en/latest/component/rl.html), [supervised learning](https://qlib.readthedocs.io/en/latest/component/workflow.html#model-section)) and patterns at different levels(e.g. [market dynamic modeling](https://qlib.readthedocs.io/en/latest/component/meta.html)).
By modeling the market, [trading strategies](https://qlib.readthedocs.io/en/latest/component/strategy.html) will generate trade decisions that will be executed. Multiple trading strategies and executors in different levels or granularities can be [nested to be optimized and run together](https://qlib.readthedocs.io/en/latest/component/highfreq.html).
At last, a comprehensive [analysis](https://qlib.readthedocs.io/en/latest/component/report.html) will be provided and the model can be [served online](https://qlib.readthedocs.io/en/latest/component/online.html) in a low cost.


# Quick Start
Expand Down
Binary file added docs/_static/img/QlibRL_framework.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/RL_framework.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/img/framework-abstract.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/_static/img/framework.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/img/qlib_rl_highlevel.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/component/highfreq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The design of the framework is shown in the yellow part in the middle of the fig

The frequency of the trading algorithm, decision content and execution environment can be customized by users (e.g. intraday trading, daily-frequency trading, weekly-frequency trading), and the execution environment can be nested with finer-grained trading algorithm and execution environment inside (i.e. sub-workflow in the figure, e.g. daily-frequency orders can be turned into finer-grained decisions by splitting orders within the day). The flexibility of the nested decision execution framework makes it easy for users to explore the effects of combining different levels of trading strategies and break down the optimization barriers between different levels of the trading algorithm.

The optimization for the nested decision execution framework can be implemented with the support of QlibRL. To know more about how to use the QlibRL, go to API Reference: `RL API <../reference/api.html#rl>`_.
The optimization for the nested decision execution framework can be implemented with the support of `QlibRL <https://qlib.readthedocs.io/en/latest/component/rl.html>`_. To know more about how to use the QlibRL, go to API Reference: `RL API <../reference/api.html#rl>`_.

Example
=======
Expand Down
Loading