-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs/start/getdata.rst
Outdated
@@ -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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
deletefeature_label_config
docs/component/estimator.rst
Outdated
@@ -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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
docs/component/estimator.rst
Outdated
|
||
About training | ||
Trainer Field |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
docs/component/data.rst
Outdated
Cache | ||
========== | ||
|
||
Local Cache |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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
docs/component/backtest.rst
Outdated
|
||
To know more about backtesting with specific strategy, please refer to `Strategy <strategy.html>`_. | ||
|
||
Score File |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fixed
docs/component/backtest.rst
Outdated
sub_cost mean 0.000718 | ||
std 0.004694 | ||
annual 0.181003 | ||
ir 2.428964 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
docs/component/backtest.rst
Outdated
mdd -0.072977 | ||
|
||
- `sub_bench` | ||
Income without deduction of fees |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
216f2ca
to
e01553f
Compare
0c90528
to
d3e22a6
Compare
d3e22a6
to
aa51e5a
Compare
Update README.md
qlib auto init basedon project & black format
Fix test_start setting in `Benchmark.basic_task()`
typo