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

release-0.5.0 #1

Merged
merged 107 commits into from
Sep 24, 2020
Merged

release-0.5.0 #1

merged 107 commits into from
Sep 24, 2020

Conversation

you-n-g
Copy link
Collaborator

@you-n-g you-n-g commented Sep 16, 2020

typo

Copy link
Collaborator Author

@you-n-g you-n-g left a comment

Choose a reason for hiding this comment

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

Make this part optional and put it at last.
image

Make it possible that user could leave the model.score not implemented.
Maybe a try catch NotImplement can solve the problem
image

@@ -8,17 +8,15 @@ Data Retrieval
Introduction
====================

Users can get stock data by Qlib, the following are some examples.
Users can get stock data by ``Qlib``. Following examples will demonstrate the basic user interface.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We will only provide csi300 and all stock pool in our demo. Please change this tutorial

args:
start_date: 2005-01-01
end_date: 2018-04-30
feature_label_config: /data/qlib/feature_config/feature_config.yaml

The class `SomeDataHandler` should be in the module `custom_data_handler`, and Qlib could parse the `module_path` to load the class.
The class `SomeDataHandler` should be in the module `custom_data_handler`, and ``Qlib`` could parse the `module_path` to load the class.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Did you test feature_label_config ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

deletefeature_label_config

@@ -471,7 +404,7 @@ Qlib have provided two implemented trainer,
The rolling trainer will use the rolling iterator of the data processor to split data for rolling training.


User can specify `trainer` through the configuration file:
Users can specify `trainer` through the configuration file:
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yaml will not accept such style of comments

image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

trt?
image

Copy link
Collaborator

Choose a reason for hiding this comment

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

fixed


About training
Trainer Field
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Trainer section maybe better for such title

---------------
Users can use APIs in ``qlib.data`` to retrieve data, please refer to `Data Retrieval <../start/getdata.html>`_.

Filter
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Put the Filter behind feature.
Feature is Much more important

Copy link
Collaborator

Choose a reason for hiding this comment

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

fixed

Cache
==========

Local Cache
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

spli the memory cache and disk cache into two sub-sections in Cache section

Copy link
Collaborator

Choose a reason for hiding this comment

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

How to split the Cache? what's the disk cache?

backtest:
normal_backtest_args:
verbose: False
limit_threshold: 0.095
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@zhupr
Please add limit_threshold=0.0095 as the default option in China Stock market setting


To know more about backtesting with specific strategy, please refer to `Strategy <strategy.html>`_.

Score File
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Please rename all the content like Score XXX which indicates the predction of model to Prediction.
Such consistant name will help user understand the doc

Copy link
Collaborator

Choose a reason for hiding this comment

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

fixed

sub_cost mean 0.000718
std 0.004694
annual 0.181003
ir 2.428964
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@bxdd Only the docs are changed. The code is not changed

Copy link
Collaborator

Choose a reason for hiding this comment

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

@zhupr It seems to have been fixed by Pengrong

mdd -0.072977

- `sub_bench`
Income without deduction of fees
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Income -> returns of the portfolio

Copy link
Collaborator

Choose a reason for hiding this comment

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

fixed

Interday Model: Model Training & Prediction <component/model.rst>
Interday Strategy: Portfolio Management <component/strategy.rst>
Intraday Trading: Model&Strategy Testing <component/backtest.rst>
Aanalysis: Evaluation & Results Analysis <component/report.rst>
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The content in report.rst is too simple.
There are no docs about the graph output by the functions
It's better to put all the graphs in the docs and exaplain then one by one
@bxdd @zhupr

@you-n-g you-n-g reopened this Sep 22, 2020
@you-n-g you-n-g merged commit de9e13b into main Sep 24, 2020
@you-n-g you-n-g deleted the release-0.5.0 branch September 25, 2020 14:46
you-n-g pushed a commit that referenced this pull request May 17, 2021
qlib auto init basedon project & black format
wangwenxi-handsome added a commit that referenced this pull request Aug 26, 2021
Mingzhe-Han added a commit that referenced this pull request Oct 3, 2021
ZhongHaoAustin pushed a commit to ZhongHaoAustin/qlib that referenced this pull request Apr 25, 2024
Fix test_start setting in `Benchmark.basic_task()`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants