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 (2,431 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (14,037 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Examine the current config management in qlib/config.py, understand the pedantic library, and refactor to use pedantic for better documentation and validation.
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60