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

docs: add background reference for lowercase features dir check

Browse Source
This commit is contained in:
Linlang
2026-01-16 18:56:06 +08:00
parent cf0b9f132f
commit 9f1a7b1ae7
1 changed files with 11 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
scripts/check_data_health.py
View File

@@ -69,10 +69,19 @@ class DataHealthChecker:
self.data[instrument] = df
print(df)
# NOTE:
# This check is added due to a known issue in Qlib where feature paths
# are constructed using lowercased instrument names. On case-sensitive
# file systems (e.g. Linux), uppercase directory names under `features/`
# will cause data loading failures.
#
# See: https://github.com/microsoft/qlib/issues/2053
def check_features_dir_lowercase(self) -> Optional[pd.DataFrame]:
"""
Check whether all subdirectories under qlib_dir/features are named in lowercase.
This check is only applicable when qlib_dir is provided.
Check whether all subdirectories under `<qlib_dir>/features` are named in lowercase.
This validation helps prevent data loading issues on case-sensitive
file systems caused by uppercase instrument directory names.
"""
if not self.qlib_dir:
return None