ls_mlkit.pipeline.callback module

class ls_mlkit.pipeline.callback.BaseCallback[source]

Bases: object

abstractmethod on_event(event: CallbackEvent, *args, **kwargs)[source]

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(value)[source]

Bases: Enum

AFTER_BACKWARD = 'after_backward'
AFTER_COMPUTE_LOSS = 'after_compute_loss'
AFTER_EVAL = 'after_eval'
AFTER_EVAL_STEP = 'after_eval_step'
AFTER_LOAD = 'after_load'
AFTER_OPTIMIZER_STEP = 'after_optimizer_step'
AFTER_SAVE = 'after_save'
BEFORE_BACKWARD = 'before_backward'
BEFORE_COMPUTE_LOSS = 'before_compute_loss'
BEFORE_EVAL = 'before_eval'
BEFORE_EVAL_STEP = 'before_eval_step'
BEFORE_LOAD = 'before_load'
BEFORE_OPTIMIZER_STEP = 'before_optimizer_step'
BEFORE_SAVE = 'before_save'
EPOCH_END = 'epoch_end'
EPOCH_START = 'epoch_start'
STEP_END = 'step_end'
STEP_START = 'step_start'
TRAINING_END = 'training_end'
TRAINING_START = 'training_start'
class ls_mlkit.pipeline.callback.CallbackManager[source]

Bases: object

add_callback(callback: BaseCallback)[source]

Add a callback

Parameters:

callback (BaseCallback) – the callback to add

add_callbacks(callbacks: List[BaseCallback])[source]

Add a list of callbacks

Parameters:

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

trigger(event: CallbackEvent, *args, **kwargs)[source]

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