This commit is contained in:
lee
2025-06-18 14:35:43 +08:00
commit e474ab5f9f
529 changed files with 80523 additions and 0 deletions

View File

@ -0,0 +1,120 @@
---
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
---
# 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](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 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

View File

@ -0,0 +1,40 @@
---
description: Uncover the specifics of Ultralytics ClearML callbacks, from pretrain routine start to training end. Boost your ML model performance.
keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation end, train epoch end, training end
---
# Reference for `ultralytics/utils/callbacks/clearml.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.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/clearml.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

View File

@ -0,0 +1,108 @@
---
description: Explore comprehensive documentation for utilising Comet Callbacks in Ultralytics. Learn to optimise training, logging, and experiment workflows.
keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experiment Workflows
---
# Reference for `ultralytics/utils/callbacks/comet.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.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/comet.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

View File

@ -0,0 +1,48 @@
---
description: Browse through Ultralytics YOLO docs to learn about important logging and callback functions used in training and pretraining models.
keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine learning, models
---
# Reference for `ultralytics/utils/callbacks/dvc.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.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/dvc.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

View File

@ -0,0 +1,44 @@
---
description: Explore the detailed information on key Ultralytics callbacks such as on_pretrain_routine_end, on_model_save, on_train_start, and on_predict_start.
keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_train_start, on_predict_start, hub, training
---
# Reference for `ultralytics/utils/callbacks/hub.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.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/hub.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

View File

@ -0,0 +1,28 @@
---
description: Understand routines at the end of pre-training and training in Ultralytics. Elevate your MLflow callbacks expertise.
keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end, Machine Learning, Training
---
# Reference for `ultralytics/utils/callbacks/mlflow.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.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/mlflow.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

View File

@ -0,0 +1,44 @@
---
description: Explore exhaustive details about Ultralytics callbacks in Neptune, with specifics about scalar logging, routine start, and more.
keywords: Ultralytics, Neptune callbacks, on_train_epoch_end, on_val_end, _log_plot, _log_images, on_pretrain_routine_start, on_fit_epoch_end, on_train_end
---
# Reference for `ultralytics/utils/callbacks/neptune.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.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/neptune.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

View File

@ -0,0 +1,16 @@
---
description: Discover the functionality of the on_fit_epoch_end callback in the Ultralytics YOLO framework. Learn how to end an epoch in your deep learning projects.
keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep learning, YOLO framework
---
# Reference for `ultralytics/utils/callbacks/raytune.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.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/raytune.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

View File

@ -0,0 +1,36 @@
---
description: Explore Ultralytics YOLO Docs for a deep understanding of log_scalars, on_batch_end & other callback utilities embedded in the tensorboard module.
keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_batch_end, tensorboard
---
# Reference for `ultralytics/utils/callbacks/tensorboard.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.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/tensorboard.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

View File

@ -0,0 +1,40 @@
---
description: Deep dive into Ultralytics callbacks. Learn how to use the _log_plots, on_fit_epoch_end, and on_train_end functions effectively.
keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end
---
# Reference for `ultralytics/utils/callbacks/wb.py`
!!! Note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.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/wb.py) 🛠️. Thank you 🙏!
<br><br>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>