microsoft/qlib

Refactor the setting/config management with pedantic

Open

#1 309 ouverte le 9 oct. 2022

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)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.

Guide contributeur

Stack technique
python
Domaine
backend
Type d'issue
refactor
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Python basicsQlib config (qlib/config.py)pedantic library overview
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
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.