unit8co/darts

Unified API : `model.params` attribute

Open

#192 opened on 2020年9月28日

GitHub で見る
 (8 comments) (1 reaction) (0 assignees)Python (762 forks)batch import
good first issueimprovement

Repository metrics

Stars
 (6,832 stars)
PR merge metrics
 (平均マージ 143d 16h) (30d で 16 merged PRs)

説明

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

コントリビューターガイド

調査方針
この課題は、ForecastingModel 基底クラスに `params` プロパティを追加してモデルパラメータへのアクセスを統一し、実装すべきモデルのチェックリストを提案しています。既存の ExponentialSmoothing と Prophet モデルは完了済み（マーク済み）です。実装するには、ForecastingModel 抽象クラス（おそらく darts/models/forecasting model.py 内）を見つけ、辞書を返す `params` プロパティを定義します。次に、チェックリストに記載されている各サブクラスでこのプロパティをオーバーライドし、基盤となるモデルオブジェクトからパラメータを抽出します。一貫性のために sklearn の `get params` パターンを参照しますが、提案通りプロパティ構文を使用してください。実装の詳細については、リポジトリの既存のパターン（例：ExponentialSmoothing と Prophet）を確認してください。
技術スタック
python
領域
backend
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonGit
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80