Skip to content

Commit 4d6fadd

Browse files
authored
docs: fix broken documentation links (#1592)
Co-authored-by: Eduardo Lopez <5743857+loama@users.noreply.github.com>
1 parent 9991cd5 commit 4d6fadd

7 files changed

Lines changed: 13 additions & 13 deletions

File tree

426 KB
Loading

docs/models.gru.html.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ of the prediction.
2727

2828
- [Junyoung Chung, Caglar Gulcehre, KyungHyun Cho,
2929
Yoshua Bengio (2014). “Empirical Evaluation of Gated Recurrent Neural
30-
Networks on Sequence Modeling”.](https:arxivorg/abs/1412.3555)
30+
Networks on Sequence Modeling”.](https://arxiv.org/abs/1412.3555)
3131
- [Kyunghyun Cho, Bart van Merrienboer, Dzmitry Bahdanau, Yoshua Bengio
3232
(2014). “On the Properties of Neural Machine Translation:
3333
Encoder-Decoder Approaches”.](https://arxiv.org/abs/1409.1259)

docs/models.nbeatsx.html.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ is an
1111
[`MLP`](./models.mlp.html#mlp)-based
1212
deep neural architecture with backward and forward residual links. The
1313
network has two variants: (1) in its interpretable configuration,
14-
[`NBEATS`](./neuralforecast/models.nbeats.html#nbeats-2)
14+
[`NBEATS`](./models.nbeats.html#nbeats)
1515
sequentially projects the signal into polynomials and harmonic basis to
1616
learn trend and seasonality components; (2) in its generic
1717
configuration, it substitutes the polynomial and harmonic basis for

docs/models.stemgnn.html.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Zhang (2020). “Spectral Temporal Graph Neural Network for Multivariate
2424
Time-series
2525
Forecasting”.](https://proceedings.neurips.cc/paper/2020/hash/cdf6581cb7aca4b7e19ef136c6e601a5-Abstract.html)
2626

27-
![Figure 1. StemGNN.](./imgs_models/stemgnn.png)
27+
![Figure 1. StemGNN.](./imgs_models/StemGNN.png)
2828
*Figure 1. StemGNN.*
2929

3030
## 1. StemGNN
@@ -115,4 +115,4 @@ ax.grid()
115115

116116
::: neuralforecast.models.stemgnn.StockBlockLayer
117117
options:
118-
members: []
118+
members: []

nbs/docs/tutorials/adding_models.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@
350350
"\n",
351351
"### b. Tests and documentation\n",
352352
"\n",
353-
"`nbdev` allows for testing and documenting the model during the development process. It allows users to iterate the development within the notebook, testing the code in the same environment. Refer to existing models, such as the complete MLP model [here](https://github.com/Nixtla/neuralforecast/blob/main/nbs/models.mlp.ipynb). These files already contain the tests, documentation, and usage examples that were used during the development process.\n",
353+
"`nbdev` allows for testing and documenting the model during the development process. It allows users to iterate the development within the notebook, testing the code in the same environment. Refer to the existing MLP [implementation](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/models/mlp.py), [tests](https://github.com/Nixtla/neuralforecast/blob/main/tests/test_models/test_mlp.py), and [usage documentation](https://nixtlaverse.nixtla.io/neuralforecast/models.mlp.html) for a complete example of the model development process.\n",
354354
"\n",
355355
"### c. Export the new model to the library with `nbdev`\n",
356356
"\n",
@@ -369,7 +369,7 @@
369369
"Finally, add the model to the `core` class and additional files:\n",
370370
"\n",
371371
"1. Manually add the model in the following [init file](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/models/__init__.py).\n",
372-
"2. Add the model to the `core` class, using the `nbdev` file [here](https://github.com/Nixtla/neuralforecast/blob/main/nbs/core.ipynb):\n",
372+
"2. Add the model to the `core` class, using the source file [here](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/core.py):\n",
373373
" \n",
374374
" a. Add the model to the initial model list:\n",
375375
" ```python\n",
@@ -392,9 +392,9 @@
392392
"\n",
393393
"It's important to add the model to the necessary documentation pages so that everyone can find the documentation:\n",
394394
"\n",
395-
"1. Add the model to the [model overview table](https://github.com/Nixtla/neuralforecast/blob/main/nbs/docs/capabilities/01_overview.ipynb).\n",
396-
"2. Add the model to the [sidebar](https://github.com/Nixtla/neuralforecast/blob/main/nbs/sidebar.yml) for the API reference.\n",
397-
"3. Add the model to [mint.json](https://github.com/Nixtla/neuralforecast/blob/main/nbs/mint.json)."
395+
"1. Add the model to the [model overview table](https://github.com/Nixtla/neuralforecast/blob/main/nbs/docs/capabilities/overview.ipynb).\n",
396+
"2. Add the model to the [documentation navigation](https://github.com/Nixtla/neuralforecast/blob/main/docs/mintlify/docs.json) for the API reference.\n",
397+
"3. Confirm the page is present in [docs.json](https://github.com/Nixtla/neuralforecast/blob/main/docs/mintlify/docs.json)."
398398
]
399399
},
400400
{
@@ -424,7 +424,7 @@
424424
"* Implement `init` and `forward` methods and set the class attributes.\n",
425425
"* Export model with `nbdev_export`.\n",
426426
"* Add model to this [init file](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/models/__init__.py).\n",
427-
"* Add the model to the `core ` class [here](https://github.com/Nixtla/neuralforecast/blob/main/nbs/core.ipynb).\n",
427+
"* Add the model to the `core` class [here](https://github.com/Nixtla/neuralforecast/blob/main/neuralforecast/core.py).\n",
428428
"* Follow the CONTRIBUTING guide to create the PR to upload the model.\n"
429429
]
430430
}

nbs/docs/tutorials/comparing_methods.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1672,7 +1672,7 @@
16721672
"source": [
16731673
"This machine doesn't have GPU, but Google Colabs offers some for free. \n",
16741674
"\n",
1675-
"Using [Colab's GPU to train NeuralForecast](https://nixtla.github.io/neuralforecast/examples/intermittentdata.html).\n"
1675+
"Using [Colab's GPU to train NeuralForecast](https://nixtlaverse.nixtla.io/neuralforecast/docs/tutorials/intermittent_data.html).\n"
16761676
]
16771677
},
16781678
{
@@ -2716,7 +2716,7 @@
27162716
"id": "1394e95e-b65c-45d6-aea0-55e9e1940b60",
27172717
"metadata": {},
27182718
"source": [
2719-
"- [Available Models StatsForecast](../../../statsforecast/models.html)\n",
2719+
"- [Available Models StatsForecast](../../../statsforecast/src/core/models.html)\n",
27202720
"- [Available Models NeuralForecast]( ../capabilities/overview.html)\n",
27212721
"- [Loss Functions in NeuralForecast](../capabilities/objectives.html)\n",
27222722
"- [Getting Started NeuralForecast](../getting-started/quickstart.html)\n",

nbs/docs/tutorials/longhorizon_transformers.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -616,7 +616,7 @@
616616
"cell_type": "markdown",
617617
"metadata": {},
618618
"source": [
619-
"We proposed an alternative model for long-horizon forecasting, the `NHITS`, based on feed-forward networks in (Challu et al. 2023). It achieves on par performance with `PatchTST`, with a fraction of the computational cost. The `NHITS` tutorial is available [here](https://nixtlaverse.nixtla.io/neuralforecast/docs/tutorials/longhorizon_with_nhits.html)."
619+
"We proposed an alternative model for long-horizon forecasting, the `NHITS`, based on feed-forward networks in (Challu et al. 2023). It achieves on par performance with `PatchTST`, with a fraction of the computational cost. The `NHITS` tutorial is available [here](https://nixtlaverse.nixtla.io/neuralforecast/docs/tutorials/longhorizon_nhits.html)."
620620
]
621621
},
622622
{

0 commit comments

Comments
 (0)