Update prediction Results docs (#4139)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher
2023-08-03 18:44:40 +02:00
committed by GitHub
parent 8870084645
commit 11d0488bf1
107 changed files with 1451 additions and 1317 deletions

View File

@ -3,137 +3,116 @@ description: Explore how to use the on-train, on-validation, on-pretrain, and on
keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predict, Parameters update, Model saving, Integration callbacks
---
## on_pretrain_routine_start
# Reference for `ultralytics/utils/callbacks/base.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
## on_pretrain_routine_end
---
### ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
## on_train_start
---
### ::: ultralytics.utils.callbacks.base.on_train_start
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
## on_train_epoch_start
---
### ::: ultralytics.utils.callbacks.base.on_train_epoch_start
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
## on_train_batch_start
---
### ::: ultralytics.utils.callbacks.base.on_train_batch_start
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
## optimizer_step
---
### ::: ultralytics.utils.callbacks.base.optimizer_step
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
## on_before_zero_grad
---
### ::: ultralytics.utils.callbacks.base.on_before_zero_grad
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
## on_train_batch_end
---
### ::: ultralytics.utils.callbacks.base.on_train_batch_end
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
## on_train_epoch_end
---
### ::: ultralytics.utils.callbacks.base.on_train_epoch_end
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
## on_model_save
---
### ::: ultralytics.utils.callbacks.base.on_model_save
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.base.on_train_end
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
## on_params_update
---
### ::: ultralytics.utils.callbacks.base.on_params_update
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
## teardown
---
### ::: ultralytics.utils.callbacks.base.teardown
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
## on_val_start
---
### ::: ultralytics.utils.callbacks.base.on_val_start
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
## on_val_batch_start
---
### ::: ultralytics.utils.callbacks.base.on_val_batch_start
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
## on_val_batch_end
---
### ::: ultralytics.utils.callbacks.base.on_val_batch_end
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
## on_val_end
---
### ::: ultralytics.utils.callbacks.base.on_val_end
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
## on_predict_start
---
### ::: ultralytics.utils.callbacks.base.on_predict_start
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
## on_predict_batch_start
---
### ::: ultralytics.utils.callbacks.base.on_predict_batch_start
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
## on_predict_batch_end
---
### ::: ultralytics.utils.callbacks.base.on_predict_batch_end
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
## on_predict_postprocess_end
---
### ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
## on_predict_end
---
### ::: ultralytics.utils.callbacks.base.on_predict_end
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
## on_export_start
---
### ::: ultralytics.utils.callbacks.base.on_export_start
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
## on_export_end
---
### ::: ultralytics.utils.callbacks.base.on_export_end
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
## get_default_callbacks
---
### ::: ultralytics.utils.callbacks.base.get_default_callbacks
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
## add_integration_callbacks
---
### ::: ultralytics.utils.callbacks.base.add_integration_callbacks
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

View File

@ -3,37 +3,36 @@ description: Uncover the specifics of Ultralytics ClearML callbacks, from pretra
keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation end, train epoch end, training end
---
## _log_debug_samples
# Reference for `ultralytics/utils/callbacks/clearml.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.clearml._log_debug_samples
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
## _log_plot
---
### ::: ultralytics.utils.callbacks.clearml._log_plot
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
## on_pretrain_routine_start
---
### ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
## on_train_epoch_end
---
### ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
## on_val_end
---
### ::: ultralytics.utils.callbacks.clearml.on_val_end
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.clearml.on_train_end
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

View File

@ -3,122 +3,104 @@ description: Explore comprehensive documentation for utilising Comet Callbacks i
keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experiment Workflows
---
## _get_comet_mode
# Reference for `ultralytics/utils/callbacks/comet.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.comet._get_comet_mode
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
## _get_comet_model_name
---
### ::: ultralytics.utils.callbacks.comet._get_comet_model_name
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
## _get_eval_batch_logging_interval
---
### ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
## _get_max_image_predictions_to_log
---
### ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
## _scale_confidence_score
---
### ::: ultralytics.utils.callbacks.comet._scale_confidence_score
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
## _should_log_confusion_matrix
---
### ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
## _should_log_image_predictions
---
### ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
## _get_experiment_type
---
### ::: ultralytics.utils.callbacks.comet._get_experiment_type
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
## _create_experiment
---
### ::: ultralytics.utils.callbacks.comet._create_experiment
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
## _fetch_trainer_metadata
---
### ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
## _scale_bounding_box_to_original_image_shape
---
### ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
## _format_ground_truth_annotations_for_detection
---
### ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
## _format_prediction_annotations_for_detection
---
### ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
## _fetch_annotations
---
### ::: ultralytics.utils.callbacks.comet._fetch_annotations
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
## _create_prediction_metadata_map
---
### ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
## _log_confusion_matrix
---
### ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
## _log_images
---
### ::: ultralytics.utils.callbacks.comet._log_images
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
## _log_image_predictions
---
### ::: ultralytics.utils.callbacks.comet._log_image_predictions
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
## _log_plots
---
### ::: ultralytics.utils.callbacks.comet._log_plots
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
## _log_model
---
### ::: ultralytics.utils.callbacks.comet._log_model
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
## on_pretrain_routine_start
---
### ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
## on_train_epoch_end
---
### ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.comet.on_train_end
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

View File

@ -3,52 +3,48 @@ description: Browse through Ultralytics YOLO docs to learn about important loggi
keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine learning, models
---
## _logger_disabled
# Reference for `ultralytics/utils/callbacks/dvc.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.dvc._logger_disabled
## ::: ultralytics.utils.callbacks.dvc._logger_disabled
<br><br>
## _log_images
---
### ::: ultralytics.utils.callbacks.dvc._log_images
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
## _log_plots
---
### ::: ultralytics.utils.callbacks.dvc._log_plots
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
## _log_confusion_matrix
---
### ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
## on_pretrain_routine_start
---
### ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
## on_pretrain_routine_end
---
### ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
## on_train_start
---
### ::: ultralytics.utils.callbacks.dvc.on_train_start
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
## on_train_epoch_start
---
### ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.dvc.on_train_end
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

View File

@ -3,42 +3,40 @@ description: Explore the detailed information on key Ultralytics callbacks such
keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_train_start, on_predict_start, hub, training
---
## on_pretrain_routine_end
# Reference for `ultralytics/utils/callbacks/hub.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
## on_model_save
---
### ::: ultralytics.utils.callbacks.hub.on_model_save
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.hub.on_train_end
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
## on_train_start
---
### ::: ultralytics.utils.callbacks.hub.on_train_start
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
## on_val_start
---
### ::: ultralytics.utils.callbacks.hub.on_val_start
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
## on_predict_start
---
### ::: ultralytics.utils.callbacks.hub.on_predict_start
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
## on_export_start
---
### ::: ultralytics.utils.callbacks.hub.on_export_start
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

View File

@ -3,17 +3,20 @@ description: Understand routines at the end of pre-training and training in Ultr
keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end, Machine Learning, Training
---
## on_pretrain_routine_end
# Reference for `ultralytics/utils/callbacks/mlflow.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.mlflow.on_train_end
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

View File

@ -3,42 +3,40 @@ description: Explore exhaustive details about Ultralytics callbacks in Neptune,
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
---
## _log_scalars
# Reference for `ultralytics/utils/callbacks/neptune.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.neptune._log_scalars
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
## _log_images
---
### ::: ultralytics.utils.callbacks.neptune._log_images
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
## _log_plot
---
### ::: ultralytics.utils.callbacks.neptune._log_plot
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
## on_pretrain_routine_start
---
### ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
## on_train_epoch_end
---
### ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
## on_val_end
---
### ::: ultralytics.utils.callbacks.neptune.on_val_end
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.neptune.on_train_end
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

View File

@ -3,7 +3,12 @@ description: Discover the functionality of the on_fit_epoch_end callback in the
keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep learning, YOLO framework
---
## on_fit_epoch_end
# Reference for `ultralytics/utils/callbacks/raytune.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

View File

@ -3,22 +3,24 @@ description: Explore Ultralytics YOLO Docs for a deep understanding of log_scala
keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_batch_end, tensorboard
---
## _log_scalars
# Reference for `ultralytics/utils/callbacks/tensorboard.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.tensorboard._log_scalars
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
## on_pretrain_routine_start
---
### ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
## on_batch_end
---
### ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
## ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

View File

@ -3,27 +3,28 @@ description: Deep dive into Ultralytics callbacks. Learn how to use the _log_plo
keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end
---
## _log_plots
# Reference for `ultralytics/utils/callbacks/wb.py`
!!! note
Full source code for 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).
---
### ::: ultralytics.utils.callbacks.wb._log_plots
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
## on_pretrain_routine_start
---
### ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
## on_fit_epoch_end
---
### ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
## on_train_epoch_end
---
### ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
## on_train_end
---
### ::: ultralytics.utils.callbacks.wb.on_train_end
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>