ml.optimizers.base

Defines the base optimizer adapter.

This class usually just wraps PyTorch optimizers, providing some common hyperparameter configurations.

class ml.optimizers.base.BaseOptimizerConfig(name: str = '???')[source]

Bases: BaseConfig

Defines the base config for all optimizers.

class ml.optimizers.base.BaseOptimizer(config: BaseConfigT)[source]

Bases: BaseObject[OptimizerConfigT], Generic[OptimizerConfigT, OptimizerT], ABC

Defines the base optimizer type.

property common_kwargs: dict[str, Any]
abstract get(model: Module) → OptimizerT[source]

Given a base module, returns an optimizer.

Parameters:

model – The model to get an optimizer for

Returns:

The constructed optimizer