Skip to content

Forecasting API

Auto-generated from source — see Forecasting for narrative descriptions.

PatchTST

keras_climate.forecasting.patchtst.PatchTST

PatchTST(seq_len=336, pred_len=96, num_channels=7, patch_len=16, stride=8, d_model=128, depth=3, num_heads=16, mlp_ratio=2.0, dropout=0.2, use_revin=True, padding_patch='end', name='patchtst')
Source code in keras_climate/forecasting/patchtst.py
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def PatchTST(
    seq_len=336,
    pred_len=96,
    num_channels=7,
    patch_len=16,
    stride=8,
    d_model=128,
    depth=3,
    num_heads=16,
    mlp_ratio=2.0,
    dropout=0.2,
    use_revin=True,
    padding_patch="end",
    name="patchtst",
):
    inputs = keras.Input(shape=(seq_len, num_channels), name="series")
    x = inputs

    revin = RevIN(name="revin") if use_revin else None
    if revin is not None:
        x = revin(x, mode="norm")

    padded_seq_len = seq_len
    if padding_patch == "end":
        padded_seq_len += stride
        x = layers.Lambda(
            lambda t: ops.concatenate(
                [t, ops.repeat(t[:, -1:, :], stride, axis=1)], axis=1
            ),
            output_shape=(padded_seq_len, num_channels),
            name="replication_pad",
        )(x)

    num_patches = (padded_seq_len - patch_len) // stride + 1
    patches = PatchifyTS(patch_len, stride, num_patches, name="patchify")(x)

    tokens = layers.Dense(d_model, name="patch_proj")(patches)
    tokens = LearnedPositionalEmbedding(num_patches, d_model, name="pos_embed")(tokens)
    tokens = layers.Dropout(dropout)(tokens)

    for i in range(depth):
        tokens = TransformerEncoderBlock(
            d_model, num_heads, mlp_ratio, drop=dropout, name=f"encoder_block{i}"
        )(tokens)
    tokens = layers.LayerNormalization(epsilon=1e-6, name="encoder_norm")(tokens)

    flat = layers.Reshape((num_patches * d_model,), name="flatten")(tokens)
    head = layers.Dense(pred_len, name="forecast_head")(flat)

    out = layers.Lambda(
        lambda t: ops.transpose(
            ops.reshape(t, (-1, num_channels, pred_len)), (0, 2, 1)
        ),
        output_shape=(pred_len, num_channels),
        name="reshape_output",
    )(head)

    if revin is not None:
        out = revin(out, mode="denorm")

    return keras.Model(inputs, out, name=name)

keras_climate.forecasting.patchtst.RevIN

RevIN(eps=1e-05, affine=True, **kwargs)

Bases: Layer

Source code in keras_climate/forecasting/patchtst.py
 8
 9
10
11
def __init__(self, eps=1e-5, affine=True, **kwargs):
    super().__init__(**kwargs)
    self.eps = eps
    self.affine = affine

TimesNet

keras_climate.forecasting.timesnet.TimesNet

TimesNet(seq_len=96, pred_len=96, num_channels=7, d_model=64, d_ff=128, num_layers=2, num_kernels=6, top_k=5, use_revin=True, name='timesnet')
Source code in keras_climate/forecasting/timesnet.py
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
def TimesNet(
    seq_len=96,
    pred_len=96,
    num_channels=7,
    d_model=64,
    d_ff=128,
    num_layers=2,
    num_kernels=6,
    top_k=5,
    use_revin=True,
    name="timesnet",
):
    inputs = keras.Input(shape=(seq_len, num_channels), name="series")
    x = inputs

    revin = RevIN(name="revin") if use_revin else None
    if revin is not None:
        x = revin(x, mode="norm")

    x = layers.Dense(d_model, name="value_embed")(x)

    for i in range(num_layers):
        x = FFTPeriodBlock(d_model, d_ff, num_kernels, top_k, name=f"timesblock{i}")(
            x, seq_len=seq_len
        )
        x = layers.LayerNormalization(epsilon=1e-6, name=f"norm{i}")(x)

    x_t = layers.Permute((2, 1), name="transpose_for_time_proj")(x)
    x_t = layers.Dense(seq_len + pred_len, name="predict_linear")(x_t)
    x = layers.Permute((2, 1), name="transpose_back")(x_t)

    out = layers.Dense(num_channels, name="output_proj")(x)
    out = layers.Lambda(lambda t: t[:, -pred_len:, :], name="slice_horizon")(out)

    if revin is not None:
        out = revin(out, mode="denorm")

    return keras.Model(inputs, out, name=name)

TFT

keras_climate.forecasting.tft.TemporalFusionTransformer

TemporalFusionTransformer(encoder_len=168, decoder_len=24, num_past_vars=6, num_future_vars=3, num_static_vars=2, hidden_dim=64, num_heads=4, dropout=0.1, quantiles=(0.1, 0.5, 0.9), name='tft')
Source code in keras_climate/forecasting/tft.py
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
def TemporalFusionTransformer(
    encoder_len=168,
    decoder_len=24,
    num_past_vars=6,
    num_future_vars=3,
    num_static_vars=2,
    hidden_dim=64,
    num_heads=4,
    dropout=0.1,
    quantiles=(0.1, 0.5, 0.9),
    name="tft",
):
    past_in = keras.Input((encoder_len, num_past_vars), name="past_inputs")
    future_in = keras.Input((decoder_len, num_future_vars), name="future_inputs")
    static_in = keras.Input((num_static_vars,), name="static_inputs")

    static_embed = layers.Dense(hidden_dim, name="static_embed")(static_in)
    static_context_enrichment = GatedResidualNetwork(
        hidden_dim, dropout, name="static_ctx_enrichment"
    )(static_embed)
    static_context_h = GatedResidualNetwork(hidden_dim, dropout, name="static_ctx_h")(
        static_embed
    )
    static_context_c = GatedResidualNetwork(hidden_dim, dropout, name="static_ctx_c")(
        static_embed
    )

    past_var_embeds = [
        layers.Dense(hidden_dim, name=f"past_var{i}_embed")(
            layers.Lambda(lambda t, idx=i: t[..., idx : idx + 1])(past_in)
        )
        for i in range(num_past_vars)
    ]
    past_selected, past_weights = VariableSelectionNetwork(
        num_past_vars, hidden_dim, dropout, name="past_vsn"
    )(past_var_embeds)

    future_var_embeds = [
        layers.Dense(hidden_dim, name=f"future_var{i}_embed")(
            layers.Lambda(lambda t, idx=i: t[..., idx : idx + 1])(future_in)
        )
        for i in range(num_future_vars)
    ]
    future_selected, future_weights = VariableSelectionNetwork(
        num_future_vars, hidden_dim, dropout, name="future_vsn"
    )(future_var_embeds)

    encoder_out, state_h, state_c = layers.LSTM(
        hidden_dim, return_sequences=True, return_state=True, name="lstm_encoder"
    )(past_selected, initial_state=[static_context_h, static_context_c])

    decoder_out = layers.LSTM(hidden_dim, return_sequences=True, name="lstm_decoder")(
        future_selected, initial_state=[state_h, state_c]
    )

    lstm_out = layers.Concatenate(axis=1, name="concat_encoder_decoder")(
        [encoder_out, decoder_out]
    )
    lstm_in = layers.Concatenate(axis=1, name="concat_selected")(
        [past_selected, future_selected]
    )

    gated = GatedResidualNetwork(hidden_dim, dropout, name="post_lstm_gate")(lstm_out)
    x = layers.LayerNormalization(name="post_lstm_norm")(gated + lstm_in)

    enriched = GatedResidualNetwork(hidden_dim, dropout, name="static_enrichment")(
        x + static_context_enrichment[:, None, :]
    )

    total_len = encoder_len + decoder_len
    mask = causal_mask(total_len)
    attn_out = InterpretableMultiHeadAttention(
        hidden_dim, num_heads, dropout, name="attention"
    )(enriched, mask=mask)
    attn_out = layers.Dropout(dropout)(attn_out)
    x = layers.LayerNormalization(name="post_attn_norm")(attn_out + enriched)

    x = GatedResidualNetwork(hidden_dim, dropout, name="positionwise_ff")(x)
    x = layers.LayerNormalization(name="final_norm")(x + lstm_out)

    decoder_span = layers.Lambda(
        lambda t, L=encoder_len: t[:, L:, :], name="slice_decoder_span"
    )(x)

    outputs = layers.Dense(len(quantiles), name="quantile_head")(decoder_span)

    return keras.Model([past_in, future_in, static_in], outputs, name=name)

DLinear

keras_climate.forecasting.dlinear.DLinear

DLinear(seq_len=336, pred_len=96, num_channels=7, kernel_size=25, individual=False, name='dlinear')
Source code in keras_climate/forecasting/dlinear.py
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def DLinear(
    seq_len=336,
    pred_len=96,
    num_channels=7,
    kernel_size=25,
    individual=False,
    name="dlinear",
):
    inputs = keras.Input(shape=(seq_len, num_channels), name="series")
    seasonal, trend = SeriesDecomposition(kernel_size, name="decomp")(inputs)

    seasonal_out = _time_linear(
        seasonal, pred_len, num_channels, individual, "linear_seasonal"
    )
    trend_out = _time_linear(trend, pred_len, num_channels, individual, "linear_trend")
    outputs = layers.Add(name="add")([seasonal_out, trend_out])

    return keras.Model(inputs, outputs, name=name)

keras_climate.forecasting.dlinear.SeriesDecomposition

SeriesDecomposition(kernel_size=25, **kwargs)

Bases: Layer

Source code in keras_climate/forecasting/dlinear.py
 7
 8
 9
10
11
12
def __init__(self, kernel_size=25, **kwargs):
    super().__init__(**kwargs)
    self.kernel_size = kernel_size
    self.avg_pool = layers.AveragePooling1D(
        pool_size=kernel_size, strides=1, padding="valid"
    )

N-BEATS

keras_climate.forecasting.nbeats.NBeats

NBeats(seq_len=96, pred_len=24, stack_types=('trend', 'seasonality'), num_blocks_per_stack=3, hidden_dim=256, num_fc_layers=4, trend_degree=2, num_harmonics=1, name='nbeats')
Source code in keras_climate/forecasting/nbeats.py
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
def NBeats(
    seq_len=96,
    pred_len=24,
    stack_types=("trend", "seasonality"),
    num_blocks_per_stack=3,
    hidden_dim=256,
    num_fc_layers=4,
    trend_degree=2,
    num_harmonics=1,
    name="nbeats",
):
    inputs = keras.Input(shape=(seq_len,), name="series")
    residual = inputs
    forecast = None

    block_idx = 0
    for stack_type in stack_types:
        for _ in range(num_blocks_per_stack):
            basis, theta_size = _make_basis(
                stack_type,
                seq_len,
                pred_len,
                trend_degree,
                num_harmonics,
                name=f"block{block_idx}_basis",
            )
            block = NBeatsBlock(
                hidden_dim, num_fc_layers, basis, theta_size, name=f"block{block_idx}"
            )
            backcast, block_forecast = block(residual)
            residual = layers.Subtract(name=f"block{block_idx}_residual")(
                [residual, backcast]
            )
            forecast = (
                block_forecast
                if forecast is None
                else layers.Add(name=f"block{block_idx}_forecast_sum")(
                    [forecast, block_forecast]
                )
            )
            block_idx += 1

    return keras.Model(inputs, forecast, name=name)

keras_climate.forecasting.nbeats.GenericBasis

GenericBasis(backcast_size, forecast_size, **kwargs)

Bases: Layer

Source code in keras_climate/forecasting/nbeats.py
 8
 9
10
11
def __init__(self, backcast_size, forecast_size, **kwargs):
    super().__init__(**kwargs)
    self.backcast_size = backcast_size
    self.forecast_size = forecast_size

keras_climate.forecasting.nbeats.TrendBasis

TrendBasis(degree, backcast_size, forecast_size, **kwargs)

Bases: Layer

Source code in keras_climate/forecasting/nbeats.py
19
20
21
22
23
24
25
26
27
28
def __init__(self, degree, backcast_size, forecast_size, **kwargs):
    super().__init__(**kwargs)
    self.degree = degree
    poly = degree + 1
    self._backcast_basis_np = np.stack(
        [(np.arange(backcast_size) / backcast_size) ** i for i in range(poly)]
    ).astype("float32")
    self._forecast_basis_np = np.stack(
        [(np.arange(forecast_size) / forecast_size) ** i for i in range(poly)]
    ).astype("float32")

keras_climate.forecasting.nbeats.SeasonalityBasis

SeasonalityBasis(num_harmonics, backcast_size, forecast_size, **kwargs)

Bases: Layer

Source code in keras_climate/forecasting/nbeats.py
55
56
57
58
59
60
61
62
63
64
def __init__(self, num_harmonics, backcast_size, forecast_size, **kwargs):
    super().__init__(**kwargs)
    self.num_harmonics = num_harmonics
    k = np.arange(1, num_harmonics + 1)[:, None]
    t_back = np.arange(backcast_size)[None, :] / forecast_size
    t_fore = np.arange(forecast_size)[None, :] / forecast_size
    self._backcast_cos_np = np.cos(2 * np.pi * k * t_back).astype("float32")
    self._backcast_sin_np = np.sin(2 * np.pi * k * t_back).astype("float32")
    self._forecast_cos_np = np.cos(2 * np.pi * k * t_fore).astype("float32")
    self._forecast_sin_np = np.sin(2 * np.pi * k * t_fore).astype("float32")

Informer

keras_climate.forecasting.informer.Informer

Informer(seq_len=96, label_len=48, pred_len=24, num_channels=7, d_model=64, num_heads=4, d_ff=128, encoder_layers=2, decoder_layers=1, dropout=0.1, distil=True, name='informer')
Source code in keras_climate/forecasting/informer.py
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def Informer(
    seq_len=96,
    label_len=48,
    pred_len=24,
    num_channels=7,
    d_model=64,
    num_heads=4,
    d_ff=128,
    encoder_layers=2,
    decoder_layers=1,
    dropout=0.1,
    distil=True,
    name="informer",
):
    enc_in = keras.Input((seq_len, num_channels), name="encoder_series")
    dec_in = keras.Input((label_len + pred_len, num_channels), name="decoder_series")

    enc_x = DataEmbedding(d_model, dropout=dropout, name="enc_embedding")(enc_in)
    for i in range(encoder_layers):
        enc_x = InformerEncoderLayer(
            d_model, num_heads, d_ff, dropout, name=f"encoder_layer{i}"
        )(enc_x)
        if distil and i < encoder_layers - 1:
            enc_x = DistillConv(d_model, name=f"distill{i}")(enc_x)

    dec_x = DataEmbedding(d_model, dropout=dropout, name="dec_embedding")(dec_in)
    self_mask = causal_mask(label_len + pred_len)
    for i in range(decoder_layers):
        dec_x = InformerDecoderLayer(
            d_model, num_heads, d_ff, dropout, name=f"decoder_layer{i}"
        )(dec_x, enc_x, self_mask=self_mask)

    out = layers.Dense(num_channels, name="projection")(dec_x)
    out = layers.Lambda(lambda t: t[:, -pred_len:, :], name="slice_forecast")(out)

    return keras.Model([enc_in, dec_in], out, name=name)

Autoformer

keras_climate.forecasting.autoformer.Autoformer

Autoformer(seq_len=96, label_len=48, pred_len=24, num_channels=7, d_model=64, num_heads=4, d_ff=128, encoder_layers=2, decoder_layers=1, moving_avg=25, dropout=0.1, name='autoformer')
Source code in keras_climate/forecasting/autoformer.py
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def Autoformer(
    seq_len=96,
    label_len=48,
    pred_len=24,
    num_channels=7,
    d_model=64,
    num_heads=4,
    d_ff=128,
    encoder_layers=2,
    decoder_layers=1,
    moving_avg=25,
    dropout=0.1,
    name="autoformer",
):
    enc_in = keras.Input((seq_len, num_channels), name="encoder_series")
    label_in = keras.Input((label_len, num_channels), name="label_series")

    seasonal_init, trend_init = SeriesDecomposition(moving_avg, name="init_decomp")(
        label_in
    )

    mean_trend = layers.Lambda(
        lambda t: ops.mean(t, axis=1, keepdims=True), name="label_mean"
    )(label_in)
    trend_pred_part = layers.Lambda(
        lambda t: ops.repeat(t, pred_len, axis=1), name="trend_pred_fill"
    )(mean_trend)
    trend_init_full = layers.Concatenate(axis=1, name="trend_init_concat")(
        [trend_init, trend_pred_part]
    )

    zeros_seasonal = layers.Lambda(
        lambda t: ops.zeros((ops.shape(t)[0], pred_len, num_channels)),
        name="seasonal_pred_fill",
    )(label_in)
    seasonal_init_full = layers.Concatenate(axis=1, name="seasonal_init_concat")(
        [seasonal_init, zeros_seasonal]
    )

    enc_x = ValueEmbedding(d_model, name="enc_embedding")(enc_in)
    for i in range(encoder_layers):
        enc_x = AutoformerEncoderLayer(
            d_model, num_heads, d_ff, moving_avg, dropout, name=f"encoder_layer{i}"
        )(enc_x)

    dec_x = ValueEmbedding(d_model, name="dec_embedding")(seasonal_init_full)
    trend = trend_init_full
    for i in range(decoder_layers):
        dec_x, layer_trend = AutoformerDecoderLayer(
            d_model,
            num_heads,
            d_ff,
            num_channels,
            moving_avg,
            dropout,
            name=f"decoder_layer{i}",
        )(dec_x, enc_x)
        trend = layers.Add(name=f"decoder_layer{i}_trend_add")([trend, layer_trend])

    seasonal_out = layers.Dense(num_channels, name="projection")(dec_x)
    out = layers.Add(name="final_add")([seasonal_out, trend])
    out = layers.Lambda(lambda t: t[:, -pred_len:, :], name="slice_forecast")(out)

    return keras.Model([enc_in, label_in], out, name=name)

keras_climate.forecasting.autoformer.AutoCorrelation

AutoCorrelation(d_model, num_heads, **kwargs)

Bases: Layer

Source code in keras_climate/forecasting/autoformer.py
 9
10
11
12
13
def __init__(self, d_model, num_heads, **kwargs):
    super().__init__(**kwargs)
    self.d_model = d_model
    self.num_heads = num_heads
    self.head_dim = d_model // num_heads