Engine Model and Results Docs improvements (#14564)

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Felipe Parodi <fparodi@pennmedicine.upenn.edu>
This commit is contained in:
Glenn Jocher 2024-07-21 20:14:49 +02:00 committed by GitHub
parent e59376b55f
commit 291883a23f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
123 changed files with 3789 additions and 1368 deletions

View file

@ -9,163 +9,163 @@ keywords: Ultralytics, utils, TQDM, Python, ML, Machine Learning utilities, YOLO
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><br>
<br>
## ::: ultralytics.utils.TQDM
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.SimpleClass
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ThreadingLocked
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.TryExcept
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.Retry
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.SettingsManager
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plt_settings
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.set_logging
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.emojis
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.yaml_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.yaml_load
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.yaml_print
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.read_device_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_ubuntu
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_colab
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_kaggle
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_jupyter
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_docker
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_raspberrypi
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_jetson
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_online
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_pip_package
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_dir_writeable
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_pytest_running
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_github_action_running
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_git_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.is_git_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_git_origin_url
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_git_branch
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_default_args
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_ubuntu_version
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.get_user_config_dir
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.colorstr
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.remove_colorstr
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.threaded
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.set_sentry
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.deprecation_warn
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.clean_url
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.url2file

View file

@ -9,11 +9,11 @@ keywords: YOLO batch size, CUDA memory, PyTorch autobatch, Ultralytics, machine
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><br>
<br>
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.autobatch.autobatch

View file

@ -9,15 +9,15 @@ keywords: YOLO, model benchmarking, ONNX, TensorRT, PyTorch, TensorFlow, CoreML,
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><br>
<br>
## ::: ultralytics.utils.benchmarks.RF100Benchmark
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.benchmarks.benchmark

View file

@ -9,111 +9,111 @@ keywords: Ultralytics, base callbacks, training, validation, prediction, model e
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><br>
<br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks

View file

@ -9,31 +9,31 @@ keywords: Ultralytics, YOLO, ClearML, integration, callbacks, pretraining, train
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><br>
<br>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.clearml.on_train_end

View file

@ -9,99 +9,99 @@ keywords: Ultralytics, YOLO, Comet, callbacks, logging, machine learning, monito
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><br>
<br>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.comet.on_train_end

View file

@ -9,39 +9,39 @@ keywords: Ultralytics, DVC, DVCLive, machine learning, logging, training, callba
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><br>
<br>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.dvc.on_train_end

View file

@ -9,39 +9,39 @@ keywords: Ultralytics, callbacks, pretrain, model save, train start, train end,
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><br>
<br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.hub.on_export_start

View file

@ -9,23 +9,23 @@ keywords: MLflow, Ultralytics YOLO, logging, metrics, parameters, model artifact
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><br>
<br>
## ::: ultralytics.utils.callbacks.mlflow.sanitize_dict
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.mlflow.on_train_end

View file

@ -9,35 +9,35 @@ keywords: Ultralytics, NeptuneAI, YOLO, experiment logging, machine learning, AI
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><br>
<br>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.neptune.on_train_end

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, Ray Tune, hyperparameter tuning, YOLO, machine learning,
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><br>
<br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end

View file

@ -9,27 +9,27 @@ keywords: Ultralytics, TensorBoard, callbacks, machine learning, training visual
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><br>
<br>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end

View file

@ -9,31 +9,31 @@ keywords: Ultralytics, YOLO, WandB, callbacks, logging, metrics, visualizations,
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><br>
<br>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.callbacks.wb.on_train_end

View file

@ -9,103 +9,103 @@ keywords: Ultralytics, YOLO, utility functions, version checks, requirements, im
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><br>
<br>
## ::: ultralytics.utils.checks.parse_requirements
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.parse_version
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.is_ascii
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_imgsz
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_version
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_latest_pypi_version
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_pip_update_available
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_font
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_python
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_requirements
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_torchvision
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_suffix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_yolov5u_filename
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_model_file_from_stem
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_file
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_yaml
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_is_path_safe
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_imshow
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_yolo
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.collect_system_info
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.check_amp
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.git_describe
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.print_args
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.cuda_device_count
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.checks.cuda_is_available

View file

@ -9,19 +9,19 @@ keywords: Ultralytics, distributed training, DDP, multi-node training, network p
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><br>
<br>
## ::: ultralytics.utils.dist.find_free_network_port
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.dist.generate_ddp_file
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.dist.generate_ddp_command
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.dist.ddp_cleanup

View file

@ -9,43 +9,43 @@ keywords: Ultralytics, download utilities, URL validation, zip directory, unzip
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><br>
<br>
## ::: ultralytics.utils.downloads.is_url
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.delete_dsstore
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.zip_directory
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.unzip_file
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.check_disk_space
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.get_google_drive_file_info
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.safe_download
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.get_github_assets
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.attempt_download_asset
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.downloads.download

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, YOLO, error handling, HUBModelError, model fetching, cust
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><br>
<br>
## ::: ultralytics.utils.errors.HUBModelError

View file

@ -9,35 +9,35 @@ keywords: Ultralytics, file utilities, Python, WorkingDirectory, increment_path,
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><br>
<br>
## ::: ultralytics.utils.files.WorkingDirectory
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.spaces_in_path
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.increment_path
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.file_age
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.file_date
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.file_size
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.get_latest_run
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.files.update_models

View file

@ -9,15 +9,15 @@ keywords: Ultralytics, bounding boxes, Instances, bbox formats, conversions, AI,
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). 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/instance.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.instance.Bboxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.instance.Instances
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.instance._ntuple

View file

@ -9,51 +9,51 @@ keywords: Ultralytics, loss functions, Varifocal Loss, Focal Loss, Bbox Loss, Ro
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). 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/loss.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.loss.VarifocalLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.FocalLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.DFLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.BboxLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.RotatedBboxLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.KeypointLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8DetectionLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8SegmentationLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8PoseLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8ClassificationLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.v8OBBLoss
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.loss.E2EDetectLoss

View file

@ -9,87 +9,87 @@ keywords: Ultralytics, metrics, model validation, performance analysis, IoU, con
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). 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/metrics.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.metrics.ConfusionMatrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.Metric
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.DetMetrics
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.SegmentMetrics
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.PoseMetrics
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.ClassifyMetrics
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.OBBMetrics
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.bbox_ioa
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.box_iou
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.bbox_iou
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.mask_iou
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.kpt_iou
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics._get_covariance_matrix
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.probiou
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.batch_probiou
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.smooth_BCE
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.smooth
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.plot_pr_curve
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.plot_mc_curve
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.compute_ap
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.metrics.ap_per_class

View file

@ -9,123 +9,123 @@ keywords: Ultralytics, utility operations, non-max suppression, bounding box tra
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). 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/ops.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.ops.Profile
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.segment2box
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.make_divisible
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.nms_rotated
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.non_max_suppression
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.clip_boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.clip_coords
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_image
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxy2xywh
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywh2xyxy
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywhn2xyxy
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxy2xywhn
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywh2ltwh
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxy2ltwh
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.ltwh2xywh
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xyxyxyxy2xywhr
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.xywhr2xyxyxyxy
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.ltwh2xyxy
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.segments2boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.resample_segments
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.crop_mask
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.process_mask
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.process_mask_native
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.scale_coords
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.regularize_rboxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.masks2segments
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.convert_torch2numpy_batch
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.ops.clean_str

View file

@ -9,19 +9,19 @@ keywords: Ultralytics, utils, patches, imread, imwrite, imshow, torch_save, Open
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). 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/patches.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.patches.imread
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.patches.imwrite
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.patches.imshow
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.patches.torch_save

View file

@ -9,47 +9,47 @@ keywords: ultralytics, plotting, utilities, documentation, data visualization, a
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). 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/plotting.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.plotting.Colors
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.Annotator
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_labels
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.save_one_box
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_images
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_results
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plt_color_scatter
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.plot_tune_results
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.output_to_target
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.output_to_rotated_target
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.plotting.feature_visualization

View file

@ -9,27 +9,27 @@ keywords: Ultralytics, YOLO, TaskAlignedAssigner, object detection, machine lear
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). 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/tal.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.tal.TaskAlignedAssigner
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.tal.RotatedTaskAlignedAssigner
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.tal.make_anchors
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.tal.dist2bbox
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.tal.bbox2dist
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.tal.dist2rbox

View file

@ -9,115 +9,115 @@ keywords: Ultralytics, torch utils, model optimization, device selection, infere
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). 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/torch_utils.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.torch_utils.ModelEMA
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.EarlyStopping
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.torch_distributed_zero_first
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.smart_inference_mode
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_cpu_info
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.select_device
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.time_sync
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.fuse_conv_and_bn
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.fuse_deconv_and_bn
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.model_info
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_num_params
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_num_gradients
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.model_info_for_loggers
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_flops
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_flops_with_torch_profiler
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.initialize_weights
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.scale_img
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.make_divisible
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.copy_attr
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.get_latest_opset
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.intersect_dicts
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.is_parallel
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.de_parallel
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.one_cycle
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.init_seeds
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.strip_optimizer
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.convert_optimizer_state_dict_to_fp16
<br><br>
<br><br><hr><br>
## ::: ultralytics.utils.torch_utils.profile

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, TritonRemoteModel, Triton Inference Server, model client,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/triton.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/utils/triton.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/triton.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.triton.TritonRemoteModel

View file

@ -9,7 +9,7 @@ keywords: Ultralytics, tuner, hyperparameter tuning, Ray Tune, YOLO, machine lea
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). 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/tuner.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.utils.tuner.run_ray_tune