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

Update Docs about some concepts in DataHandler #1485

Merged
merged 1 commit into from
Apr 7, 2023
Merged
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion qlib/data/dataset/handler.py
Original file line number Diff line number Diff line change
Expand Up @@ -357,11 +357,17 @@ class DataHandlerLP(DataHandler):

- These processors only apply to the learning phase.

Tips to improve the performance of data handler
Tips for data handler

- To reduce the memory cost

- `drop_raw=True`: this will modify the data inplace on raw data;

- Please note processed data like `self._infer` or `self._learn` are concepts different from `segments` in Qlib's `Dataset` like "train" and "test"

- Processed data like `self._infer` or `self._learn` are underlying data processed with different processors
- `segments` in Qlib's `Dataset` like "train" and "test" are simply the time segmentations when querying data("train" are often before "test" in time-series).
- For example, you can query `data._infer` processed by `infer_processors` in the "train" time segmentation.
"""

# based on `self._data`, _infer and _learn are genrated after processors
Expand Down