liuyu/qlib
1
0
Fork 0
mirror of https://github.com/microsoft/qlib.git synced 2026-07-09 22:10:56 +08:00
Code Activity

Fix typos and grammar errors in docstrings and comments (#1366)

Browse Source 
* fix gramma error in doc strings

* fix typos in exchange.py

* fix typos and gramma errors

* fix typo and rename function param to avoid shading python keyword

* remove redundant parathesis; pass kwargs to parent class

* fix pyblack

* further correction

* assign -> be assigned to
This commit is contained in:
YQ Tsui
2022-11-20 14:15:59 +08:00
committed by GitHub
parent 0c4db8b0f8
commit cc01812c62
24 changed files with 77 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
qlib/data/dataset/handler.py
View File

@@ -137,7 +137,7 @@ class DataHandler(Serializable):
# Setup data.
# _data may be with multiple column index level. The outer level indicates the feature set name
with TimeInspector.logt("Loading data"):
# make sure the fetch method is based on a index-sorted pd.DataFrame
# make sure the fetch method is based on an index-sorted pd.DataFrame
self._data = lazy_sort_index(self.data_loader.load(self.instruments, self.start_time, self.end_time))
# TODO: cache
@@ -167,7 +167,7 @@ class DataHandler(Serializable):
- a slice range
- pd.Index for specific indexes
Following conflictions may occurs
Following conflicts may occur
- Does ["20200101", "20210101"] mean selecting this slice or these two days?
@@ -229,7 +229,7 @@ class DataHandler(Serializable):
# This method is extracted for sharing in subclasses
from .storage import BaseHandlerStorage # pylint: disable=C0415
# Following conflictions may occurs
# Following conflicts may occur
# - Does [20200101", "20210101"] mean selecting this slice or these two days?
# To solve this issue
# - slice have higher priorities (except when level is none)
@@ -313,7 +313,7 @@ class DataHandler(Serializable):
self, periods: int, min_periods: Optional[int] = None, **kwargs
) -> Iterator[Tuple[pd.Timestamp, pd.DataFrame]]:
"""
get a iterator of sliced data with given periods
get an iterator of sliced data with given periods
Args:
periods (int): number of periods.
@@ -412,13 +412,13 @@ class DataHandlerLP(DataHandler):
process_type: str
PTYPE_I = 'independent'
- self._infer will processed by infer_processors
- self._infer will be processed by infer_processors
- self._learn will be processed by learn_processors
PTYPE_A = 'append'
- self._infer will processed by infer_processors
- self._infer will be processed by infer_processors
- self._learn will be processed by infer_processors + learn_processors
@@ -671,7 +671,8 @@ class DataHandlerLP(DataHandler):
def cast(cls, handler: "DataHandlerLP") -> "DataHandlerLP":
"""
Motivation
- A user create a datahandler in his customized package. Then he want to share the processed handler to other users without introduce the package dependency and complicated data processing logic.
- A user creates a datahandler in his customized package. Then he wants to share the processed handler to
other users without introduce the package dependency and complicated data processing logic.
- This class make it possible by casting the class to DataHandlerLP and only keep the processed data
Parameters
@@ -685,7 +686,7 @@ class DataHandlerLP(DataHandler):
the converted processed data
"""
new_hd: DataHandlerLP = object.__new__(DataHandlerLP)
new_hd.from_cast = True # add a mark for the casted instance
new_hd.from_cast = True # add a mark for the cast instance
for key in list(DataHandlerLP.ATTR_MAP.values()) + [
"instruments",

3
qlib/data/dataset/storage.py
View File

@@ -8,7 +8,8 @@ from .utils import get_level_index, fetch_df_by_index, fetch_df_by_col
class BaseHandlerStorage:
"""Base data storage for datahandler
"""
Base data storage for datahandler
- pd.DataFrame is the default data storage format in Qlib datahandler
- If users want to use custom data storage, they should define subclass inherited BaseHandlerStorage, and implement the following method
"""