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,167 +3,140 @@ description: Explore the Ultralytics Utils package, with handy functions like co
keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_logging, is_kaggle, is_docker, clean_url
---
## SimpleClass
# Reference for `ultralytics/utils.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils.py).
---
### ::: ultralytics.utils.SimpleClass
## ::: ultralytics.utils.SimpleClass
<br><br>
## IterableSimpleNamespace
---
### ::: ultralytics.utils.IterableSimpleNamespace
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br>
## EmojiFilter
---
### ::: ultralytics.utils.EmojiFilter
## ::: ultralytics.utils.EmojiFilter
<br><br>
## ThreadingLocked
---
### ::: ultralytics.utils.ThreadingLocked
## ::: ultralytics.utils.ThreadingLocked
<br><br>
## TryExcept
---
### ::: ultralytics.utils.TryExcept
## ::: ultralytics.utils.TryExcept
<br><br>
## SettingsManager
---
### ::: ultralytics.utils.SettingsManager
## ::: ultralytics.utils.SettingsManager
<br><br>
## plt_settings
---
### ::: ultralytics.utils.plt_settings
## ::: ultralytics.utils.plt_settings
<br><br>
## set_logging
---
### ::: ultralytics.utils.set_logging
## ::: ultralytics.utils.set_logging
<br><br>
## emojis
---
### ::: ultralytics.utils.emojis
## ::: ultralytics.utils.emojis
<br><br>
## yaml_save
---
### ::: ultralytics.utils.yaml_save
## ::: ultralytics.utils.yaml_save
<br><br>
## yaml_load
---
### ::: ultralytics.utils.yaml_load
## ::: ultralytics.utils.yaml_load
<br><br>
## yaml_print
---
### ::: ultralytics.utils.yaml_print
## ::: ultralytics.utils.yaml_print
<br><br>
## is_colab
---
### ::: ultralytics.utils.is_colab
## ::: ultralytics.utils.is_colab
<br><br>
## is_kaggle
---
### ::: ultralytics.utils.is_kaggle
## ::: ultralytics.utils.is_kaggle
<br><br>
## is_jupyter
---
### ::: ultralytics.utils.is_jupyter
## ::: ultralytics.utils.is_jupyter
<br><br>
## is_docker
---
### ::: ultralytics.utils.is_docker
## ::: ultralytics.utils.is_docker
<br><br>
## is_online
---
### ::: ultralytics.utils.is_online
## ::: ultralytics.utils.is_online
<br><br>
## is_pip_package
---
### ::: ultralytics.utils.is_pip_package
## ::: ultralytics.utils.is_pip_package
<br><br>
## is_dir_writeable
---
### ::: ultralytics.utils.is_dir_writeable
## ::: ultralytics.utils.is_dir_writeable
<br><br>
## is_pytest_running
---
### ::: ultralytics.utils.is_pytest_running
## ::: ultralytics.utils.is_pytest_running
<br><br>
## is_github_actions_ci
---
### ::: ultralytics.utils.is_github_actions_ci
## ::: ultralytics.utils.is_github_actions_ci
<br><br>
## is_git_dir
---
### ::: ultralytics.utils.is_git_dir
## ::: ultralytics.utils.is_git_dir
<br><br>
## get_git_dir
---
### ::: ultralytics.utils.get_git_dir
## ::: ultralytics.utils.get_git_dir
<br><br>
## get_git_origin_url
---
### ::: ultralytics.utils.get_git_origin_url
## ::: ultralytics.utils.get_git_origin_url
<br><br>
## get_git_branch
---
### ::: ultralytics.utils.get_git_branch
## ::: ultralytics.utils.get_git_branch
<br><br>
## get_default_args
---
### ::: ultralytics.utils.get_default_args
## ::: ultralytics.utils.get_default_args
<br><br>
## get_user_config_dir
---
### ::: ultralytics.utils.get_user_config_dir
## ::: ultralytics.utils.get_user_config_dir
<br><br>
## colorstr
---
### ::: ultralytics.utils.colorstr
## ::: ultralytics.utils.colorstr
<br><br>
## threaded
---
### ::: ultralytics.utils.threaded
## ::: ultralytics.utils.threaded
<br><br>
## set_sentry
---
### ::: ultralytics.utils.set_sentry
## ::: ultralytics.utils.set_sentry
<br><br>
## deprecation_warn
---
### ::: ultralytics.utils.deprecation_warn
## ::: ultralytics.utils.deprecation_warn
<br><br>
## clean_url
---
### ::: ultralytics.utils.clean_url
## ::: ultralytics.utils.clean_url
<br><br>
## url2file
---
### ::: ultralytics.utils.url2file
## ::: ultralytics.utils.url2file
<br><br>

View File

@ -3,12 +3,16 @@ description: Explore Ultralytics documentation for check_train_batch_size utilit
keywords: Ultralytics, check_train_batch_size, autobatch, utility, machine learning, documentation
---
## check_train_batch_size
# Reference for `ultralytics/utils/autobatch.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py).
---
### ::: ultralytics.utils.autobatch.check_train_batch_size
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
## autobatch
---
### ::: ultralytics.utils.autobatch.autobatch
## ::: ultralytics.utils.autobatch.autobatch
<br><br>

View File

@ -3,12 +3,16 @@ description: Discover how to profile your models using Ultralytics utilities. En
keywords: Ultralytics, ProfileModels, benchmarks, model profiling, performance optimization
---
## ProfileModels
# Reference for `ultralytics/utils/benchmarks.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py).
---
### ::: ultralytics.utils.benchmarks.ProfileModels
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
## benchmark
---
### ::: ultralytics.utils.benchmarks.benchmark
## ::: ultralytics.utils.benchmarks.benchmark
<br><br>

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>

View File

@ -3,92 +3,80 @@ description: Learn about our routine checks that safeguard Ultralytics operation
keywords: Ultralytics, utility checks, ASCII, check_version, pip_update, check_python, check_torchvision, check_yaml, YOLO filename
---
## is_ascii
# Reference for `ultralytics/utils/checks.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py).
---
### ::: ultralytics.utils.checks.is_ascii
## ::: ultralytics.utils.checks.is_ascii
<br><br>
## check_imgsz
---
### ::: ultralytics.utils.checks.check_imgsz
## ::: ultralytics.utils.checks.check_imgsz
<br><br>
## check_version
---
### ::: ultralytics.utils.checks.check_version
## ::: ultralytics.utils.checks.check_version
<br><br>
## check_latest_pypi_version
---
### ::: ultralytics.utils.checks.check_latest_pypi_version
## ::: ultralytics.utils.checks.check_latest_pypi_version
<br><br>
## check_pip_update_available
---
### ::: ultralytics.utils.checks.check_pip_update_available
## ::: ultralytics.utils.checks.check_pip_update_available
<br><br>
## check_font
---
### ::: ultralytics.utils.checks.check_font
## ::: ultralytics.utils.checks.check_font
<br><br>
## check_python
---
### ::: ultralytics.utils.checks.check_python
## ::: ultralytics.utils.checks.check_python
<br><br>
## check_requirements
---
### ::: ultralytics.utils.checks.check_requirements
## ::: ultralytics.utils.checks.check_requirements
<br><br>
## check_torchvision
---
### ::: ultralytics.utils.checks.check_torchvision
## ::: ultralytics.utils.checks.check_torchvision
<br><br>
## check_suffix
---
### ::: ultralytics.utils.checks.check_suffix
## ::: ultralytics.utils.checks.check_suffix
<br><br>
## check_yolov5u_filename
---
### ::: ultralytics.utils.checks.check_yolov5u_filename
## ::: ultralytics.utils.checks.check_yolov5u_filename
<br><br>
## check_file
---
### ::: ultralytics.utils.checks.check_file
## ::: ultralytics.utils.checks.check_file
<br><br>
## check_yaml
---
### ::: ultralytics.utils.checks.check_yaml
## ::: ultralytics.utils.checks.check_yaml
<br><br>
## check_imshow
---
### ::: ultralytics.utils.checks.check_imshow
## ::: ultralytics.utils.checks.check_imshow
<br><br>
## check_yolo
---
### ::: ultralytics.utils.checks.check_yolo
## ::: ultralytics.utils.checks.check_yolo
<br><br>
## check_amp
---
### ::: ultralytics.utils.checks.check_amp
## ::: ultralytics.utils.checks.check_amp
<br><br>
## git_describe
---
### ::: ultralytics.utils.checks.git_describe
## ::: ultralytics.utils.checks.git_describe
<br><br>
## print_args
---
### ::: ultralytics.utils.checks.print_args
## ::: ultralytics.utils.checks.print_args
<br><br>

View File

@ -3,22 +3,24 @@ description: Discover the role of dist.find_free_network_port & dist.generate_dd
keywords: Ultralytics, DDP, DDP utility functions, Distributed Data Processing, find free network port, generate DDP command
---
## find_free_network_port
# Reference for `ultralytics/utils/dist.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py).
---
### ::: ultralytics.utils.dist.find_free_network_port
## ::: ultralytics.utils.dist.find_free_network_port
<br><br>
## generate_ddp_file
---
### ::: ultralytics.utils.dist.generate_ddp_file
## ::: ultralytics.utils.dist.generate_ddp_file
<br><br>
## generate_ddp_command
---
### ::: ultralytics.utils.dist.generate_ddp_command
## ::: ultralytics.utils.dist.generate_ddp_command
<br><br>
## ddp_cleanup
---
### ::: ultralytics.utils.dist.ddp_cleanup
## ::: ultralytics.utils.dist.ddp_cleanup
<br><br>

View File

@ -3,37 +3,36 @@ description: Learn about the download utilities in Ultralytics YOLO, featuring f
keywords: Ultralytics, YOLO, download utilities, is_url, check_disk_space, get_github_assets, download, documentation
---
## is_url
# Reference for `ultralytics/utils/downloads.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py).
---
### ::: ultralytics.utils.downloads.is_url
## ::: ultralytics.utils.downloads.is_url
<br><br>
## unzip_file
---
### ::: ultralytics.utils.downloads.unzip_file
## ::: ultralytics.utils.downloads.unzip_file
<br><br>
## check_disk_space
---
### ::: ultralytics.utils.downloads.check_disk_space
## ::: ultralytics.utils.downloads.check_disk_space
<br><br>
## safe_download
---
### ::: ultralytics.utils.downloads.safe_download
## ::: ultralytics.utils.downloads.safe_download
<br><br>
## get_github_assets
---
### ::: ultralytics.utils.downloads.get_github_assets
## ::: ultralytics.utils.downloads.get_github_assets
<br><br>
## attempt_download_asset
---
### ::: ultralytics.utils.downloads.attempt_download_asset
## ::: ultralytics.utils.downloads.attempt_download_asset
<br><br>
## download
---
### ::: ultralytics.utils.downloads.download
## ::: ultralytics.utils.downloads.download
<br><br>

View File

@ -3,7 +3,12 @@ description: Learn about the HUBModelError in Ultralytics. Enhance your understa
keywords: Ultralytics, HUBModelError, Machine Learning, Error troubleshooting, Ultralytics documentation
---
## HUBModelError
# Reference for `ultralytics/utils/errors.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py).
---
### ::: ultralytics.utils.errors.HUBModelError
## ::: ultralytics.utils.errors.HUBModelError
<br><br>

View File

@ -3,42 +3,40 @@ description: Discover how to use Ultralytics utility functions for file-related
keywords: Ultralytics, utility functions, file operations, working directory, file age, file size, create directories
---
## WorkingDirectory
# Reference for `ultralytics/utils/files.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py).
---
### ::: ultralytics.utils.files.WorkingDirectory
## ::: ultralytics.utils.files.WorkingDirectory
<br><br>
## spaces_in_path
---
### ::: ultralytics.utils.files.spaces_in_path
## ::: ultralytics.utils.files.spaces_in_path
<br><br>
## increment_path
---
### ::: ultralytics.utils.files.increment_path
## ::: ultralytics.utils.files.increment_path
<br><br>
## file_age
---
### ::: ultralytics.utils.files.file_age
## ::: ultralytics.utils.files.file_age
<br><br>
## file_date
---
### ::: ultralytics.utils.files.file_date
## ::: ultralytics.utils.files.file_date
<br><br>
## file_size
---
### ::: ultralytics.utils.files.file_size
## ::: ultralytics.utils.files.file_size
<br><br>
## get_latest_run
---
### ::: ultralytics.utils.files.get_latest_run
## ::: ultralytics.utils.files.get_latest_run
<br><br>
## make_dirs
---
### ::: ultralytics.utils.files.make_dirs
## ::: ultralytics.utils.files.make_dirs
<br><br>

View File

@ -3,17 +3,20 @@ description: Dive into Ultralytics detailed utility guide. Learn about Bboxes, _
keywords: Ultralytics, Bboxes, _ntuple, utility, ultralytics utils.instance
---
## Bboxes
# Reference for `ultralytics/utils/instance.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py).
---
### ::: ultralytics.utils.instance.Bboxes
## ::: ultralytics.utils.instance.Bboxes
<br><br>
## Instances
---
### ::: ultralytics.utils.instance.Instances
## ::: ultralytics.utils.instance.Instances
<br><br>
## _ntuple
---
### ::: ultralytics.utils.instance._ntuple
## ::: ultralytics.utils.instance._ntuple
<br><br>

View File

@ -3,42 +3,40 @@ description: Explore Ultralytics' versatile loss functions - VarifocalLoss, Bbox
keywords: Ultralytics, Loss functions, VarifocalLoss, BboxLoss, v8DetectionLoss, v8PoseLoss, YOLO, Ultralytics Documentation
---
## VarifocalLoss
# Reference for `ultralytics/utils/loss.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py).
---
### ::: ultralytics.utils.loss.VarifocalLoss
## ::: ultralytics.utils.loss.VarifocalLoss
<br><br>
## FocalLoss
---
### ::: ultralytics.utils.loss.FocalLoss
## ::: ultralytics.utils.loss.FocalLoss
<br><br>
## BboxLoss
---
### ::: ultralytics.utils.loss.BboxLoss
## ::: ultralytics.utils.loss.BboxLoss
<br><br>
## KeypointLoss
---
### ::: ultralytics.utils.loss.KeypointLoss
## ::: ultralytics.utils.loss.KeypointLoss
<br><br>
## v8DetectionLoss
---
### ::: ultralytics.utils.loss.v8DetectionLoss
## ::: ultralytics.utils.loss.v8DetectionLoss
<br><br>
## v8SegmentationLoss
---
### ::: ultralytics.utils.loss.v8SegmentationLoss
## ::: ultralytics.utils.loss.v8SegmentationLoss
<br><br>
## v8PoseLoss
---
### ::: ultralytics.utils.loss.v8PoseLoss
## ::: ultralytics.utils.loss.v8PoseLoss
<br><br>
## v8ClassificationLoss
---
### ::: ultralytics.utils.loss.v8ClassificationLoss
## ::: ultralytics.utils.loss.v8ClassificationLoss
<br><br>

View File

@ -3,92 +3,80 @@ description: Explore Ultralytics YOLO metrics tools - from confusion matrix, det
keywords: Ultralytics, YOLO, YOLOv3, YOLOv4, metrics, confusion matrix, detection metrics, pose metrics, box IOU, mask IOU, plot precision-recall curves, compute average precision
---
## ConfusionMatrix
# Reference for `ultralytics/utils/metrics.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py).
---
### ::: ultralytics.utils.metrics.ConfusionMatrix
## ::: ultralytics.utils.metrics.ConfusionMatrix
<br><br>
## Metric
---
### ::: ultralytics.utils.metrics.Metric
## ::: ultralytics.utils.metrics.Metric
<br><br>
## DetMetrics
---
### ::: ultralytics.utils.metrics.DetMetrics
## ::: ultralytics.utils.metrics.DetMetrics
<br><br>
## SegmentMetrics
---
### ::: ultralytics.utils.metrics.SegmentMetrics
## ::: ultralytics.utils.metrics.SegmentMetrics
<br><br>
## PoseMetrics
---
### ::: ultralytics.utils.metrics.PoseMetrics
## ::: ultralytics.utils.metrics.PoseMetrics
<br><br>
## ClassifyMetrics
---
### ::: ultralytics.utils.metrics.ClassifyMetrics
## ::: ultralytics.utils.metrics.ClassifyMetrics
<br><br>
## box_area
---
### ::: ultralytics.utils.metrics.box_area
## ::: ultralytics.utils.metrics.box_area
<br><br>
## bbox_ioa
---
### ::: ultralytics.utils.metrics.bbox_ioa
## ::: ultralytics.utils.metrics.bbox_ioa
<br><br>
## box_iou
---
### ::: ultralytics.utils.metrics.box_iou
## ::: ultralytics.utils.metrics.box_iou
<br><br>
## bbox_iou
---
### ::: ultralytics.utils.metrics.bbox_iou
## ::: ultralytics.utils.metrics.bbox_iou
<br><br>
## mask_iou
---
### ::: ultralytics.utils.metrics.mask_iou
## ::: ultralytics.utils.metrics.mask_iou
<br><br>
## kpt_iou
---
### ::: ultralytics.utils.metrics.kpt_iou
## ::: ultralytics.utils.metrics.kpt_iou
<br><br>
## smooth_BCE
---
### ::: ultralytics.utils.metrics.smooth_BCE
## ::: ultralytics.utils.metrics.smooth_BCE
<br><br>
## smooth
---
### ::: ultralytics.utils.metrics.smooth
## ::: ultralytics.utils.metrics.smooth
<br><br>
## plot_pr_curve
---
### ::: ultralytics.utils.metrics.plot_pr_curve
## ::: ultralytics.utils.metrics.plot_pr_curve
<br><br>
## plot_mc_curve
---
### ::: ultralytics.utils.metrics.plot_mc_curve
## ::: ultralytics.utils.metrics.plot_mc_curve
<br><br>
## compute_ap
---
### ::: ultralytics.utils.metrics.compute_ap
## ::: ultralytics.utils.metrics.compute_ap
<br><br>
## ap_per_class
---
### ::: ultralytics.utils.metrics.ap_per_class
## ::: ultralytics.utils.metrics.ap_per_class
<br><br>

View File

@ -3,142 +3,120 @@ description: Explore detailed documentation for Ultralytics utility operations.
keywords: Ultralytics YOLO, Utility Operations, segment2box, make_divisible, clip_boxes, scale_image, xywh2xyxy, xyxy2xywhn, xywh2ltwh, ltwh2xywh, segments2boxes, crop_mask, process_mask, scale_masks, masks2segments
---
## Profile
# Reference for `ultralytics/utils/ops.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py).
---
### ::: ultralytics.utils.ops.Profile
## ::: ultralytics.utils.ops.Profile
<br><br>
## coco80_to_coco91_class
---
### ::: ultralytics.utils.ops.coco80_to_coco91_class
## ::: ultralytics.utils.ops.coco80_to_coco91_class
<br><br>
## segment2box
---
### ::: ultralytics.utils.ops.segment2box
## ::: ultralytics.utils.ops.segment2box
<br><br>
## scale_boxes
---
### ::: ultralytics.utils.ops.scale_boxes
## ::: ultralytics.utils.ops.scale_boxes
<br><br>
## make_divisible
---
### ::: ultralytics.utils.ops.make_divisible
## ::: ultralytics.utils.ops.make_divisible
<br><br>
## non_max_suppression
---
### ::: ultralytics.utils.ops.non_max_suppression
## ::: ultralytics.utils.ops.non_max_suppression
<br><br>
## clip_boxes
---
### ::: ultralytics.utils.ops.clip_boxes
## ::: ultralytics.utils.ops.clip_boxes
<br><br>
## clip_coords
---
### ::: ultralytics.utils.ops.clip_coords
## ::: ultralytics.utils.ops.clip_coords
<br><br>
## scale_image
---
### ::: ultralytics.utils.ops.scale_image
## ::: ultralytics.utils.ops.scale_image
<br><br>
## xyxy2xywh
---
### ::: ultralytics.utils.ops.xyxy2xywh
## ::: ultralytics.utils.ops.xyxy2xywh
<br><br>
## xywh2xyxy
---
### ::: ultralytics.utils.ops.xywh2xyxy
## ::: ultralytics.utils.ops.xywh2xyxy
<br><br>
## xywhn2xyxy
---
### ::: ultralytics.utils.ops.xywhn2xyxy
## ::: ultralytics.utils.ops.xywhn2xyxy
<br><br>
## xyxy2xywhn
---
### ::: ultralytics.utils.ops.xyxy2xywhn
## ::: ultralytics.utils.ops.xyxy2xywhn
<br><br>
## xyn2xy
---
### ::: ultralytics.utils.ops.xyn2xy
## ::: ultralytics.utils.ops.xyn2xy
<br><br>
## xywh2ltwh
---
### ::: ultralytics.utils.ops.xywh2ltwh
## ::: ultralytics.utils.ops.xywh2ltwh
<br><br>
## xyxy2ltwh
---
### ::: ultralytics.utils.ops.xyxy2ltwh
## ::: ultralytics.utils.ops.xyxy2ltwh
<br><br>
## ltwh2xywh
---
### ::: ultralytics.utils.ops.ltwh2xywh
## ::: ultralytics.utils.ops.ltwh2xywh
<br><br>
## ltwh2xyxy
---
### ::: ultralytics.utils.ops.ltwh2xyxy
## ::: ultralytics.utils.ops.ltwh2xyxy
<br><br>
## segments2boxes
---
### ::: ultralytics.utils.ops.segments2boxes
## ::: ultralytics.utils.ops.segments2boxes
<br><br>
## resample_segments
---
### ::: ultralytics.utils.ops.resample_segments
## ::: ultralytics.utils.ops.resample_segments
<br><br>
## crop_mask
---
### ::: ultralytics.utils.ops.crop_mask
## ::: ultralytics.utils.ops.crop_mask
<br><br>
## process_mask_upsample
---
### ::: ultralytics.utils.ops.process_mask_upsample
## ::: ultralytics.utils.ops.process_mask_upsample
<br><br>
## process_mask
---
### ::: ultralytics.utils.ops.process_mask
## ::: ultralytics.utils.ops.process_mask
<br><br>
## process_mask_native
---
### ::: ultralytics.utils.ops.process_mask_native
## ::: ultralytics.utils.ops.process_mask_native
<br><br>
## scale_masks
---
### ::: ultralytics.utils.ops.scale_masks
## ::: ultralytics.utils.ops.scale_masks
<br><br>
## scale_coords
---
### ::: ultralytics.utils.ops.scale_coords
## ::: ultralytics.utils.ops.scale_coords
<br><br>
## masks2segments
---
### ::: ultralytics.utils.ops.masks2segments
## ::: ultralytics.utils.ops.masks2segments
<br><br>
## clean_str
---
### ::: ultralytics.utils.ops.clean_str
## ::: ultralytics.utils.ops.clean_str
<br><br>

View File

@ -3,22 +3,24 @@ description: Learn about Ultralytics utils patches including imread, imshow and
keywords: Ultralytics, Utils, Patches, imread, imshow, torch_save, image processing
---
## imread
# Reference for `ultralytics/utils/patches.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py).
---
### ::: ultralytics.utils.patches.imread
## ::: ultralytics.utils.patches.imread
<br><br>
## imwrite
---
### ::: ultralytics.utils.patches.imwrite
## ::: ultralytics.utils.patches.imwrite
<br><br>
## imshow
---
### ::: ultralytics.utils.patches.imshow
## ::: ultralytics.utils.patches.imshow
<br><br>
## torch_save
---
### ::: ultralytics.utils.patches.torch_save
## ::: ultralytics.utils.patches.torch_save
<br><br>

View File

@ -3,42 +3,40 @@ description: Master advanced plotting utils from Ultralytics including color ann
keywords: Ultralytics, plotting, utils, color annotation, label plotting, image plotting, feature visualization
---
## Colors
# Reference for `ultralytics/utils/plotting.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py).
---
### ::: ultralytics.utils.plotting.Colors
## ::: ultralytics.utils.plotting.Colors
<br><br>
## Annotator
---
### ::: ultralytics.utils.plotting.Annotator
## ::: ultralytics.utils.plotting.Annotator
<br><br>
## plot_labels
---
### ::: ultralytics.utils.plotting.plot_labels
## ::: ultralytics.utils.plotting.plot_labels
<br><br>
## save_one_box
---
### ::: ultralytics.utils.plotting.save_one_box
## ::: ultralytics.utils.plotting.save_one_box
<br><br>
## plot_images
---
### ::: ultralytics.utils.plotting.plot_images
## ::: ultralytics.utils.plotting.plot_images
<br><br>
## plot_results
---
### ::: ultralytics.utils.plotting.plot_results
## ::: ultralytics.utils.plotting.plot_results
<br><br>
## output_to_target
---
### ::: ultralytics.utils.plotting.output_to_target
## ::: ultralytics.utils.plotting.output_to_target
<br><br>
## feature_visualization
---
### ::: ultralytics.utils.plotting.feature_visualization
## ::: ultralytics.utils.plotting.feature_visualization
<br><br>

View File

@ -3,32 +3,32 @@ description: Explore Ultralytics utilities for optimized task assignment, boundi
keywords: Ultralytics, task aligned assigner, select highest overlaps, make anchors, dist2bbox, bbox2dist, utilities, algorithm
---
## TaskAlignedAssigner
# Reference for `ultralytics/utils/tal.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py).
---
### ::: ultralytics.utils.tal.TaskAlignedAssigner
## ::: ultralytics.utils.tal.TaskAlignedAssigner
<br><br>
## select_candidates_in_gts
---
### ::: ultralytics.utils.tal.select_candidates_in_gts
## ::: ultralytics.utils.tal.select_candidates_in_gts
<br><br>
## select_highest_overlaps
---
### ::: ultralytics.utils.tal.select_highest_overlaps
## ::: ultralytics.utils.tal.select_highest_overlaps
<br><br>
## make_anchors
---
### ::: ultralytics.utils.tal.make_anchors
## ::: ultralytics.utils.tal.make_anchors
<br><br>
## dist2bbox
---
### ::: ultralytics.utils.tal.dist2bbox
## ::: ultralytics.utils.tal.dist2bbox
<br><br>
## bbox2dist
---
### ::: ultralytics.utils.tal.bbox2dist
## ::: ultralytics.utils.tal.bbox2dist
<br><br>

View File

@ -3,137 +3,116 @@ description: Explore Ultralytics-tailored torch utility features like Model EMA,
keywords: Ultralytics, Torch Utils, Model EMA, Early Stopping, Smart Inference, Get CPU Info, Time Sync, Fuse Deconv and bn, Get num params, Get FLOPs, Scale img, Copy attr, Intersect dicts, De_parallel, Init seeds, Profile
---
## ModelEMA
# Reference for `ultralytics/utils/torch_utils.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py).
---
### ::: ultralytics.utils.torch_utils.ModelEMA
## ::: ultralytics.utils.torch_utils.ModelEMA
<br><br>
## EarlyStopping
---
### ::: ultralytics.utils.torch_utils.EarlyStopping
## ::: ultralytics.utils.torch_utils.EarlyStopping
<br><br>
## torch_distributed_zero_first
---
### ::: ultralytics.utils.torch_utils.torch_distributed_zero_first
## ::: ultralytics.utils.torch_utils.torch_distributed_zero_first
<br><br>
## smart_inference_mode
---
### ::: ultralytics.utils.torch_utils.smart_inference_mode
## ::: ultralytics.utils.torch_utils.smart_inference_mode
<br><br>
## get_cpu_info
---
### ::: ultralytics.utils.torch_utils.get_cpu_info
## ::: ultralytics.utils.torch_utils.get_cpu_info
<br><br>
## select_device
---
### ::: ultralytics.utils.torch_utils.select_device
## ::: ultralytics.utils.torch_utils.select_device
<br><br>
## time_sync
---
### ::: ultralytics.utils.torch_utils.time_sync
## ::: ultralytics.utils.torch_utils.time_sync
<br><br>
## fuse_conv_and_bn
---
### ::: ultralytics.utils.torch_utils.fuse_conv_and_bn
## ::: ultralytics.utils.torch_utils.fuse_conv_and_bn
<br><br>
## fuse_deconv_and_bn
---
### ::: ultralytics.utils.torch_utils.fuse_deconv_and_bn
## ::: ultralytics.utils.torch_utils.fuse_deconv_and_bn
<br><br>
## model_info
---
### ::: ultralytics.utils.torch_utils.model_info
## ::: ultralytics.utils.torch_utils.model_info
<br><br>
## get_num_params
---
### ::: ultralytics.utils.torch_utils.get_num_params
## ::: ultralytics.utils.torch_utils.get_num_params
<br><br>
## get_num_gradients
---
### ::: ultralytics.utils.torch_utils.get_num_gradients
## ::: ultralytics.utils.torch_utils.get_num_gradients
<br><br>
## model_info_for_loggers
---
### ::: ultralytics.utils.torch_utils.model_info_for_loggers
## ::: ultralytics.utils.torch_utils.model_info_for_loggers
<br><br>
## get_flops
---
### ::: ultralytics.utils.torch_utils.get_flops
## ::: ultralytics.utils.torch_utils.get_flops
<br><br>
## get_flops_with_torch_profiler
---
### ::: ultralytics.utils.torch_utils.get_flops_with_torch_profiler
## ::: ultralytics.utils.torch_utils.get_flops_with_torch_profiler
<br><br>
## initialize_weights
---
### ::: ultralytics.utils.torch_utils.initialize_weights
## ::: ultralytics.utils.torch_utils.initialize_weights
<br><br>
## scale_img
---
### ::: ultralytics.utils.torch_utils.scale_img
## ::: ultralytics.utils.torch_utils.scale_img
<br><br>
## make_divisible
---
### ::: ultralytics.utils.torch_utils.make_divisible
## ::: ultralytics.utils.torch_utils.make_divisible
<br><br>
## copy_attr
---
### ::: ultralytics.utils.torch_utils.copy_attr
## ::: ultralytics.utils.torch_utils.copy_attr
<br><br>
## get_latest_opset
---
### ::: ultralytics.utils.torch_utils.get_latest_opset
## ::: ultralytics.utils.torch_utils.get_latest_opset
<br><br>
## intersect_dicts
---
### ::: ultralytics.utils.torch_utils.intersect_dicts
## ::: ultralytics.utils.torch_utils.intersect_dicts
<br><br>
## is_parallel
---
### ::: ultralytics.utils.torch_utils.is_parallel
## ::: ultralytics.utils.torch_utils.is_parallel
<br><br>
## de_parallel
---
### ::: ultralytics.utils.torch_utils.de_parallel
## ::: ultralytics.utils.torch_utils.de_parallel
<br><br>
## one_cycle
---
### ::: ultralytics.utils.torch_utils.one_cycle
## ::: ultralytics.utils.torch_utils.one_cycle
<br><br>
## init_seeds
---
### ::: ultralytics.utils.torch_utils.init_seeds
## ::: ultralytics.utils.torch_utils.init_seeds
<br><br>
## strip_optimizer
---
### ::: ultralytics.utils.torch_utils.strip_optimizer
## ::: ultralytics.utils.torch_utils.strip_optimizer
<br><br>
## profile
---
### ::: ultralytics.utils.torch_utils.profile
## ::: ultralytics.utils.torch_utils.profile
<br><br>

View File

@ -3,7 +3,12 @@ description: Learn to utilize the run_ray_tune function with Ultralytics. Make y
keywords: Ultralytics, run_ray_tune, machine learning tuning, machine learning efficiency
---
## run_ray_tune
# Reference for `ultralytics/utils/tuner.py`
!!! note
Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py).
---
### ::: ultralytics.utils.tuner.run_ray_tune
## ::: ultralytics.utils.tuner.run_ray_tune
<br><br>