All Catalyst custom types are defined in this module.


alias of torch.nn.modules.module.Module


alias of torch.nn.modules.module.Module

class catalyst.typing.Optimizer(params, defaults)[source]

Bases: object

Base class for all optimizers.


Parameters need to be specified as collections that have a deterministic ordering that is consistent between runs. Examples of objects that don’t satisfy those properties are sets and iterators over values of dictionaries.

  • params (iterable) – an iterable of torch.Tensor s or dict s. Specifies what Tensors should be optimized.

  • defaults – (dict): a dict containing default values of optimization options (used when a parameter group doesn’t specify them).


Add a param group to the Optimizer s param_groups.

This can be useful when fine tuning a pre-trained network as frozen layers can be made trainable and added to the Optimizer as training progresses.

  • param_group (dict) – Specifies what Tensors should be optimized along with group

  • optimization options. (specific) –


Loads the optimizer state.


state_dict (dict) – optimizer state. Should be an object returned from a call to state_dict().


Returns the state of the optimizer as a dict.

It contains two entries:

  • state - a dict holding current optimization state. Its content

    differs between optimizer classes.

  • param_groups - a dict containing all parameter groups


Performs a single optimization step (parameter update).


closure (callable) – A closure that reevaluates the model and returns the loss. Optional for most optimizers.


Unless otherwise specified, this function should not modify the .grad field of the parameters.

zero_grad(set_to_none: bool = False)[source]

Sets the gradients of all optimized torch.Tensor s to zero.


set_to_none (bool) – instead of setting to zero, set the grads to None. This is will in general have lower memory footprint, and can modestly improve performance. However, it changes certain behaviors. For example: 1. When the user tries to access a gradient and perform manual ops on it, a None attribute or a Tensor full of 0s will behave differently. 2. If the user requests zero_grad(set_to_none=True) followed by a backward pass, .grads are guaranteed to be None for params that did not receive a gradient. 3. torch.optim optimizers have a different behavior if the gradient is 0 or None (in one case it does the step with a gradient of 0 and in the other it skips the step altogether).


alias of torch.optim.lr_scheduler._LRScheduler

class catalyst.typing.Dataset[source]

Bases: typing.Generic

An abstract class representing a Dataset.

All datasets that represent a map from keys to data samples should subclass it. All subclasses should overwrite __getitem__(), supporting fetching a data sample for a given key. Subclasses could also optionally overwrite __len__(), which is expected to return the size of the dataset by many Sampler implementations and the default options of DataLoader.


DataLoader by default constructs a index sampler that yields integral indices. To make it work with a map-style dataset with non-integral indices/keys, a custom sampler must be provided.