clarity.engine.system module

Adopted from Asteroid https://github.com/asteroid-team/asteroid/blob/master/asteroid/engine/system.py

class clarity.engine.system.System(*args: Any, **kwargs: Any)

Bases: LightningModule

common_step(batch, batch_nb, train=True)

Common forward step between training and validation. The function of this method is to unpack the data given by the loader, forward the batch through the model and compute the loss. Pytorch-lightning handles all the rest.

Parameters:

• batch – the object returned by the loader (a list of torch.Tensor in most cases) but can be something else.

• _batch_nb (int) – The number of the batch in the epoch.

• _train (bool) – Whether in training mode. Needed only if the training and validation steps are fundamentally different, otherwise, pytorch-lightning handles the usual differences.

Returns:

The loss value on this batch.

Return type:

torch.Tensor

Note

This is typically the method to overwrite when subclassing System. If the training and validation steps are somehow different (except for loss.backward() and optimzer.step()), the argument train can be used to switch behavior. Otherwise, training_step and validation_step can be overwriten.

configure_optimizers()

Initialize optimizers, batch-wise and epoch-wise schedulers.

forward(*args, **kwargs)

Applies forward pass of the model.

Returns:

torch.Tensor

on_save_checkpoint(checkpoint)

Overwrite if you want to save more things in the checkpoint.

on_validation_epoch_end()

Log hp_metric to tensorboard for hparams selection.

train_dataloader()

Training dataloader

training_step(batch, batch_nb)

Pass data through the model and compute the loss. Backprop is not performed (meaning PL will do it for you).

Parameters:

• batch – the object returned by the loader (a list of torch.Tensor in most cases) but can be something else.

• batch_nb (int) – The number of the batch in the epoch.

Returns:

torch.Tensor, the value of the loss.

val_dataloader()

Validation dataloader

validation_step(batch, batch_nb)

Need to overwrite PL validation_step to do validation.

Parameters:

• batch – the object returned by the loader (a list of torch.Tensor in most cases) but can be something else.

• batch_nb (int) – The number of the batch in the epoch.