Network Utilities#

Classes#

class UtilityMixin[source]#

Bases: object

Mixin class providing utility functions for architecture classes.

static init_optimiser(parameters, **kwargs)[source]#

Sets the optimiser for the architecture, by default AdamW.

Parameters:
parametersParamsT

Architecture parameters to optimise

**kwargs

Optional keyword arguments to pass to the optimiser

Returns:
Optimizer

Architecture optimiser

static init_scheduler(optimiser, **kwargs)[source]#

Initialise the scheduler for the architecture, by default ReduceLROnPlateau.

Parameters:
optimiserOptimizer

Architecture optimiser

**kwargs

Optional keyword arguments to pass to the scheduler

Returns:
LRScheduler

Optimiser scheduler

static set_optimiser(parameters, **kwargs)[source]#

Deprecated alias of init_optimiser().

Deprecated since version 3.11.0: Use init_optimiser() instead.

static set_scheduler(optimiser, **kwargs)[source]#

Deprecated alias of init_scheduler().

Deprecated since version 3.11.0: Use init_scheduler() instead.