Docstrings arguments cleanup (#3229)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher
2023-06-17 16:17:07 +02:00
committed by GitHub
parent 62916b3b0a
commit bd0f7ecf6f
93 changed files with 1104 additions and 1102 deletions

View File

@ -3,137 +3,137 @@ description: Learn about YOLO's callback functions from on_train_start to add_in
keywords: YOLO, Ultralytics, callbacks, object detection, training, inference
---
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_start
<br><br>
# on_pretrain_routine_end
## on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_end
### ::: ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_end
<br><br>
# on_train_start
## on_train_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_start
### ::: ultralytics.yolo.utils.callbacks.base.on_train_start
<br><br>
# on_train_epoch_start
## on_train_epoch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_epoch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_train_epoch_start
<br><br>
# on_train_batch_start
## on_train_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_batch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_train_batch_start
<br><br>
# optimizer_step
## optimizer_step
---
:::ultralytics.yolo.utils.callbacks.base.optimizer_step
### ::: ultralytics.yolo.utils.callbacks.base.optimizer_step
<br><br>
# on_before_zero_grad
## on_before_zero_grad
---
:::ultralytics.yolo.utils.callbacks.base.on_before_zero_grad
### ::: ultralytics.yolo.utils.callbacks.base.on_before_zero_grad
<br><br>
# on_train_batch_end
## on_train_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_batch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_train_batch_end
<br><br>
# on_train_epoch_end
## on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_epoch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_train_epoch_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_fit_epoch_end
<br><br>
# on_model_save
## on_model_save
---
:::ultralytics.yolo.utils.callbacks.base.on_model_save
### ::: ultralytics.yolo.utils.callbacks.base.on_model_save
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_end
### ::: ultralytics.yolo.utils.callbacks.base.on_train_end
<br><br>
# on_params_update
## on_params_update
---
:::ultralytics.yolo.utils.callbacks.base.on_params_update
### ::: ultralytics.yolo.utils.callbacks.base.on_params_update
<br><br>
# teardown
## teardown
---
:::ultralytics.yolo.utils.callbacks.base.teardown
### ::: ultralytics.yolo.utils.callbacks.base.teardown
<br><br>
# on_val_start
## on_val_start
---
:::ultralytics.yolo.utils.callbacks.base.on_val_start
### ::: ultralytics.yolo.utils.callbacks.base.on_val_start
<br><br>
# on_val_batch_start
## on_val_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_val_batch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_val_batch_start
<br><br>
# on_val_batch_end
## on_val_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_val_batch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_val_batch_end
<br><br>
# on_val_end
## on_val_end
---
:::ultralytics.yolo.utils.callbacks.base.on_val_end
### ::: ultralytics.yolo.utils.callbacks.base.on_val_end
<br><br>
# on_predict_start
## on_predict_start
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_start
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_start
<br><br>
# on_predict_batch_start
## on_predict_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_batch_start
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_batch_start
<br><br>
# on_predict_batch_end
## on_predict_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_batch_end
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_batch_end
<br><br>
# on_predict_postprocess_end
## on_predict_postprocess_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_postprocess_end
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_postprocess_end
<br><br>
# on_predict_end
## on_predict_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_end
### ::: ultralytics.yolo.utils.callbacks.base.on_predict_end
<br><br>
# on_export_start
## on_export_start
---
:::ultralytics.yolo.utils.callbacks.base.on_export_start
### ::: ultralytics.yolo.utils.callbacks.base.on_export_start
<br><br>
# on_export_end
## on_export_end
---
:::ultralytics.yolo.utils.callbacks.base.on_export_end
### ::: ultralytics.yolo.utils.callbacks.base.on_export_end
<br><br>
# get_default_callbacks
## get_default_callbacks
---
:::ultralytics.yolo.utils.callbacks.base.get_default_callbacks
### ::: ultralytics.yolo.utils.callbacks.base.get_default_callbacks
<br><br>
# add_integration_callbacks
## add_integration_callbacks
---
:::ultralytics.yolo.utils.callbacks.base.add_integration_callbacks
### ::: ultralytics.yolo.utils.callbacks.base.add_integration_callbacks
<br><br>

View File

@ -3,37 +3,37 @@ description: Improve your YOLOv5 model training with callbacks from ClearML. Lea
keywords: Ultralytics YOLO, callbacks, log plots, epoch monitoring, training end events
---
# _log_debug_samples
## _log_debug_samples
---
:::ultralytics.yolo.utils.callbacks.clearml._log_debug_samples
### ::: ultralytics.yolo.utils.callbacks.clearml._log_debug_samples
<br><br>
# _log_plot
## _log_plot
---
:::ultralytics.yolo.utils.callbacks.clearml._log_plot
### ::: ultralytics.yolo.utils.callbacks.clearml._log_plot
<br><br>
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.clearml.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
# on_train_epoch_end
## on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_train_epoch_end
### ::: ultralytics.yolo.utils.callbacks.clearml.on_train_epoch_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
# on_val_end
## on_val_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_val_end
### ::: ultralytics.yolo.utils.callbacks.clearml.on_val_end
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_train_end
### ::: ultralytics.yolo.utils.callbacks.clearml.on_train_end
<br><br>

View File

@ -3,122 +3,122 @@ description: Learn about YOLO callbacks using the Comet.ml platform, enhancing o
keywords: Ultralytics, YOLO, callbacks, Comet ML, log images, log predictions, log plots, fetch metadata, fetch annotations, create experiment data, format experiment data
---
# _get_comet_mode
## _get_comet_mode
---
:::ultralytics.yolo.utils.callbacks.comet._get_comet_mode
### ::: ultralytics.yolo.utils.callbacks.comet._get_comet_mode
<br><br>
# _get_comet_model_name
## _get_comet_model_name
---
:::ultralytics.yolo.utils.callbacks.comet._get_comet_model_name
### ::: ultralytics.yolo.utils.callbacks.comet._get_comet_model_name
<br><br>
# _get_eval_batch_logging_interval
## _get_eval_batch_logging_interval
---
:::ultralytics.yolo.utils.callbacks.comet._get_eval_batch_logging_interval
### ::: ultralytics.yolo.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
# _get_max_image_predictions_to_log
## _get_max_image_predictions_to_log
---
:::ultralytics.yolo.utils.callbacks.comet._get_max_image_predictions_to_log
### ::: ultralytics.yolo.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
# _scale_confidence_score
## _scale_confidence_score
---
:::ultralytics.yolo.utils.callbacks.comet._scale_confidence_score
### ::: ultralytics.yolo.utils.callbacks.comet._scale_confidence_score
<br><br>
# _should_log_confusion_matrix
## _should_log_confusion_matrix
---
:::ultralytics.yolo.utils.callbacks.comet._should_log_confusion_matrix
### ::: ultralytics.yolo.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
# _should_log_image_predictions
## _should_log_image_predictions
---
:::ultralytics.yolo.utils.callbacks.comet._should_log_image_predictions
### ::: ultralytics.yolo.utils.callbacks.comet._should_log_image_predictions
<br><br>
# _get_experiment_type
## _get_experiment_type
---
:::ultralytics.yolo.utils.callbacks.comet._get_experiment_type
### ::: ultralytics.yolo.utils.callbacks.comet._get_experiment_type
<br><br>
# _create_experiment
## _create_experiment
---
:::ultralytics.yolo.utils.callbacks.comet._create_experiment
### ::: ultralytics.yolo.utils.callbacks.comet._create_experiment
<br><br>
# _fetch_trainer_metadata
## _fetch_trainer_metadata
---
:::ultralytics.yolo.utils.callbacks.comet._fetch_trainer_metadata
### ::: ultralytics.yolo.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
# _scale_bounding_box_to_original_image_shape
## _scale_bounding_box_to_original_image_shape
---
:::ultralytics.yolo.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
### ::: ultralytics.yolo.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
# _format_ground_truth_annotations_for_detection
## _format_ground_truth_annotations_for_detection
---
:::ultralytics.yolo.utils.callbacks.comet._format_ground_truth_annotations_for_detection
### ::: ultralytics.yolo.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
# _format_prediction_annotations_for_detection
## _format_prediction_annotations_for_detection
---
:::ultralytics.yolo.utils.callbacks.comet._format_prediction_annotations_for_detection
### ::: ultralytics.yolo.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
# _fetch_annotations
## _fetch_annotations
---
:::ultralytics.yolo.utils.callbacks.comet._fetch_annotations
### ::: ultralytics.yolo.utils.callbacks.comet._fetch_annotations
<br><br>
# _create_prediction_metadata_map
## _create_prediction_metadata_map
---
:::ultralytics.yolo.utils.callbacks.comet._create_prediction_metadata_map
### ::: ultralytics.yolo.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
# _log_confusion_matrix
## _log_confusion_matrix
---
:::ultralytics.yolo.utils.callbacks.comet._log_confusion_matrix
### ::: ultralytics.yolo.utils.callbacks.comet._log_confusion_matrix
<br><br>
# _log_images
## _log_images
---
:::ultralytics.yolo.utils.callbacks.comet._log_images
### ::: ultralytics.yolo.utils.callbacks.comet._log_images
<br><br>
# _log_image_predictions
## _log_image_predictions
---
:::ultralytics.yolo.utils.callbacks.comet._log_image_predictions
### ::: ultralytics.yolo.utils.callbacks.comet._log_image_predictions
<br><br>
# _log_plots
## _log_plots
---
:::ultralytics.yolo.utils.callbacks.comet._log_plots
### ::: ultralytics.yolo.utils.callbacks.comet._log_plots
<br><br>
# _log_model
## _log_model
---
:::ultralytics.yolo.utils.callbacks.comet._log_model
### ::: ultralytics.yolo.utils.callbacks.comet._log_model
<br><br>
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.comet.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
# on_train_epoch_end
## on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.comet.on_train_epoch_end
### ::: ultralytics.yolo.utils.callbacks.comet.on_train_epoch_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.comet.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.comet.on_fit_epoch_end
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.comet.on_train_end
### ::: ultralytics.yolo.utils.callbacks.comet.on_train_end
<br><br>

View File

@ -3,52 +3,52 @@ description: Explore Ultralytics YOLO Utils DVC Callbacks such as logging images
keywords: Ultralytics, YOLO, Utils, DVC, Callbacks, images, plots, confusion matrices, training progress
---
# _logger_disabled
## _logger_disabled
---
:::ultralytics.yolo.utils.callbacks.dvc._logger_disabled
### ::: ultralytics.yolo.utils.callbacks.dvc._logger_disabled
<br><br>
# _log_images
## _log_images
---
:::ultralytics.yolo.utils.callbacks.dvc._log_images
### ::: ultralytics.yolo.utils.callbacks.dvc._log_images
<br><br>
# _log_plots
## _log_plots
---
:::ultralytics.yolo.utils.callbacks.dvc._log_plots
### ::: ultralytics.yolo.utils.callbacks.dvc._log_plots
<br><br>
# _log_confusion_matrix
## _log_confusion_matrix
---
:::ultralytics.yolo.utils.callbacks.dvc._log_confusion_matrix
### ::: ultralytics.yolo.utils.callbacks.dvc._log_confusion_matrix
<br><br>
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.dvc.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
# on_pretrain_routine_end
## on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.dvc.on_pretrain_routine_end
### ::: ultralytics.yolo.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
# on_train_start
## on_train_start
---
:::ultralytics.yolo.utils.callbacks.dvc.on_train_start
### ::: ultralytics.yolo.utils.callbacks.dvc.on_train_start
<br><br>
# on_train_epoch_start
## on_train_epoch_start
---
:::ultralytics.yolo.utils.callbacks.dvc.on_train_epoch_start
### ::: ultralytics.yolo.utils.callbacks.dvc.on_train_epoch_start
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.dvc.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.dvc.on_train_end
### ::: ultralytics.yolo.utils.callbacks.dvc.on_train_end
<br><br>

View File

@ -3,42 +3,42 @@ description: Improve YOLOv5 model training with Ultralytics' on-train callbacks.
keywords: Ultralytics, YOLO, callbacks, on_pretrain_routine_end, on_fit_epoch_end, on_train_start, on_val_start, on_predict_start, on_export_start
---
# on_pretrain_routine_end
## on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.hub.on_pretrain_routine_end
### ::: ultralytics.yolo.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.hub.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.hub.on_fit_epoch_end
<br><br>
# on_model_save
## on_model_save
---
:::ultralytics.yolo.utils.callbacks.hub.on_model_save
### ::: ultralytics.yolo.utils.callbacks.hub.on_model_save
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.hub.on_train_end
### ::: ultralytics.yolo.utils.callbacks.hub.on_train_end
<br><br>
# on_train_start
## on_train_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_train_start
### ::: ultralytics.yolo.utils.callbacks.hub.on_train_start
<br><br>
# on_val_start
## on_val_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_val_start
### ::: ultralytics.yolo.utils.callbacks.hub.on_val_start
<br><br>
# on_predict_start
## on_predict_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_predict_start
### ::: ultralytics.yolo.utils.callbacks.hub.on_predict_start
<br><br>
# on_export_start
## on_export_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_export_start
### ::: ultralytics.yolo.utils.callbacks.hub.on_export_start
<br><br>

View File

@ -3,17 +3,17 @@ description: Track model performance and metrics with MLflow in YOLOv5. Use call
keywords: Ultralytics, YOLO, Utils, MLflow, callbacks, on_pretrain_routine_end, on_train_end, Tracking, Model Management, training
---
# on_pretrain_routine_end
## on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_pretrain_routine_end
### ::: ultralytics.yolo.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_train_end
### ::: ultralytics.yolo.utils.callbacks.mlflow.on_train_end
<br><br>

View File

@ -3,42 +3,42 @@ description: Improve YOLOv5 training with Neptune, a powerful logging tool. Trac
keywords: Ultralytics, YOLO, Neptune, Callbacks, log scalars, log images, log plots, training, validation
---
# _log_scalars
## _log_scalars
---
:::ultralytics.yolo.utils.callbacks.neptune._log_scalars
### ::: ultralytics.yolo.utils.callbacks.neptune._log_scalars
<br><br>
# _log_images
## _log_images
---
:::ultralytics.yolo.utils.callbacks.neptune._log_images
### ::: ultralytics.yolo.utils.callbacks.neptune._log_images
<br><br>
# _log_plot
## _log_plot
---
:::ultralytics.yolo.utils.callbacks.neptune._log_plot
### ::: ultralytics.yolo.utils.callbacks.neptune._log_plot
<br><br>
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.neptune.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
# on_train_epoch_end
## on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.neptune.on_train_epoch_end
### ::: ultralytics.yolo.utils.callbacks.neptune.on_train_epoch_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.neptune.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
# on_val_end
## on_val_end
---
:::ultralytics.yolo.utils.callbacks.neptune.on_val_end
### ::: ultralytics.yolo.utils.callbacks.neptune.on_val_end
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.neptune.on_train_end
### ::: ultralytics.yolo.utils.callbacks.neptune.on_train_end
<br><br>

View File

@ -3,7 +3,7 @@ description: '"Improve YOLO model performance with on_fit_epoch_end callback. Le
keywords: on_fit_epoch_end, Ultralytics YOLO, callback function, training, model tuning
---
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.raytune.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

View File

@ -3,22 +3,22 @@ description: Learn how to monitor the training process with Tensorboard using Ul
keywords: TensorBoard callbacks, YOLO training, ultralytics YOLO
---
# _log_scalars
## _log_scalars
---
:::ultralytics.yolo.utils.callbacks.tensorboard._log_scalars
### ::: ultralytics.yolo.utils.callbacks.tensorboard._log_scalars
<br><br>
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.tensorboard.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
# on_batch_end
## on_batch_end
---
:::ultralytics.yolo.utils.callbacks.tensorboard.on_batch_end
### ::: ultralytics.yolo.utils.callbacks.tensorboard.on_batch_end
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.tensorboard.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

View File

@ -3,27 +3,27 @@ description: Learn how to use Ultralytics YOLO's built-in callbacks `on_pretrain
keywords: Ultralytics, YOLO, callbacks, weights, biases, training
---
# _log_plots
## _log_plots
---
:::ultralytics.yolo.utils.callbacks.wb._log_plots
### ::: ultralytics.yolo.utils.callbacks.wb._log_plots
<br><br>
# on_pretrain_routine_start
## on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.wb.on_pretrain_routine_start
### ::: ultralytics.yolo.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
# on_fit_epoch_end
## on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.wb.on_fit_epoch_end
### ::: ultralytics.yolo.utils.callbacks.wb.on_fit_epoch_end
<br><br>
# on_train_epoch_end
## on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.wb.on_train_epoch_end
### ::: ultralytics.yolo.utils.callbacks.wb.on_train_epoch_end
<br><br>
# on_train_end
## on_train_end
---
:::ultralytics.yolo.utils.callbacks.wb.on_train_end
### ::: ultralytics.yolo.utils.callbacks.wb.on_train_end
<br><br>