microsoft/qlib

Refactor the setting/config management with pedantic

Open

#1,309 opened on Oct 9, 2022

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (14,037 stars) (2,431 forks)batch import
enhancementhelp wanted

Description

🌟 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.

Contributor guide

Tech stack
python
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python basicsQlib config (qlib/config.py)pedantic library overview
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.