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 1 commit
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: 10 additions & 10 deletions docs/component/highfreq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,33 +8,33 @@ Design of Nested Decision Execution Framework for High-Frequency Trading
Introduction
============

Daily trading (e.g. portfolio management) and intraday trading (e.g. orders execution) are two hot topics in Quant investment and usually studied separately.
Daily trading (e.g. portfolio management) and intraday trading (e.g. orders execution) are two hot topics in Quant investment and are usually studied separately.

To get the join trading performance of daily and intraday trading, they must interact with each other and run backtest jointly.
In order to support the joint backtest strategies in multiple levels, a corresponding framework is required. None of the publicly available high-frequency trading frameworks considers multi-level joint trading, which make the backtesting aforementioned inaccurate.
In order to support the joint backtest strategies at multiple levels, a corresponding framework is required. None of the publicly available high-frequency trading frameworks considers multi-level joint trading, which makes the backtesting aforementioned inaccurate.

Besides backtesting, the optimization of strategies from different levels is not standalone and can be affected by each other.
For example, the best portfolio management strategy may change with the performance of order executions(e.g. a portfolio with higher turnover may becomes a better choice when we improve the order execution strategies).
To achieve the overall good performance , it is necessary to consider the interaction of strategies in different level.
For example, the best portfolio management strategy may change with the performance of order executions(e.g. a portfolio with higher turnover may become a better choice when we improve the order execution strategies).
To achieve overall good performance, it is necessary to consider the interaction of strategies at a different levels.

Therefore, building a new framework for trading in multiple levels becomes necessary to solve the various problems mentioned above, for which we designed a nested decision execution framework that consider the interaction of strategies.
Therefore, building a new framework for trading on multiple levels becomes necessary to solve the various problems mentioned above, for which we designed a nested decision execution framework that considers the interaction of strategies.

.. image:: ../_static/img/framework.svg

The design of the framework is shown in the yellow part in the middle of the figure above. Each level consists of ``Trading Agent`` and ``Execution Env``. ``Trading Agent`` has its own data processing module (``Information Extractor``), forecasting module (``Forecast Model``) and decision generator (``Decision Generator``). The trading algorithm generates the decisions by the ``Decision Generator`` based on the forecast signals output by the ``Forecast Module``, and the decisions generated by the trading algorithm are passed to the ``Execution Env``, which returns the execution results.

The frequency of 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 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 trading algorithm.
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 an RL-based method, which can be supported by `qlib.rl<https://github.com/microsoft/qlib/tree/main/examples/rl>`_.
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>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reference to the RL docs will be better instead of RL API.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It has been fixed.


Example
=======

An example of nested decision execution framework for high-frequency can be found `here <https://github.com/microsoft/qlib/blob/main/examples/nested_decision_execution/workflow.py>`_.
An example of a nested decision execution framework for high-frequency can be found `here <https://github.com/microsoft/qlib/blob/main/examples/nested_decision_execution/workflow.py>`_.


Besides, the above examples, here are some other related work about high-frequency trading in Qlib.
Besides, the above examples, here are some other related works about high-frequency trading in Qlib.

- `Prediction with high-frequency data <https://github.com/microsoft/qlib/tree/main/examples/highfreq#benchmarks-performance-predicting-the-price-trend-in-high-frequency-data>`_
- `Examples <https://github.com/microsoft/qlib/blob/main/examples/orderbook_data/>`_ to extract features form high-frequency data without fixed frequency.
- `Examples <https://github.com/microsoft/qlib/blob/main/examples/orderbook_data/>`_ to extract features from high-frequency data without fixed frequency.
- `A paper <https://github.com/microsoft/qlib/tree/high-freq-execution#high-frequency-execution>`_ for high-frequency trading.
12 changes: 6 additions & 6 deletions docs/component/rl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Base Modules

EnvWrapper
------------
EnvWrapper is the complete capsulation of the simulated environment. It receives actions from outside (policy / strategy / agent), simulates the changes of the market, and then replies rewards and updated states, thus forming an interaction loop.
EnvWrapper is the complete capsulation of the simulated environment. It receives actions from outside (policy / strategy / agent), simulates the changes in the market, and then replies rewards and updated states, thus forming an interaction loop.

In QlibRL, EnvWrapper is a subclass of gym.Env, so it implements all necessary interfaces of gym.Env. Any classes or pipelines that accept gym.Env should also accept EnvWrapper. Developers do not need to implement their own EnvWrapper to build their own environment. Instead, they only need to implement 4 components of the EnvWrapper:

Expand All @@ -32,7 +32,7 @@ In QlibRL, EnvWrapper is a subclass of gym.Env, so it implements all necessary i
- `Reward function`
The reward function returns a numerical reward to the policy after each time the policy takes an action.

EnvWrapper will organically organize these components. Such decomposition allows for better flexibility in development. For example, if the developers want to train multiple types of policies in one same environment, they only need to design one simulator, and design different state interpreters / action interpreters / reward functions for a different types of policies.
EnvWrapper will organically organize these components. Such decomposition allows for better flexibility in development. For example, if the developers want to train multiple types of policies in the same environment, they only need to design one simulator, and design different state interpreters / action interpreters / reward functions for different types of policies.

QlibRL has well-defined base classes for all these 4 components. All the developers need to do is define their own components by inheriting the base classes and then implementing all interfaces required by the base classes.

Expand Down Expand Up @@ -60,15 +60,15 @@ Order Execution
------------
As a fundamental problem in algorithmic trading, order execution aims at fulfilling a specific trading order, either liquidation or acquirement, for a given instrument. Essentially, the goal of order execution is twofold: it not only requires to fulfill the whole order but also targets a more economical execution with maximizing profit gain (or minimizing capital loss). The order execution with only one order of liquidation or acquirement is called single-asset order execution.

Considering stock investment always aim to pursue long-term maximized profits, is usually manifests as a sequential process of continuously adjusting the asset portfolios, execution for multiple orders, including order of liquidation and acquirement, brings more constraints and making the sequence of execution for different orders should be considered, e.g. before executing an order to buy some stocks, we have to sell at least one stock. The order execution with multiple assets is called multi-asset order execution.
Considering stock investment always aim to pursue long-term maximized profits, it usually manifests as a sequential process of continuously adjusting the asset portfolios, execution for multiple orders, including order of liquidation and acquirement, brings more constraints and makes the sequence of execution for different orders should be considered, e.g. before executing an order to buy some stocks, we have to sell at least one stock. The order execution with multiple assets is called multi-asset order execution.

According to the order execution’s trait of sequential decision making, an RL-based solution could be applied to solve the order execution. With an RL-based solution, an agent optimizes execution strategy through interacting with the market environment.
According to the order execution’s trait of sequential decision-making, an RL-based solution could be applied to solve the order execution. With an RL-based solution, an agent optimizes execution strategy by interacting with the market environment.

With QlibRL, the RL algorithm in the above scenarios can be easily implemented.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can add an extra section for nested Portfolio Construction & Order Execution
and emphasize the difference from traditional methods.

Nested Portfolio Construction and Order Executor
------------
QlibRL make it possible to jointly optimize different levels of strategies/models/agents. Take `Nested Decision Execution Framework <https://github.com/microsoft/qlib/blob/main/examples/nested_decision_execution>`_ an example of, optimization of order execution strategy and portfolio management strategy can interact with each other to maximize returns.
QlibRL makes it possible to jointly optimize different levels of strategies/models/agents. Take `Nested Decision Execution Framework <https://github.com/microsoft/qlib/blob/main/examples/nested_decision_execution>`_ as an example of, the optimization of order execution strategy and portfolio management strategy can interact with each other to maximize returns.

Base Class & Interface
============
Expand Down Expand Up @@ -99,7 +99,7 @@ If developers have already defined their simulator / interpreters / reward funct
policy=policy,
reward=PAPenaltyReward(),
vessel_kwargs={
"episode_per_iter": 100, 6
"episode_per_iter": 100,
"update_kwargs": {
"batch_size": 64,
"repeat": 5,
Expand Down