pynnlf 0.2.2__py3-none-any.whl

pynnlf/scaffold/models/mXX_template.py

@@ -0,0 +1,68 @@
+#!/usr/bin/env python
+# coding: utf-8
+
+import numpy as np
+import pandas as pd
+
+def train_model_mXX_template(hyperparameter, train_df_X, train_df_y, forecast_horizon=None):
+    """
+    Train the model and return a model object.
+
+    Notes:
+        - Your model file name MUST start with an ID prefix: m19_*.py
+        - Your function names MUST match the file stem (without .py).
+          Example file: m19_my_model.py
+          Functions must be:
+            - train_model_m19_my_model(...)
+            - produce_forecast_m19_my_model(...)
+
+    Args:
+        hyperparameter (dict): hyperparameter dict for this run (from models/hyperparameters.yaml)
+        train_df_X (pd.DataFrame): predictors for training set
+        train_df_y (pd.DataFrame): target for training set, with column 'y'
+        forecast_horizon (int | None): forecast horizon in minutes (optional)
+
+    Returns:
+        object: model object (can be dict/class) used later in produce_forecast_*
+    """
+    # Example: no training, just store a bias from hyperparameters
+    bias = float(hyperparameter.get("bias", 0.0))
+    model = {"bias": bias}
+    return model
+
+
+def produce_forecast_mXX_template(model, train_df_X, test_df_X, train_df_y=None, forecast_horizon=None):
+    """
+    Produce forecasts for train and test sets.
+
+    Important:
+        - Return TWO outputs: (train_y_hat, test_y_hat)
+        - Each output can be:
+            - pd.Series indexed like train_df_X/test_df_X
+            - OR a 1D numpy array of matching length
+          (The engine will align/convert to Series.)
+
+    Args:
+        model (object): model object returned by train_model_*
+        train_df_X (pd.DataFrame): predictors for training set
+        test_df_X (pd.DataFrame): predictors for test set
+        train_df_y (pd.DataFrame | None): target training set (optional; used by Prophet-like models)
+        forecast_horizon (int | None): minutes (optional)
+
+    Returns:
+        tuple:
+            train_y_hat (pd.Series | np.ndarray): forecast for train
+            test_y_hat (pd.Series | np.ndarray): forecast for test
+    """
+    # Example baseline: last-observation “naive” + bias
+    if forecast_horizon is None:
+        raise ValueError("forecast_horizon must be provided for this template.")
+
+    horizon = pd.Timedelta(minutes=int(forecast_horizon))
+    last_obs_col = f"y_lag_{horizon}m"
+    bias = float(model.get("bias", 0.0))
+
+    train_y_hat = train_df_X[last_obs_col] + bias
+    test_y_hat = test_df_X[last_obs_col] + bias
+
+    return train_y_hat, test_y_hat

pynnlf/scaffold/specs/batch.yaml

@@ -0,0 +1,4 @@
+datasets: [ds0]
+forecast_horizons: [fh1]
+model_and_hp:
+  - [m6, hp1]

pynnlf/scaffold/specs/experiment.yaml

@@ -0,0 +1,4 @@
+dataset: ds0
+forecast_horizon: fh1
+model: m6
+hyperparameter: hp1

pynnlf/scaffold/specs/pynnlf_config.yaml

@@ -0,0 +1,69 @@
+paths:
+  data_dir: data
+  output_dir: experiment_result
+  hyperparameters_path: models/hyperparameters.yaml
+
+dataset_download:
+  base_url: "https://raw.githubusercontent.com/mssamhan31/PyNNLF/main/data/"
+
+datasets:
+  ds0: ds0_test.csv
+  ds1: ds1_ashd.csv
+  ds2: ds2_aedp_5min.csv
+  ds3: ds3_aedp_30min.csv
+  ds4: ds4_ashd_with_weather.csv
+  ds5: ds5_aedp_30min_with_weather.csv
+  ds6: ds6_aedp_cluster_5min.csv
+  ds7: ds7_aedp_cluster_30min.csv
+  ds8: ds8_aedp_cluster_30min_with_weather.csv
+  ds9: ds9_aedp_cluster2_5min.csv
+  ds10: ds10_aedp_cluster2_30min.csv
+  ds11: ds11_aedp_cluster2_30min_with_weather.csv
+  ds12: ds12_ashd_with_cloud_bom.csv
+  ds13: ds13_ashd_with_cloud_solcast.csv
+  ds14: ds14_ausgrid_zs_mascot.csv
+  ds15: ds15_ausgrid_zs_mascot_30min_with_weather.csv
+
+forecast_horizons:
+  fh1: 30
+  fh2: 60
+  fh3: 120
+  fh4: 180
+  fh5: 240
+  fh6: 300
+  fh7: 360
+  fh8: 1440
+  fh9: 2880
+  fh10: 10080
+  fh11: 43200
+
+models:
+  m1: m1_naive
+  m2: m2_snaive
+  m3: m3_ets
+  m4: m4_arima
+  m5: m5_sarima
+  m6: m6_lr
+  m7: m7_ann
+  m8: m8_dnn
+  m9: m9_rt
+  m10: m10_rf
+  m11: m11_svr
+  m12: m12_rnn
+  m13: m13_lstm
+  m14: m14_gru
+  m15: m15_transformer
+  m16: m16_prophet
+  m17: m17_xgb
+  m18: m18_nbeats
+
+cv:
+  k: 10
+  max_lag_day: 7
+
+plot:
+  enabled: true
+  colors:
+    dark_blue: "#22303D"
+    orange: "#EB932C"
+  font_family: Arial