ConvTranRegressorTorch

class ConvTranRegressorTorch(net_type: str = 'C-T', activation: str | None | Callable = None, activation_hidden: str | None | Callable = 'relu', emb_size: int = 16, dim_ff: int = 256, num_heads: int = 8, dropout: float = 0.01, use_abs_pos_encoding: bool = True, use_rel_pos_encoding: bool = True, abs_pos_encoding_scheme: str | None = 'tAPE', rel_pos_encoding_scheme: str | None = 'erpe', num_epochs: int = 100, batch_size: int = 1, optimizer: str | None | Callable = 'RMSprop', criterion: str | None | Callable = 'MSELoss', callbacks: None | str | tuple[str, ...] = 'ReduceLROnPlateau', optimizer_kwargs: dict | None = None, criterion_kwargs: dict | None = None, callback_kwargs: dict | None = None, lr: float = 0.001, verbose: bool = False, random_state: int = 0)[source]

ConvTran regressor in PyTorch.

Parameters:

net_typestr, default=”C-T”

Network type to use. Should be one of “T” (Transformer), “C-T” (ConvTran) or “C-CT” (Causal ConvTran).

activationstr, Callable, or None, default=None

Activation applied to the output layer.

Permitted values:

None: no activation is applied to the output layer and the network returns raw outputs.
str: name of a class in torch.nn. Case-sensitive names are recommended and must match PyTorch (e.g., "ReLU", "LeakyReLU"). Lowercase aliases for common activations are also accepted (e.g., "relu" is resolved to "ReLU"). The class is instantiated with default constructor arguments. Must be a valid torch.nn activation; see https://pytorch.org/docs/stable/nn.html#non-linear-activations-weighted-sum-nonlinearity
torch.nn.Module: an instance of a torch.nn.Module subclass, for example torch.nn.ReLU(). Arbitrary callables are not supported.

activation_hiddenstr, Callable, or None, default=”relu”

Activation applied to the hidden layers.

Permitted values:

None: no activation is applied to the hidden layers.
str: name of a class in torch.nn. Case-sensitive names are recommended and must match PyTorch (e.g., "ReLU", "LeakyReLU"). Lowercase aliases for common activations are also accepted (e.g., "relu" is resolved to "ReLU"). The class is instantiated with default constructor arguments. Must be a valid torch.nn activation; see https://pytorch.org/docs/stable/nn.html#non-linear-activations-weighted-sum-nonlinearity
torch.nn.Module: an instance of a torch.nn.Module subclass, for example torch.nn.ReLU(). Arbitrary callables are not supported.

emb_sizeint, default=16

Embedding dimension used in attention and feed-forward blocks.

dim_ffint, default=256

Hidden dimension of the feed-forward block.

num_headsint, default=8

Number of attention heads.

dropoutfloat, default=0.01

Dropout rate applied in attention and feed-forward blocks.

use_abs_pos_encodingbool, default=True

Whether to apply absolute positional encoding.

use_rel_pos_encodingbool, default=True

Whether to apply relative positional encoding.

abs_pos_encoding_schemestr or None, default=”tAPE”

Absolute positional encoding scheme. Supported values: “tAPE”, “sin”, “learn”, or None.

rel_pos_encoding_schemestr or None, default=”erpe”

Relative positional encoding scheme. Supported values: “erpe”, “vector”, or None.

num_epochsint, default = 100

The number of epochs to train the model.

batch_sizeint, default = 1

The size of each mini-batch during training.

optimizerstr or None or an instance of optimizers

defined in torch.optim, default = “RMSprop” The optimizer to use for training the model. List of available optimizers: https://pytorch.org/docs/stable/optim.html#algorithms

criterioncase insensitive str or None or an instance of a loss function

defined in PyTorch, default = “MSELoss” The loss function to be used in training the neural network. List of available loss functions: https://pytorch.org/docs/stable/nn.html#loss-functions

callbacksNone or str or a tuple of str, default = “ReduceLROnPlateau”

Learning rate schedulers applied during training. Currently only learning rate schedulers are supported as callbacks. If more than one scheduler is passed, they are applied sequentially in the order they are passed. If None, then no learning rate scheduler is used. Note: Since PyTorch learning rate schedulers need to be initialized with the optimizer object, we only accept the class name (str) of the scheduler here and do not accept an instance of the scheduler. As that can lead to errors and unexpected behavior. List of available learning rate schedulers: https://pytorch.org/docs/stable/optim.html#how-to-adjust-learning-rate

optimizer_kwargsdict or None, default = None

Additional keyword arguments to pass to the optimizer.

criterion_kwargsdict or None, default = None

Additional keyword arguments to pass to the loss function.

callback_kwargsdict or None, default = None

The keyword arguments to be passed to the callbacks.

lrfloat, default = 0.001

The learning rate to use for the optimizer.

verbosebool, default = False

Whether to print progress information during training.

random_stateint, default = 0

Seed to ensure reproducibility.

Attributes:

is_fitted: Whether fit has been called.

Examples

>>> from sktime.regression.deep_learning.convtran import ConvTranRegressorTorch
>>> from sktime.datasets import load_unit_test
>>> X_train, y_train = load_unit_test(split="train")
>>> X_test, y_test = load_unit_test(split="test")
>>> reg = ConvTranRegressorTorch(num_epochs=20, batch_size=4)
>>> reg.fit(X_train, y_train)
ConvTranRegressorTorch(...)

Methods

`check_is_fitted`([method_name])	Check if the estimator has been fitted.
`clone`()	Obtain a clone of the object with same hyper-parameters and config.
`clone_tags`(estimator[, tag_names])	Clone tags from another object as dynamic override.
`create_test_instance`([parameter_set])	Construct an instance of the class, using first test parameter set.
`create_test_instances_and_names`([parameter_set])	Create list of all test instances and a list of names for them.
`fit`(X, y)	Fit time series regressor to training data.
`get_class_tag`(tag_name[, tag_value_default])	Get class tag value from class, with tag level inheritance from parents.
`get_class_tags`()	Get class tags from class, with tag level inheritance from parent classes.
`get_config`()	Get config flags for self.
`get_fitted_params`([deep])	Get fitted parameters.
`get_param_defaults`()	Get object's parameter defaults.
`get_param_names`([sort])	Get object's parameter names.
`get_params`([deep])	Get a dict of parameters values for this object.
`get_tag`(tag_name[, tag_value_default, ...])	Get tag value from instance, with tag level inheritance and overrides.
`get_tags`()	Get tags from instance, with tag level inheritance and overrides.
`get_test_params`([parameter_set])	Return testing parameter settings for the estimator.
`is_composite`()	Check if the object is composed of other BaseObjects.
`load_from_path`(serial)	Load object from file location.
`load_from_serial`(serial)	Load object from serialized memory container.
`predict`(X)	Predicts labels for sequences in X.
`reset`()	Reset the object to a clean post-init state.
`save`([path, serialization_format])	Save serialized self to bytes-like object or to (.zip) file.
`score`(X, y[, multioutput])	Scores predicted labels against ground truth labels on X.
`set_config`(**config_dict)	Set config flags to given values.
`set_params`(**params)	Set the parameters of this object.
`set_random_state`([random_state, deep, ...])	Set random_state pseudo-random seed parameters for self.
`set_tags`(**tag_dict)	Set instance level tag overrides to given values.