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

Qlib data doc #1207

Merged
merged 8 commits into from
Jul 22, 2022
Merged

Qlib data doc #1207

merged 8 commits into from
Jul 22, 2022

Conversation

chenditc
Copy link
Contributor

Add doc and comments for data and feature

Description

Add comments to explain data structure and feature's meaning

Motivation and Context

Documentation to explain data structure, what is the input and output for each step? Since most data in managed as file, user can sample a few to take a deeper look.

It would also be helpful for user to know how the price volume factor is calcualted and what do they mean.

How Has This Been Tested?

  • Pass the test by running: pytest qlib/tests/test_all_pipeline.py under upper directory of qlib.
  • If you are adding a new feature, test on your own test scripts.

Screenshots of Test Results (if appropriate):

  1. Pipeline test:
  2. Your own tests:

Types of changes

  • Fix bugs
  • Add new feature
  • Update documentation

scripts/data_collector/yahoo/README.md Outdated Show resolved Hide resolved
fields += ["Resi($close, %d)/$close" % d for d in windows]
names += ["RESI%d" % d for d in windows]
if use("MAX"):
# The max price for past d days, divided by latest close price to remove unit
# Represent the upper resistent price range with 80% percentile of price.
Copy link
Collaborator

Choose a reason for hiding this comment

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

How can we get with 80% percentile of price from the expression?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was try to express this works with QTLU to for a resistence price range between 80% - 100% of price band. I guess this wording is too confusing. I will just remove this sentence.

fields += ["Max($high, %d)/$close" % d for d in windows]
names += ["MAX%d" % d for d in windows]
if use("LOW"):
# The low price for past d days, divided by latest close price to remove unit
# Represent the lower supporting price range with 20% percentile of price.
Copy link
Collaborator

Choose a reason for hiding this comment

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

How can we get with 20% percentile of price from the expression?

@you-n-g you-n-g merged commit 86f08e4 into microsoft:main Jul 22, 2022
@you-n-g
Copy link
Collaborator

you-n-g commented Jul 22, 2022

Thanks so much.
It looks great now.
The CI is broken due to the new version of PIP.
It will be fixed in https://github.com/microsoft/qlib/pull/1222/files

Welcome to become one of Qlib's contributors

@you-n-g you-n-g added the dependencies Pull requests that update a dependency file label Dec 9, 2022
qianyun210603 pushed a commit to qianyun210603/qlib that referenced this pull request Mar 23, 2023
* Explain data crawler structure

* Add documentation for data and feature

* Update scripts/data_collector/yahoo/README.md

Co-authored-by: you-n-g <[email protected]>

* Remove some confusing wording

* Add third party data source

* Fix command typo

* Update commands

Co-authored-by: you-n-g <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants