ultralytics 8.0.136 refactor and simplify package (#3748)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Laughing
GitHub
169
docs/reference/utils/__init__.md
Normal file
169
docs/reference/utils/__init__.md
Normal file
@ -0,0 +1,169 @@
|
||||
## SimpleClass
|
||||
---
|
||||
### ::: ultralytics.utils.SimpleClass
|
||||
<br><br>
|
||||
|
||||
## IterableSimpleNamespace
|
||||
---
|
||||
### ::: ultralytics.utils.IterableSimpleNamespace
|
||||
<br><br>
|
||||
|
||||
## EmojiFilter
|
||||
---
|
||||
### ::: ultralytics.utils.EmojiFilter
|
||||
<br><br>
|
||||
|
||||
## ThreadingLocked
|
||||
---
|
||||
### ::: ultralytics.utils.ThreadingLocked
|
||||
<br><br>
|
||||
|
||||
## TryExcept
|
||||
---
|
||||
### ::: ultralytics.utils.TryExcept
|
||||
<br><br>
|
||||
|
||||
## plt_settings
|
||||
---
|
||||
### ::: ultralytics.utils.plt_settings
|
||||
<br><br>
|
||||
|
||||
## set_logging
|
||||
---
|
||||
### ::: ultralytics.utils.set_logging
|
||||
<br><br>
|
||||
|
||||
## emojis
|
||||
---
|
||||
### ::: ultralytics.utils.emojis
|
||||
<br><br>
|
||||
|
||||
## yaml_save
|
||||
---
|
||||
### ::: ultralytics.utils.yaml_save
|
||||
<br><br>
|
||||
|
||||
## yaml_load
|
||||
---
|
||||
### ::: ultralytics.utils.yaml_load
|
||||
<br><br>
|
||||
|
||||
## yaml_print
|
||||
---
|
||||
### ::: ultralytics.utils.yaml_print
|
||||
<br><br>
|
||||
|
||||
## is_colab
|
||||
---
|
||||
### ::: ultralytics.utils.is_colab
|
||||
<br><br>
|
||||
|
||||
## is_kaggle
|
||||
---
|
||||
### ::: ultralytics.utils.is_kaggle
|
||||
<br><br>
|
||||
|
||||
## is_jupyter
|
||||
---
|
||||
### ::: ultralytics.utils.is_jupyter
|
||||
<br><br>
|
||||
|
||||
## is_docker
|
||||
---
|
||||
### ::: ultralytics.utils.is_docker
|
||||
<br><br>
|
||||
|
||||
## is_online
|
||||
---
|
||||
### ::: ultralytics.utils.is_online
|
||||
<br><br>
|
||||
|
||||
## is_pip_package
|
||||
---
|
||||
### ::: ultralytics.utils.is_pip_package
|
||||
<br><br>
|
||||
|
||||
## is_dir_writeable
|
||||
---
|
||||
### ::: ultralytics.utils.is_dir_writeable
|
||||
<br><br>
|
||||
|
||||
## is_pytest_running
|
||||
---
|
||||
### ::: ultralytics.utils.is_pytest_running
|
||||
<br><br>
|
||||
|
||||
## is_github_actions_ci
|
||||
---
|
||||
### ::: ultralytics.utils.is_github_actions_ci
|
||||
<br><br>
|
||||
|
||||
## is_git_dir
|
||||
---
|
||||
### ::: ultralytics.utils.is_git_dir
|
||||
<br><br>
|
||||
|
||||
## get_git_dir
|
||||
---
|
||||
### ::: ultralytics.utils.get_git_dir
|
||||
<br><br>
|
||||
|
||||
## get_git_origin_url
|
||||
---
|
||||
### ::: ultralytics.utils.get_git_origin_url
|
||||
<br><br>
|
||||
|
||||
## get_git_branch
|
||||
---
|
||||
### ::: ultralytics.utils.get_git_branch
|
||||
<br><br>
|
||||
|
||||
## get_default_args
|
||||
---
|
||||
### ::: ultralytics.utils.get_default_args
|
||||
<br><br>
|
||||
|
||||
## get_user_config_dir
|
||||
---
|
||||
### ::: ultralytics.utils.get_user_config_dir
|
||||
<br><br>
|
||||
|
||||
## colorstr
|
||||
---
|
||||
### ::: ultralytics.utils.colorstr
|
||||
<br><br>
|
||||
|
||||
## threaded
|
||||
---
|
||||
### ::: ultralytics.utils.threaded
|
||||
<br><br>
|
||||
|
||||
## set_sentry
|
||||
---
|
||||
### ::: ultralytics.utils.set_sentry
|
||||
<br><br>
|
||||
|
||||
## get_settings
|
||||
---
|
||||
### ::: ultralytics.utils.get_settings
|
||||
<br><br>
|
||||
|
||||
## set_settings
|
||||
---
|
||||
### ::: ultralytics.utils.set_settings
|
||||
<br><br>
|
||||
|
||||
## deprecation_warn
|
||||
---
|
||||
### ::: ultralytics.utils.deprecation_warn
|
||||
<br><br>
|
||||
|
||||
## clean_url
|
||||
---
|
||||
### ::: ultralytics.utils.clean_url
|
||||
<br><br>
|
||||
|
||||
## url2file
|
||||
---
|
||||
### ::: ultralytics.utils.url2file
|
||||
<br><br>
|
||||
9
docs/reference/utils/autobatch.md
Normal file
9
docs/reference/utils/autobatch.md
Normal file
@ -0,0 +1,9 @@
|
||||
## check_train_batch_size
|
||||
---
|
||||
### ::: ultralytics.utils.autobatch.check_train_batch_size
|
||||
<br><br>
|
||||
|
||||
## autobatch
|
||||
---
|
||||
### ::: ultralytics.utils.autobatch.autobatch
|
||||
<br><br>
|
||||
9
docs/reference/utils/benchmarks.md
Normal file
9
docs/reference/utils/benchmarks.md
Normal file
@ -0,0 +1,9 @@
|
||||
## ProfileModels
|
||||
---
|
||||
### ::: ultralytics.utils.benchmarks.ProfileModels
|
||||
<br><br>
|
||||
|
||||
## benchmark
|
||||
---
|
||||
### ::: ultralytics.utils.benchmarks.benchmark
|
||||
<br><br>
|
||||
134
docs/reference/utils/callbacks/base.md
Normal file
134
docs/reference/utils/callbacks/base.md
Normal file
@ -0,0 +1,134 @@
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_train_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_epoch_start
|
||||
<br><br>
|
||||
|
||||
## on_train_batch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_batch_start
|
||||
<br><br>
|
||||
|
||||
## optimizer_step
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.optimizer_step
|
||||
<br><br>
|
||||
|
||||
## on_before_zero_grad
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_before_zero_grad
|
||||
<br><br>
|
||||
|
||||
## on_train_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_model_save
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_model_save
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_train_end
|
||||
<br><br>
|
||||
|
||||
## on_params_update
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_params_update
|
||||
<br><br>
|
||||
|
||||
## teardown
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.teardown
|
||||
<br><br>
|
||||
|
||||
## on_val_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_start
|
||||
<br><br>
|
||||
|
||||
## on_val_batch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_batch_start
|
||||
<br><br>
|
||||
|
||||
## on_val_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_val_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_val_end
|
||||
<br><br>
|
||||
|
||||
## on_predict_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_batch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_batch_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_predict_postprocess_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_postprocess_end
|
||||
<br><br>
|
||||
|
||||
## on_predict_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_predict_end
|
||||
<br><br>
|
||||
|
||||
## on_export_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_export_start
|
||||
<br><br>
|
||||
|
||||
## on_export_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.on_export_end
|
||||
<br><br>
|
||||
|
||||
## get_default_callbacks
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.get_default_callbacks
|
||||
<br><br>
|
||||
|
||||
## add_integration_callbacks
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.base.add_integration_callbacks
|
||||
<br><br>
|
||||
34
docs/reference/utils/callbacks/clearml.md
Normal file
34
docs/reference/utils/callbacks/clearml.md
Normal file
@ -0,0 +1,34 @@
|
||||
## _log_debug_samples
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml._log_debug_samples
|
||||
<br><br>
|
||||
|
||||
## _log_plot
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml._log_plot
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_val_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_val_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.clearml.on_train_end
|
||||
<br><br>
|
||||
119
docs/reference/utils/callbacks/comet.md
Normal file
119
docs/reference/utils/callbacks/comet.md
Normal file
@ -0,0 +1,119 @@
|
||||
## _get_comet_mode
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_comet_mode
|
||||
<br><br>
|
||||
|
||||
## _get_comet_model_name
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_comet_model_name
|
||||
<br><br>
|
||||
|
||||
## _get_eval_batch_logging_interval
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_eval_batch_logging_interval
|
||||
<br><br>
|
||||
|
||||
## _get_max_image_predictions_to_log
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_max_image_predictions_to_log
|
||||
<br><br>
|
||||
|
||||
## _scale_confidence_score
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._scale_confidence_score
|
||||
<br><br>
|
||||
|
||||
## _should_log_confusion_matrix
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._should_log_confusion_matrix
|
||||
<br><br>
|
||||
|
||||
## _should_log_image_predictions
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._should_log_image_predictions
|
||||
<br><br>
|
||||
|
||||
## _get_experiment_type
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._get_experiment_type
|
||||
<br><br>
|
||||
|
||||
## _create_experiment
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._create_experiment
|
||||
<br><br>
|
||||
|
||||
## _fetch_trainer_metadata
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._fetch_trainer_metadata
|
||||
<br><br>
|
||||
|
||||
## _scale_bounding_box_to_original_image_shape
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
|
||||
<br><br>
|
||||
|
||||
## _format_ground_truth_annotations_for_detection
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._format_ground_truth_annotations_for_detection
|
||||
<br><br>
|
||||
|
||||
## _format_prediction_annotations_for_detection
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._format_prediction_annotations_for_detection
|
||||
<br><br>
|
||||
|
||||
## _fetch_annotations
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._fetch_annotations
|
||||
<br><br>
|
||||
|
||||
## _create_prediction_metadata_map
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._create_prediction_metadata_map
|
||||
<br><br>
|
||||
|
||||
## _log_confusion_matrix
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_confusion_matrix
|
||||
<br><br>
|
||||
|
||||
## _log_images
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_images
|
||||
<br><br>
|
||||
|
||||
## _log_image_predictions
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_image_predictions
|
||||
<br><br>
|
||||
|
||||
## _log_plots
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_plots
|
||||
<br><br>
|
||||
|
||||
## _log_model
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet._log_model
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.comet.on_train_end
|
||||
<br><br>
|
||||
49
docs/reference/utils/callbacks/dvc.md
Normal file
49
docs/reference/utils/callbacks/dvc.md
Normal file
@ -0,0 +1,49 @@
|
||||
## _logger_disabled
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._logger_disabled
|
||||
<br><br>
|
||||
|
||||
## _log_images
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._log_images
|
||||
<br><br>
|
||||
|
||||
## _log_plots
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._log_plots
|
||||
<br><br>
|
||||
|
||||
## _log_confusion_matrix
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc._log_confusion_matrix
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_train_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_train_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_train_epoch_start
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.dvc.on_train_end
|
||||
<br><br>
|
||||
39
docs/reference/utils/callbacks/hub.md
Normal file
39
docs/reference/utils/callbacks/hub.md
Normal file
@ -0,0 +1,39 @@
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_model_save
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_model_save
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_train_end
|
||||
<br><br>
|
||||
|
||||
## on_train_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_train_start
|
||||
<br><br>
|
||||
|
||||
## on_val_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_val_start
|
||||
<br><br>
|
||||
|
||||
## on_predict_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_predict_start
|
||||
<br><br>
|
||||
|
||||
## on_export_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.hub.on_export_start
|
||||
<br><br>
|
||||
14
docs/reference/utils/callbacks/mlflow.md
Normal file
14
docs/reference/utils/callbacks/mlflow.md
Normal file
@ -0,0 +1,14 @@
|
||||
## on_pretrain_routine_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.mlflow.on_pretrain_routine_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.mlflow.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.mlflow.on_train_end
|
||||
<br><br>
|
||||
39
docs/reference/utils/callbacks/neptune.md
Normal file
39
docs/reference/utils/callbacks/neptune.md
Normal file
@ -0,0 +1,39 @@
|
||||
## _log_scalars
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune._log_scalars
|
||||
<br><br>
|
||||
|
||||
## _log_images
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune._log_images
|
||||
<br><br>
|
||||
|
||||
## _log_plot
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune._log_plot
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_val_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_val_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.neptune.on_train_end
|
||||
<br><br>
|
||||
4
docs/reference/utils/callbacks/raytune.md
Normal file
4
docs/reference/utils/callbacks/raytune.md
Normal file
@ -0,0 +1,4 @@
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.raytune.on_fit_epoch_end
|
||||
<br><br>
|
||||
19
docs/reference/utils/callbacks/tensorboard.md
Normal file
19
docs/reference/utils/callbacks/tensorboard.md
Normal file
@ -0,0 +1,19 @@
|
||||
## _log_scalars
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard._log_scalars
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_batch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard.on_batch_end
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.tensorboard.on_fit_epoch_end
|
||||
<br><br>
|
||||
24
docs/reference/utils/callbacks/wb.md
Normal file
24
docs/reference/utils/callbacks/wb.md
Normal file
@ -0,0 +1,24 @@
|
||||
## _log_plots
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb._log_plots
|
||||
<br><br>
|
||||
|
||||
## on_pretrain_routine_start
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_pretrain_routine_start
|
||||
<br><br>
|
||||
|
||||
## on_fit_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_fit_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_epoch_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_train_epoch_end
|
||||
<br><br>
|
||||
|
||||
## on_train_end
|
||||
---
|
||||
### ::: ultralytics.utils.callbacks.wb.on_train_end
|
||||
<br><br>
|
||||
89
docs/reference/utils/checks.md
Normal file
89
docs/reference/utils/checks.md
Normal file
@ -0,0 +1,89 @@
|
||||
## is_ascii
|
||||
---
|
||||
### ::: ultralytics.utils.checks.is_ascii
|
||||
<br><br>
|
||||
|
||||
## check_imgsz
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_imgsz
|
||||
<br><br>
|
||||
|
||||
## check_version
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_version
|
||||
<br><br>
|
||||
|
||||
## check_latest_pypi_version
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_latest_pypi_version
|
||||
<br><br>
|
||||
|
||||
## check_pip_update_available
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_pip_update_available
|
||||
<br><br>
|
||||
|
||||
## check_font
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_font
|
||||
<br><br>
|
||||
|
||||
## check_python
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_python
|
||||
<br><br>
|
||||
|
||||
## check_requirements
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_requirements
|
||||
<br><br>
|
||||
|
||||
## check_torchvision
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_torchvision
|
||||
<br><br>
|
||||
|
||||
## check_suffix
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_suffix
|
||||
<br><br>
|
||||
|
||||
## check_yolov5u_filename
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_yolov5u_filename
|
||||
<br><br>
|
||||
|
||||
## check_file
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_file
|
||||
<br><br>
|
||||
|
||||
## check_yaml
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_yaml
|
||||
<br><br>
|
||||
|
||||
## check_imshow
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_imshow
|
||||
<br><br>
|
||||
|
||||
## check_yolo
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_yolo
|
||||
<br><br>
|
||||
|
||||
## check_amp
|
||||
---
|
||||
### ::: ultralytics.utils.checks.check_amp
|
||||
<br><br>
|
||||
|
||||
## git_describe
|
||||
---
|
||||
### ::: ultralytics.utils.checks.git_describe
|
||||
<br><br>
|
||||
|
||||
## print_args
|
||||
---
|
||||
### ::: ultralytics.utils.checks.print_args
|
||||
<br><br>
|
||||
19
docs/reference/utils/dist.md
Normal file
19
docs/reference/utils/dist.md
Normal file
@ -0,0 +1,19 @@
|
||||
## find_free_network_port
|
||||
---
|
||||
### ::: ultralytics.utils.dist.find_free_network_port
|
||||
<br><br>
|
||||
|
||||
## generate_ddp_file
|
||||
---
|
||||
### ::: ultralytics.utils.dist.generate_ddp_file
|
||||
<br><br>
|
||||
|
||||
## generate_ddp_command
|
||||
---
|
||||
### ::: ultralytics.utils.dist.generate_ddp_command
|
||||
<br><br>
|
||||
|
||||
## ddp_cleanup
|
||||
---
|
||||
### ::: ultralytics.utils.dist.ddp_cleanup
|
||||
<br><br>
|
||||
34
docs/reference/utils/downloads.md
Normal file
34
docs/reference/utils/downloads.md
Normal file
@ -0,0 +1,34 @@
|
||||
## is_url
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.is_url
|
||||
<br><br>
|
||||
|
||||
## unzip_file
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.unzip_file
|
||||
<br><br>
|
||||
|
||||
## check_disk_space
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.check_disk_space
|
||||
<br><br>
|
||||
|
||||
## safe_download
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.safe_download
|
||||
<br><br>
|
||||
|
||||
## get_github_assets
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.get_github_assets
|
||||
<br><br>
|
||||
|
||||
## attempt_download_asset
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.attempt_download_asset
|
||||
<br><br>
|
||||
|
||||
## download
|
||||
---
|
||||
### ::: ultralytics.utils.downloads.download
|
||||
<br><br>
|
||||
4
docs/reference/utils/errors.md
Normal file
4
docs/reference/utils/errors.md
Normal file
@ -0,0 +1,4 @@
|
||||
## HUBModelError
|
||||
---
|
||||
### ::: ultralytics.utils.errors.HUBModelError
|
||||
<br><br>
|
||||
34
docs/reference/utils/files.md
Normal file
34
docs/reference/utils/files.md
Normal file
@ -0,0 +1,34 @@
|
||||
## WorkingDirectory
|
||||
---
|
||||
### ::: ultralytics.utils.files.WorkingDirectory
|
||||
<br><br>
|
||||
|
||||
## increment_path
|
||||
---
|
||||
### ::: ultralytics.utils.files.increment_path
|
||||
<br><br>
|
||||
|
||||
## file_age
|
||||
---
|
||||
### ::: ultralytics.utils.files.file_age
|
||||
<br><br>
|
||||
|
||||
## file_date
|
||||
---
|
||||
### ::: ultralytics.utils.files.file_date
|
||||
<br><br>
|
||||
|
||||
## file_size
|
||||
---
|
||||
### ::: ultralytics.utils.files.file_size
|
||||
<br><br>
|
||||
|
||||
## get_latest_run
|
||||
---
|
||||
### ::: ultralytics.utils.files.get_latest_run
|
||||
<br><br>
|
||||
|
||||
## make_dirs
|
||||
---
|
||||
### ::: ultralytics.utils.files.make_dirs
|
||||
<br><br>
|
||||
14
docs/reference/utils/instance.md
Normal file
14
docs/reference/utils/instance.md
Normal file
@ -0,0 +1,14 @@
|
||||
## Bboxes
|
||||
---
|
||||
### ::: ultralytics.utils.instance.Bboxes
|
||||
<br><br>
|
||||
|
||||
## Instances
|
||||
---
|
||||
### ::: ultralytics.utils.instance.Instances
|
||||
<br><br>
|
||||
|
||||
## _ntuple
|
||||
---
|
||||
### ::: ultralytics.utils.instance._ntuple
|
||||
<br><br>
|
||||
39
docs/reference/utils/loss.md
Normal file
39
docs/reference/utils/loss.md
Normal file
@ -0,0 +1,39 @@
|
||||
## VarifocalLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.VarifocalLoss
|
||||
<br><br>
|
||||
|
||||
## FocalLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.FocalLoss
|
||||
<br><br>
|
||||
|
||||
## BboxLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.BboxLoss
|
||||
<br><br>
|
||||
|
||||
## KeypointLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.KeypointLoss
|
||||
<br><br>
|
||||
|
||||
## v8DetectionLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8DetectionLoss
|
||||
<br><br>
|
||||
|
||||
## v8SegmentationLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8SegmentationLoss
|
||||
<br><br>
|
||||
|
||||
## v8PoseLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8PoseLoss
|
||||
<br><br>
|
||||
|
||||
## v8ClassificationLoss
|
||||
---
|
||||
### ::: ultralytics.utils.loss.v8ClassificationLoss
|
||||
<br><br>
|
||||
89
docs/reference/utils/metrics.md
Normal file
89
docs/reference/utils/metrics.md
Normal file
@ -0,0 +1,89 @@
|
||||
## ConfusionMatrix
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.ConfusionMatrix
|
||||
<br><br>
|
||||
|
||||
## Metric
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.Metric
|
||||
<br><br>
|
||||
|
||||
## DetMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.DetMetrics
|
||||
<br><br>
|
||||
|
||||
## SegmentMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.SegmentMetrics
|
||||
<br><br>
|
||||
|
||||
## PoseMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.PoseMetrics
|
||||
<br><br>
|
||||
|
||||
## ClassifyMetrics
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.ClassifyMetrics
|
||||
<br><br>
|
||||
|
||||
## box_area
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.box_area
|
||||
<br><br>
|
||||
|
||||
## bbox_ioa
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.bbox_ioa
|
||||
<br><br>
|
||||
|
||||
## box_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.box_iou
|
||||
<br><br>
|
||||
|
||||
## bbox_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.bbox_iou
|
||||
<br><br>
|
||||
|
||||
## mask_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.mask_iou
|
||||
<br><br>
|
||||
|
||||
## kpt_iou
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.kpt_iou
|
||||
<br><br>
|
||||
|
||||
## smooth_BCE
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.smooth_BCE
|
||||
<br><br>
|
||||
|
||||
## smooth
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.smooth
|
||||
<br><br>
|
||||
|
||||
## plot_pr_curve
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.plot_pr_curve
|
||||
<br><br>
|
||||
|
||||
## plot_mc_curve
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.plot_mc_curve
|
||||
<br><br>
|
||||
|
||||
## compute_ap
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.compute_ap
|
||||
<br><br>
|
||||
|
||||
## ap_per_class
|
||||
---
|
||||
### ::: ultralytics.utils.metrics.ap_per_class
|
||||
<br><br>
|
||||
139
docs/reference/utils/ops.md
Normal file
139
docs/reference/utils/ops.md
Normal file
@ -0,0 +1,139 @@
|
||||
## Profile
|
||||
---
|
||||
### ::: ultralytics.utils.ops.Profile
|
||||
<br><br>
|
||||
|
||||
## coco80_to_coco91_class
|
||||
---
|
||||
### ::: ultralytics.utils.ops.coco80_to_coco91_class
|
||||
<br><br>
|
||||
|
||||
## segment2box
|
||||
---
|
||||
### ::: ultralytics.utils.ops.segment2box
|
||||
<br><br>
|
||||
|
||||
## scale_boxes
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_boxes
|
||||
<br><br>
|
||||
|
||||
## make_divisible
|
||||
---
|
||||
### ::: ultralytics.utils.ops.make_divisible
|
||||
<br><br>
|
||||
|
||||
## non_max_suppression
|
||||
---
|
||||
### ::: ultralytics.utils.ops.non_max_suppression
|
||||
<br><br>
|
||||
|
||||
## clip_boxes
|
||||
---
|
||||
### ::: ultralytics.utils.ops.clip_boxes
|
||||
<br><br>
|
||||
|
||||
## clip_coords
|
||||
---
|
||||
### ::: ultralytics.utils.ops.clip_coords
|
||||
<br><br>
|
||||
|
||||
## scale_image
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_image
|
||||
<br><br>
|
||||
|
||||
## xyxy2xywh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyxy2xywh
|
||||
<br><br>
|
||||
|
||||
## xywh2xyxy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xywh2xyxy
|
||||
<br><br>
|
||||
|
||||
## xywhn2xyxy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xywhn2xyxy
|
||||
<br><br>
|
||||
|
||||
## xyxy2xywhn
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyxy2xywhn
|
||||
<br><br>
|
||||
|
||||
## xyn2xy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyn2xy
|
||||
<br><br>
|
||||
|
||||
## xywh2ltwh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xywh2ltwh
|
||||
<br><br>
|
||||
|
||||
## xyxy2ltwh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.xyxy2ltwh
|
||||
<br><br>
|
||||
|
||||
## ltwh2xywh
|
||||
---
|
||||
### ::: ultralytics.utils.ops.ltwh2xywh
|
||||
<br><br>
|
||||
|
||||
## ltwh2xyxy
|
||||
---
|
||||
### ::: ultralytics.utils.ops.ltwh2xyxy
|
||||
<br><br>
|
||||
|
||||
## segments2boxes
|
||||
---
|
||||
### ::: ultralytics.utils.ops.segments2boxes
|
||||
<br><br>
|
||||
|
||||
## resample_segments
|
||||
---
|
||||
### ::: ultralytics.utils.ops.resample_segments
|
||||
<br><br>
|
||||
|
||||
## crop_mask
|
||||
---
|
||||
### ::: ultralytics.utils.ops.crop_mask
|
||||
<br><br>
|
||||
|
||||
## process_mask_upsample
|
||||
---
|
||||
### ::: ultralytics.utils.ops.process_mask_upsample
|
||||
<br><br>
|
||||
|
||||
## process_mask
|
||||
---
|
||||
### ::: ultralytics.utils.ops.process_mask
|
||||
<br><br>
|
||||
|
||||
## process_mask_native
|
||||
---
|
||||
### ::: ultralytics.utils.ops.process_mask_native
|
||||
<br><br>
|
||||
|
||||
## scale_masks
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_masks
|
||||
<br><br>
|
||||
|
||||
## scale_coords
|
||||
---
|
||||
### ::: ultralytics.utils.ops.scale_coords
|
||||
<br><br>
|
||||
|
||||
## masks2segments
|
||||
---
|
||||
### ::: ultralytics.utils.ops.masks2segments
|
||||
<br><br>
|
||||
|
||||
## clean_str
|
||||
---
|
||||
### ::: ultralytics.utils.ops.clean_str
|
||||
<br><br>
|
||||
19
docs/reference/utils/patches.md
Normal file
19
docs/reference/utils/patches.md
Normal file
@ -0,0 +1,19 @@
|
||||
## imread
|
||||
---
|
||||
### ::: ultralytics.utils.patches.imread
|
||||
<br><br>
|
||||
|
||||
## imwrite
|
||||
---
|
||||
### ::: ultralytics.utils.patches.imwrite
|
||||
<br><br>
|
||||
|
||||
## imshow
|
||||
---
|
||||
### ::: ultralytics.utils.patches.imshow
|
||||
<br><br>
|
||||
|
||||
## torch_save
|
||||
---
|
||||
### ::: ultralytics.utils.patches.torch_save
|
||||
<br><br>
|
||||
39
docs/reference/utils/plotting.md
Normal file
39
docs/reference/utils/plotting.md
Normal file
@ -0,0 +1,39 @@
|
||||
## Colors
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.Colors
|
||||
<br><br>
|
||||
|
||||
## Annotator
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.Annotator
|
||||
<br><br>
|
||||
|
||||
## plot_labels
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.plot_labels
|
||||
<br><br>
|
||||
|
||||
## save_one_box
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.save_one_box
|
||||
<br><br>
|
||||
|
||||
## plot_images
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.plot_images
|
||||
<br><br>
|
||||
|
||||
## plot_results
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.plot_results
|
||||
<br><br>
|
||||
|
||||
## output_to_target
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.output_to_target
|
||||
<br><br>
|
||||
|
||||
## feature_visualization
|
||||
---
|
||||
### ::: ultralytics.utils.plotting.feature_visualization
|
||||
<br><br>
|
||||
29
docs/reference/utils/tal.md
Normal file
29
docs/reference/utils/tal.md
Normal file
@ -0,0 +1,29 @@
|
||||
## TaskAlignedAssigner
|
||||
---
|
||||
### ::: ultralytics.utils.tal.TaskAlignedAssigner
|
||||
<br><br>
|
||||
|
||||
## select_candidates_in_gts
|
||||
---
|
||||
### ::: ultralytics.utils.tal.select_candidates_in_gts
|
||||
<br><br>
|
||||
|
||||
## select_highest_overlaps
|
||||
---
|
||||
### ::: ultralytics.utils.tal.select_highest_overlaps
|
||||
<br><br>
|
||||
|
||||
## make_anchors
|
||||
---
|
||||
### ::: ultralytics.utils.tal.make_anchors
|
||||
<br><br>
|
||||
|
||||
## dist2bbox
|
||||
---
|
||||
### ::: ultralytics.utils.tal.dist2bbox
|
||||
<br><br>
|
||||
|
||||
## bbox2dist
|
||||
---
|
||||
### ::: ultralytics.utils.tal.bbox2dist
|
||||
<br><br>
|
||||
134
docs/reference/utils/torch_utils.md
Normal file
134
docs/reference/utils/torch_utils.md
Normal file
@ -0,0 +1,134 @@
|
||||
## ModelEMA
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.ModelEMA
|
||||
<br><br>
|
||||
|
||||
## EarlyStopping
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.EarlyStopping
|
||||
<br><br>
|
||||
|
||||
## torch_distributed_zero_first
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.torch_distributed_zero_first
|
||||
<br><br>
|
||||
|
||||
## smart_inference_mode
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.smart_inference_mode
|
||||
<br><br>
|
||||
|
||||
## get_cpu_info
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.get_cpu_info
|
||||
<br><br>
|
||||
|
||||
## select_device
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.select_device
|
||||
<br><br>
|
||||
|
||||
## time_sync
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.time_sync
|
||||
<br><br>
|
||||
|
||||
## fuse_conv_and_bn
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.fuse_conv_and_bn
|
||||
<br><br>
|
||||
|
||||
## fuse_deconv_and_bn
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.fuse_deconv_and_bn
|
||||
<br><br>
|
||||
|
||||
## model_info
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.model_info
|
||||
<br><br>
|
||||
|
||||
## get_num_params
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.get_num_params
|
||||
<br><br>
|
||||
|
||||
## get_num_gradients
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.get_num_gradients
|
||||
<br><br>
|
||||
|
||||
## model_info_for_loggers
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.model_info_for_loggers
|
||||
<br><br>
|
||||
|
||||
## get_flops
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.get_flops
|
||||
<br><br>
|
||||
|
||||
## get_flops_with_torch_profiler
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.get_flops_with_torch_profiler
|
||||
<br><br>
|
||||
|
||||
## initialize_weights
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.initialize_weights
|
||||
<br><br>
|
||||
|
||||
## scale_img
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.scale_img
|
||||
<br><br>
|
||||
|
||||
## make_divisible
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.make_divisible
|
||||
<br><br>
|
||||
|
||||
## copy_attr
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.copy_attr
|
||||
<br><br>
|
||||
|
||||
## get_latest_opset
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.get_latest_opset
|
||||
<br><br>
|
||||
|
||||
## intersect_dicts
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.intersect_dicts
|
||||
<br><br>
|
||||
|
||||
## is_parallel
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.is_parallel
|
||||
<br><br>
|
||||
|
||||
## de_parallel
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.de_parallel
|
||||
<br><br>
|
||||
|
||||
## one_cycle
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.one_cycle
|
||||
<br><br>
|
||||
|
||||
## init_seeds
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.init_seeds
|
||||
<br><br>
|
||||
|
||||
## strip_optimizer
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.strip_optimizer
|
||||
<br><br>
|
||||
|
||||
## profile
|
||||
---
|
||||
### ::: ultralytics.utils.torch_utils.profile
|
||||
<br><br>
|
||||
4
docs/reference/utils/tuner.md
Normal file
4
docs/reference/utils/tuner.md
Normal file
@ -0,0 +1,4 @@
|
||||
## run_ray_tune
|
||||
---
|
||||
### ::: ultralytics.utils.tuner.run_ray_tune
|
||||
<br><br>
|
||||
Reference in New Issue
Block a user