unit8co/darts

Unified API : `model.params` attribute

Open

#192 geöffnet am 28. Sept. 2020

Auf GitHub ansehen
 (8 Kommentare) (1 Reaktion) (0 zugewiesene Personen)Python (762 Forks)batch import
good first issueimprovement

Repository-Metriken

Stars
 (6.832 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 143T 16h) (16 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Das Issue schlägt vor, eine `params` Eigenschaft zur ForecastingModel Basisklasse hinzuzufügen, um den Zugriff auf Modellparameter zu vereinheitlichen, mit einer Checkliste der zu implementierenden Modelle. Die bestehenden Modelle ExponentialSmoothing und Prophet wurden abgeschlossen (markiert). Zur Implementierung finden Sie die abstrakte Klasse ForecastingModel (wahrscheinlich in darts/models/forecasting model.py) und definieren Sie eine `params` Eigenschaft, die ein Wörterbuch zurückgibt. Überschreiben Sie dann diese Eigenschaft in jeder in der Checkliste aufgeführten Unterklasse, indem Sie Parameter aus den zugrunde liegenden Modellobjekten extrahieren. Beziehen Sie sich für Konsistenz auf das sklearn `get params` Muster, verwenden Sie jedoch wie vorgeschlagen die Eigenschaftssyntax. Überprüfen Sie die vorhandenen Muster des Repositorys (z. B. ExponentialSmoothing und Prophet) für Implementierungsdetails.
Tech Stack
python
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80