ls_mlkit.pipeline.callback module

class ls_mlkit.pipeline.callback.BaseCallback

Bases: object

abstractmethod on_event(event: CallbackEvent, *args, **kwargs)

On event

Parameters:

• event (CallbackEvent) – the event to trigger

• *args – the arguments to pass to the callback

• **kwargs – the keyword arguments to pass to the callback

class ls_mlkit.pipeline.callback.CallbackEvent(*values)

Bases: Enum

EPOCH_END = 'epoch_end'

EPOCH_START = 'epoch_start'

POST_BACKWARD = 'post_backward'

POST_COMPUTE_LOSS = 'post_compute_loss'

POST_EVAL = 'post_eval'

POST_EVAL_STEP = 'post_eval_step'

POST_LOAD = 'post_load'

POST_OPTIMIZER_STEP = 'post_optimizer_step'

POST_SAVE = 'post_save'

PRE_BACKWARD = 'pre_backward'

PRE_COMPUTE_LOSS = 'pre_compute_loss'

PRE_EVAL = 'pre_eval'

PRE_EVAL_STEP = 'pre_eval_step'

PRE_LOAD = 'pre_load'

PRE_OPTIMIZER_STEP = 'pre_optimizer_step'

PRE_SAVE = 'pre_save'

STEP_END = 'step_end'

STEP_START = 'step_start'

TRAINING_END = 'training_end'

TRAINING_START = 'training_start'

class ls_mlkit.pipeline.callback.CallbackManager

Bases: object

add_callback(callback: BaseCallback)

Add a callback

Parameters:

callback (BaseCallback) – the callback to add

add_callbacks(callbacks: List[BaseCallback])

Add a list of callbacks

Parameters:

callbacks (List[BaseCallback]) – the callbacks to add

callbacks: List[BaseCallback]

trigger(event: CallbackEvent, *args, **kwargs)

Trigger all callbacks for a given event

Parameters:

• event (CallbackEvent) – the event to trigger

• *args – the arguments to pass to the callback

• **kwargs – the keyword arguments to pass to the callback