microsoft/qlib

Refactor the setting/config management with pedantic

Open

#1,309 建立於 2022年10月9日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Python (14,037 star) (2,431 fork)batch import
enhancementhelp wanted

描述

🌟 Feature Description

Refactor the setting management with pedantic.

Motivation

Qlib's setting/config management is based on a dict, which is extremely free but hard to read. We hope to manage it with pedantic, which can support rich docstring and annotation.

貢獻者指南

技術棧
python
領域
backend
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Python basicsQlib config (qlib/config.py)pedantic library overview
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
Examine the existing config.py to understand current dict based implementation. Study pedantic's documentation to learn how to define settings with type annotations. Consider a step by step refactoring plan to replace dict usage with pedantic models, ensuring backward compatibility. Review any existing tests for config to maintain coverage.