单目3D初始代码

This commit is contained in:
zhao.zhu
2026-06-24 09:35:46 +08:00
commit 04a5895b6b
1153 changed files with 340700 additions and 0 deletions

View File

@@ -0,0 +1,168 @@
---
description: Explore the comprehensive reference for ultralytics.utils in the Ultralytics library. Enhance your ML workflow with these utility functions.
keywords: Ultralytics, utils, TQDM, Python, ML, Machine Learning utilities, YOLO, threading, logging, yaml, settings
---
# Reference for `ultralytics/utils/__init__.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.__init__.DataExportMixin
<br><br><hr><br>
## ::: ultralytics.utils.__init__.SimpleClass
<br><br><hr><br>
## ::: ultralytics.utils.__init__.IterableSimpleNamespace
<br><br><hr><br>
## ::: ultralytics.utils.__init__.ThreadingLocked
<br><br><hr><br>
## ::: ultralytics.utils.__init__.YAML
<br><br><hr><br>
## ::: ultralytics.utils.__init__.TryExcept
<br><br><hr><br>
## ::: ultralytics.utils.__init__.Retry
<br><br><hr><br>
## ::: ultralytics.utils.__init__.JSONDict
<br><br><hr><br>
## ::: ultralytics.utils.__init__.SettingsManager
<br><br><hr><br>
## ::: ultralytics.utils.__init__.plt_settings
<br><br><hr><br>
## ::: ultralytics.utils.__init__.set_logging
<br><br><hr><br>
## ::: ultralytics.utils.__init__.emojis
<br><br><hr><br>
## ::: ultralytics.utils.__init__.read_device_model
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_ubuntu
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_debian
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_colab
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_kaggle
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_jupyter
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_runpod
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_docker
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_raspberrypi
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_jetson
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_dgx
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_online
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_pip_package
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_dir_writeable
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_pytest_running
<br><br><hr><br>
## ::: ultralytics.utils.__init__.is_github_action_running
<br><br><hr><br>
## ::: ultralytics.utils.__init__.get_default_args
<br><br><hr><br>
## ::: ultralytics.utils.__init__.get_ubuntu_version
<br><br><hr><br>
## ::: ultralytics.utils.__init__.get_user_config_dir
<br><br><hr><br>
## ::: ultralytics.utils.__init__.colorstr
<br><br><hr><br>
## ::: ultralytics.utils.__init__.remove_colorstr
<br><br><hr><br>
## ::: ultralytics.utils.__init__.threaded
<br><br><hr><br>
## ::: ultralytics.utils.__init__.set_sentry
<br><br><hr><br>
## ::: ultralytics.utils.__init__.deprecation_warn
<br><br><hr><br>
## ::: ultralytics.utils.__init__.clean_url
<br><br><hr><br>
## ::: ultralytics.utils.__init__.url2file
<br><br><hr><br>
## ::: ultralytics.utils.__init__.vscode_msg
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Discover how to automatically estimate the best YOLO batch size for optimal CUDA memory usage in PyTorch using Ultralytics' autobatch utility.
keywords: YOLO batch size, CUDA memory, PyTorch autobatch, Ultralytics, machine learning, optimal batch size, training batch size, YOLO model
---
# Reference for `ultralytics/utils/autobatch.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autobatch.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br><hr><br>
## ::: ultralytics.utils.autobatch.autobatch
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Discover how to automatically select the most idle GPU using PyTorch and NVIDIA (nvidia-ml-py) with this AutoDevice script. Ideal for optimizing GPU usage in deep learning and computer vision tasks.
keywords: Ultralytics, AutoDevice, GPU selection, PyTorch, NVML, pynvml, GPU monitoring, CUDA, deep learning, idle GPU, memory utilization, temperature, power usage
---
# Reference for `ultralytics/utils/autodevice.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autodevice.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/autodevice.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.autodevice.GPUInfo
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore YOLO model benchmarking for speed and accuracy with formats like PyTorch, ONNX, TensorRT, and more. Detailed profiling & usage guides.
keywords: YOLO, model benchmarking, ONNX, TensorRT, PyTorch, TensorFlow, CoreML, profiling, Ultralytics, model performance
---
# Reference for `ultralytics/utils/benchmarks.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/benchmarks.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.benchmarks.RF100Benchmark
<br><br><hr><br>
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br><hr><br>
## ::: ultralytics.utils.benchmarks.benchmark
<br><br>

View File

@@ -0,0 +1,120 @@
---
description: Discover the essential base callbacks in Ultralytics for training, validation, prediction, and exporting models efficiently.
keywords: Ultralytics, base callbacks, training, validation, prediction, model export, ML, machine learning, deep learning
---
# Reference for `ultralytics/utils/callbacks/base.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.teardown
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

View File

@@ -0,0 +1,40 @@
---
description: Learn how to integrate ClearML with Ultralytics YOLO using detailed callbacks for pretraining, training, validation, and final logging.
keywords: Ultralytics, YOLO, ClearML, integration, callbacks, pretraining, training, validation, logging, AI, machine learning
---
# Reference for `ultralytics/utils/callbacks/clearml.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

View File

@@ -0,0 +1,120 @@
---
description: Explore the integration of Comet callbacks in Ultralytics YOLO, enabling advanced logging and monitoring for your machine learning experiments.
keywords: Ultralytics, YOLO, Comet, callbacks, logging, machine learning, monitoring, integration
---
# Reference for `ultralytics/utils/callbacks/comet.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._resume_or_create_experiment
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._extract_segmentation_annotation
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_image_batches
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_asset
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_table
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

View File

@@ -0,0 +1,48 @@
---
description: Learn to integrate DVCLive with Ultralytics for enhanced logging during training. Step-by-step methods for setting up and optimizing DVC callbacks.
keywords: Ultralytics, DVC, DVCLive, machine learning, logging, training, callbacks, integration
---
# Reference for `ultralytics/utils/callbacks/dvc.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

View File

@@ -0,0 +1,48 @@
---
description: Explore detailed guides on Ultralytics callbacks, including pretrain, model save, train start/end, and more. Enhance your ML training workflows with ease.
keywords: Ultralytics, callbacks, pretrain, model save, train start, train end, validation, predict, export, training, machine learning
---
# Reference for `ultralytics/utils/callbacks/hub.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

View File

@@ -0,0 +1,32 @@
---
description: Learn how to set up and customize MLflow logging for Ultralytics YOLO. Log metrics, parameters, and model artifacts easily.
keywords: MLflow, Ultralytics YOLO, logging, metrics, parameters, model artifacts, setup, tracking, customization
---
# Reference for `ultralytics/utils/callbacks/mlflow.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.mlflow.sanitize_dict
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

View File

@@ -0,0 +1,44 @@
---
description: Learn how to use NeptuneAI with Ultralytics for advanced logging and tracking of experiments. Detailed setup and callback functions included.
keywords: Ultralytics, NeptuneAI, YOLO, experiment logging, machine learning, AI, callbacks, training, validation
---
# Reference for `ultralytics/utils/callbacks/neptune.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

View File

@@ -0,0 +1,68 @@
---
description: Platform callback functions for console logging during YOLO11 training lifecycle events.
keywords: platform callbacks, training callbacks, console logging, YOLO11 training, lifecycle events, Ultralytics
---
# Reference for `ultralytics/utils/callbacks/platform.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/platform.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/platform.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.platform.slugify
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform.resolve_platform_uri
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._interp_plot
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._send
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._send_async
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._upload_model
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._upload_model_async
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._get_environment_info
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform._get_project_name
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform.on_pretrain_routine_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform.on_model_save
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.platform.on_train_end
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn how to integrate Ray Tune with Ultralytics YOLO for efficient hyperparameter tuning and performance tracking.
keywords: Ultralytics, Ray Tune, hyperparameter tuning, YOLO, machine learning, deep learning, callbacks, integration, training metrics
---
# Reference for `ultralytics/utils/callbacks/raytune.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

View File

@@ -0,0 +1,36 @@
---
description: Learn how to integrate and use TensorBoard with Ultralytics for effective model training visualization.
keywords: Ultralytics, TensorBoard, callbacks, machine learning, training visualization, logging
---
# Reference for `ultralytics/utils/callbacks/tensorboard.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

View File

@@ -0,0 +1,40 @@
---
description: Learn how Ultralytics YOLO integrates with WandB using custom callbacks for logging metrics and visualizations.
keywords: Ultralytics, YOLO, WandB, callbacks, logging, metrics, visualizations, AI, machine learning
---
# Reference for `ultralytics/utils/callbacks/wb.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>

144
docs/en/reference/utils/checks.md Executable file
View File

@@ -0,0 +1,144 @@
---
description: Explore utility functions for Ultralytics YOLO such as checking versions, image sizes, and requirements.
keywords: Ultralytics, YOLO, utility functions, version checks, requirements, image size
---
# Reference for `ultralytics/utils/checks.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/checks.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.checks.parse_requirements
<br><br><hr><br>
## ::: ultralytics.utils.checks.get_distribution_name
<br><br><hr><br>
## ::: ultralytics.utils.checks.parse_version
<br><br><hr><br>
## ::: ultralytics.utils.checks.is_ascii
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_imgsz
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_uv
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_version
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_latest_pypi_version
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_pip_update_available
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_font
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_python
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_apt_requirements
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_requirements
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_executorch_requirements
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_tensorrt
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_torchvision
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_suffix
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_yolov5u_filename
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_model_file_from_stem
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_file
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_yaml
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_is_path_safe
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_imshow
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_yolo
<br><br><hr><br>
## ::: ultralytics.utils.checks.collect_system_info
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_amp
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_multiple_install
<br><br><hr><br>
## ::: ultralytics.utils.checks.print_args
<br><br><hr><br>
## ::: ultralytics.utils.checks.cuda_device_count
<br><br><hr><br>
## ::: ultralytics.utils.checks.cuda_is_available
<br><br><hr><br>
## ::: ultralytics.utils.checks.is_rockchip
<br><br><hr><br>
## ::: ultralytics.utils.checks.is_intel
<br><br><hr><br>
## ::: ultralytics.utils.checks.is_sudo_available
<br><br>

16
docs/en/reference/utils/cpu.md Executable file
View File

@@ -0,0 +1,16 @@
---
description: Reference documentation for CPUInfo, a lightweight utility to get system CPU details in Ultralytics.
keywords: Ultralytics, CPUInfo, CPU, system info, hardware, utils
---
# Reference for `ultralytics/utils/cpu.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/cpu.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/cpu.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.cpu.CPUInfo
<br><br>

28
docs/en/reference/utils/dist.md Executable file
View File

@@ -0,0 +1,28 @@
---
description: Explore Ultralytics' utilities for distributed training including DDP file generation, command setup, and cleanup. Improve multi-node training efficiency.
keywords: Ultralytics, distributed training, DDP, multi-node training, network port, DDP file generation, DDP command, training utilities
---
# Reference for `ultralytics/utils/dist.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/dist.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.dist.find_free_network_port
<br><br><hr><br>
## ::: ultralytics.utils.dist.generate_ddp_file
<br><br><hr><br>
## ::: ultralytics.utils.dist.generate_ddp_command
<br><br><hr><br>
## ::: ultralytics.utils.dist.ddp_cleanup
<br><br>

View File

@@ -0,0 +1,52 @@
---
description: Explore and utilize the Ultralytics download utilities to handle URLs, zip/unzip files, and manage GitHub assets effectively.
keywords: Ultralytics, download utilities, URL validation, zip directory, unzip file, check disk space, Google Drive, GitHub assets, YOLO, machine learning
---
# Reference for `ultralytics/utils/downloads.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/downloads.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.downloads.is_url
<br><br><hr><br>
## ::: ultralytics.utils.downloads.delete_dsstore
<br><br><hr><br>
## ::: ultralytics.utils.downloads.zip_directory
<br><br><hr><br>
## ::: ultralytics.utils.downloads.unzip_file
<br><br><hr><br>
## ::: ultralytics.utils.downloads.check_disk_space
<br><br><hr><br>
## ::: ultralytics.utils.downloads.get_google_drive_file_info
<br><br><hr><br>
## ::: ultralytics.utils.downloads.safe_download
<br><br><hr><br>
## ::: ultralytics.utils.downloads.get_github_assets
<br><br><hr><br>
## ::: ultralytics.utils.downloads.attempt_download_asset
<br><br><hr><br>
## ::: ultralytics.utils.downloads.download
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore error handling for Ultralytics YOLO. Learn about custom exceptions like HUBModelError to manage model fetching issues effectively.
keywords: Ultralytics, YOLO, error handling, HUBModelError, model fetching, custom exceptions, Python
---
# Reference for `ultralytics/utils/errors.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/errors.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.errors.HUBModelError
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Reference for utilities supporting telemetry, analytics, and event handling with lightweight background requests.
keywords: Ultralytics, YOLO, utils, telemetry, analytics, events, anonymization, background, JSON, POST, Python
---
# Reference for `ultralytics/utils/events.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/events.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/events.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.events.Events
<br><br><hr><br>
## ::: ultralytics.utils.events._post
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: TensorRT engine export utilities for converting ONNX models to optimized TensorRT engines. Provides functions for ONNX export from PyTorch models and TensorRT engine generation with support for FP16/INT8 quantization, dynamic shapes, DLA acceleration, and INT8 calibration for NVIDIA GPU inference optimization.
keywords: Ultralytics, TensorRT export, ONNX export, PyTorch to ONNX, quantization, FP16, INT8, dynamic shapes, DLA acceleration, GPU inference, model optimization, calibration, NVIDIA, inference engine, model export
---
# Reference for `ultralytics/utils/export/engine.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/engine.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/engine.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.export.engine.torch2onnx
<br><br><hr><br>
## ::: ultralytics.utils.export.engine.onnx2engine
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore the Ultralytics ExecuTorch export utility for converting YOLO models to ExecuTorch (.pte) format for efficient on-device inference on mobile and edge devices.
keywords: Ultralytics, ExecuTorch, YOLO, model export, PyTorch, edge AI, mobile deployment, on-device inference, XNNPACK, pte format, embedded systems
---
# Reference for `ultralytics/utils/export/executorch.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/executorch.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/executorch.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.export.executorch.executorch_wrapper
<br><br><hr><br>
## ::: ultralytics.utils.export.executorch._executorch_kpts_decode
<br><br><hr><br>
## ::: ultralytics.utils.export.executorch.torch2executorch
<br><br>

View File

@@ -0,0 +1,36 @@
---
description: Learn how to export PyTorch models to Sony IMX format using Ultralytics utilities. Comprehensive guide for configurations and precision optimizations.
keywords: Ultralytics, YOLO, export, Sony IMX, PyTorch, model conversion, INT8, machine learning, NMS, Detect, Pose
---
# Reference for `ultralytics/utils/export/imx.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/imx.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/imx.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.export.imx.FXModel
<br><br><hr><br>
## ::: ultralytics.utils.export.imx.NMSWrapper
<br><br><hr><br>
## ::: ultralytics.utils.export.imx._inference
<br><br><hr><br>
## ::: ultralytics.utils.export.imx.pose_forward
<br><br><hr><br>
## ::: ultralytics.utils.export.imx.segment_forward
<br><br><hr><br>
## ::: ultralytics.utils.export.imx.torch2imx
<br><br>

View File

@@ -0,0 +1,44 @@
---
description: TensorFlow export utilities for converting PyTorch models to various TensorFlow formats. Provides functions for converting models to TensorFlow SavedModel, Protocol Buffer (.pb), TensorFlow Lite, Edge TPU, and TensorFlow.js formats via ONNX intermediate representation with support for INT8 quantization and calibration.
keywords: Ultralytics, TensorFlow, SavedModel, Protocol Buffer, TensorFlow Lite, TFLite, Edge TPU, TensorFlow.js, ONNX conversion, PyTorch to TensorFlow, INT8 quantization, model calibration, frozen graph, onnx2tf, model export, web deployment, mobile deployment
---
# Reference for `ultralytics/utils/export/tensorflow.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/tensorflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/export/tensorflow.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.export.tensorflow.tf_wrapper
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow._tf_decode_boxes
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow._tf_kpts_decode
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow.onnx2saved_model
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow.keras2pb
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow.tflite2edgetpu
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow.pb2tfjs
<br><br><hr><br>
## ::: ultralytics.utils.export.tensorflow.gd_outputs
<br><br>

View File

@@ -0,0 +1,44 @@
---
description: Explore the utility functions and context managers in Ultralytics like WorkingDirectory, increment_path, file_size, and more. Enhance your file handling in Python.
keywords: Ultralytics, file utilities, Python, WorkingDirectory, increment_path, file_size, file_age, contexts, file handling, file management
---
# Reference for `ultralytics/utils/files.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/files.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.files.WorkingDirectory
<br><br><hr><br>
## ::: ultralytics.utils.files.spaces_in_path
<br><br><hr><br>
## ::: ultralytics.utils.files.increment_path
<br><br><hr><br>
## ::: ultralytics.utils.files.file_age
<br><br><hr><br>
## ::: ultralytics.utils.files.file_date
<br><br><hr><br>
## ::: ultralytics.utils.files.file_size
<br><br><hr><br>
## ::: ultralytics.utils.files.get_latest_run
<br><br><hr><br>
## ::: ultralytics.utils.files.update_models
<br><br>

16
docs/en/reference/utils/git.md Executable file
View File

@@ -0,0 +1,16 @@
---
description: Utilities for retrieving Git repository metadata such as branch, commit, and origin URL, used in Ultralytics projects.
keywords: Ultralytics, Git, GitRepo, branch, commit, origin, repository, utils, metadata, version control
---
# Reference for `ultralytics/utils/git.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/git.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/git.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.git.GitRepo
<br><br>

View File

@@ -0,0 +1,24 @@
---
description: Explore Ultralytics utilities for bounding boxes and instances, providing detailed documentation on handling bbox formats, conversions, and more.
keywords: Ultralytics, bounding boxes, Instances, bbox formats, conversions, AI, deep learning, YOLO, xyxy, xywh, ltwh
---
# Reference for `ultralytics/utils/instance.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/instance.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.instance.Bboxes
<br><br><hr><br>
## ::: ultralytics.utils.instance.Instances
<br><br><hr><br>
## ::: ultralytics.utils.instance._ntuple
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: High-performance console output capture with API/file streaming for YOLO11 training logs.
keywords: ConsoleLogger, console capture, log streaming, API logging, file logging, YOLO11, Ultralytics
---
# Reference for `ultralytics/utils/logger.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/logger.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/logger.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.logger.ConsoleLogger
<br><br><hr><br>
## ::: ultralytics.utils.logger.SystemLogger
<br><br>

88
docs/en/reference/utils/loss.md Executable file
View File

@@ -0,0 +1,88 @@
---
description: Explore detailed descriptions and implementations of various loss functions used in Ultralytics models, including Varifocal Loss, Focal Loss, Bbox Loss, and more.
keywords: Ultralytics, loss functions, Varifocal Loss, Focal Loss, Bbox Loss, Rotated Bbox Loss, Keypoint Loss, YOLO, model training, documentation
---
# Reference for `ultralytics/utils/loss.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/loss.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.loss.VarifocalLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.FocalLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.DFLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.BboxLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.RLELoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.RotatedBboxLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.MultiChannelDiceLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.BCEDiceLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.KeypointLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8DetectionLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8SegmentationLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8PoseLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.PoseLoss26
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8ClassificationLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8OBBLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.E2EDetectLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.E2ELoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.TVPDetectLoss
<br><br><hr><br>
## ::: ultralytics.utils.loss.TVPSegmentLoss
<br><br>

View File

@@ -0,0 +1,96 @@
---
description: Explore detailed metrics and utility functions for model validation and performance analysis with Ultralytics' metrics module.
keywords: Ultralytics, metrics, model validation, performance analysis, IoU, confusion matrix
---
# Reference for `ultralytics/utils/metrics.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/metrics.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.metrics.ConfusionMatrix
<br><br><hr><br>
## ::: ultralytics.utils.metrics.Metric
<br><br><hr><br>
## ::: ultralytics.utils.metrics.DetMetrics
<br><br><hr><br>
## ::: ultralytics.utils.metrics.SegmentMetrics
<br><br><hr><br>
## ::: ultralytics.utils.metrics.PoseMetrics
<br><br><hr><br>
## ::: ultralytics.utils.metrics.ClassifyMetrics
<br><br><hr><br>
## ::: ultralytics.utils.metrics.OBBMetrics
<br><br><hr><br>
## ::: ultralytics.utils.metrics.bbox_ioa
<br><br><hr><br>
## ::: ultralytics.utils.metrics.box_iou
<br><br><hr><br>
## ::: ultralytics.utils.metrics.bbox_iou
<br><br><hr><br>
## ::: ultralytics.utils.metrics.mask_iou
<br><br><hr><br>
## ::: ultralytics.utils.metrics.kpt_iou
<br><br><hr><br>
## ::: ultralytics.utils.metrics._get_covariance_matrix
<br><br><hr><br>
## ::: ultralytics.utils.metrics.probiou
<br><br><hr><br>
## ::: ultralytics.utils.metrics.batch_probiou
<br><br><hr><br>
## ::: ultralytics.utils.metrics.smooth_bce
<br><br><hr><br>
## ::: ultralytics.utils.metrics.smooth
<br><br><hr><br>
## ::: ultralytics.utils.metrics.plot_pr_curve
<br><br><hr><br>
## ::: ultralytics.utils.metrics.plot_mc_curve
<br><br><hr><br>
## ::: ultralytics.utils.metrics.compute_ap
<br><br><hr><br>
## ::: ultralytics.utils.metrics.ap_per_class
<br><br>

20
docs/en/reference/utils/nms.md Executable file
View File

@@ -0,0 +1,20 @@
---
description: Custom NMS implementation for Ultralytics YOLO with TorchNMS class for torchvision-free inference and fast-nms for oriented bounding boxes. Optimized for speed and accuracy.
keywords: NMS, non-maximum suppression, TorchNMS, YOLO, torchvision-free, rotated NMS, object detection, bounding boxes, IoU threshold, custom implementation
---
# Reference for `ultralytics/utils/nms.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/nms.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/nms.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.nms.TorchNMS
<br><br><hr><br>
## ::: ultralytics.utils.nms.non_max_suppression
<br><br>

124
docs/en/reference/utils/ops.md Executable file
View File

@@ -0,0 +1,124 @@
---
description: Explore detailed documentation on utility operations in Ultralytics including non-max suppression, bounding box transformations, and more.
keywords: Ultralytics, utility operations, non-max suppression, bounding box transformations, YOLOv8, machine learning
---
# Reference for `ultralytics/utils/ops.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/ops.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.ops.Profile
<br><br><hr><br>
## ::: ultralytics.utils.ops.segment2box
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_boxes
<br><br><hr><br>
## ::: ultralytics.utils.ops.make_divisible
<br><br><hr><br>
## ::: ultralytics.utils.ops.clip_boxes
<br><br><hr><br>
## ::: ultralytics.utils.ops.clip_coords
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxy2xywh
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywh2xyxy
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywhn2xyxy
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxy2xywhn
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywh2ltwh
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxy2ltwh
<br><br><hr><br>
## ::: ultralytics.utils.ops.ltwh2xywh
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxyxyxy2xywhr
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywhr2xyxyxyxy
<br><br><hr><br>
## ::: ultralytics.utils.ops.ltwh2xyxy
<br><br><hr><br>
## ::: ultralytics.utils.ops.segments2boxes
<br><br><hr><br>
## ::: ultralytics.utils.ops.resample_segments
<br><br><hr><br>
## ::: ultralytics.utils.ops.crop_mask
<br><br><hr><br>
## ::: ultralytics.utils.ops.process_mask
<br><br><hr><br>
## ::: ultralytics.utils.ops.process_mask_native
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_masks
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_coords
<br><br><hr><br>
## ::: ultralytics.utils.ops.regularize_rboxes
<br><br><hr><br>
## ::: ultralytics.utils.ops.masks2segments
<br><br><hr><br>
## ::: ultralytics.utils.ops.convert_torch2numpy_batch
<br><br><hr><br>
## ::: ultralytics.utils.ops.clean_str
<br><br><hr><br>
## ::: ultralytics.utils.ops.empty_like
<br><br>

View File

@@ -0,0 +1,52 @@
---
description: Explore and contribute to Ultralytics' utils/patches.py. Learn about the imread, imwrite, imshow, and torch_save functions.
keywords: Ultralytics, utils, patches, imread, imwrite, imshow, torch_save, OpenCV, PyTorch, GitHub
---
# Reference for `ultralytics/utils/patches.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/patches.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.patches.imread
<br><br><hr><br>
## ::: ultralytics.utils.patches.image_open
<br><br><hr><br>
## ::: ultralytics.utils.patches._imread_pil
<br><br><hr><br>
## ::: ultralytics.utils.patches.imwrite
<br><br><hr><br>
## ::: ultralytics.utils.patches.imshow
<br><br><hr><br>
## ::: ultralytics.utils.patches.torch_load
<br><br><hr><br>
## ::: ultralytics.utils.patches.torch_save
<br><br><hr><br>
## ::: ultralytics.utils.patches.arange_patch
<br><br><hr><br>
## ::: ultralytics.utils.patches.onnx_export_patch
<br><br><hr><br>
## ::: ultralytics.utils.patches.override_configs
<br><br>

View File

@@ -0,0 +1,48 @@
---
description: Explore detailed functionalities of Ultralytics plotting utilities for data visualizations and custom annotations in ML projects.
keywords: ultralytics, plotting, utilities, documentation, data visualization, annotations, python, ML tools
---
# Reference for `ultralytics/utils/plotting.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/plotting.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.plotting.Colors
<br><br><hr><br>
## ::: ultralytics.utils.plotting.Annotator
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_labels
<br><br><hr><br>
## ::: ultralytics.utils.plotting.save_one_box
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_images
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_results
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plt_color_scatter
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_tune_results
<br><br><hr><br>
## ::: ultralytics.utils.plotting.feature_visualization
<br><br>

40
docs/en/reference/utils/tal.md Executable file
View File

@@ -0,0 +1,40 @@
---
description: Explore the TaskAlignedAssigner in Ultralytics YOLO. Learn about the TaskAlignedMetric and its applications in object detection.
keywords: Ultralytics, YOLO, TaskAlignedAssigner, object detection, machine learning, AI, Tal.py, PyTorch
---
# Reference for `ultralytics/utils/tal.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tal.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.tal.TaskAlignedAssigner
<br><br><hr><br>
## ::: ultralytics.utils.tal.RotatedTaskAlignedAssigner
<br><br><hr><br>
## ::: ultralytics.utils.tal.make_anchors
<br><br><hr><br>
## ::: ultralytics.utils.tal.dist2bbox
<br><br><hr><br>
## ::: ultralytics.utils.tal.bbox2dist
<br><br><hr><br>
## ::: ultralytics.utils.tal.dist2rbox
<br><br><hr><br>
## ::: ultralytics.utils.tal.rbox2dist
<br><br>

View File

@@ -0,0 +1,136 @@
---
description: Explore valuable torch utilities from Ultralytics for optimized model performance, including device selection, model fusion, and inference optimization.
keywords: Ultralytics, torch utils, model optimization, device selection, inference optimization, model fusion, CPU info, PyTorch tools
---
# Reference for `ultralytics/utils/torch_utils.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/torch_utils.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.torch_utils.ModelEMA
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.EarlyStopping
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.torch_distributed_zero_first
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.smart_inference_mode
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.autocast
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_cpu_info
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_gpu_info
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.select_device
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.time_sync
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.fuse_conv_and_bn
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.fuse_deconv_and_bn
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.model_info
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_num_params
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_num_gradients
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.model_info_for_loggers
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_flops
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_flops_with_torch_profiler
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.initialize_weights
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.scale_img
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.copy_attr
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.intersect_dicts
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.is_parallel
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.unwrap_model
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.one_cycle
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.init_seeds
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.unset_deterministic
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.strip_optimizer
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.convert_optimizer_state_dict_to_fp16
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.cuda_memory_usage
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.profile_ops
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.attempt_compile
<br><br>

20
docs/en/reference/utils/tqdm.md Executable file
View File

@@ -0,0 +1,20 @@
---
description: Lightweight zero-dependency progress bar for Ultralytics with rich-style displays, GitHub Actions support, and comprehensive formatting options.
keywords: TQDM, progress bar, Ultralytics, GitHub Actions, zero dependencies, rich style, download progress, training progress, Unicode blocks
---
# Reference for `ultralytics/utils/tqdm.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tqdm.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tqdm.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.tqdm.TQDM
<br><br><hr><br>
## ::: ultralytics.utils.tqdm.is_noninteractive_console
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Learn how to use the TritonRemoteModel class for interacting with remote Triton Inference Server models. Detailed guide with code examples and attributes.
keywords: Ultralytics, TritonRemoteModel, Triton Inference Server, model client, inference, remote model, machine learning, AI, Python
---
# Reference for `ultralytics/utils/triton.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/triton.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/triton.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.triton.TritonRemoteModel
<br><br>

View File

@@ -0,0 +1,16 @@
---
description: Explore how to use ultralytics.utils.tuner.py for efficient hyperparameter tuning with Ray Tune. Learn implementation details and example usage.
keywords: Ultralytics, tuner, hyperparameter tuning, Ray Tune, YOLO, machine learning, AI, optimization
---
# Reference for `ultralytics/utils/tuner.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/tuner.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.tuner.run_ray_tune
<br><br>

View File

@@ -0,0 +1,20 @@
---
description: Explore the Ultralytics upload utilities with retry logic, progress bars, and signed URL support for cloud storage.
keywords: Ultralytics, upload utilities, file upload, retry logic, progress bar, cloud storage, GCS, YOLO, machine learning
---
# Reference for `ultralytics/utils/uploads.py`
!!! success "Improvements"
This page is sourced from [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/uploads.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/uploads.py). Have an improvement or example to add? Open a [Pull Request](https://docs.ultralytics.com/help/contributing/) — thank you! 🙏
<br>
## ::: ultralytics.utils.uploads._ProgressReader
<br><br><hr><br>
## ::: ultralytics.utils.uploads.safe_upload
<br><br>