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>

docs/build_reference.py

@@ -0,0 +1,108 @@
+# Ultralytics YOLO 🚀, AGPL-3.0 license
+"""
+Helper file to build Ultralytics Docs reference section. Recursively walks through ultralytics dir and builds an MkDocs
+reference section of *.md files composed of classes and functions, and also creates a nav menu for use in mkdocs.yaml.
+
+Note: Must be run from repository root directory. Do not run from docs directory.
+"""
+
+import os
+import re
+from collections import defaultdict
+from pathlib import Path
+
+TARGET_DIR = Path('..')
+
+
+def extract_classes_and_functions(filepath):
+    with open(filepath, 'r') as file:
+        content = file.read()
+
+    class_pattern = r"(?:^|\n)class\s(\w+)(?:\(|:)"
+    func_pattern = r"(?:^|\n)def\s(\w+)\("
+
+    classes = re.findall(class_pattern, content)
+    functions = re.findall(func_pattern, content)
+
+    return classes, functions
+
+
+def create_markdown(py_filepath, module_path, classes, functions):
+    md_filepath = py_filepath.with_suffix('.md')
+
+    md_content = [f"# {class_name}\n---\n:::{module_path}.{class_name}\n<br><br>\n" for class_name in classes]
+    md_content.extend(f"# {func_name}\n---\n:::{module_path}.{func_name}\n<br><br>\n" for func_name in functions)
+    md_content = "\n".join(md_content)
+
+    os.makedirs(os.path.dirname(md_filepath), exist_ok=True)
+    with open(md_filepath, 'w') as file:
+        file.write(md_content)
+
+    return md_filepath.relative_to(TARGET_DIR)
+
+
+def nested_dict():
+    return defaultdict(nested_dict)
+
+
+def sort_nested_dict(d):
+    return {
+        key: sort_nested_dict(value) if isinstance(value, dict) else value
+        for key, value in sorted(d.items())
+    }
+
+
+def create_nav_menu_yaml(nav_items):
+    nav_tree = nested_dict()
+
+    for item_str in nav_items:
+        item = Path(item_str)
+        parts = item.parts
+        current_level = nav_tree['reference']
+        for part in parts[2:-1]:  # skip the first two parts (docs and reference) and the last part (filename)
+            current_level = current_level[part]
+
+        md_file_name = parts[-1].replace('.md', '')
+        current_level[md_file_name] = item
+
+    nav_tree_sorted = sort_nested_dict(nav_tree)
+
+    def _dict_to_yaml(d, level=0):
+        yaml_str = ""
+        indent = "  " * level
+        for k, v in d.items():
+            if isinstance(v, dict):
+                yaml_str += f"{indent}- {k}:\n{_dict_to_yaml(v, level + 1)}"
+            else:
+                yaml_str += f"{indent}- {k}: {str(v).replace('docs/', '')}\n"
+        return yaml_str
+
+    with open(TARGET_DIR / 'nav_menu_updated.yml', 'w') as file:
+        yaml_str = _dict_to_yaml(nav_tree_sorted)
+        file.write(yaml_str)
+
+
+def main():
+    source_dir = Path("../ultralytics")
+    target_dir = Path("reference")
+
+    nav_items = []
+
+    for root, _, files in os.walk(source_dir):
+        for file in files:
+            if file.endswith(".py") and file != "__init__.py":
+                py_filepath = Path(root) / file
+                classes, functions = extract_classes_and_functions(py_filepath)
+
+                if classes or functions:
+                    py_filepath_rel = py_filepath.relative_to(source_dir)
+                    md_filepath = target_dir / py_filepath_rel
+                    module_path = f"ultralytics.{py_filepath_rel.with_suffix('').as_posix().replace('/', '.')}"
+                    md_rel_filepath = create_markdown(md_filepath, module_path, classes, functions)
+                    nav_items.append(str(md_rel_filepath))
+
+    create_nav_menu_yaml(nav_items)
+
+
+if __name__ == "__main__":
+    main()

docs/modes/predict.md

@@ -202,7 +202,7 @@ operations are cached, meaning they're only calculated once per object, and thos
     results[0].probs  # cls prob, (num_class, )
     ```
 
-Class reference documentation for `Results` module and its components can be found [here](../reference/results.md)
+Class reference documentation for `Results` module and its components can be found [here](../reference/yolo/engine/results.md)
 
 ## Plotting results
 

docs/quickstart.md

@@ -25,7 +25,7 @@ See the `ultralytics` [requirements.txt](https://github.com/ultralytics/ultralyt
     PyTorch requirements vary by operating system and CUDA requirements, so it's recommended to install PyTorch first following instructions at [https://pytorch.org/get-started/locally](https://pytorch.org/get-started/locally).
 
     <a href="https://pytorch.org/get-started/locally/">
-        <img width="100%" alt="PyTorch Installation Instructions" src="https://user-images.githubusercontent.com/26833433/228650108-ab0ec98a-b328-4f40-a40d-95355e8a84e3.png">
+        <img width="800" alt="PyTorch Installation Instructions" src="https://user-images.githubusercontent.com/26833433/228650108-ab0ec98a-b328-4f40-a40d-95355e8a84e3.png">
     </a>
 
 

docs/reference/base_pred.md

@@ -1,8 +0,0 @@
-All task Predictors are inherited from `BasePredictors` class that contains the model validation routine boilerplate.
-You can override any function of these Trainers to suit your needs.
-
----
-
-### BasePredictor API Reference
-
-:::ultralytics.yolo.engine.predictor.BasePredictor

docs/reference/base_trainer.md

@@ -1,8 +0,0 @@
-All task Trainers are inherited from `BaseTrainer` class that contains the model training and optimization routine
-boilerplate. You can override any function of these Trainers to suit your needs.
-
----
-
-### BaseTrainer API Reference
-
-:::ultralytics.yolo.engine.trainer.BaseTrainer

docs/reference/base_val.md

@@ -1,8 +0,0 @@
-All task Validators are inherited from `BaseValidator` class that contains the model validation routine boilerplate. You
-can override any function of these Trainers to suit your needs.
-
----
-
-### BaseValidator API Reference
-
-:::ultralytics.yolo.engine.validator.BaseValidator

docs/reference/exporter.md

@@ -1,3 +0,0 @@
-### Exporter API Reference
-
-:::ultralytics.yolo.engine.exporter.Exporter

docs/reference/hub/auth.md

@@ -0,0 +1,4 @@
+# Auth
+---
+:::ultralytics.hub.auth.Auth
+<br><br>

docs/reference/hub/session.md

@@ -0,0 +1,4 @@
+# HUBTrainingSession
+---
+:::ultralytics.hub.session.HUBTrainingSession
+<br><br>

docs/reference/hub/utils.md

@@ -0,0 +1,24 @@
+# Traces
+---
+:::ultralytics.hub.utils.Traces
+<br><br>
+
+# check_dataset_disk_space
+---
+:::ultralytics.hub.utils.check_dataset_disk_space
+<br><br>
+
+# request_with_credentials
+---
+:::ultralytics.hub.utils.request_with_credentials
+<br><br>
+
+# requests_with_progress
+---
+:::ultralytics.hub.utils.requests_with_progress
+<br><br>
+
+# smart_request
+---
+:::ultralytics.hub.utils.smart_request
+<br><br>

docs/reference/model.md

@@ -1 +0,0 @@
-::: ultralytics.yolo.engine.model

docs/reference/nn.md

@@ -1,19 +0,0 @@
-# nn Module
-
-Ultralytics nn module contains 3 main components:
-
-1. **AutoBackend**: A module that can run inference on all popular model formats
-2. **BaseModel**: `BaseModel` class defines the operations supported by tasks like Detection and Segmentation
-3. **modules**: Optimized and reusable neural network blocks built on PyTorch.
-
-## AutoBackend
-
-:::ultralytics.nn.autobackend.AutoBackend
-
-## BaseModel
-
-:::ultralytics.nn.tasks.BaseModel
-
-## Modules
-
-TODO

docs/reference/nn/autobackend.md

@@ -0,0 +1,9 @@
+# AutoBackend
+---
+:::ultralytics.nn.autobackend.AutoBackend
+<br><br>
+
+# check_class_names
+---
+:::ultralytics.nn.autobackend.check_class_names
+<br><br>

docs/reference/nn/autoshape.md

@@ -0,0 +1,9 @@
+# AutoShape
+---
+:::ultralytics.nn.autoshape.AutoShape
+<br><br>
+
+# Detections
+---
+:::ultralytics.nn.autoshape.Detections
+<br><br>

docs/reference/nn/modules.md

@@ -0,0 +1,159 @@
+# Conv
+---
+:::ultralytics.nn.modules.Conv
+<br><br>
+
+# DWConv
+---
+:::ultralytics.nn.modules.DWConv
+<br><br>
+
+# DWConvTranspose2d
+---
+:::ultralytics.nn.modules.DWConvTranspose2d
+<br><br>
+
+# ConvTranspose
+---
+:::ultralytics.nn.modules.ConvTranspose
+<br><br>
+
+# DFL
+---
+:::ultralytics.nn.modules.DFL
+<br><br>
+
+# TransformerLayer
+---
+:::ultralytics.nn.modules.TransformerLayer
+<br><br>
+
+# TransformerBlock
+---
+:::ultralytics.nn.modules.TransformerBlock
+<br><br>
+
+# Bottleneck
+---
+:::ultralytics.nn.modules.Bottleneck
+<br><br>
+
+# BottleneckCSP
+---
+:::ultralytics.nn.modules.BottleneckCSP
+<br><br>
+
+# C3
+---
+:::ultralytics.nn.modules.C3
+<br><br>
+
+# C2
+---
+:::ultralytics.nn.modules.C2
+<br><br>
+
+# C2f
+---
+:::ultralytics.nn.modules.C2f
+<br><br>
+
+# ChannelAttention
+---
+:::ultralytics.nn.modules.ChannelAttention
+<br><br>
+
+# SpatialAttention
+---
+:::ultralytics.nn.modules.SpatialAttention
+<br><br>
+
+# CBAM
+---
+:::ultralytics.nn.modules.CBAM
+<br><br>
+
+# C1
+---
+:::ultralytics.nn.modules.C1
+<br><br>
+
+# C3x
+---
+:::ultralytics.nn.modules.C3x
+<br><br>
+
+# C3TR
+---
+:::ultralytics.nn.modules.C3TR
+<br><br>
+
+# C3Ghost
+---
+:::ultralytics.nn.modules.C3Ghost
+<br><br>
+
+# SPP
+---
+:::ultralytics.nn.modules.SPP
+<br><br>
+
+# SPPF
+---
+:::ultralytics.nn.modules.SPPF
+<br><br>
+
+# Focus
+---
+:::ultralytics.nn.modules.Focus
+<br><br>
+
+# GhostConv
+---
+:::ultralytics.nn.modules.GhostConv
+<br><br>
+
+# GhostBottleneck
+---
+:::ultralytics.nn.modules.GhostBottleneck
+<br><br>
+
+# Concat
+---
+:::ultralytics.nn.modules.Concat
+<br><br>
+
+# Proto
+---
+:::ultralytics.nn.modules.Proto
+<br><br>
+
+# Ensemble
+---
+:::ultralytics.nn.modules.Ensemble
+<br><br>
+
+# Detect
+---
+:::ultralytics.nn.modules.Detect
+<br><br>
+
+# Segment
+---
+:::ultralytics.nn.modules.Segment
+<br><br>
+
+# Pose
+---
+:::ultralytics.nn.modules.Pose
+<br><br>
+
+# Classify
+---
+:::ultralytics.nn.modules.Classify
+<br><br>
+
+# autopad
+---
+:::ultralytics.nn.modules.autopad
+<br><br>

docs/reference/nn/tasks.md

@@ -0,0 +1,59 @@
+# BaseModel
+---
+:::ultralytics.nn.tasks.BaseModel
+<br><br>
+
+# DetectionModel
+---
+:::ultralytics.nn.tasks.DetectionModel
+<br><br>
+
+# SegmentationModel
+---
+:::ultralytics.nn.tasks.SegmentationModel
+<br><br>
+
+# PoseModel
+---
+:::ultralytics.nn.tasks.PoseModel
+<br><br>
+
+# ClassificationModel
+---
+:::ultralytics.nn.tasks.ClassificationModel
+<br><br>
+
+# torch_safe_load
+---
+:::ultralytics.nn.tasks.torch_safe_load
+<br><br>
+
+# attempt_load_weights
+---
+:::ultralytics.nn.tasks.attempt_load_weights
+<br><br>
+
+# attempt_load_one_weight
+---
+:::ultralytics.nn.tasks.attempt_load_one_weight
+<br><br>
+
+# parse_model
+---
+:::ultralytics.nn.tasks.parse_model
+<br><br>
+
+# yaml_model_load
+---
+:::ultralytics.nn.tasks.yaml_model_load
+<br><br>
+
+# guess_model_scale
+---
+:::ultralytics.nn.tasks.guess_model_scale
+<br><br>
+
+# guess_model_task
+---
+:::ultralytics.nn.tasks.guess_model_task
+<br><br>

docs/reference/ops.md

@@ -1,208 +0,0 @@
-This module contains optimized deep learning related operations used in the Ultralytics YOLO framework
-
-## Non-max suppression
-
-:::ultralytics.yolo.utils.ops.non_max_suppression
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## Scale boxes
-
-:::ultralytics.yolo.utils.ops.scale_boxes
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## Scale image
-
-:::ultralytics.yolo.utils.ops.scale_image
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## clip boxes
-
-:::ultralytics.yolo.utils.ops.clip_boxes
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-# Box Format Conversion
-
-## xyxy2xywh
-
-:::ultralytics.yolo.utils.ops.xyxy2xywh
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## xywh2xyxy
-
-:::ultralytics.yolo.utils.ops.xywh2xyxy
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## xywhn2xyxy
-
-:::ultralytics.yolo.utils.ops.xywhn2xyxy
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## xyxy2xywhn
-
-:::ultralytics.yolo.utils.ops.xyxy2xywhn
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## xyn2xy
-
-:::ultralytics.yolo.utils.ops.xyn2xy
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## xywh2ltwh
-
-:::ultralytics.yolo.utils.ops.xywh2ltwh
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## xyxy2ltwh
-
-:::ultralytics.yolo.utils.ops.xyxy2ltwh
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## ltwh2xywh
-
-:::ultralytics.yolo.utils.ops.ltwh2xywh
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## ltwh2xyxy
-
-:::ultralytics.yolo.utils.ops.ltwh2xyxy
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## segment2box
-
-:::ultralytics.yolo.utils.ops.segment2box
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-# Mask Operations
-
-## resample_segments
-
-:::ultralytics.yolo.utils.ops.resample_segments
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## crop_mask
-
-:::ultralytics.yolo.utils.ops.crop_mask
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## process_mask_upsample
-
-:::ultralytics.yolo.utils.ops.process_mask_upsample
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## process_mask
-
-:::ultralytics.yolo.utils.ops.process_mask
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## process_mask_native
-
-:::ultralytics.yolo.utils.ops.process_mask_native
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## scale_coords
-
-:::ultralytics.yolo.utils.ops.scale_coords
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## masks2segments
-
-:::ultralytics.yolo.utils.ops.masks2segments
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-## clip_coords
-
-:::ultralytics.yolo.utils.ops.clip_coords
-handler: python
-options:
-show_source: false
-show_root_toc_entry: false
----
-
-
-
-
-

docs/reference/results.md

@@ -1,11 +0,0 @@
-### Results API Reference
-
-:::ultralytics.yolo.engine.results.Results
-
-### Boxes API Reference
-
-:::ultralytics.yolo.engine.results.Boxes
-
-### Masks API Reference
-
-:::ultralytics.yolo.engine.results.Masks

docs/reference/tracker/track.md

@@ -0,0 +1,14 @@
+# on_predict_start
+---
+:::ultralytics.tracker.track.on_predict_start
+<br><br>
+
+# on_predict_postprocess_end
+---
+:::ultralytics.tracker.track.on_predict_postprocess_end
+<br><br>
+
+# register_tracker
+---
+:::ultralytics.tracker.track.register_tracker
+<br><br>

docs/reference/tracker/trackers/basetrack.md

@@ -0,0 +1,9 @@
+# TrackState
+---
+:::ultralytics.tracker.trackers.basetrack.TrackState
+<br><br>
+
+# BaseTrack
+---
+:::ultralytics.tracker.trackers.basetrack.BaseTrack
+<br><br>

docs/reference/tracker/trackers/bot_sort.md

@@ -0,0 +1,9 @@
+# BOTrack
+---
+:::ultralytics.tracker.trackers.bot_sort.BOTrack
+<br><br>
+
+# BOTSORT
+---
+:::ultralytics.tracker.trackers.bot_sort.BOTSORT
+<br><br>

docs/reference/tracker/trackers/byte_tracker.md

@@ -0,0 +1,9 @@
+# STrack
+---
+:::ultralytics.tracker.trackers.byte_tracker.STrack
+<br><br>
+
+# BYTETracker
+---
+:::ultralytics.tracker.trackers.byte_tracker.BYTETracker
+<br><br>

docs/reference/tracker/utils/gmc.md

@@ -0,0 +1,4 @@
+# GMC
+---
+:::ultralytics.tracker.utils.gmc.GMC
+<br><br>

docs/reference/tracker/utils/kalman_filter.md

@@ -0,0 +1,9 @@
+# KalmanFilterXYAH
+---
+:::ultralytics.tracker.utils.kalman_filter.KalmanFilterXYAH
+<br><br>
+
+# KalmanFilterXYWH
+---
+:::ultralytics.tracker.utils.kalman_filter.KalmanFilterXYWH
+<br><br>

docs/reference/tracker/utils/matching.md

@@ -0,0 +1,59 @@
+# merge_matches
+---
+:::ultralytics.tracker.utils.matching.merge_matches
+<br><br>
+
+# _indices_to_matches
+---
+:::ultralytics.tracker.utils.matching._indices_to_matches
+<br><br>
+
+# linear_assignment
+---
+:::ultralytics.tracker.utils.matching.linear_assignment
+<br><br>
+
+# ious
+---
+:::ultralytics.tracker.utils.matching.ious
+<br><br>
+
+# iou_distance
+---
+:::ultralytics.tracker.utils.matching.iou_distance
+<br><br>
+
+# v_iou_distance
+---
+:::ultralytics.tracker.utils.matching.v_iou_distance
+<br><br>
+
+# embedding_distance
+---
+:::ultralytics.tracker.utils.matching.embedding_distance
+<br><br>
+
+# gate_cost_matrix
+---
+:::ultralytics.tracker.utils.matching.gate_cost_matrix
+<br><br>
+
+# fuse_motion
+---
+:::ultralytics.tracker.utils.matching.fuse_motion
+<br><br>
+
+# fuse_iou
+---
+:::ultralytics.tracker.utils.matching.fuse_iou
+<br><br>
+
+# fuse_score
+---
+:::ultralytics.tracker.utils.matching.fuse_score
+<br><br>
+
+# bbox_ious
+---
+:::ultralytics.tracker.utils.matching.bbox_ious
+<br><br>

docs/reference/yolo/data/augment.md

@@ -0,0 +1,89 @@
+# BaseTransform
+---
+:::ultralytics.yolo.data.augment.BaseTransform
+<br><br>
+
+# Compose
+---
+:::ultralytics.yolo.data.augment.Compose
+<br><br>
+
+# BaseMixTransform
+---
+:::ultralytics.yolo.data.augment.BaseMixTransform
+<br><br>
+
+# Mosaic
+---
+:::ultralytics.yolo.data.augment.Mosaic
+<br><br>
+
+# MixUp
+---
+:::ultralytics.yolo.data.augment.MixUp
+<br><br>
+
+# RandomPerspective
+---
+:::ultralytics.yolo.data.augment.RandomPerspective
+<br><br>
+
+# RandomHSV
+---
+:::ultralytics.yolo.data.augment.RandomHSV
+<br><br>
+
+# RandomFlip
+---
+:::ultralytics.yolo.data.augment.RandomFlip
+<br><br>
+
+# LetterBox
+---
+:::ultralytics.yolo.data.augment.LetterBox
+<br><br>
+
+# CopyPaste
+---
+:::ultralytics.yolo.data.augment.CopyPaste
+<br><br>
+
+# Albumentations
+---
+:::ultralytics.yolo.data.augment.Albumentations
+<br><br>
+
+# Format
+---
+:::ultralytics.yolo.data.augment.Format
+<br><br>
+
+# ClassifyLetterBox
+---
+:::ultralytics.yolo.data.augment.ClassifyLetterBox
+<br><br>
+
+# CenterCrop
+---
+:::ultralytics.yolo.data.augment.CenterCrop
+<br><br>
+
+# ToTensor
+---
+:::ultralytics.yolo.data.augment.ToTensor
+<br><br>
+
+# v8_transforms
+---
+:::ultralytics.yolo.data.augment.v8_transforms
+<br><br>
+
+# classify_transforms
+---
+:::ultralytics.yolo.data.augment.classify_transforms
+<br><br>
+
+# classify_albumentations
+---
+:::ultralytics.yolo.data.augment.classify_albumentations
+<br><br>

docs/reference/yolo/data/base.md

@@ -0,0 +1,4 @@
+# BaseDataset
+---
+:::ultralytics.yolo.data.base.BaseDataset
+<br><br>

docs/reference/yolo/data/build.md

@@ -0,0 +1,34 @@
+# InfiniteDataLoader
+---
+:::ultralytics.yolo.data.build.InfiniteDataLoader
+<br><br>
+
+# _RepeatSampler
+---
+:::ultralytics.yolo.data.build._RepeatSampler
+<br><br>
+
+# seed_worker
+---
+:::ultralytics.yolo.data.build.seed_worker
+<br><br>
+
+# build_dataloader
+---
+:::ultralytics.yolo.data.build.build_dataloader
+<br><br>
+
+# build_classification_dataloader
+---
+:::ultralytics.yolo.data.build.build_classification_dataloader
+<br><br>
+
+# check_source
+---
+:::ultralytics.yolo.data.build.check_source
+<br><br>
+
+# load_inference_source
+---
+:::ultralytics.yolo.data.build.load_inference_source
+<br><br>

docs/reference/yolo/data/dataloaders/stream_loaders.md

@@ -0,0 +1,34 @@
+# SourceTypes
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.SourceTypes
+<br><br>
+
+# LoadStreams
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadStreams
+<br><br>
+
+# LoadScreenshots
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadScreenshots
+<br><br>
+
+# LoadImages
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadImages
+<br><br>
+
+# LoadPilAndNumpy
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadPilAndNumpy
+<br><br>
+
+# LoadTensor
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.LoadTensor
+<br><br>
+
+# autocast_list
+---
+:::ultralytics.yolo.data.dataloaders.stream_loaders.autocast_list
+<br><br>

docs/reference/yolo/data/dataloaders/v5augmentations.md

@@ -0,0 +1,84 @@
+# Albumentations
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.Albumentations
+<br><br>
+
+# LetterBox
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.LetterBox
+<br><br>
+
+# CenterCrop
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.CenterCrop
+<br><br>
+
+# ToTensor
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.ToTensor
+<br><br>
+
+# normalize
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.normalize
+<br><br>
+
+# denormalize
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.denormalize
+<br><br>
+
+# augment_hsv
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.augment_hsv
+<br><br>
+
+# hist_equalize
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.hist_equalize
+<br><br>
+
+# replicate
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.replicate
+<br><br>
+
+# letterbox
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.letterbox
+<br><br>
+
+# random_perspective
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.random_perspective
+<br><br>
+
+# copy_paste
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.copy_paste
+<br><br>
+
+# cutout
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.cutout
+<br><br>
+
+# mixup
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.mixup
+<br><br>
+
+# box_candidates
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.box_candidates
+<br><br>
+
+# classify_albumentations
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.classify_albumentations
+<br><br>
+
+# classify_transforms
+---
+:::ultralytics.yolo.data.dataloaders.v5augmentations.classify_transforms
+<br><br>

docs/reference/yolo/data/dataloaders/v5loader.md

@@ -0,0 +1,89 @@
+# InfiniteDataLoader
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.InfiniteDataLoader
+<br><br>
+
+# _RepeatSampler
+---
+:::ultralytics.yolo.data.dataloaders.v5loader._RepeatSampler
+<br><br>
+
+# LoadScreenshots
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.LoadScreenshots
+<br><br>
+
+# LoadImages
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.LoadImages
+<br><br>
+
+# LoadStreams
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.LoadStreams
+<br><br>
+
+# LoadImagesAndLabels
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.LoadImagesAndLabels
+<br><br>
+
+# ClassificationDataset
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.ClassificationDataset
+<br><br>
+
+# get_hash
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.get_hash
+<br><br>
+
+# exif_size
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.exif_size
+<br><br>
+
+# exif_transpose
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.exif_transpose
+<br><br>
+
+# seed_worker
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.seed_worker
+<br><br>
+
+# create_dataloader
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.create_dataloader
+<br><br>
+
+# img2label_paths
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.img2label_paths
+<br><br>
+
+# flatten_recursive
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.flatten_recursive
+<br><br>
+
+# extract_boxes
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.extract_boxes
+<br><br>
+
+# autosplit
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.autosplit
+<br><br>
+
+# verify_image_label
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.verify_image_label
+<br><br>
+
+# create_classification_dataloader
+---
+:::ultralytics.yolo.data.dataloaders.v5loader.create_classification_dataloader
+<br><br>

docs/reference/yolo/data/dataset.md

@@ -0,0 +1,14 @@
+# YOLODataset
+---
+:::ultralytics.yolo.data.dataset.YOLODataset
+<br><br>
+
+# ClassificationDataset
+---
+:::ultralytics.yolo.data.dataset.ClassificationDataset
+<br><br>
+
+# SemanticDataset
+---
+:::ultralytics.yolo.data.dataset.SemanticDataset
+<br><br>

docs/reference/yolo/data/dataset_wrappers.md

@@ -0,0 +1,4 @@
+# MixAndRectDataset
+---
+:::ultralytics.yolo.data.dataset_wrappers.MixAndRectDataset
+<br><br>

docs/reference/yolo/data/utils.md

@@ -0,0 +1,64 @@
+# HUBDatasetStats
+---
+:::ultralytics.yolo.data.utils.HUBDatasetStats
+<br><br>
+
+# img2label_paths
+---
+:::ultralytics.yolo.data.utils.img2label_paths
+<br><br>
+
+# get_hash
+---
+:::ultralytics.yolo.data.utils.get_hash
+<br><br>
+
+# exif_size
+---
+:::ultralytics.yolo.data.utils.exif_size
+<br><br>
+
+# verify_image_label
+---
+:::ultralytics.yolo.data.utils.verify_image_label
+<br><br>
+
+# polygon2mask
+---
+:::ultralytics.yolo.data.utils.polygon2mask
+<br><br>
+
+# polygons2masks
+---
+:::ultralytics.yolo.data.utils.polygons2masks
+<br><br>
+
+# polygons2masks_overlap
+---
+:::ultralytics.yolo.data.utils.polygons2masks_overlap
+<br><br>
+
+# check_det_dataset
+---
+:::ultralytics.yolo.data.utils.check_det_dataset
+<br><br>
+
+# check_cls_dataset
+---
+:::ultralytics.yolo.data.utils.check_cls_dataset
+<br><br>
+
+# compress_one_image
+---
+:::ultralytics.yolo.data.utils.compress_one_image
+<br><br>
+
+# delete_dsstore
+---
+:::ultralytics.yolo.data.utils.delete_dsstore
+<br><br>
+
+# zip_directory
+---
+:::ultralytics.yolo.data.utils.zip_directory
+<br><br>

docs/reference/yolo/engine/exporter.md

@@ -0,0 +1,29 @@
+# iOSDetectModel
+---
+:::ultralytics.yolo.engine.exporter.iOSDetectModel
+<br><br>
+
+# Exporter
+---
+:::ultralytics.yolo.engine.exporter.Exporter
+<br><br>
+
+# export_formats
+---
+:::ultralytics.yolo.engine.exporter.export_formats
+<br><br>
+
+# gd_outputs
+---
+:::ultralytics.yolo.engine.exporter.gd_outputs
+<br><br>
+
+# try_export
+---
+:::ultralytics.yolo.engine.exporter.try_export
+<br><br>
+
+# export
+---
+:::ultralytics.yolo.engine.exporter.export
+<br><br>

docs/reference/yolo/engine/model.md

@@ -0,0 +1,4 @@
+# YOLO
+---
+:::ultralytics.yolo.engine.model.YOLO
+<br><br>

docs/reference/yolo/engine/predictor.md

@@ -0,0 +1,4 @@
+# BasePredictor
+---
+:::ultralytics.yolo.engine.predictor.BasePredictor
+<br><br>

docs/reference/yolo/engine/results.md

@@ -0,0 +1,19 @@
+# BaseTensor
+---
+:::ultralytics.yolo.engine.results.BaseTensor
+<br><br>
+
+# Results
+---
+:::ultralytics.yolo.engine.results.Results
+<br><br>
+
+# Boxes
+---
+:::ultralytics.yolo.engine.results.Boxes
+<br><br>
+
+# Masks
+---
+:::ultralytics.yolo.engine.results.Masks
+<br><br>

docs/reference/yolo/engine/trainer.md

@@ -0,0 +1,9 @@
+# BaseTrainer
+---
+:::ultralytics.yolo.engine.trainer.BaseTrainer
+<br><br>
+
+# check_amp
+---
+:::ultralytics.yolo.engine.trainer.check_amp
+<br><br>

docs/reference/yolo/engine/validator.md

@@ -0,0 +1,4 @@
+# BaseValidator
+---
+:::ultralytics.yolo.engine.validator.BaseValidator
+<br><br>

docs/reference/yolo/utils/autobatch.md

@@ -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>

docs/reference/yolo/utils/benchmarks.md

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

docs/reference/yolo/utils/callbacks/base.md

@@ -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>

docs/reference/yolo/utils/callbacks/clearml.md

@@ -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>

docs/reference/yolo/utils/callbacks/comet.md

@@ -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>

docs/reference/yolo/utils/callbacks/hub.md

@@ -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>

docs/reference/yolo/utils/callbacks/mlflow.md

@@ -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>

docs/reference/yolo/utils/callbacks/raytune.md

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

docs/reference/yolo/utils/callbacks/tensorboard.md

@@ -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>

docs/reference/yolo/utils/callbacks/wb.md

@@ -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>

docs/reference/yolo/utils/checks.md

@@ -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>

docs/reference/yolo/utils/dist.md

@@ -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>

docs/reference/yolo/utils/downloads.md

@@ -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>

docs/reference/yolo/utils/errors.md

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

docs/reference/yolo/utils/files.md

@@ -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>

docs/reference/yolo/utils/instance.md

@@ -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>

docs/reference/yolo/utils/loss.md

@@ -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>

docs/reference/yolo/utils/metrics.md

@@ -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>

docs/reference/yolo/utils/ops.md

@@ -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>

docs/reference/yolo/utils/plotting.md

@@ -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>

docs/reference/yolo/utils/tal.md

@@ -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>

docs/reference/yolo/utils/torch_utils.md

@@ -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>

docs/reference/yolo/v8/classify/predict.md

@@ -0,0 +1,9 @@
+# ClassificationPredictor
+---
+:::ultralytics.yolo.v8.classify.predict.ClassificationPredictor
+<br><br>
+
+# predict
+---
+:::ultralytics.yolo.v8.classify.predict.predict
+<br><br>

docs/reference/yolo/v8/classify/train.md

@@ -0,0 +1,9 @@
+# ClassificationTrainer
+---
+:::ultralytics.yolo.v8.classify.train.ClassificationTrainer
+<br><br>
+
+# train
+---
+:::ultralytics.yolo.v8.classify.train.train
+<br><br>

docs/reference/yolo/v8/classify/val.md

@@ -0,0 +1,9 @@
+# ClassificationValidator
+---
+:::ultralytics.yolo.v8.classify.val.ClassificationValidator
+<br><br>
+
+# val
+---
+:::ultralytics.yolo.v8.classify.val.val
+<br><br>

docs/reference/yolo/v8/detect/predict.md

@@ -0,0 +1,9 @@
+# DetectionPredictor
+---
+:::ultralytics.yolo.v8.detect.predict.DetectionPredictor
+<br><br>
+
+# predict
+---
+:::ultralytics.yolo.v8.detect.predict.predict
+<br><br>

docs/reference/yolo/v8/detect/train.md

@@ -0,0 +1,14 @@
+# DetectionTrainer
+---
+:::ultralytics.yolo.v8.detect.train.DetectionTrainer
+<br><br>
+
+# Loss
+---
+:::ultralytics.yolo.v8.detect.train.Loss
+<br><br>
+
+# train
+---
+:::ultralytics.yolo.v8.detect.train.train
+<br><br>

docs/reference/yolo/v8/detect/val.md

@@ -0,0 +1,9 @@
+# DetectionValidator
+---
+:::ultralytics.yolo.v8.detect.val.DetectionValidator
+<br><br>
+
+# val
+---
+:::ultralytics.yolo.v8.detect.val.val
+<br><br>

docs/reference/yolo/v8/pose/predict.md

@@ -0,0 +1,9 @@
+# PosePredictor
+---
+:::ultralytics.yolo.v8.pose.predict.PosePredictor
+<br><br>
+
+# predict
+---
+:::ultralytics.yolo.v8.pose.predict.predict
+<br><br>

docs/reference/yolo/v8/pose/train.md

@@ -0,0 +1,14 @@
+# PoseTrainer
+---
+:::ultralytics.yolo.v8.pose.train.PoseTrainer
+<br><br>
+
+# PoseLoss
+---
+:::ultralytics.yolo.v8.pose.train.PoseLoss
+<br><br>
+
+# train
+---
+:::ultralytics.yolo.v8.pose.train.train
+<br><br>

docs/reference/yolo/v8/pose/val.md

@@ -0,0 +1,9 @@
+# PoseValidator
+---
+:::ultralytics.yolo.v8.pose.val.PoseValidator
+<br><br>
+
+# val
+---
+:::ultralytics.yolo.v8.pose.val.val
+<br><br>

docs/reference/yolo/v8/segment/predict.md

@@ -0,0 +1,9 @@
+# SegmentationPredictor
+---
+:::ultralytics.yolo.v8.segment.predict.SegmentationPredictor
+<br><br>
+
+# predict
+---
+:::ultralytics.yolo.v8.segment.predict.predict
+<br><br>

docs/reference/yolo/v8/segment/train.md

@@ -0,0 +1,14 @@
+# SegmentationTrainer
+---
+:::ultralytics.yolo.v8.segment.train.SegmentationTrainer
+<br><br>
+
+# SegLoss
+---
+:::ultralytics.yolo.v8.segment.train.SegLoss
+<br><br>
+
+# train
+---
+:::ultralytics.yolo.v8.segment.train.train
+<br><br>

docs/reference/yolo/v8/segment/val.md

@@ -0,0 +1,9 @@
+# SegmentationValidator
+---
+:::ultralytics.yolo.v8.segment.val.SegmentationValidator
+<br><br>
+
+# val
+---
+:::ultralytics.yolo.v8.segment.val.val
+<br><br>

docs/usage/engine.md

@@ -9,7 +9,7 @@ custom model and dataloader by just overriding these functions:
 
 * `get_model(cfg, weights)` - The function that builds the model to be trained
 * `get_dataloder()` - The function that builds the dataloader
-  More details and source code can be found in [`BaseTrainer` Reference](../reference/base_trainer.md)
+  More details and source code can be found in [`BaseTrainer` Reference](../reference/yolo/engine/trainer.md)
 
 ## DetectionTrainer