Refactor the setting/config management with pedantic
Open
Nobody has claimed this yet.
enhancement
help wanted
- Dominant language
- Python
- Stars
- 48.7k
- Forks
- 7.7k
- PR merge metrics
- No merged PRs in 30d
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
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading qlib/config.py and the pedantic documentation to understand the current dict-based setting management and the proposed replacement. Done means the setting/config management is refactored to use pedantic with rich docstrings and annotations, while preserving the required configuration behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100