microsoft/qlib

Refactor the setting/config management with pedantic

Open

#1.309 geöffnet am 9. Okt. 2022

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (14.037 Stars) (2.431 Forks)batch import
enhancementhelp wanted

Beschreibung

🌟 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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Python basicsQlib config (qlib/config.py)pedantic library overview
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
40
Research-Richtung
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.