Skip to content

Commit 9400a1b

Browse files
authored
[CHORE] missed fixes (#1505)
1 parent 4168c85 commit 9400a1b

9 files changed

Lines changed: 13 additions & 12 deletions

File tree

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)
14+
[`NBEATS`](./neuralforecast/models.nbeats.html#nbeats-2)
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

nbs/docs/tutorials/comparing_methods.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"\n",
3333
"We will train an assortment of models from various forecasting paradigms:\n",
3434
"\n",
35-
"*[StatsForecast]((https://github.com/Nixtla/statsforecast))*\n",
35+
"*[StatsForecast](https://github.com/Nixtla/statsforecast)*\n",
3636
"\n",
3737
"- Baseline models: These models are simple yet often highly effective for providing an initial perspective on the forecasting problem. We will use `SeasonalNaive` and `HistoricAverage` models for this category.\n",
3838
"- Intermittent models: For series with sporadic, non-continuous demand, we will utilize models like `CrostonOptimized`, `IMAPA`, and `ADIDA`. These models are particularly suited for handling zero-inflated series.\n",

nbs/docs/tutorials/forecasting_tft.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@
453453
"cell_type": "markdown",
454454
"metadata": {},
455455
"source": [
456-
"The `cross_validation` method allows you to simulate multiple historic forecasts, greatly simplifying pipelines by replacing for loops with `fit` and `predict` methods. See [this tutorial](https://nixtlaverse.nixtla.io/statsforecast/examples/getting_started_complete.html) for an animation of how the windows are defined. \n",
456+
"The `cross_validation` method allows you to simulate multiple historic forecasts, greatly simplifying pipelines by replacing for loops with `fit` and `predict` methods. See [this tutorial](https://nixtlaverse.nixtla.io/statsforecast/docs/getting-started/getting_started_complete.html) for an animation of how the windows are defined. \n",
457457
"\n",
458458
"With time series data, cross validation is done by defining a sliding window across the historical data and predicting the period following it. This form of cross validation allows us to arrive at a better estimation of our model’s predictive abilities across a wider range of temporal instances while also keeping the data in the training set contiguous as is required by our models. The `cross_validation` method will use the validation set for hyperparameter selection, and will then produce the forecasts for the test set.\n",
459459
"\n",

nbs/docs/tutorials/intermittent_data.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
"source": [
6161
"## 1. Install libraries \n",
6262
"\n",
63-
"We assume that you have NeuralForecast already installed. If not, check this guide for instructions on [how to install NeuralForecast](https://nixtlaverse.nixtla.io/neuralforecast/examples/installation.html) \n",
63+
"We assume that you have NeuralForecast already installed. If not, check this guide for instructions on [how to install NeuralForecast](https://nixtlaverse.nixtla.io/neuralforecast/docs/getting-started/installation.html) \n",
6464
"\n",
6565
"Install the necessary packages using `pip install neuralforecast`"
6666
]
@@ -135,7 +135,7 @@
135135
"cell_type": "markdown",
136136
"metadata": {},
137137
"source": [
138-
"Plot some series using the plot method from the `StatsForecast` class. This method prints 8 random series from the dataset and is useful for basic [EDA](https://nixtlaverse.nixtla.io/statsforecast/core.html#statsforecast.plot)."
138+
"Plot some series using the plot method from the `StatsForecast` class. This method prints 8 random series from the dataset and is useful for basic [EDA](https://nixtlaverse.nixtla.io/statsforecast/src/core/core.html#statsforecast.plot)."
139139
]
140140
},
141141
{

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/examples/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_with_nhits.html)."
620620
]
621621
},
622622
{

nbs/docs/tutorials/using_mlflow.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"id": "963311a3-2427-4694-981b-438fce1c2981",
2323
"metadata": {},
2424
"source": [
25-
"To install Neuralforecast refer to [Installation](../getting-started/04_installation).\n",
25+
"To install Neuralforecast refer to [Installation](../getting-started/installation.html).\n",
2626
"\n",
2727
"To install mlflow: `pip install mlflow`"
2828
]

nbs/docs/use-cases/electricity_peak_forecasting.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@
208208
"source": [
209209
"We fit the model by instantiating a `NeuralForecast` object with the following required parameters:\n",
210210
"\n",
211-
"* `models`: a list of models. Select the models you want from [models]( ../capabilities/overview.html.ipynb) and import them.\n",
211+
"* `models`: a list of models. Select the models you want from [models]( ../capabilities/overview.html) and import them.\n",
212212
"\n",
213213
"* `freq`: a string indicating the frequency of the data. (See [panda's available frequencies](https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases).)"
214214
]
@@ -231,7 +231,7 @@
231231
"cell_type": "markdown",
232232
"metadata": {},
233233
"source": [
234-
"The `cross_validation` method allows the user to simulate multiple historic forecasts, greatly simplifying pipelines by replacing for loops with `fit` and `predict` methods. This method re-trains the model and forecast each window. See [this tutorial](https://nixtlaverse.nixtla.io/statsforecast/examples/getting_started_complete.html) for an animation of how the windows are defined. \n",
234+
"The `cross_validation` method allows the user to simulate multiple historic forecasts, greatly simplifying pipelines by replacing for loops with `fit` and `predict` methods. This method re-trains the model and forecast each window. See [this tutorial](https://nixtlaverse.nixtla.io/statsforecast/docs/getting-started/getting_started_complete.html) for an animation of how the windows are defined. \n",
235235
"\n",
236236
"Use the `cross_validation` method to produce all the daily forecasts for September. To produce daily forecasts set the forecasting horizon `h` as 24. In this example we are simulating deploying the pipeline during September, so set the number of windows as 30 (one for each day). Finally, set the step size between windows as 24, to only produce one forecast per day."
237237
]

neuralforecast/models/hint.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ class HINT:
134134
135135
Args:
136136
h (int): Forecast horizon.
137-
model (NeuralForecast model): Instantiated model class from [architecture collection](./models).
137+
model (NeuralForecast model): Instantiated model class from [architecture collection](./models.html).
138138
S (np.ndarray): Dumming matrix of size (`base`, `bottom`) see HierarchicalForecast's [aggregate method](../hierarchicalforecast/utils.html#aggregate).
139139
reconciliation (str): HINT's reconciliation method from ['BottomUp', 'MinTraceOLS', 'MinTraceWLS'].
140140
alias (str, optional): Custom name of the model.
@@ -206,7 +206,7 @@ def fit(
206206
cross-learning the hierachy's series scales.
207207
208208
Args:
209-
dataset (TimeSeriesDataset): NeuralForecast's `TimeSeriesDataset` see details [here](./tsdataset)
209+
dataset (TimeSeriesDataset): NeuralForecast's `TimeSeriesDataset` see details [here](./tsdataset.html)
210210
val_size (int): size of the validation set, (default 0).
211211
test_size (int): size of the test set, (default 0).
212212
random_seed (int): random seed for the prediction.
@@ -236,7 +236,7 @@ def predict(self, dataset, step_size=1, random_seed=None, **data_module_kwargs):
236236
bootstrapped sample reconciliation.
237237
238238
Args:
239-
dataset (TimeSeriesDataset): NeuralForecast's `TimeSeriesDataset` see details [here](./tsdataset)
239+
dataset (TimeSeriesDataset): NeuralForecast's `TimeSeriesDataset` see details [here](./tsdataset.html)
240240
step_size (int): steps between sequential predictions, (default 1).
241241
random_seed (int): random seed for the prediction.
242242
**data_kwarg: additional parameters for the dataset module.

neuralforecast/models/timemixer.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ def forward(self, x_list):
252252

253253
class TimeMixer(BaseModel):
254254
"""TimeMixer
255+
255256
Args:
256257
h (int): Forecast horizon.
257258
input_size (int): autorregresive inputs size, y=[1,2,3,4] input_size=2 -> y_[t-2:t]=[1,2].

0 commit comments

Comments
 (0)