Reference for ultralytics/utils/callbacks/base.py
Note
This file is available at https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
ultralytics.utils.callbacks.base.on_pretrain_routine_start
ultralytics.utils.callbacks.base.on_pretrain_routine_end
ultralytics.utils.callbacks.base.on_train_start
ultralytics.utils.callbacks.base.on_train_epoch_start
ultralytics.utils.callbacks.base.on_train_batch_start
ultralytics.utils.callbacks.base.optimizer_step
ultralytics.utils.callbacks.base.on_before_zero_grad
ultralytics.utils.callbacks.base.on_train_batch_end
ultralytics.utils.callbacks.base.on_train_epoch_end
ultralytics.utils.callbacks.base.on_fit_epoch_end
ultralytics.utils.callbacks.base.on_model_save
ultralytics.utils.callbacks.base.on_train_end
ultralytics.utils.callbacks.base.on_params_update
ultralytics.utils.callbacks.base.teardown
ultralytics.utils.callbacks.base.on_val_start
ultralytics.utils.callbacks.base.on_val_batch_start
ultralytics.utils.callbacks.base.on_val_batch_end
ultralytics.utils.callbacks.base.on_val_end
ultralytics.utils.callbacks.base.on_predict_start
ultralytics.utils.callbacks.base.on_predict_batch_start
ultralytics.utils.callbacks.base.on_predict_batch_end
ultralytics.utils.callbacks.base.on_predict_postprocess_end
ultralytics.utils.callbacks.base.on_predict_end
ultralytics.utils.callbacks.base.on_export_start
ultralytics.utils.callbacks.base.on_export_end
ultralytics.utils.callbacks.base.get_default_callbacks
Get the default callbacks for Ultralytics training, validation, prediction, and export processes.
Returns:
Type | Description |
---|---|
dict
|
Dictionary of default callbacks for various training events. Each key in the dictionary represents an event during the training process, and the corresponding value is a list of callback functions that are executed when that event occurs. |
Examples:
>>> callbacks = get_default_callbacks()
>>> print(list(callbacks.keys())) # show all available callback events
['on_pretrain_routine_start', 'on_pretrain_routine_end', ...]
Source code in ultralytics/utils/callbacks/base.py
ultralytics.utils.callbacks.base.add_integration_callbacks
Add integration callbacks to the instance's callbacks dictionary.
This function loads and adds various integration callbacks to the provided instance. The specific callbacks added depend on the type of instance provided. All instances receive HUB callbacks, while Trainer instances also receive additional callbacks for various integrations like ClearML, Comet, DVC, MLflow, Neptune, Ray Tune, TensorBoard, and Weights & Biases.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
instance
|
Trainer | Predictor | Validator | Exporter
|
The object instance to which callbacks will be added. The type of instance determines which callbacks are loaded. |
required |
Examples:
>>> from ultralytics.engine.trainer import BaseTrainer
>>> trainer = BaseTrainer()
>>> add_integration_callbacks(trainer)