Callback

class composer.Callback[source]

Bases: composer.core.serializable.Serializable, abc.ABC

Base class for callbacks.

A callback is similar to an Algorithm, in that they are run on specific events. By convention, Callbacks should not modify State.

Each method name corresponds to an Event.

Subclasses of callbacks should override these methods to run in response to given Event invocations.

after_backward(state: State, logger: Logger) → None[source]

Called on the AFTER_BACKWARD event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

after_dataloader(state: State, logger: Logger) → None[source]

Called on the AFTER_DATALOADER event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

after_forward(state: State, logger: Logger) → None[source]

Called on the AFTER_FORWARD event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

after_loss(state: State, logger: Logger) → None[source]

Called on the AFTER_LOSS event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

after_train_batch(state: State, logger: Logger) → None[source]

Called on the AFTER_TRAIN_BATCH event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

batch_end(state: State, logger: Logger) → None[source]

Called on the BATCH_END event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

batch_start(state: State, logger: Logger) → None[source]

Called on the BATCH_START event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

before_backward(state: State, logger: Logger) → None[source]

Called on the BEFORE_BACKWARD event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

before_forward(state: State, logger: Logger) → None[source]

Called on the BEFORE_FORWARD event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

before_loss(state: State, logger: Logger) → None[source]

Called on the BEFORE_LOSS event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

before_train_batch(state: State, logger: Logger) → None[source]

Called on the BEFORE_TRAIN_BATCH event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

epoch_end(state: State, logger: Logger) → None[source]

Called on the EPOCH_END event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

epoch_start(state: State, logger: Logger) → None[source]

Called on the EPOCH_START event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

eval_after_forward(state: State, logger: Logger) → None[source]

Called on the EVAL_AFTER_FORWARD event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

eval_batch_end(state: State, logger: Logger) → None[source]

Called on the EVAL_BATCH_END event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

eval_batch_start(state: State, logger: Logger) → None[source]

Called on the EVAL_BATCH_START event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

eval_before_forward(state: State, logger: Logger) → None[source]

Called on the EVAL_BATCH_FORWARD event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

eval_end(state: State, logger: Logger) → None[source]

Called on the EVAL_END event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

eval_start(state: State, logger: Logger) → None[source]

Called on the EVAL_START event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

init(state: State, logger: Logger) → None[source]

Called on the INIT event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

training_end(state: State, logger: Logger) → None[source]

Called on the TRAINING_END event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.

training_start(state: State, logger: Logger) → None[source]

Called on the Event.TRAINING_START event.

Parameters

state (State) – The global state.
logger (Logger) – The logger.