ultralytics 8.0.79 expand Docs reference section (#2053)

Co-authored-by: Ayush Chaurasia <ayush.chaurarsia@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Fri3dChicken <87434761+AmoghDhaliwal@users.noreply.github.com>
This commit is contained in:
Glenn Jocher
2023-04-16 12:28:12 +02:00
committed by GitHub
parent 47bd8b433b
commit 31db8ed163
106 changed files with 2570 additions and 529 deletions

View File

@ -0,0 +1,9 @@
# check_train_batch_size
---
:::ultralytics.yolo.utils.autobatch.check_train_batch_size
<br><br>
# autobatch
---
:::ultralytics.yolo.utils.autobatch.autobatch
<br><br>

View File

@ -0,0 +1,4 @@
# benchmark
---
:::ultralytics.yolo.utils.benchmarks.benchmark
<br><br>

View File

@ -0,0 +1,134 @@
# on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_start
<br><br>
# on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.base.on_pretrain_routine_end
<br><br>
# on_train_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_start
<br><br>
# on_train_epoch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_epoch_start
<br><br>
# on_train_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_train_batch_start
<br><br>
# optimizer_step
---
:::ultralytics.yolo.utils.callbacks.base.optimizer_step
<br><br>
# on_before_zero_grad
---
:::ultralytics.yolo.utils.callbacks.base.on_before_zero_grad
<br><br>
# on_train_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_batch_end
<br><br>
# on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_epoch_end
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_fit_epoch_end
<br><br>
# on_model_save
---
:::ultralytics.yolo.utils.callbacks.base.on_model_save
<br><br>
# on_train_end
---
:::ultralytics.yolo.utils.callbacks.base.on_train_end
<br><br>
# on_params_update
---
:::ultralytics.yolo.utils.callbacks.base.on_params_update
<br><br>
# teardown
---
:::ultralytics.yolo.utils.callbacks.base.teardown
<br><br>
# on_val_start
---
:::ultralytics.yolo.utils.callbacks.base.on_val_start
<br><br>
# on_val_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_val_batch_start
<br><br>
# on_val_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_val_batch_end
<br><br>
# on_val_end
---
:::ultralytics.yolo.utils.callbacks.base.on_val_end
<br><br>
# on_predict_start
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_start
<br><br>
# on_predict_batch_start
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_batch_start
<br><br>
# on_predict_batch_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_batch_end
<br><br>
# on_predict_postprocess_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_postprocess_end
<br><br>
# on_predict_end
---
:::ultralytics.yolo.utils.callbacks.base.on_predict_end
<br><br>
# on_export_start
---
:::ultralytics.yolo.utils.callbacks.base.on_export_start
<br><br>
# on_export_end
---
:::ultralytics.yolo.utils.callbacks.base.on_export_end
<br><br>
# get_default_callbacks
---
:::ultralytics.yolo.utils.callbacks.base.get_default_callbacks
<br><br>
# add_integration_callbacks
---
:::ultralytics.yolo.utils.callbacks.base.add_integration_callbacks
<br><br>

View File

@ -0,0 +1,34 @@
# _log_debug_samples
---
:::ultralytics.yolo.utils.callbacks.clearml._log_debug_samples
<br><br>
# _log_plot
---
:::ultralytics.yolo.utils.callbacks.clearml._log_plot
<br><br>
# on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.clearml.on_pretrain_routine_start
<br><br>
# on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_train_epoch_end
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_fit_epoch_end
<br><br>
# on_val_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_val_end
<br><br>
# on_train_end
---
:::ultralytics.yolo.utils.callbacks.clearml.on_train_end
<br><br>

View File

@ -0,0 +1,84 @@
# _get_experiment_type
---
:::ultralytics.yolo.utils.callbacks.comet._get_experiment_type
<br><br>
# _create_experiment
---
:::ultralytics.yolo.utils.callbacks.comet._create_experiment
<br><br>
# _fetch_trainer_metadata
---
:::ultralytics.yolo.utils.callbacks.comet._fetch_trainer_metadata
<br><br>
# _scale_bounding_box_to_original_image_shape
---
:::ultralytics.yolo.utils.callbacks.comet._scale_bounding_box_to_original_image_shape
<br><br>
# _format_ground_truth_annotations_for_detection
---
:::ultralytics.yolo.utils.callbacks.comet._format_ground_truth_annotations_for_detection
<br><br>
# _format_prediction_annotations_for_detection
---
:::ultralytics.yolo.utils.callbacks.comet._format_prediction_annotations_for_detection
<br><br>
# _fetch_annotations
---
:::ultralytics.yolo.utils.callbacks.comet._fetch_annotations
<br><br>
# _create_prediction_metadata_map
---
:::ultralytics.yolo.utils.callbacks.comet._create_prediction_metadata_map
<br><br>
# _log_confusion_matrix
---
:::ultralytics.yolo.utils.callbacks.comet._log_confusion_matrix
<br><br>
# _log_images
---
:::ultralytics.yolo.utils.callbacks.comet._log_images
<br><br>
# _log_image_predictions
---
:::ultralytics.yolo.utils.callbacks.comet._log_image_predictions
<br><br>
# _log_plots
---
:::ultralytics.yolo.utils.callbacks.comet._log_plots
<br><br>
# _log_model
---
:::ultralytics.yolo.utils.callbacks.comet._log_model
<br><br>
# on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.comet.on_pretrain_routine_start
<br><br>
# on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.comet.on_train_epoch_end
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.comet.on_fit_epoch_end
<br><br>
# on_train_end
---
:::ultralytics.yolo.utils.callbacks.comet.on_train_end
<br><br>

View File

@ -0,0 +1,39 @@
# on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.hub.on_pretrain_routine_end
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.hub.on_fit_epoch_end
<br><br>
# on_model_save
---
:::ultralytics.yolo.utils.callbacks.hub.on_model_save
<br><br>
# on_train_end
---
:::ultralytics.yolo.utils.callbacks.hub.on_train_end
<br><br>
# on_train_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_train_start
<br><br>
# on_val_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_val_start
<br><br>
# on_predict_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_predict_start
<br><br>
# on_export_start
---
:::ultralytics.yolo.utils.callbacks.hub.on_export_start
<br><br>

View File

@ -0,0 +1,19 @@
# on_pretrain_routine_end
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_pretrain_routine_end
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_fit_epoch_end
<br><br>
# on_model_save
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_model_save
<br><br>
# on_train_end
---
:::ultralytics.yolo.utils.callbacks.mlflow.on_train_end
<br><br>

View File

@ -0,0 +1,4 @@
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.raytune.on_fit_epoch_end
<br><br>

View File

@ -0,0 +1,19 @@
# _log_scalars
---
:::ultralytics.yolo.utils.callbacks.tensorboard._log_scalars
<br><br>
# on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.tensorboard.on_pretrain_routine_start
<br><br>
# on_batch_end
---
:::ultralytics.yolo.utils.callbacks.tensorboard.on_batch_end
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.tensorboard.on_fit_epoch_end
<br><br>

View File

@ -0,0 +1,19 @@
# on_pretrain_routine_start
---
:::ultralytics.yolo.utils.callbacks.wb.on_pretrain_routine_start
<br><br>
# on_fit_epoch_end
---
:::ultralytics.yolo.utils.callbacks.wb.on_fit_epoch_end
<br><br>
# on_train_epoch_end
---
:::ultralytics.yolo.utils.callbacks.wb.on_train_epoch_end
<br><br>
# on_train_end
---
:::ultralytics.yolo.utils.callbacks.wb.on_train_end
<br><br>

View File

@ -0,0 +1,79 @@
# is_ascii
---
:::ultralytics.yolo.utils.checks.is_ascii
<br><br>
# check_imgsz
---
:::ultralytics.yolo.utils.checks.check_imgsz
<br><br>
# check_version
---
:::ultralytics.yolo.utils.checks.check_version
<br><br>
# check_latest_pypi_version
---
:::ultralytics.yolo.utils.checks.check_latest_pypi_version
<br><br>
# check_pip_update_available
---
:::ultralytics.yolo.utils.checks.check_pip_update_available
<br><br>
# check_font
---
:::ultralytics.yolo.utils.checks.check_font
<br><br>
# check_python
---
:::ultralytics.yolo.utils.checks.check_python
<br><br>
# check_requirements
---
:::ultralytics.yolo.utils.checks.check_requirements
<br><br>
# check_suffix
---
:::ultralytics.yolo.utils.checks.check_suffix
<br><br>
# check_yolov5u_filename
---
:::ultralytics.yolo.utils.checks.check_yolov5u_filename
<br><br>
# check_file
---
:::ultralytics.yolo.utils.checks.check_file
<br><br>
# check_yaml
---
:::ultralytics.yolo.utils.checks.check_yaml
<br><br>
# check_imshow
---
:::ultralytics.yolo.utils.checks.check_imshow
<br><br>
# check_yolo
---
:::ultralytics.yolo.utils.checks.check_yolo
<br><br>
# git_describe
---
:::ultralytics.yolo.utils.checks.git_describe
<br><br>
# print_args
---
:::ultralytics.yolo.utils.checks.print_args
<br><br>

View File

@ -0,0 +1,19 @@
# find_free_network_port
---
:::ultralytics.yolo.utils.dist.find_free_network_port
<br><br>
# generate_ddp_file
---
:::ultralytics.yolo.utils.dist.generate_ddp_file
<br><br>
# generate_ddp_command
---
:::ultralytics.yolo.utils.dist.generate_ddp_command
<br><br>
# ddp_cleanup
---
:::ultralytics.yolo.utils.dist.ddp_cleanup
<br><br>

View File

@ -0,0 +1,24 @@
# is_url
---
:::ultralytics.yolo.utils.downloads.is_url
<br><br>
# unzip_file
---
:::ultralytics.yolo.utils.downloads.unzip_file
<br><br>
# safe_download
---
:::ultralytics.yolo.utils.downloads.safe_download
<br><br>
# attempt_download_asset
---
:::ultralytics.yolo.utils.downloads.attempt_download_asset
<br><br>
# download
---
:::ultralytics.yolo.utils.downloads.download
<br><br>

View File

@ -0,0 +1,4 @@
# HUBModelError
---
:::ultralytics.yolo.utils.errors.HUBModelError
<br><br>

View File

@ -0,0 +1,29 @@
# WorkingDirectory
---
:::ultralytics.yolo.utils.files.WorkingDirectory
<br><br>
# increment_path
---
:::ultralytics.yolo.utils.files.increment_path
<br><br>
# file_age
---
:::ultralytics.yolo.utils.files.file_age
<br><br>
# file_date
---
:::ultralytics.yolo.utils.files.file_date
<br><br>
# file_size
---
:::ultralytics.yolo.utils.files.file_size
<br><br>
# get_latest_run
---
:::ultralytics.yolo.utils.files.get_latest_run
<br><br>

View File

@ -0,0 +1,14 @@
# Bboxes
---
:::ultralytics.yolo.utils.instance.Bboxes
<br><br>
# Instances
---
:::ultralytics.yolo.utils.instance.Instances
<br><br>
# _ntuple
---
:::ultralytics.yolo.utils.instance._ntuple
<br><br>

View File

@ -0,0 +1,14 @@
# VarifocalLoss
---
:::ultralytics.yolo.utils.loss.VarifocalLoss
<br><br>
# BboxLoss
---
:::ultralytics.yolo.utils.loss.BboxLoss
<br><br>
# KeypointLoss
---
:::ultralytics.yolo.utils.loss.KeypointLoss
<br><br>

View File

@ -0,0 +1,94 @@
# FocalLoss
---
:::ultralytics.yolo.utils.metrics.FocalLoss
<br><br>
# ConfusionMatrix
---
:::ultralytics.yolo.utils.metrics.ConfusionMatrix
<br><br>
# Metric
---
:::ultralytics.yolo.utils.metrics.Metric
<br><br>
# DetMetrics
---
:::ultralytics.yolo.utils.metrics.DetMetrics
<br><br>
# SegmentMetrics
---
:::ultralytics.yolo.utils.metrics.SegmentMetrics
<br><br>
# PoseMetrics
---
:::ultralytics.yolo.utils.metrics.PoseMetrics
<br><br>
# ClassifyMetrics
---
:::ultralytics.yolo.utils.metrics.ClassifyMetrics
<br><br>
# box_area
---
:::ultralytics.yolo.utils.metrics.box_area
<br><br>
# bbox_ioa
---
:::ultralytics.yolo.utils.metrics.bbox_ioa
<br><br>
# box_iou
---
:::ultralytics.yolo.utils.metrics.box_iou
<br><br>
# bbox_iou
---
:::ultralytics.yolo.utils.metrics.bbox_iou
<br><br>
# mask_iou
---
:::ultralytics.yolo.utils.metrics.mask_iou
<br><br>
# kpt_iou
---
:::ultralytics.yolo.utils.metrics.kpt_iou
<br><br>
# smooth_BCE
---
:::ultralytics.yolo.utils.metrics.smooth_BCE
<br><br>
# smooth
---
:::ultralytics.yolo.utils.metrics.smooth
<br><br>
# plot_pr_curve
---
:::ultralytics.yolo.utils.metrics.plot_pr_curve
<br><br>
# plot_mc_curve
---
:::ultralytics.yolo.utils.metrics.plot_mc_curve
<br><br>
# compute_ap
---
:::ultralytics.yolo.utils.metrics.compute_ap
<br><br>
# ap_per_class
---
:::ultralytics.yolo.utils.metrics.ap_per_class
<br><br>

View File

@ -0,0 +1,134 @@
# Profile
---
:::ultralytics.yolo.utils.ops.Profile
<br><br>
# coco80_to_coco91_class
---
:::ultralytics.yolo.utils.ops.coco80_to_coco91_class
<br><br>
# segment2box
---
:::ultralytics.yolo.utils.ops.segment2box
<br><br>
# scale_boxes
---
:::ultralytics.yolo.utils.ops.scale_boxes
<br><br>
# make_divisible
---
:::ultralytics.yolo.utils.ops.make_divisible
<br><br>
# non_max_suppression
---
:::ultralytics.yolo.utils.ops.non_max_suppression
<br><br>
# clip_boxes
---
:::ultralytics.yolo.utils.ops.clip_boxes
<br><br>
# clip_coords
---
:::ultralytics.yolo.utils.ops.clip_coords
<br><br>
# scale_image
---
:::ultralytics.yolo.utils.ops.scale_image
<br><br>
# xyxy2xywh
---
:::ultralytics.yolo.utils.ops.xyxy2xywh
<br><br>
# xywh2xyxy
---
:::ultralytics.yolo.utils.ops.xywh2xyxy
<br><br>
# xywhn2xyxy
---
:::ultralytics.yolo.utils.ops.xywhn2xyxy
<br><br>
# xyxy2xywhn
---
:::ultralytics.yolo.utils.ops.xyxy2xywhn
<br><br>
# xyn2xy
---
:::ultralytics.yolo.utils.ops.xyn2xy
<br><br>
# xywh2ltwh
---
:::ultralytics.yolo.utils.ops.xywh2ltwh
<br><br>
# xyxy2ltwh
---
:::ultralytics.yolo.utils.ops.xyxy2ltwh
<br><br>
# ltwh2xywh
---
:::ultralytics.yolo.utils.ops.ltwh2xywh
<br><br>
# ltwh2xyxy
---
:::ultralytics.yolo.utils.ops.ltwh2xyxy
<br><br>
# segments2boxes
---
:::ultralytics.yolo.utils.ops.segments2boxes
<br><br>
# resample_segments
---
:::ultralytics.yolo.utils.ops.resample_segments
<br><br>
# crop_mask
---
:::ultralytics.yolo.utils.ops.crop_mask
<br><br>
# process_mask_upsample
---
:::ultralytics.yolo.utils.ops.process_mask_upsample
<br><br>
# process_mask
---
:::ultralytics.yolo.utils.ops.process_mask
<br><br>
# process_mask_native
---
:::ultralytics.yolo.utils.ops.process_mask_native
<br><br>
# scale_coords
---
:::ultralytics.yolo.utils.ops.scale_coords
<br><br>
# masks2segments
---
:::ultralytics.yolo.utils.ops.masks2segments
<br><br>
# clean_str
---
:::ultralytics.yolo.utils.ops.clean_str
<br><br>

View File

@ -0,0 +1,34 @@
# Colors
---
:::ultralytics.yolo.utils.plotting.Colors
<br><br>
# Annotator
---
:::ultralytics.yolo.utils.plotting.Annotator
<br><br>
# plot_labels
---
:::ultralytics.yolo.utils.plotting.plot_labels
<br><br>
# save_one_box
---
:::ultralytics.yolo.utils.plotting.save_one_box
<br><br>
# plot_images
---
:::ultralytics.yolo.utils.plotting.plot_images
<br><br>
# plot_results
---
:::ultralytics.yolo.utils.plotting.plot_results
<br><br>
# output_to_target
---
:::ultralytics.yolo.utils.plotting.output_to_target
<br><br>

View File

@ -0,0 +1,29 @@
# TaskAlignedAssigner
---
:::ultralytics.yolo.utils.tal.TaskAlignedAssigner
<br><br>
# select_candidates_in_gts
---
:::ultralytics.yolo.utils.tal.select_candidates_in_gts
<br><br>
# select_highest_overlaps
---
:::ultralytics.yolo.utils.tal.select_highest_overlaps
<br><br>
# make_anchors
---
:::ultralytics.yolo.utils.tal.make_anchors
<br><br>
# dist2bbox
---
:::ultralytics.yolo.utils.tal.dist2bbox
<br><br>
# bbox2dist
---
:::ultralytics.yolo.utils.tal.bbox2dist
<br><br>

View File

@ -0,0 +1,119 @@
# ModelEMA
---
:::ultralytics.yolo.utils.torch_utils.ModelEMA
<br><br>
# EarlyStopping
---
:::ultralytics.yolo.utils.torch_utils.EarlyStopping
<br><br>
# torch_distributed_zero_first
---
:::ultralytics.yolo.utils.torch_utils.torch_distributed_zero_first
<br><br>
# smart_inference_mode
---
:::ultralytics.yolo.utils.torch_utils.smart_inference_mode
<br><br>
# select_device
---
:::ultralytics.yolo.utils.torch_utils.select_device
<br><br>
# time_sync
---
:::ultralytics.yolo.utils.torch_utils.time_sync
<br><br>
# fuse_conv_and_bn
---
:::ultralytics.yolo.utils.torch_utils.fuse_conv_and_bn
<br><br>
# fuse_deconv_and_bn
---
:::ultralytics.yolo.utils.torch_utils.fuse_deconv_and_bn
<br><br>
# model_info
---
:::ultralytics.yolo.utils.torch_utils.model_info
<br><br>
# get_num_params
---
:::ultralytics.yolo.utils.torch_utils.get_num_params
<br><br>
# get_num_gradients
---
:::ultralytics.yolo.utils.torch_utils.get_num_gradients
<br><br>
# get_flops
---
:::ultralytics.yolo.utils.torch_utils.get_flops
<br><br>
# initialize_weights
---
:::ultralytics.yolo.utils.torch_utils.initialize_weights
<br><br>
# scale_img
---
:::ultralytics.yolo.utils.torch_utils.scale_img
<br><br>
# make_divisible
---
:::ultralytics.yolo.utils.torch_utils.make_divisible
<br><br>
# copy_attr
---
:::ultralytics.yolo.utils.torch_utils.copy_attr
<br><br>
# get_latest_opset
---
:::ultralytics.yolo.utils.torch_utils.get_latest_opset
<br><br>
# intersect_dicts
---
:::ultralytics.yolo.utils.torch_utils.intersect_dicts
<br><br>
# is_parallel
---
:::ultralytics.yolo.utils.torch_utils.is_parallel
<br><br>
# de_parallel
---
:::ultralytics.yolo.utils.torch_utils.de_parallel
<br><br>
# one_cycle
---
:::ultralytics.yolo.utils.torch_utils.one_cycle
<br><br>
# init_seeds
---
:::ultralytics.yolo.utils.torch_utils.init_seeds
<br><br>
# strip_optimizer
---
:::ultralytics.yolo.utils.torch_utils.strip_optimizer
<br><br>
# profile
---
:::ultralytics.yolo.utils.torch_utils.profile
<br><br>