Skip to content

Commit ad099fc

Browse files
authored
docs: improve forecasting model search metadata (#1594)
Co-authored-by: Eduardo Lopez <5743857+loama@users.noreply.github.com>
1 parent 0feaadf commit ad099fc

7 files changed

Lines changed: 35 additions & 19 deletions

File tree

docs/models.informer.html.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
Informer: Efficient Transformer with ProbSparse attention for long-sequence time series forecasting. Reduces O(L^2) complexity for scalable predictions.
3+
Build long horizon forecasts with Informer in NeuralForecast. Learn ProbSparse attention, architecture, parameters, and a complete Python workflow.
44
output-file: models.informer.html
5-
title: Informer
5+
title: Informer Time Series Forecasting in Python
66
---
77

88
The Informer model tackles the vanilla Transformer computational
@@ -119,4 +119,4 @@ else:
119119

120120
::: neuralforecast.models.informer.ProbMask
121121
options:
122-
members: []
122+
members: []

docs/models.itransformer.html.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
iTransformer: Inverted Transformer architecture for multivariate time series forecasting with attention on time points and feed-forward on series dimensions.
3+
Build multivariate forecasts with iTransformer in NeuralForecast. Learn its inverted attention architecture, parameters, and Python workflow.
44
output-file: models.itransformer.html
5-
title: iTransformer
5+
title: iTransformer Time Series Forecasting in Python
66
---
77

88
The iTransformer model simply takes the Transformer architecture but it
@@ -79,4 +79,4 @@ ax.set_ylabel('Monthly Passengers', fontsize=20)
7979
ax.set_xlabel('Year', fontsize=20)
8080
ax.legend(prop={'size': 15})
8181
ax.grid()
82-
```
82+
```

docs/models.kan.html.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
KAN: Kolmogorov-Arnold Networks for time series forecasting. MLP alternative using learnable activation functions for improved non-linear pattern modeling.
3+
Build time series forecasts with Kolmogorov Arnold Networks in NeuralForecast. Compare KAN with MLP models and run a complete Python example.
44
output-file: models.kan.html
5-
title: KAN
5+
title: KAN Time Series Forecasting in Python
66
---
77

88
Kolmogorov-Arnold Networks (KANs) are an alternative to Multi-Layer
@@ -78,4 +78,4 @@ plt.grid()
7878

7979
::: neuralforecast.models.kan.KANLinear
8080
options:
81-
members: []
81+
members: []

docs/models.patchtst.html.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
PatchTST: Efficient Transformer model for multivariate forecasting using patched time series and channel-independence for scalable long-term predictions.
3+
Build long horizon forecasts with PatchTST in NeuralForecast. Learn how temporal patches and channel independence work, then run a complete Python example.
44
output-file: models.patchtst.html
5-
title: PatchTST
5+
title: PatchTST Time Series Forecasting in Python
66
---
77

88
The PatchTST model is an efficient Transformer-based model for
@@ -144,4 +144,4 @@ else:
144144

145145
::: neuralforecast.models.patchtst.PatchTST_backbone
146146
options:
147-
members: []
147+
members: []

docs/models.tft.html.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
TFT: Temporal Fusion Transformer with interpretable multi-horizon forecasting. LSTM encoder, multi-head attention, variable selection for complex time series.
3+
Build interpretable forecasts with Temporal Fusion Transformer in NeuralForecast using static, historic, and future variables in Python.
44
output-file: models.tft.html
5-
title: TFT
5+
title: Temporal Fusion Transformer Forecasting in Python
66
---
77

88
In summary Temporal Fusion Transformer (TFT) combines gating layers, an
@@ -469,4 +469,3 @@ mechanism has a great resemblence to a single attention layer, but it
469469
allows for $M$ multiple attention weights, and can be therefore be
470470
interpreted as the average ensemble of $M$ single attention layers.
471471

472-

nbs/docs/capabilities/cross_validation.ipynb

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "raw",
5+
"metadata": {},
6+
"source": [
7+
"---\n",
8+
"title: NeuralForecast Cross Validation API and Parameters\n",
9+
"description: Understand NeuralForecast cross validation parameters, including horizons, windows, step size, validation size, test size, and refitting behavior.\n",
10+
"---"
11+
]
12+
},
313
{
414
"cell_type": "markdown",
515
"metadata": {},
616
"source": [
7-
"# Cross-validation | NeuralForecast\n",
8-
"\n",
917
":::{.callout-warning collapse=\"true\"}\n",
1018
"## Prerequesites\n",
1119
"This Guide assumes basic familiarity with NeuralForecast. For a minimal example visit the [Quick Start](../getting-started/quickstart.html)\n",

nbs/docs/tutorials/cross_validation.ipynb

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "raw",
5+
"metadata": {},
6+
"source": [
7+
"---\n",
8+
"title: Time Series Cross Validation Tutorial with NeuralForecast\n",
9+
"description: Build a complete NeuralForecast cross validation workflow in Python, compare predictions with actual values, and evaluate models across rolling windows.\n",
10+
"---"
11+
]
12+
},
313
{
414
"cell_type": "markdown",
515
"metadata": {},
616
"source": [
7-
"# Cross-validation| NeuralForecast\n",
817
"> Implement cross-validation to evaluate models on historical data"
918
]
1019
},
@@ -969,4 +978,4 @@
969978
},
970979
"nbformat": 4,
971980
"nbformat_minor": 4
972-
}
981+
}

0 commit comments

Comments
 (0)