microsoft/qlib

Refactor the setting/config management with pedantic

Open

#1,309 opened on 2022年10月9日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)Python (14,037 stars) (2,431 forks)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
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.