Skip to content

Commit 9bc90c1

Browse files
authored
[DOCS] fix remaining broken links (#1499)
1 parent d08a107 commit 9bc90c1

16 files changed

Lines changed: 46 additions & 46 deletions

docs/models.html.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Recurrent neural networks for sequential forecasting:
4646
Attention-based architectures for capturing complex temporal patterns:
4747

4848
- `AutoTFT`: [Temporal Fusion Transformer with multi-horizon forecasting](./models.tft.html)
49-
- `AutoVanillaTransformer`: [Standard transformer architecture](./models.vanillatransformer.hml)
49+
- `AutoVanillaTransformer`: [Standard transformer architecture](./models.vanillatransformer.html)
5050
- `AutoInformer`: [Efficient transformer for long sequence forecasting](./models.informer.html)
5151
- `AutoAutoformer`: [Auto-correlation based transformer](./models.autoformer.html)
5252
- `AutoFEDformer`: [Frequency enhanced decomposition transformer](./models.fedformer.html)
@@ -160,7 +160,7 @@ from neuralforecast.auto import AutoHINT
160160
from neuralforecast.models.nhits import NHITS
161161
from ray import tune
162162

163-
# Perform a conjunct hyperparameter optimization with
163+
# Perform a conjunct hyperparameter optimization with
164164
# NHITS + HINT reconciliation configurations
165165
nhits_config = {
166166
"learning_rate": tune.choice([1e-3]), # Initial Learning rate

nbs/docs/capabilities/cross_validation.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"\n",
99
":::{.callout-warning collapse=\"true\"}\n",
1010
"## Prerequesites\n",
11-
"This Guide assumes basic familiarity with NeuralForecast. For a minimal example visit the [Quick Start](../getting-started/02_quickstart.ipynb)\n",
11+
"This Guide assumes basic familiarity with NeuralForecast. For a minimal example visit the [Quick Start](../getting-started/quickstart.html)\n",
1212
":::\n",
1313
"\n",
1414
"To measure the performance of a forecasting model, we can assess its performance on historical data using *cross-validation*.\n",

nbs/docs/capabilities/exogenous_variables.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
"metadata": {},
4242
"source": [
4343
":::{.callout-important}\n",
44-
"This Guide assumes basic knowledge on the NeuralForecast library. For a minimal example visit the [Getting Started](../getting-started/02_quickstart.ipynb) guide.\n",
44+
"This Guide assumes basic knowledge on the NeuralForecast library. For a minimal example visit the [Getting Started](../getting-started/quickstart.html) guide.\n",
4545
":::"
4646
]
4747
},

nbs/docs/capabilities/objectives.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"\n",
1818
"| Scale-Dependent | Percentage-Errors | Scale-Independent | Robust |\n",
1919
"|:-------------------------------------------------------------|:----------------------------------------------------------------------|:---------------------------------------------------------------|:-------------------------------------------------------|\n",
20-
"|[**MAE**](../../losses.pytorch.html#mae) |[**MAPE**](../../losses.pytorch.html#mape) |[**MASE**](../../losses.pytorch.html#mase)|[**Huber**](../losses.pytorch#class-huberloss) |\n",
20+
"|[**MAE**](../../losses.pytorch.html#mae) |[**MAPE**](../../losses.pytorch.html#mape) |[**MASE**](../../losses.pytorch.html#mase)|[**Huber**](../../losses.pytorch.html#huber-loss) |\n",
2121
"|[**MSE**](../../losses.pytorch.html#mse) |[**sMAPE**](../../losses.pytorch.html#smape) | |[**Tukey**](../../losses.pytorch.html#tukeyloss) |\n",
2222
"|[**RMSE**](../../losses.pytorch.html#rmse) | | |[**HuberMQLoss**](../../losses.pytorch.html#hubermqloss)|\n",
2323
"\n",

nbs/docs/capabilities/save_load_models.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"metadata": {},
2727
"source": [
2828
":::{.callout-important}\n",
29-
"This Guide assumes basic knowledge on the NeuralForecast library. For a minimal example visit the [Getting Started](../getting-started/02_quickstart.ipynb) guide.\n",
29+
"This Guide assumes basic knowledge on the NeuralForecast library. For a minimal example visit the [Getting Started](../getting-started/quickstart.html) guide.\n",
3030
":::"
3131
]
3232
},

nbs/docs/getting-started/introduction.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"* **Train and Evaluation Losses** Scale-dependent, percentage and scale independent errors, and parametric likelihoods.\n",
3838
"* **Automatic Model Selection** Parallelized automatic hyperparameter tuning, that efficiently searches best validation configuration.\n",
3939
"* **Simple Interface** Unified SKLearn Interface for `StatsForecast` and `MLForecast` compatibility.\n",
40-
"* **Model Collection**: Out of the box implementation of `MLP`, `LSTM`, `RNN`, `TCN`, `DilatedRNN`, `NBEATS`, `NHITS`, `ESRNN`, `Informer`, `TFT`, `PatchTST`, `VanillaTransformer`, `StemGNN` and `HINT`. See the entire [collection here](../capabilities/01_overview)."
40+
"* **Model Collection**: Out of the box implementation of `MLP`, `LSTM`, `RNN`, `TCN`, `DilatedRNN`, `NBEATS`, `NHITS`, `ESRNN`, `Informer`, `TFT`, `PatchTST`, `VanillaTransformer`, `StemGNN` and `HINT`. See the entire [collection here](../capabilities/overview.html)."
4141
]
4242
},
4343
{

nbs/docs/getting-started/quickstart.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"cell_type": "markdown",
1515
"metadata": {},
1616
"source": [
17-
"This notebook provides an example on how to start using the main functionalities of the NeuralForecast library. The `NeuralForecast` class allows users to easily interact with `NeuralForecast.models` PyTorch models. In this example we will forecast AirPassengers data with a classic `LSTM` and the recent `NHITS` models. The full list of available models is available [here](../capabilities/01_overview).\n"
17+
"This notebook provides an example on how to start using the main functionalities of the NeuralForecast library. The `NeuralForecast` class allows users to easily interact with `NeuralForecast.models` PyTorch models. In this example we will forecast AirPassengers data with a classic `LSTM` and the recent `NHITS` models. The full list of available models is available [here]( ../capabilities/overview.html).\n"
1818
]
1919
},
2020
{
@@ -412,7 +412,7 @@
412412
"metadata": {},
413413
"source": [
414414
":::{.callout-tip}\n",
415-
"For this guide we are using a simple `LSTM` model. More recent models, such as `TSMixer`, `TFT` and `NHITS` achieve better accuracy than `LSTM` in most settings. The full list of available models is available [here](../capabilities/01_overview).\n",
415+
"For this guide we are using a simple `LSTM` model. More recent models, such as `TSMixer`, `TFT` and `NHITS` achieve better accuracy than `LSTM` in most settings. The full list of available models is available [here]( ../capabilities/overview.html).\n",
416416
":::"
417417
]
418418
},

nbs/docs/tutorials/comparing_methods.ipynb

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,8 @@
160160
"# The 'demand' becomes 'y' representing the target variable we want to forecast\n",
161161
"Y_df = Y_df.rename(\n",
162162
" columns={\n",
163-
" 'item_id': 'unique_id', \n",
164-
" 'timestamp': 'ds', \n",
163+
" 'item_id': 'unique_id',\n",
164+
" 'timestamp': 'ds',\n",
165165
" 'demand': 'y'\n",
166166
" }\n",
167167
")\n",
@@ -431,7 +431,7 @@
431431
"# Get the current time before forecasting starts, this will be used to measure the execution time\n",
432432
"init = time()\n",
433433
"\n",
434-
"# Call the forecast method of the StatsForecast instance to predict the next 28 days (h=28) \n",
434+
"# Call the forecast method of the StatsForecast instance to predict the next 28 days (h=28)\n",
435435
"fcst_df = sf.forecast(df=Y_df, h=28)\n",
436436
"\n",
437437
"# Get the current time after the forecasting ends\n",
@@ -1267,7 +1267,7 @@
12671267
"plot_series(\n",
12681268
" Y_df,\n",
12691269
" fcst_df,\n",
1270-
" max_insample_length=28 * 3, \n",
1270+
" max_insample_length=28 * 3,\n",
12711271
" models=['CrostonOptimized', 'AutoNHITS', 'SeasonalNaive', 'LGBMRegressor'],\n",
12721272
")"
12731273
]
@@ -1519,7 +1519,7 @@
15191519
"source": [
15201520
"init = time()\n",
15211521
"cv_mlf_df = mlf.cross_validation(\n",
1522-
" df=Y_df, \n",
1522+
" df=Y_df,\n",
15231523
" h=horizon,\n",
15241524
" n_windows=3,\n",
15251525
")\n",
@@ -1897,9 +1897,9 @@
18971897
"for cutoff in cutoffs:\n",
18981898
" display(\n",
18991899
" plot_series(\n",
1900-
" Y_df, \n",
1901-
" cv_df.query('cutoff == @cutoff').drop(columns=['y', 'cutoff']), \n",
1902-
" max_insample_length=28 * 5, \n",
1900+
" Y_df,\n",
1901+
" cv_df.query('cutoff == @cutoff').drop(columns=['y', 'cutoff']),\n",
1902+
" max_insample_length=28 * 5,\n",
19031903
" ids=['FOODS_3_001_CA_1'],\n",
19041904
" )\n",
19051905
" )"
@@ -1976,7 +1976,7 @@
19761976
"for cutoff in cutoffs:\n",
19771977
" display(\n",
19781978
" plot_series(\n",
1979-
" agg_Y_df, \n",
1979+
" agg_Y_df,\n",
19801980
" agg_cv_df.query('cutoff == @cutoff').drop(columns=['y', 'cutoff']),\n",
19811981
" max_insample_length=28 * 5,\n",
19821982
" )\n",
@@ -2649,8 +2649,8 @@
26492649
"source": [
26502650
"plot_series(\n",
26512651
" Y_df,\n",
2652-
" cv_df.drop(columns=['cutoff', 'y']), \n",
2653-
" max_insample_length=28 * 6, \n",
2652+
" cv_df.drop(columns=['cutoff', 'y']),\n",
2653+
" max_insample_length=28 * 6,\n",
26542654
" models=['AutoNHITS'],\n",
26552655
")"
26562656
]
@@ -2716,12 +2716,12 @@
27162716
"id": "1394e95e-b65c-45d6-aea0-55e9e1940b60",
27172717
"metadata": {},
27182718
"source": [
2719-
"- [Available Models StatsForecast](../../../statsforecast/models)\n",
2720-
"- [Available Models NeuralForecast](../capabilities/01_overview)\n",
2721-
"- [Loss Functions in NeuralForecast](../capabilities/02_objectives)\n",
2722-
"- [Getting Started NeuralForecast](../getting-started/02_quickstart)\n",
2723-
"- [Hierarchical Reconciliation](../../../hierarchicalforecast/examples/TourismSmall)\n",
2724-
"- [Distributed ML Forecast (trees)](../../../mlforecast/docs/getting-started/quick_start_distributed)\n",
2719+
"- [Available Models StatsForecast](../../../statsforecast/models.html)\n",
2720+
"- [Available Models NeuralForecast]( ../capabilities/overview.html)\n",
2721+
"- [Loss Functions in NeuralForecast](../capabilities/objectives.html)\n",
2722+
"- [Getting Started NeuralForecast](../getting-started/quickstart.html)\n",
2723+
"- [Hierarchical Reconciliation](../../../hierarchicalforecast/examples/tourismsmall.html)\n",
2724+
"- [Distributed ML Forecast (trees)](../../../mlforecast/docs/getting-started/quick_start_distributed.html)\n",
27252725
"- [Using StatsForecast to train millions of time series](https://www.anyscale.com/blog/how-nixtla-uses-ray-to-accurately-predict-more-than-a-million-time-series)\n",
27262726
"- [Intermittent Demand Forecasting With Nixtla on Databricks](https://www.databricks.com/blog/2022/12/06/intermittent-demand-forecasting-nixtla-databricks.html)"
27272727
]

nbs/docs/tutorials/cross_validation.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"source": [
4141
":::{.callout-warning collapse=\"true\"}\n",
4242
"## Prerequesites\n",
43-
"This guide assumes basic familiarity with `neuralforecast`. For a minimal example visit the [Quick Start](../getting-started/02_quickstart.ipynb)\n",
43+
"This guide assumes basic familiarity with `neuralforecast`. For a minimal example visit the [Quick Start](../getting-started/quickstart.html)\n",
4444
":::"
4545
]
4646
},
@@ -274,7 +274,7 @@
274274
"cell_type": "markdown",
275275
"metadata": {},
276276
"source": [
277-
"In this tutorial, we will use `neuralforecast's` [MPL](../../models.mlp#class-mlp), [NBEATS](../../models.nbeats#class-nbeats), and [NHITS](../../models.nhits#class-nhits) models. \n",
277+
"In this tutorial, we will use `neuralforecast's` [MPL](../../models.mlp.html#mlp-2), [NBEATS](../../models.nbeats.html#nbeats), and [NHITS](../../models.nhits.html#nhits) models. \n",
278278
"\n",
279279
"First, we need to create a list of models and then instantiate the `NeuralForecast` class. For each model, we'll define the following hyperparameters:\n",
280280
"\n",

nbs/docs/tutorials/forecasting_tft.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@
538538
"\n",
539539
"In Challu et al [2] we demonstrate that the N-HiTS model outperforms the latest transformers by more than 20% with 50 times less computation.\n",
540540
"\n",
541-
"Learn how to use the N-HiTS and the NeuralForecast library in [this tutorial](../use-cases/electricity_peak_forecasting)."
541+
"Learn how to use the N-HiTS and the NeuralForecast library in [this tutorial](../use-cases/electricity_peak_forecasting.html)."
542542
]
543543
},
544544
{

0 commit comments

Comments
 (0)