2023-07-17 10:40:04 +00:00
---
description: Explore how to use the on-train, on-validation, on-pretrain, and on-predict callbacks in Ultralytics. Learn to update params, save models, and add integration callbacks.
keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predict, Parameters update, Model saving, Integration callbacks
---
2023-08-03 16:44:40 +00:00
# Reference for `ultralytics/utils/callbacks/base.py`
2023-11-18 20:51:47 +00:00
!!! Note
2023-08-03 16:44:40 +00:00
2023-11-12 01:49:37 +00:00
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py ](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py ). If you spot a problem please help fix it by [contributing ](https://docs.ultralytics.com/help/contributing/ ) a [Pull Request ](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/base.py ) 🛠️. Thank you 🙏!
2023-08-03 16:44:40 +00:00
2023-11-25 16:59:01 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_train_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.optimizer_step
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_model_save
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_train_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_params_update
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.teardown
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_val_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_val_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_predict_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_predict_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_export_start
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.on_export_end
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
2023-11-25 16:59:01 +00:00
2023-07-16 15:47:45 +00:00
< br > < br >
2023-08-03 16:44:40 +00:00
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
2023-11-25 16:59:01 +00:00
2023-07-23 14:03:34 +00:00
< br > < br >