PrecisionPlugin

class lightning.pytorch.plugins.precision.PrecisionPlugin

Bases: lightning.fabric.plugins.precision.precision.Precision, lightning.pytorch.core.hooks.CheckpointHooks

Base class for all plugins handling the precision-specific parts of the training.

The class attribute precision must be overwritten in child classes. The default value reflects fp32 training.

backward(tensor, model, optimizer, *args, **kwargs)

Performs the actual backpropagation.

Parameters

• tensor (Tensor) – the loss value obtained from the closure

• model (LightningModule) – the model to be optimized

• optimizer (Optional[Steppable]) – current optimizer being used. None if using manual optimization

• *args – Positional arguments intended for the actual function that performs the backward, like backward().

• **kwargs – Keyword arguments for the same purpose as *args.

Return type

None

clip_grad_by_norm(optimizer, clip_val)

Clip gradients by norm.

Return type

None

clip_grad_by_value(optimizer, clip_val)

Clip gradients by value.

Return type

None

clip_gradients(optimizer, clip_val=0.0, gradient_clip_algorithm=GradClipAlgorithmType.NORM)

Clips the gradients.

Return type

None

connect(model, optimizers, lr_schedulers)

Connects this plugin to the accelerator and the training process.

Return type

Tuple[Module, List[Optimizer], List[Any]]

optimizer_step(optimizer, model, closure, **kwargs)

Hook to run the optimizer step.

Return type

Any

post_backward(tensor, module)

Runs after precision plugin executes backward.

Parameters

• tensor (Tensor) – The tensor that will be used for backpropagation

• module (LightningModule) – The module that was involved in producing the tensor and whose parameters need the gradients

Return type

Tensor

pre_backward(tensor, module)

Runs before precision plugin executes backward.

Parameters

• tensor (Tensor) – The tensor that will be used for backpropagation

• module (LightningModule) – The module that was involved in producing the tensor and whose parameters need the gradients

Return type

Tensor

predict_step_context()

A contextmanager for the predict step.

Return type

Generator[None, None, None]

test_step_context()

A contextmanager for the test step.

Return type

Generator[None, None, None]

train_step_context()

A contextmanager for the training step.

Return type

Generator[None, None, None]

val_step_context()

A contextmanager for the validation step.

Return type

Generator[None, None, None]