Commit a74dc9a0 authored by chenzk's avatar chenzk
Browse files

v1.0

parents
---
description: Explore Kalman filter implementations like KalmanFilterXYAH and KalmanFilterXYWH for tracking bounding boxes in image space using Ultralytics.
keywords: Kalman Filter, Object Tracking, Python, Ultralytics, YOLO, Bounding Boxes, Image Processing
---
# Reference for `ultralytics/trackers/utils/kalman_filter.py`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/kalman_filter.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/kalman_filter.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/kalman_filter.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYAH
<br><br><hr><br>
## ::: ultralytics.trackers.utils.kalman_filter.KalmanFilterXYWH
<br><br>
---
description: Explore the utility functions for matching in trackers used by Ultralytics, including linear assignment, IoU distance, embedding distance, and more.
keywords: Ultralytics, matching utils, linear assignment, IoU distance, embedding distance, fuse score, tracking, Python, documentation
---
# Reference for `ultralytics/trackers/utils/matching.py`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/matching.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/trackers/utils/matching.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/trackers/utils/matching.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.trackers.utils.matching.linear_assignment
<br><br><hr><br>
## ::: ultralytics.trackers.utils.matching.iou_distance
<br><br><hr><br>
## ::: ultralytics.trackers.utils.matching.embedding_distance
<br><br><hr><br>
## ::: ultralytics.trackers.utils.matching.fuse_score
<br><br>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/\_\_init\_\_.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/__init__.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/__init__.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.utils.TQDM
<br><br><hr><br>
## ::: ultralytics.utils.SimpleClass
<br><br><hr><br>
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br><hr><br>
## ::: ultralytics.utils.ThreadingLocked
<br><br><hr><br>
## ::: ultralytics.utils.TryExcept
<br><br><hr><br>
## ::: ultralytics.utils.Retry
<br><br><hr><br>
## ::: ultralytics.utils.JSONDict
<br><br><hr><br>
## ::: ultralytics.utils.SettingsManager
<br><br><hr><br>
## ::: ultralytics.utils.plt_settings
<br><br><hr><br>
## ::: ultralytics.utils.set_logging
<br><br><hr><br>
## ::: ultralytics.utils.emojis
<br><br><hr><br>
## ::: ultralytics.utils.yaml_save
<br><br><hr><br>
## ::: ultralytics.utils.yaml_load
<br><br><hr><br>
## ::: ultralytics.utils.yaml_print
<br><br><hr><br>
## ::: ultralytics.utils.read_device_model
<br><br><hr><br>
## ::: ultralytics.utils.is_ubuntu
<br><br><hr><br>
## ::: ultralytics.utils.is_colab
<br><br><hr><br>
## ::: ultralytics.utils.is_kaggle
<br><br><hr><br>
## ::: ultralytics.utils.is_jupyter
<br><br><hr><br>
## ::: ultralytics.utils.is_docker
<br><br><hr><br>
## ::: ultralytics.utils.is_raspberrypi
<br><br><hr><br>
## ::: ultralytics.utils.is_jetson
<br><br><hr><br>
## ::: ultralytics.utils.is_online
<br><br><hr><br>
## ::: ultralytics.utils.is_pip_package
<br><br><hr><br>
## ::: ultralytics.utils.is_dir_writeable
<br><br><hr><br>
## ::: ultralytics.utils.is_pytest_running
<br><br><hr><br>
## ::: ultralytics.utils.is_github_action_running
<br><br><hr><br>
## ::: ultralytics.utils.get_git_dir
<br><br><hr><br>
## ::: ultralytics.utils.is_git_dir
<br><br><hr><br>
## ::: ultralytics.utils.get_git_origin_url
<br><br><hr><br>
## ::: ultralytics.utils.get_git_branch
<br><br><hr><br>
## ::: ultralytics.utils.get_default_args
<br><br><hr><br>
## ::: ultralytics.utils.get_ubuntu_version
<br><br><hr><br>
## ::: ultralytics.utils.get_user_config_dir
<br><br><hr><br>
## ::: ultralytics.utils.colorstr
<br><br><hr><br>
## ::: ultralytics.utils.remove_colorstr
<br><br><hr><br>
## ::: ultralytics.utils.threaded
<br><br><hr><br>
## ::: ultralytics.utils.set_sentry
<br><br><hr><br>
## ::: ultralytics.utils.deprecation_warn
<br><br><hr><br>
## ::: ultralytics.utils.clean_url
<br><br><hr><br>
## ::: ultralytics.utils.url2file
<br><br><hr><br>
## ::: ultralytics.utils.vscode_msg
<br><br>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/autobatch.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br><hr><br>
## ::: ultralytics.utils.autobatch.autobatch
<br><br>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/benchmarks.py) 🛠️. 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/base.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/base.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/clearml.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/clearml.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/comet.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/comet.py) 🛠️. Thank you 🙏!
<br>
## ::: 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._get_experiment_type
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._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_for_detection
<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.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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/dvc.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/dvc.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/hub.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/hub.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/mlflow.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/mlflow.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/neptune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/neptune.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/raytune.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/raytune.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/tensorboard.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/tensorboard.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/callbacks/wb.py). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/callbacks/wb.py) 🛠️. Thank you 🙏!
<br>
## ::: 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>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/checks.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.utils.checks.parse_requirements
<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_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_requirements
<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.git_describe
<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>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/dist.py) 🛠️. 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>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/downloads.py) 🛠️. 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>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/errors.py) 🛠️. Thank you 🙏!
<br>
## ::: ultralytics.utils.errors.HUBModelError
<br><br>
---
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`
!!! note
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/utils/files.py) 🛠️. 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>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment