Skip to main content

​
module neuralforecast.models.tide

​
class MLPResidual

MLPResidual

​
method __init__

__init__(input_dim, hidden_size, output_dim, dropout, layernorm)

​
method forward

forward(input)

​
class TiDE

TiDE Time-series Dense Encoder (TiDE) is a MLP-based univariate time-series forecasting model. TiDE uses Multi-layer Perceptrons (MLPs) in an encoder-decoder model for long-term time-series forecasting. Args:
  • h (int): forecast horizon.
  • input_size (int): considered autorregresive inputs (lags), y=[1,2,3,4] input_size=2 -> lags=[1,2].
  • hidden_size (int): number of units for the dense MLPs.
  • decoder_output_dim (int): number of units for the output of the decoder.
  • temporal_decoder_dim (int): number of units for the hidden sizeof the temporal decoder.
  • dropout (float): dropout rate between (0, 1) .
  • layernorm (bool): if True uses Layer Normalization on the MLP residual block outputs.
  • num_encoder_layers (int): number of encoder layers.
  • num_decoder_layers (int): number of decoder layers.
  • temporal_width (int): lower temporal projected dimension.
  • futr_exog_list (str list): future exogenous columns.
  • hist_exog_list (str list): historic exogenous columns.
  • stat_exog_list (str list): static exogenous columns.
  • exclude_insample_y (bool): whether to exclude the target variable from the historic exogenous data.
  • loss (PyTorch module): instantiated train loss class from losses collection.
  • valid_loss (PyTorch module): instantiated valid loss class from losses collection.
  • max_steps (int): maximum number of training steps.
  • learning_rate (float): Learning rate between (0, 1).
  • num_lr_decays (int): Number of learning rate decays, evenly distributed across max_steps.
  • early_stop_patience_steps (int): Number of validation iterations before early stopping.
  • val_check_steps (int): Number of training steps between every validation loss check.
  • batch_size (int): number of different series in each batch.
  • valid_batch_size (int): number of different series in each validation and test batch.
  • windows_batch_size (int): number of windows to sample in each training batch, default uses all.
  • inference_windows_batch_size (int): number of windows to sample in each inference batch, -1 uses all.
  • start_padding_enabled (bool): if True, the model will pad the time series with zeros at the beginning, by input size.
  • training_data_availability_threshold (Union[float, List[float]]): minimum fraction of valid data points required for training windows. Single float applies to both insample and outsample; list of two floats specifies [insample_fraction, outsample_fraction]. Default 0.0 allows windows with only 1 valid data point (current behavior).
  • step_size (int): step size between each window of temporal data.
  • scaler_type (str): type of scaler for temporal inputs normalization see temporal scalers.
  • random_seed (int): random_seed for pytorch initializer and numpy generators.
  • drop_last_loader (bool): if True TimeSeriesDataLoader drops last non-full batch.
  • alias (str): optional, Custom name of the model.
  • optimizer (Subclass of ‘torch.optim.Optimizer’): optional, user specified optimizer instead of the default choice (Adam).
  • optimizer_kwargs (dict): optional, list of parameters used by the user specified optimizer.
  • lr_scheduler (Subclass of ‘torch.optim.lr_scheduler.LRScheduler’): optional, user specified lr_scheduler instead of the default choice (StepLR).
  • lr_scheduler_kwargs (dict): optional, list of parameters used by the user specified lr_scheduler.
  • dataloader_kwargs (dict): optional, list of parameters passed into the PyTorch Lightning dataloader by the TimeSeriesDataLoader.
  • **trainer_kwargs (int): keyword trainer arguments inherited from PyTorch Lighning’s trainer.
References:

​
method __init__

__init__(
    h,
    input_size,
    hidden_size=512,
    decoder_output_dim=32,
    temporal_decoder_dim=128,
    dropout=0.3,
    layernorm=True,
    num_encoder_layers=1,
    num_decoder_layers=1,
    temporal_width=4,
    futr_exog_list=None,
    hist_exog_list=None,
    stat_exog_list=None,
    exclude_insample_y=False,
    loss=MAE(),
    valid_loss=None,
    max_steps: int = 1000,
    learning_rate: float = 0.001,
    num_lr_decays: int = -1,
    early_stop_patience_steps: int = -1,
    val_check_steps: int = 100,
    batch_size: int = 32,
    valid_batch_size: Optional[int] = None,
    windows_batch_size=1024,
    inference_windows_batch_size=1024,
    start_padding_enabled=False,
    training_data_availability_threshold=0.0,
    step_size: int = 1,
    scaler_type: str = 'identity',
    random_seed: int = 1,
    drop_last_loader: bool = False,
    alias: Optional[str] = None,
    optimizer=None,
    optimizer_kwargs=None,
    lr_scheduler=None,
    lr_scheduler_kwargs=None,
    dataloader_kwargs=None,
    **trainer_kwargs
)

​
property automatic_optimization

If set to False you are responsible for calling .backward(), .step(), .zero_grad().

​
property current_epoch

The current epoch in the Trainer, or 0 if not attached.

​
property device

​
property device_mesh

Strategies like ModelParallelStrategy will create a device mesh that can be accessed in the :meth:~pytorch_lightning.core.hooks.ModelHooks.configure_model hook to parallelize the LightningModule.

​
property dtype

​
property example_input_array

The example input array is a specification of what the module can consume in the :meth:forward method. The return type is interpreted as follows:
  • Single tensor: It is assumed the model takes a single argument, i.e., model.forward(model.example_input_array)
  • Tuple: The input array should be interpreted as a sequence of positional arguments, i.e., model.forward(*model.example_input_array)
  • Dict: The input array represents named keyword arguments, i.e., model.forward(**model.example_input_array)

​
property fabric

​
property global_rank

The index of the current process across all nodes and devices.

​
property global_step

Total training batches seen across all epochs. If no Trainer is attached, this property is 0.

​
property hparams

The collection of hyperparameters saved with :meth:save_hyperparameters. It is mutable by the user. For the frozen set of initial hyperparameters, use :attr:hparams_initial. Returns: Mutable hyperparameters dictionary

​
property hparams_initial

The collection of hyperparameters saved with :meth:save_hyperparameters. These contents are read-only. Manual updates to the saved hyperparameters can instead be performed through :attr:hparams. Returns:
  • AttributeDict: immutable initial hyperparameters

​
property local_rank

The index of the current process within a single node.

​
property logger

Reference to the logger object in the Trainer.

​
property loggers

Reference to the list of loggers in the Trainer.

​
property on_gpu

Returns True if this model is currently located on a GPU. Useful to set flags around the LightningModule for different CPU vs GPU behavior.

​
property strict_loading

Determines how Lightning loads this model using .load_state_dict(..., strict=model.strict_loading).

​
property trainer

​
method forward

forward(windows_batch)