florist.api.clients.optimizers module

Definitions for the optimizers that can be used.

class Optimizer(value)

Bases: Enum

Enumeration of pre-defined optimizers.

ADAM_W = 'AdamW'

SGD = 'SGD'

classmethod get(optimizer, model_parameters)

Return an instance for the given optimizer with model parameters.

Parameters:

• optimizer (Self) – (Optimizer) The optimizer type to get and instance of.

• model_parameters (Iterator[Parameter]) – (Iterator[torch.nn.parameter.Parameter]) The parameters of the model that will be set to the optimizer.

Return type:

Optimizer

Returns:

(torch.optim.Optimizer) An instance of the optimizer.

classmethod list()

List all the supported optimizers.

Return type:

list[str]

Returns:

(list[str]) a list of supported optimizers.