Docstrings arguments cleanup (#3229)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher
2023-06-17 16:17:07 +02:00
committed by GitHub
parent 62916b3b0a
commit bd0f7ecf6f
93 changed files with 1104 additions and 1102 deletions

View File

@ -3,7 +3,7 @@ description: Learn how to use auto_annotate in Ultralytics YOLO to generate anno
keywords: Ultralytics YOLO, Auto Annotator, AI, image annotation, object detection, labelling, tool
---
# auto_annotate
## auto_annotate
---
:::ultralytics.yolo.data.annotator.auto_annotate
### ::: ultralytics.yolo.data.annotator.auto_annotate
<br><br>

View File

@ -3,97 +3,97 @@ description: Use Ultralytics YOLO Data Augmentation transforms with Base, MixUp,
keywords: YOLO, data augmentation, transforms, BaseTransform, MixUp, RandomHSV, Albumentations, ToTensor, classify_transforms, classify_albumentations
---
# BaseTransform
## BaseTransform
---
:::ultralytics.yolo.data.augment.BaseTransform
### ::: ultralytics.yolo.data.augment.BaseTransform
<br><br>
# Compose
## Compose
---
:::ultralytics.yolo.data.augment.Compose
### ::: ultralytics.yolo.data.augment.Compose
<br><br>
# BaseMixTransform
## BaseMixTransform
---
:::ultralytics.yolo.data.augment.BaseMixTransform
### ::: ultralytics.yolo.data.augment.BaseMixTransform
<br><br>
# Mosaic
## Mosaic
---
:::ultralytics.yolo.data.augment.Mosaic
### ::: ultralytics.yolo.data.augment.Mosaic
<br><br>
# MixUp
## MixUp
---
:::ultralytics.yolo.data.augment.MixUp
### ::: ultralytics.yolo.data.augment.MixUp
<br><br>
# RandomPerspective
## RandomPerspective
---
:::ultralytics.yolo.data.augment.RandomPerspective
### ::: ultralytics.yolo.data.augment.RandomPerspective
<br><br>
# RandomHSV
## RandomHSV
---
:::ultralytics.yolo.data.augment.RandomHSV
### ::: ultralytics.yolo.data.augment.RandomHSV
<br><br>
# RandomFlip
## RandomFlip
---
:::ultralytics.yolo.data.augment.RandomFlip
### ::: ultralytics.yolo.data.augment.RandomFlip
<br><br>
# LetterBox
## LetterBox
---
:::ultralytics.yolo.data.augment.LetterBox
### ::: ultralytics.yolo.data.augment.LetterBox
<br><br>
# CopyPaste
## CopyPaste
---
:::ultralytics.yolo.data.augment.CopyPaste
### ::: ultralytics.yolo.data.augment.CopyPaste
<br><br>
# Albumentations
## Albumentations
---
:::ultralytics.yolo.data.augment.Albumentations
### ::: ultralytics.yolo.data.augment.Albumentations
<br><br>
# Format
## Format
---
:::ultralytics.yolo.data.augment.Format
### ::: ultralytics.yolo.data.augment.Format
<br><br>
# ClassifyLetterBox
## ClassifyLetterBox
---
:::ultralytics.yolo.data.augment.ClassifyLetterBox
### ::: ultralytics.yolo.data.augment.ClassifyLetterBox
<br><br>
# CenterCrop
## CenterCrop
---
:::ultralytics.yolo.data.augment.CenterCrop
### ::: ultralytics.yolo.data.augment.CenterCrop
<br><br>
# ToTensor
## ToTensor
---
:::ultralytics.yolo.data.augment.ToTensor
### ::: ultralytics.yolo.data.augment.ToTensor
<br><br>
# v8_transforms
## v8_transforms
---
:::ultralytics.yolo.data.augment.v8_transforms
### ::: ultralytics.yolo.data.augment.v8_transforms
<br><br>
# classify_transforms
## classify_transforms
---
:::ultralytics.yolo.data.augment.classify_transforms
### ::: ultralytics.yolo.data.augment.classify_transforms
<br><br>
# hsv2colorjitter
## hsv2colorjitter
---
:::ultralytics.yolo.data.augment.hsv2colorjitter
### ::: ultralytics.yolo.data.augment.hsv2colorjitter
<br><br>
# classify_albumentations
## classify_albumentations
---
:::ultralytics.yolo.data.augment.classify_albumentations
### ::: ultralytics.yolo.data.augment.classify_albumentations
<br><br>

View File

@ -3,7 +3,7 @@ description: Learn about BaseDataset in Ultralytics YOLO, a flexible dataset cla
keywords: BaseDataset, Ultralytics YOLO, object detection, real-world applications, documentation
---
# BaseDataset
## BaseDataset
---
:::ultralytics.yolo.data.base.BaseDataset
### ::: ultralytics.yolo.data.base.BaseDataset
<br><br>

View File

@ -3,37 +3,37 @@ description: Maximize YOLO performance with Ultralytics' InfiniteDataLoader, see
keywords: Ultralytics, YOLO, object detection, data loading, build dataloader, load inference source
---
# InfiniteDataLoader
## InfiniteDataLoader
---
:::ultralytics.yolo.data.build.InfiniteDataLoader
### ::: ultralytics.yolo.data.build.InfiniteDataLoader
<br><br>
# _RepeatSampler
## _RepeatSampler
---
:::ultralytics.yolo.data.build._RepeatSampler
### ::: ultralytics.yolo.data.build._RepeatSampler
<br><br>
# seed_worker
## seed_worker
---
:::ultralytics.yolo.data.build.seed_worker
### ::: ultralytics.yolo.data.build.seed_worker
<br><br>
# build_yolo_dataset
## build_yolo_dataset
---
:::ultralytics.yolo.data.build.build_yolo_dataset
### ::: ultralytics.yolo.data.build.build_yolo_dataset
<br><br>
# build_dataloader
## build_dataloader
---
:::ultralytics.yolo.data.build.build_dataloader
### ::: ultralytics.yolo.data.build.build_dataloader
<br><br>
# check_source
## check_source
---
:::ultralytics.yolo.data.build.check_source
### ::: ultralytics.yolo.data.build.check_source
<br><br>
# load_inference_source
## load_inference_source
---
:::ultralytics.yolo.data.build.load_inference_source
### ::: ultralytics.yolo.data.build.load_inference_source
<br><br>

View File

@ -3,32 +3,32 @@ description: Convert COCO-91 to COCO-80 class, RLE to polygon, and merge multi-s
keywords: Ultralytics, YOLO, converter, COCO91, COCO80, rle2polygon, merge_multi_segment, annotations
---
# coco91_to_coco80_class
## coco91_to_coco80_class
---
:::ultralytics.yolo.data.converter.coco91_to_coco80_class
### ::: ultralytics.yolo.data.converter.coco91_to_coco80_class
<br><br>
# convert_coco
## convert_coco
---
:::ultralytics.yolo.data.converter.convert_coco
### ::: ultralytics.yolo.data.converter.convert_coco
<br><br>
# rle2polygon
## rle2polygon
---
:::ultralytics.yolo.data.converter.rle2polygon
### ::: ultralytics.yolo.data.converter.rle2polygon
<br><br>
# min_index
## min_index
---
:::ultralytics.yolo.data.converter.min_index
### ::: ultralytics.yolo.data.converter.min_index
<br><br>
# merge_multi_segment
## merge_multi_segment
---
:::ultralytics.yolo.data.converter.merge_multi_segment
### ::: ultralytics.yolo.data.converter.merge_multi_segment
<br><br>
# delete_dsstore
## delete_dsstore
---
:::ultralytics.yolo.data.converter.delete_dsstore
### ::: ultralytics.yolo.data.converter.delete_dsstore
<br><br>

View File

@ -3,42 +3,42 @@ description: 'Ultralytics YOLO Docs: Learn about stream loaders for image and te
keywords: Ultralytics YOLO, data loaders, stream load images, screenshots, tensor data, autocast list, youtube URL retriever
---
# SourceTypes
## SourceTypes
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.SourceTypes
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.SourceTypes
<br><br>
# LoadStreams
## LoadStreams
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadStreams
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.LoadStreams
<br><br>
# LoadScreenshots
## LoadScreenshots
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadScreenshots
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.LoadScreenshots
<br><br>
# LoadImages
## LoadImages
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadImages
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.LoadImages
<br><br>
# LoadPilAndNumpy
## LoadPilAndNumpy
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadPilAndNumpy
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.LoadPilAndNumpy
<br><br>
# LoadTensor
## LoadTensor
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadTensor
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.LoadTensor
<br><br>
# autocast_list
## autocast_list
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.autocast_list
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.autocast_list
<br><br>
# get_best_youtube_url
## get_best_youtube_url
---
:::ultralytics.yolo.data.dataloaders.stream_loaders.get_best_youtube_url
### ::: ultralytics.yolo.data.dataloaders.stream_loaders.get_best_youtube_url
<br><br>

View File

@ -3,87 +3,87 @@ description: Enhance image data with Albumentations CenterCrop, normalize, augme
keywords: YOLO, object detection, data loaders, V5 augmentations, CenterCrop, normalize, random_perspective
---
# Albumentations
## Albumentations
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.Albumentations
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.Albumentations
<br><br>
# LetterBox
## LetterBox
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.LetterBox
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.LetterBox
<br><br>
# CenterCrop
## CenterCrop
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.CenterCrop
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.CenterCrop
<br><br>
# ToTensor
## ToTensor
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.ToTensor
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.ToTensor
<br><br>
# normalize
## normalize
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.normalize
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.normalize
<br><br>
# denormalize
## denormalize
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.denormalize
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.denormalize
<br><br>
# augment_hsv
## augment_hsv
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.augment_hsv
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.augment_hsv
<br><br>
# hist_equalize
## hist_equalize
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.hist_equalize
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.hist_equalize
<br><br>
# replicate
## replicate
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.replicate
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.replicate
<br><br>
# letterbox
## letterbox
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.letterbox
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.letterbox
<br><br>
# random_perspective
## random_perspective
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.random_perspective
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.random_perspective
<br><br>
# copy_paste
## copy_paste
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.copy_paste
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.copy_paste
<br><br>
# cutout
## cutout
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.cutout
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.cutout
<br><br>
# mixup
## mixup
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.mixup
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.mixup
<br><br>
# box_candidates
## box_candidates
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.box_candidates
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.box_candidates
<br><br>
# classify_albumentations
## classify_albumentations
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.classify_albumentations
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.classify_albumentations
<br><br>
# classify_transforms
## classify_transforms
---
:::ultralytics.yolo.data.dataloaders.v5augmentations.classify_transforms
### ::: ultralytics.yolo.data.dataloaders.v5augmentations.classify_transforms
<br><br>

View File

@ -3,92 +3,92 @@ description: Efficiently load images and labels to models using Ultralytics YOLO
keywords: YOLO, data loader, image classification, object detection, Ultralytics
---
# InfiniteDataLoader
## InfiniteDataLoader
---
:::ultralytics.yolo.data.dataloaders.v5loader.InfiniteDataLoader
### ::: ultralytics.yolo.data.dataloaders.v5loader.InfiniteDataLoader
<br><br>
# _RepeatSampler
## _RepeatSampler
---
:::ultralytics.yolo.data.dataloaders.v5loader._RepeatSampler
### ::: ultralytics.yolo.data.dataloaders.v5loader._RepeatSampler
<br><br>
# LoadScreenshots
## LoadScreenshots
---
:::ultralytics.yolo.data.dataloaders.v5loader.LoadScreenshots
### ::: ultralytics.yolo.data.dataloaders.v5loader.LoadScreenshots
<br><br>
# LoadImages
## LoadImages
---
:::ultralytics.yolo.data.dataloaders.v5loader.LoadImages
### ::: ultralytics.yolo.data.dataloaders.v5loader.LoadImages
<br><br>
# LoadStreams
## LoadStreams
---
:::ultralytics.yolo.data.dataloaders.v5loader.LoadStreams
### ::: ultralytics.yolo.data.dataloaders.v5loader.LoadStreams
<br><br>
# LoadImagesAndLabels
## LoadImagesAndLabels
---
:::ultralytics.yolo.data.dataloaders.v5loader.LoadImagesAndLabels
### ::: ultralytics.yolo.data.dataloaders.v5loader.LoadImagesAndLabels
<br><br>
# ClassificationDataset
## ClassificationDataset
---
:::ultralytics.yolo.data.dataloaders.v5loader.ClassificationDataset
### ::: ultralytics.yolo.data.dataloaders.v5loader.ClassificationDataset
<br><br>
# get_hash
## get_hash
---
:::ultralytics.yolo.data.dataloaders.v5loader.get_hash
### ::: ultralytics.yolo.data.dataloaders.v5loader.get_hash
<br><br>
# exif_size
## exif_size
---
:::ultralytics.yolo.data.dataloaders.v5loader.exif_size
### ::: ultralytics.yolo.data.dataloaders.v5loader.exif_size
<br><br>
# exif_transpose
## exif_transpose
---
:::ultralytics.yolo.data.dataloaders.v5loader.exif_transpose
### ::: ultralytics.yolo.data.dataloaders.v5loader.exif_transpose
<br><br>
# seed_worker
## seed_worker
---
:::ultralytics.yolo.data.dataloaders.v5loader.seed_worker
### ::: ultralytics.yolo.data.dataloaders.v5loader.seed_worker
<br><br>
# create_dataloader
## create_dataloader
---
:::ultralytics.yolo.data.dataloaders.v5loader.create_dataloader
### ::: ultralytics.yolo.data.dataloaders.v5loader.create_dataloader
<br><br>
# img2label_paths
## img2label_paths
---
:::ultralytics.yolo.data.dataloaders.v5loader.img2label_paths
### ::: ultralytics.yolo.data.dataloaders.v5loader.img2label_paths
<br><br>
# flatten_recursive
## flatten_recursive
---
:::ultralytics.yolo.data.dataloaders.v5loader.flatten_recursive
### ::: ultralytics.yolo.data.dataloaders.v5loader.flatten_recursive
<br><br>
# extract_boxes
## extract_boxes
---
:::ultralytics.yolo.data.dataloaders.v5loader.extract_boxes
### ::: ultralytics.yolo.data.dataloaders.v5loader.extract_boxes
<br><br>
# autosplit
## autosplit
---
:::ultralytics.yolo.data.dataloaders.v5loader.autosplit
### ::: ultralytics.yolo.data.dataloaders.v5loader.autosplit
<br><br>
# verify_image_label
## verify_image_label
---
:::ultralytics.yolo.data.dataloaders.v5loader.verify_image_label
### ::: ultralytics.yolo.data.dataloaders.v5loader.verify_image_label
<br><br>
# create_classification_dataloader
## create_classification_dataloader
---
:::ultralytics.yolo.data.dataloaders.v5loader.create_classification_dataloader
### ::: ultralytics.yolo.data.dataloaders.v5loader.create_classification_dataloader
<br><br>

View File

@ -3,17 +3,17 @@ description: Create custom YOLOv5 datasets with Ultralytics YOLODataset and Sema
keywords: YOLODataset, SemanticDataset, Ultralytics YOLO Docs, Object Detection, Segmentation
---
# YOLODataset
## YOLODataset
---
:::ultralytics.yolo.data.dataset.YOLODataset
### ::: ultralytics.yolo.data.dataset.YOLODataset
<br><br>
# ClassificationDataset
## ClassificationDataset
---
:::ultralytics.yolo.data.dataset.ClassificationDataset
### ::: ultralytics.yolo.data.dataset.ClassificationDataset
<br><br>
# SemanticDataset
## SemanticDataset
---
:::ultralytics.yolo.data.dataset.SemanticDataset
### ::: ultralytics.yolo.data.dataset.SemanticDataset
<br><br>

View File

@ -3,7 +3,7 @@ description: Create a custom dataset of mixed and oriented rectangular objects w
keywords: Ultralytics YOLO, MixAndRectDataset, dataset wrapper, image-level annotations, object-level annotations, rectangular object detection
---
# MixAndRectDataset
## MixAndRectDataset
---
:::ultralytics.yolo.data.dataset_wrappers.MixAndRectDataset
### ::: ultralytics.yolo.data.dataset_wrappers.MixAndRectDataset
<br><br>

View File

@ -3,67 +3,67 @@ description: Efficiently handle data in YOLO with Ultralytics. Utilize HUBDatase
keywords: YOLOv4, Object Detection, Computer Vision, Deep Learning, Convolutional Neural Network, CNN, Ultralytics Docs
---
# HUBDatasetStats
## HUBDatasetStats
---
:::ultralytics.yolo.data.utils.HUBDatasetStats
### ::: ultralytics.yolo.data.utils.HUBDatasetStats
<br><br>
# img2label_paths
## img2label_paths
---
:::ultralytics.yolo.data.utils.img2label_paths
### ::: ultralytics.yolo.data.utils.img2label_paths
<br><br>
# get_hash
## get_hash
---
:::ultralytics.yolo.data.utils.get_hash
### ::: ultralytics.yolo.data.utils.get_hash
<br><br>
# exif_size
## exif_size
---
:::ultralytics.yolo.data.utils.exif_size
### ::: ultralytics.yolo.data.utils.exif_size
<br><br>
# verify_image_label
## verify_image_label
---
:::ultralytics.yolo.data.utils.verify_image_label
### ::: ultralytics.yolo.data.utils.verify_image_label
<br><br>
# polygon2mask
## polygon2mask
---
:::ultralytics.yolo.data.utils.polygon2mask
### ::: ultralytics.yolo.data.utils.polygon2mask
<br><br>
# polygons2masks
## polygons2masks
---
:::ultralytics.yolo.data.utils.polygons2masks
### ::: ultralytics.yolo.data.utils.polygons2masks
<br><br>
# polygons2masks_overlap
## polygons2masks_overlap
---
:::ultralytics.yolo.data.utils.polygons2masks_overlap
### ::: ultralytics.yolo.data.utils.polygons2masks_overlap
<br><br>
# check_det_dataset
## check_det_dataset
---
:::ultralytics.yolo.data.utils.check_det_dataset
### ::: ultralytics.yolo.data.utils.check_det_dataset
<br><br>
# check_cls_dataset
## check_cls_dataset
---
:::ultralytics.yolo.data.utils.check_cls_dataset
### ::: ultralytics.yolo.data.utils.check_cls_dataset
<br><br>
# compress_one_image
## compress_one_image
---
:::ultralytics.yolo.data.utils.compress_one_image
### ::: ultralytics.yolo.data.utils.compress_one_image
<br><br>
# delete_dsstore
## delete_dsstore
---
:::ultralytics.yolo.data.utils.delete_dsstore
### ::: ultralytics.yolo.data.utils.delete_dsstore
<br><br>
# zip_directory
## zip_directory
---
:::ultralytics.yolo.data.utils.zip_directory
### ::: ultralytics.yolo.data.utils.zip_directory
<br><br>