unit8co/darts

Unified API : `model.params` attribute

Open

#192 ouverte le 28 sept. 2020

Voir sur GitHub
 (8 commentaires) (1 réaction) (0 assignés)Python (762 forks)batch import
good first issueimprovement

Métriques du dépôt

Stars
 (6 832 stars)
Métriques de merge PR
 (Merge moyen 143j 16h) (16 PRs mergées en 30 j)

Description

Hello! Firstly, I wanted to thank you for this wonderful library.

Unified API to get model's params might make darts more convenient. For example, to get params of Exponential Smoothing model, We have to code like this:

model = ExponentialSmoothing()
model.fit(train)

print(model.model.model.params) # {'smoothing_level': 0.5789473661331209, 'smoothing_slope': ...

So, I want to implement model.get_params() method like sklearn. model.params attribute with property like statsmodels and fbprophet.

I would like to get your opinion before send PR. Thanks!

  • Models
    • abstract params() function in the ForecastingModel superclass
    • ARIMA
    • AutoARIMA
    • Baseline Models
      • NaiveDrift
      • NaiveMean
      • NaiveSeasonal
    • ExponentialSmoothing
    • FFT
    • Prophet
    • StandardRegressionModel
    • TCNModel
    • Theta
    • TorchForecastingModel (RNNModel)
  • Preprocessing
    • Scaler wrapper

Guide contributeur

Direction de recherche
Le problème propose d'ajouter une propriété `params` à la classe de base ForecastingModel pour unifier l'accès aux paramètres du modèle, avec une liste de contrôle des modèles à implémenter. Les modèles existants ExponentialSmoothing et Prophet ont été complétés (marqués). Pour implémenter, localisez la classe abstraite ForecastingModel (probablement dans darts/models/forecasting model.py) et définissez une propriété `params` qui renvoie un dictionnaire. Ensuite, remplacez cette propriété dans chaque sous classe listée dans la liste de contrôle, en extrayant les paramètres des objets de modèle sous jacents. Référez vous au modèle `get params` de sklearn pour la cohérence, mais utilisez la syntaxe de propriété comme suggéré. Vérifiez les modèles existants du dépôt (par exemple ExponentialSmoothing et Prophet) pour les détails d'implémentation.
Stack technique
python
Domaine
backend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80