HongChuang/ultralytics-ascend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Update docs predict, buttons, reference (#6585)

Browse source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Glenn Jocher 2023-11-25 17:59:01 +01:00 • committed by GitHub
parent a1ccdb00ed
commit e361194d7f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
141 changed files with 1044 additions and 828 deletions
Download patch file Download diff file Expand all files Collapse all files

74
docs/en/reference/utils/__init__.md
View file

@ -9,146 +9,148 @@ keywords: Ultralytics, Utils, utilitarian functions, colorstr, yaml_save, set_lo
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>
## ::: ultralytics.utils.TQDM
<br><br>
---
## ::: ultralytics.utils.SimpleClass
<br><br>
---
## ::: ultralytics.utils.IterableSimpleNamespace
<br><br>
---
## ::: ultralytics.utils.ThreadingLocked
<br><br>
---
## ::: ultralytics.utils.TryExcept
<br><br>
---
## ::: ultralytics.utils.SettingsManager
<br><br>
---
## ::: ultralytics.utils.plt_settings
<br><br>
---
## ::: ultralytics.utils.set_logging
<br><br>
---
## ::: ultralytics.utils.emojis
<br><br>
---
## ::: ultralytics.utils.yaml_save
<br><br>
---
## ::: ultralytics.utils.yaml_load
<br><br>
---
## ::: ultralytics.utils.yaml_print
<br><br>
---
## ::: ultralytics.utils.is_ubuntu
<br><br>
---
## ::: ultralytics.utils.is_colab
<br><br>
---
## ::: ultralytics.utils.is_kaggle
<br><br>
---
## ::: ultralytics.utils.is_jupyter
<br><br>
---
## ::: ultralytics.utils.is_docker
<br><br>
---
## ::: ultralytics.utils.is_online
<br><br>
---
## ::: ultralytics.utils.is_pip_package
<br><br>
---
## ::: ultralytics.utils.is_dir_writeable
<br><br>
---
## ::: ultralytics.utils.is_pytest_running
<br><br>
---
## ::: ultralytics.utils.is_github_action_running
<br><br>
---
## ::: ultralytics.utils.is_git_dir
<br><br>
---
## ::: ultralytics.utils.get_git_dir
<br><br>
---
## ::: ultralytics.utils.get_git_origin_url
<br><br>
---
## ::: ultralytics.utils.get_git_branch
<br><br>
---
## ::: ultralytics.utils.get_default_args
<br><br>
---
## ::: ultralytics.utils.get_ubuntu_version
<br><br>
---
## ::: ultralytics.utils.get_user_config_dir
<br><br>
---
## ::: ultralytics.utils.colorstr
<br><br>
---
## ::: ultralytics.utils.remove_colorstr
<br><br>
---
## ::: ultralytics.utils.threaded
<br><br>
---
## ::: ultralytics.utils.set_sentry
<br><br>
---
## ::: ultralytics.utils.deprecation_warn
<br><br>
---
## ::: ultralytics.utils.clean_url
<br><br>
---
## ::: ultralytics.utils.url2file
<br><br>

10
docs/en/reference/utils/autobatch.md
View file

@ -9,10 +9,12 @@ keywords: Ultralytics, check_train_batch_size, autobatch, utility, machine learn
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 🙏!
---
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
---
## ::: ultralytics.utils.autobatch.autobatch
## ::: ultralytics.utils.autobatch.check_train_batch_size
<br><br>
## ::: ultralytics.utils.autobatch.autobatch
<br><br>

10
docs/en/reference/utils/benchmarks.md
View file

@ -9,10 +9,12 @@ keywords: Ultralytics, ProfileModels, benchmarks, model profiling, performance o
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 🙏!
---
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
---
## ::: ultralytics.utils.benchmarks.benchmark
## ::: ultralytics.utils.benchmarks.ProfileModels
<br><br>
## ::: ultralytics.utils.benchmarks.benchmark
<br><br>

56
docs/en/reference/utils/callbacks/base.md
View file

@ -9,110 +9,112 @@ keywords: Ultralytics, Callbacks, On-train, On-validation, On-pretrain, On-predi
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>
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_epoch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.optimizer_step
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_before_zero_grad
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_model_save
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_train_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_params_update
<br><br>
---
## ::: ultralytics.utils.callbacks.base.teardown
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_batch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_predict_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_export_start
<br><br>
---
## ::: ultralytics.utils.callbacks.base.on_export_end
<br><br>
---
## ::: ultralytics.utils.callbacks.base.get_default_callbacks
<br><br>
---
## ::: ultralytics.utils.callbacks.base.add_integration_callbacks
<br><br>

16
docs/en/reference/utils/callbacks/clearml.md
View file

@ -9,30 +9,32 @@ keywords: Ultralytics, clearML, callbacks, pretrain routine start, validation en
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>
## ::: ultralytics.utils.callbacks.clearml._log_debug_samples
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml._log_plot
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.clearml.on_train_end
<br><br>

50
docs/en/reference/utils/callbacks/comet.md
View file

@ -9,98 +9,100 @@ keywords: Ultralytics, Comet Callbacks, Training optimisation, Logging, Experime
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>
## ::: ultralytics.utils.callbacks.comet._get_comet_mode
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_comet_model_name
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._scale_confidence_score
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._get_experiment_type
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._create_experiment
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._fetch_annotations
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_image_predictions
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.comet._log_model
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.comet.on_train_end
<br><br>

20
docs/en/reference/utils/callbacks/dvc.md
View file

@ -9,38 +9,40 @@ keywords: Ultralytics, YOLO, callbacks, logger, training, pretraining, machine l
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>
## ::: ultralytics.utils.callbacks.dvc._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.dvc.on_train_end
<br><br>

18
docs/en/reference/utils/callbacks/hub.md
View file

@ -9,34 +9,36 @@ keywords: Ultralytics, callbacks, on_pretrain_routine_end, on_model_save, on_tra
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>
## ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_model_save
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_train_end
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_val_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_predict_start
<br><br>
---
## ::: ultralytics.utils.callbacks.hub.on_export_start
<br><br>

8
docs/en/reference/utils/callbacks/mlflow.md
View file

@ -9,14 +9,16 @@ keywords: Ultralytics, MLflow, Callbacks, on_pretrain_routine_end, on_train_end,
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>
## ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
---
## ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.mlflow.on_train_end
<br><br>

18
docs/en/reference/utils/callbacks/neptune.md
View file

@ -9,34 +9,36 @@ keywords: Ultralytics, Neptune callbacks, on_train_epoch_end, on_val_end, _log_p
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>
## ::: ultralytics.utils.callbacks.neptune._log_scalars
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune._log_images
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune._log_plot
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_val_end
<br><br>
---
## ::: ultralytics.utils.callbacks.neptune.on_train_end
<br><br>

6
docs/en/reference/utils/callbacks/raytune.md
View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, on_fit_epoch_end, callbacks, documentation, deep le
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 🙏!
---
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>
## ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

14
docs/en/reference/utils/callbacks/tensorboard.md
View file

@ -9,26 +9,28 @@ keywords: Ultralytics, YOLO, documentation, callback utilities, log_scalars, on_
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>
## ::: ultralytics.utils.callbacks.tensorboard._log_scalars
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard._log_tensorboard_graph
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_train_start
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

16
docs/en/reference/utils/callbacks/wb.md
View file

@ -9,30 +9,32 @@ keywords: Ultralytics, callbacks, _log_plots, on_fit_epoch_end, on_train_end
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>
## ::: ultralytics.utils.callbacks.wb._custom_table
<br><br>
---
## ::: ultralytics.utils.callbacks.wb._plot_curve
<br><br>
---
## ::: ultralytics.utils.callbacks.wb._log_plots
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
<br><br>
---
## ::: ultralytics.utils.callbacks.wb.on_train_end
<br><br>

52
docs/en/reference/utils/checks.md
View file

@ -9,102 +9,104 @@ keywords: Ultralytics, utility checks, ASCII, check_version, pip_update, check_p
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>
## ::: ultralytics.utils.checks.parse_requirements
<br><br>
---
## ::: ultralytics.utils.checks.parse_version
<br><br>
---
## ::: ultralytics.utils.checks.is_ascii
<br><br>
---
## ::: ultralytics.utils.checks.check_imgsz
<br><br>
---
## ::: ultralytics.utils.checks.check_version
<br><br>
---
## ::: ultralytics.utils.checks.check_latest_pypi_version
<br><br>
---
## ::: ultralytics.utils.checks.check_pip_update_available
<br><br>
---
## ::: ultralytics.utils.checks.check_font
<br><br>
---
## ::: ultralytics.utils.checks.check_python
<br><br>
---
## ::: ultralytics.utils.checks.check_requirements
<br><br>
---
## ::: ultralytics.utils.checks.check_torchvision
<br><br>
---
## ::: ultralytics.utils.checks.check_suffix
<br><br>
---
## ::: ultralytics.utils.checks.check_yolov5u_filename
<br><br>
---
## ::: ultralytics.utils.checks.check_model_file_from_stem
<br><br>
---
## ::: ultralytics.utils.checks.check_file
<br><br>
---
## ::: ultralytics.utils.checks.check_yaml
<br><br>
---
## ::: ultralytics.utils.checks.check_is_path_safe
<br><br>
---
## ::: ultralytics.utils.checks.check_imshow
<br><br>
---
## ::: ultralytics.utils.checks.check_yolo
<br><br>
---
## ::: ultralytics.utils.checks.collect_system_info
<br><br>
---
## ::: ultralytics.utils.checks.check_amp
<br><br>
---
## ::: ultralytics.utils.checks.git_describe
<br><br>
---
## ::: ultralytics.utils.checks.print_args
<br><br>
---
## ::: ultralytics.utils.checks.cuda_device_count
<br><br>
---
## ::: ultralytics.utils.checks.cuda_is_available
<br><br>

10
docs/en/reference/utils/dist.md
View file

@ -9,18 +9,20 @@ keywords: Ultralytics, DDP, DDP utility functions, Distributed Data Processing,
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>
## ::: ultralytics.utils.dist.find_free_network_port
<br><br>
---
## ::: ultralytics.utils.dist.generate_ddp_file
<br><br>
---
## ::: ultralytics.utils.dist.generate_ddp_command
<br><br>
---
## ::: ultralytics.utils.dist.ddp_cleanup
<br><br>

22
docs/en/reference/utils/downloads.md
View file

@ -9,42 +9,44 @@ keywords: Ultralytics, YOLO, download utilities, is_url, check_disk_space, get_g
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>
## ::: ultralytics.utils.downloads.is_url
<br><br>
---
## ::: ultralytics.utils.downloads.delete_dsstore
<br><br>
---
## ::: ultralytics.utils.downloads.zip_directory
<br><br>
---
## ::: ultralytics.utils.downloads.unzip_file
<br><br>
---
## ::: ultralytics.utils.downloads.check_disk_space
<br><br>
---
## ::: ultralytics.utils.downloads.get_google_drive_file_info
<br><br>
---
## ::: ultralytics.utils.downloads.safe_download
<br><br>
---
## ::: ultralytics.utils.downloads.get_github_assets
<br><br>
---
## ::: ultralytics.utils.downloads.attempt_download_asset
<br><br>
---
## ::: ultralytics.utils.downloads.download
<br><br>

6
docs/en/reference/utils/errors.md
View file

@ -9,6 +9,8 @@ keywords: Ultralytics, HUBModelError, Machine Learning, Error troubleshooting, U
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 🙏!
---
## ::: ultralytics.utils.errors.HUBModelError
<br><br>
## ::: ultralytics.utils.errors.HUBModelError
<br><br>

16
docs/en/reference/utils/files.md
View file

@ -9,30 +9,32 @@ keywords: Ultralytics, utility functions, file operations, working directory, fi
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>
## ::: ultralytics.utils.files.WorkingDirectory
<br><br>
---
## ::: ultralytics.utils.files.spaces_in_path
<br><br>
---
## ::: ultralytics.utils.files.increment_path
<br><br>
---
## ::: ultralytics.utils.files.file_age
<br><br>
---
## ::: ultralytics.utils.files.file_date
<br><br>
---
## ::: ultralytics.utils.files.file_size
<br><br>
---
## ::: ultralytics.utils.files.get_latest_run
<br><br>

8
docs/en/reference/utils/instance.md
View file

@ -9,14 +9,16 @@ keywords: Ultralytics, Bboxes, _ntuple, utility, ultralytics utils.instance
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>
## ::: ultralytics.utils.instance.Bboxes
<br><br>
---
## ::: ultralytics.utils.instance.Instances
<br><br>
---
## ::: ultralytics.utils.instance._ntuple
<br><br>

18
docs/en/reference/utils/loss.md
View file

@ -9,34 +9,36 @@ keywords: Ultralytics, Loss functions, VarifocalLoss, BboxLoss, v8DetectionLoss,
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>
## ::: ultralytics.utils.loss.VarifocalLoss
<br><br>
---
## ::: ultralytics.utils.loss.FocalLoss
<br><br>
---
## ::: ultralytics.utils.loss.BboxLoss
<br><br>
---
## ::: ultralytics.utils.loss.KeypointLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8DetectionLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8SegmentationLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8PoseLoss
<br><br>
---
## ::: ultralytics.utils.loss.v8ClassificationLoss
<br><br>

36
docs/en/reference/utils/metrics.md
View file

@ -9,70 +9,72 @@ keywords: Ultralytics, YOLO, YOLOv3, YOLOv4, metrics, confusion matrix, detectio
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>
## ::: ultralytics.utils.metrics.ConfusionMatrix
<br><br>
---
## ::: ultralytics.utils.metrics.Metric
<br><br>
---
## ::: ultralytics.utils.metrics.DetMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.SegmentMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.PoseMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.ClassifyMetrics
<br><br>
---
## ::: ultralytics.utils.metrics.bbox_ioa
<br><br>
---
## ::: ultralytics.utils.metrics.box_iou
<br><br>
---
## ::: ultralytics.utils.metrics.bbox_iou
<br><br>
---
## ::: ultralytics.utils.metrics.mask_iou
<br><br>
---
## ::: ultralytics.utils.metrics.kpt_iou
<br><br>
---
## ::: ultralytics.utils.metrics.smooth_BCE
<br><br>
---
## ::: ultralytics.utils.metrics.smooth
<br><br>
---
## ::: ultralytics.utils.metrics.plot_pr_curve
<br><br>
---
## ::: ultralytics.utils.metrics.plot_mc_curve
<br><br>
---
## ::: ultralytics.utils.metrics.compute_ap
<br><br>
---
## ::: ultralytics.utils.metrics.ap_per_class
<br><br>

60
docs/en/reference/utils/ops.md
View file

@ -9,118 +9,120 @@ keywords: Ultralytics YOLO, Utility Operations, segment2box, make_divisible, cli
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>
## ::: ultralytics.utils.ops.Profile
<br><br>
---
## ::: ultralytics.utils.ops.segment2box
<br><br>
---
## ::: ultralytics.utils.ops.scale_boxes
<br><br>
---
## ::: ultralytics.utils.ops.make_divisible
<br><br>
---
## ::: ultralytics.utils.ops.non_max_suppression
<br><br>
---
## ::: ultralytics.utils.ops.clip_boxes
<br><br>
---
## ::: ultralytics.utils.ops.clip_coords
<br><br>
---
## ::: ultralytics.utils.ops.scale_image
<br><br>
---
## ::: ultralytics.utils.ops.xyxy2xywh
<br><br>
---
## ::: ultralytics.utils.ops.xywh2xyxy
<br><br>
---
## ::: ultralytics.utils.ops.xywhn2xyxy
<br><br>
---
## ::: ultralytics.utils.ops.xyxy2xywhn
<br><br>
---
## ::: ultralytics.utils.ops.xywh2ltwh
<br><br>
---
## ::: ultralytics.utils.ops.xyxy2ltwh
<br><br>
---
## ::: ultralytics.utils.ops.ltwh2xywh
<br><br>
---
## ::: ultralytics.utils.ops.xyxyxyxy2xywhr
<br><br>
---
## ::: ultralytics.utils.ops.xywhr2xyxyxyxy
<br><br>
---
## ::: ultralytics.utils.ops.ltwh2xyxy
<br><br>
---
## ::: ultralytics.utils.ops.segments2boxes
<br><br>
---
## ::: ultralytics.utils.ops.resample_segments
<br><br>
---
## ::: ultralytics.utils.ops.crop_mask
<br><br>
---
## ::: ultralytics.utils.ops.process_mask_upsample
<br><br>
---
## ::: ultralytics.utils.ops.process_mask
<br><br>
---
## ::: ultralytics.utils.ops.process_mask_native
<br><br>
---
## ::: ultralytics.utils.ops.scale_masks
<br><br>
---
## ::: ultralytics.utils.ops.scale_coords
<br><br>
---
## ::: ultralytics.utils.ops.masks2segments
<br><br>
---
## ::: ultralytics.utils.ops.convert_torch2numpy_batch
<br><br>
---
## ::: ultralytics.utils.ops.clean_str
<br><br>

10
docs/en/reference/utils/patches.md
View file

@ -9,18 +9,20 @@ keywords: Ultralytics, Utils, Patches, imread, imshow, torch_save, image process
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>
## ::: ultralytics.utils.patches.imread
<br><br>
---
## ::: ultralytics.utils.patches.imwrite
<br><br>
---
## ::: ultralytics.utils.patches.imshow
<br><br>
---
## ::: ultralytics.utils.patches.torch_save
<br><br>

22
docs/en/reference/utils/plotting.md
View file

@ -9,42 +9,44 @@ keywords: Ultralytics, plotting, utils, color annotation, label plotting, image
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>
## ::: ultralytics.utils.plotting.Colors
<br><br>
---
## ::: ultralytics.utils.plotting.Annotator
<br><br>
---
## ::: ultralytics.utils.plotting.plot_labels
<br><br>
---
## ::: ultralytics.utils.plotting.save_one_box
<br><br>
---
## ::: ultralytics.utils.plotting.plot_images
<br><br>
---
## ::: ultralytics.utils.plotting.plot_results
<br><br>
---
## ::: ultralytics.utils.plotting.plt_color_scatter
<br><br>
---
## ::: ultralytics.utils.plotting.plot_tune_results
<br><br>
---
## ::: ultralytics.utils.plotting.output_to_target
<br><br>
---
## ::: ultralytics.utils.plotting.feature_visualization
<br><br>

14
docs/en/reference/utils/tal.md
View file

@ -9,26 +9,28 @@ keywords: Ultralytics, task aligned assigner, select highest overlaps, make anch
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>
## ::: ultralytics.utils.tal.TaskAlignedAssigner
<br><br>
---
## ::: ultralytics.utils.tal.select_candidates_in_gts
<br><br>
---
## ::: ultralytics.utils.tal.select_highest_overlaps
<br><br>
---
## ::: ultralytics.utils.tal.make_anchors
<br><br>
---
## ::: ultralytics.utils.tal.dist2bbox
<br><br>
---
## ::: ultralytics.utils.tal.bbox2dist
<br><br>

56
docs/en/reference/utils/torch_utils.md
View file

@ -9,110 +9,112 @@ keywords: Ultralytics, Torch Utils, Model EMA, Early Stopping, Smart Inference,
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>
## ::: ultralytics.utils.torch_utils.ModelEMA
<br><br>
---
## ::: ultralytics.utils.torch_utils.EarlyStopping
<br><br>
---
## ::: ultralytics.utils.torch_utils.torch_distributed_zero_first
<br><br>
---
## ::: ultralytics.utils.torch_utils.smart_inference_mode
<br><br>
---
## ::: ultralytics.utils.torch_utils.get_cpu_info
<br><br>
---
## ::: ultralytics.utils.torch_utils.select_device
<br><br>
---
## ::: ultralytics.utils.torch_utils.time_sync
<br><br>
---
## ::: ultralytics.utils.torch_utils.fuse_conv_and_bn
<br><br>
---
## ::: ultralytics.utils.torch_utils.fuse_deconv_and_bn
<br><br>
---
## ::: ultralytics.utils.torch_utils.model_info
<br><br>
---
## ::: ultralytics.utils.torch_utils.get_num_params
<br><br>
---
## ::: ultralytics.utils.torch_utils.get_num_gradients
<br><br>
---
## ::: ultralytics.utils.torch_utils.model_info_for_loggers
<br><br>
---
## ::: ultralytics.utils.torch_utils.get_flops
<br><br>
---
## ::: ultralytics.utils.torch_utils.get_flops_with_torch_profiler
<br><br>
---
## ::: ultralytics.utils.torch_utils.initialize_weights
<br><br>
---
## ::: ultralytics.utils.torch_utils.scale_img
<br><br>
---
## ::: ultralytics.utils.torch_utils.make_divisible
<br><br>
---
## ::: ultralytics.utils.torch_utils.copy_attr
<br><br>
---
## ::: ultralytics.utils.torch_utils.get_latest_opset
<br><br>
---
## ::: ultralytics.utils.torch_utils.intersect_dicts
<br><br>
---
## ::: ultralytics.utils.torch_utils.is_parallel
<br><br>
---
## ::: ultralytics.utils.torch_utils.de_parallel
<br><br>
---
## ::: ultralytics.utils.torch_utils.one_cycle
<br><br>
---
## ::: ultralytics.utils.torch_utils.init_seeds
<br><br>
---
## ::: ultralytics.utils.torch_utils.strip_optimizer
<br><br>
---
## ::: ultralytics.utils.torch_utils.profile
<br><br>

6
docs/en/reference/utils/triton.md
View file

@ -9,6 +9,8 @@ keywords: Ultralytics, YOLO, TritonRemoteModel, machine learning, model serving,
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 🙏!
---
## ::: ultralytics.utils.triton.TritonRemoteModel
<br><br>
## ::: ultralytics.utils.triton.TritonRemoteModel
<br><br>

6
docs/en/reference/utils/tuner.md
View file

@ -9,6 +9,8 @@ keywords: Ultralytics, run_ray_tune, machine learning tuning, machine learning e
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 🙏!
---
## ::: ultralytics.utils.tuner.run_ray_tune
<br><br>
## ::: ultralytics.utils.tuner.run_ray_tune
<br><br>