topobench.optimizer package

Submodules

topobench.optimizer.base module

Abstract class for the optimizer manager class.

class topobench.optimizer.base.AbstractOptimizer

Bases: ABC

Abstract class for the optimizer manager class.

abstract configure_optimizer(model_parameters: dict)

Configure the optimizer and scheduler.

Act as a wrapper.

Parameters:

model_parametersdict

The model parameters.

topobench.optimizer.optimizer module

Optimizer class responsible of managing both optimizer and scheduler.

class topobench.optimizer.optimizer.TBOptimizer(optimizer_id, parameters, scheduler=None)

Bases: AbstractOptimizer

Optimizer class that manage both optimizer and scheduler, fully compatible with torch.optim classes.

Parameters:

optimizer_idstr

Name of the torch optimizer class to be used.

parametersdict

Parameters to be passed to the optimizer.

schedulerdict, optional

Scheduler id and parameters to be used. Default is None.

configure_optimizer(model_parameters) → dict[slice(<class 'str'>, typing.Any, None)]

Configure the optimizer and scheduler.

Act as a wrapper to provide the LightningTrainer module the required config dict when it calls TBModel’s configure_optimizers() method.

Parameters:

model_parametersdict

The model parameters.

Returns:

dict

The optimizer and scheduler configuration.

Module contents

Init file for optimizer module.

class topobench.optimizer.TBOptimizer(optimizer_id, parameters, scheduler=None)

Bases: AbstractOptimizer

Optimizer class that manage both optimizer and scheduler, fully compatible with torch.optim classes.

Parameters:

optimizer_idstr

Name of the torch optimizer class to be used.

parametersdict

Parameters to be passed to the optimizer.

schedulerdict, optional

Scheduler id and parameters to be used. Default is None.

configure_optimizer(model_parameters) → dict[slice(<class 'str'>, typing.Any, None)]

Configure the optimizer and scheduler.

Act as a wrapper to provide the LightningTrainer module the required config dict when it calls TBModel’s configure_optimizers() method.

Parameters:

model_parametersdict

The model parameters.

Returns:

dict

The optimizer and scheduler configuration.