Update prediction Results docs (#4139)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2023-08-03 18:44:40 +02:00
parent 8870084645
commit 11d0488bf1
107 changed files with 1451 additions and 1317 deletions
--- a/docs/reference/models/fastsam/model.md
+++ b/docs/reference/models/fastsam/model.md
@ -3,7 +3,12 @@ description: Learn all about Ultralytics FastSAM model. Dive into our comprehens
 keywords: Ultralytics, FastSAM model, Model documentation, Efficient model training
 ---

-## FastSAM
+# Reference for `ultralytics/models/fastsam/model.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/model.py).
+
 ---
-### ::: ultralytics.models.fastsam.model.FastSAM
+## ::: ultralytics.models.fastsam.model.FastSAM
 <br><br>
--- a/docs/reference/models/fastsam/predict.md
+++ b/docs/reference/models/fastsam/predict.md
@ -3,7 +3,12 @@ description: Get detailed insights about Ultralytics FastSAMPredictor. Learn to
 keywords: Ultralytics, FastSAMPredictor, predictive modeling, AI optimization, machine learning, deep learning, Ultralytics documentation
 ---

-## FastSAMPredictor
+# Reference for `ultralytics/models/fastsam/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/predict.py).
+
 ---
-### ::: ultralytics.models.fastsam.predict.FastSAMPredictor
+## ::: ultralytics.models.fastsam.predict.FastSAMPredictor
 <br><br>
--- a/docs/reference/models/fastsam/prompt.md
+++ b/docs/reference/models/fastsam/prompt.md
@ -3,7 +3,12 @@ description: Learn to effectively utilize FastSAMPrompt model from Ultralytics.
 keywords: Ultralytics, FastSAMPrompt, machine learning, model, guide, documentation
 ---

-## FastSAMPrompt
+# Reference for `ultralytics/models/fastsam/prompt.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/prompt.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/prompt.py).
+
 ---
-### ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
+## ::: ultralytics.models.fastsam.prompt.FastSAMPrompt
 <br><br>
--- a/docs/reference/models/fastsam/utils.md
+++ b/docs/reference/models/fastsam/utils.md
@ -3,12 +3,16 @@ description: Learn how to adjust bounding boxes to image borders in Ultralytics
 keywords: Ultralytics, bounding boxes, Bboxes, image borders, object detection, bbox_iou, model utilities
 ---

-## adjust_bboxes_to_image_border
+# Reference for `ultralytics/models/fastsam/utils.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/utils.py).
+
 ---
-### ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
+## ::: ultralytics.models.fastsam.utils.adjust_bboxes_to_image_border
 <br><br>

-## bbox_iou
 ---
-### ::: ultralytics.models.fastsam.utils.bbox_iou
+## ::: ultralytics.models.fastsam.utils.bbox_iou
 <br><br>
--- a/docs/reference/models/fastsam/val.md
+++ b/docs/reference/models/fastsam/val.md
@ -3,7 +3,12 @@ description: Learn about FastSAMValidator in Ultralytics models. Comprehensive g
 keywords: Ultralytics, FastSAMValidator, model, synthetic, AI, machine learning, validation
 ---

-## FastSAMValidator
+# Reference for `ultralytics/models/fastsam/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/fastsam/val.py).
+
 ---
-### ::: ultralytics.models.fastsam.val.FastSAMValidator
+## ::: ultralytics.models.fastsam.val.FastSAMValidator
 <br><br>
--- a/docs/reference/models/nas/model.md
+++ b/docs/reference/models/nas/model.md
@ -3,7 +3,12 @@ description: Learn how our NAS model operates in Ultralytics. Comprehensive guid
 keywords: Ultralytics, NAS model, NAS guide, machine learning, model documentation
 ---

-## NAS
+# Reference for `ultralytics/models/nas/model.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/model.py).
+
 ---
-### ::: ultralytics.models.nas.model.NAS
+## ::: ultralytics.models.nas.model.NAS
 <br><br>
--- a/docs/reference/models/nas/predict.md
+++ b/docs/reference/models/nas/predict.md
@ -3,7 +3,12 @@ description: Explore Ultralytics NASPredictor. Understand high-level architectur
 keywords: NASPredictor, Ultralytics, Ultralytics model, model architecture, efficient predictions
 ---

-## NASPredictor
+# Reference for `ultralytics/models/nas/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/predict.py).
+
 ---
-### ::: ultralytics.models.nas.predict.NASPredictor
+## ::: ultralytics.models.nas.predict.NASPredictor
 <br><br>
--- a/docs/reference/models/nas/val.md
+++ b/docs/reference/models/nas/val.md
@ -3,7 +3,12 @@ description: Explore the utilities and functions of the Ultralytics NASValidator
 keywords: Ultralytics, NASValidator, models.nas.val.NASValidator, AI models, allocation, optimization
 ---

-## NASValidator
+# Reference for `ultralytics/models/nas/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/nas/val.py).
+
 ---
-### ::: ultralytics.models.nas.val.NASValidator
+## ::: ultralytics.models.nas.val.NASValidator
 <br><br>
--- a/docs/reference/models/rtdetr/model.md
+++ b/docs/reference/models/rtdetr/model.md
@ -3,7 +3,12 @@ description: Explore the specifics of using the RTDETR model in Ultralytics. Det
 keywords: Ultralytics, RTDETR model, Ultralytics models, object detection, Ultralytics documentation
 ---

-## RTDETR
+# Reference for `ultralytics/models/rtdetr/model.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/model.py).
+
 ---
-### ::: ultralytics.models.rtdetr.model.RTDETR
+## ::: ultralytics.models.rtdetr.model.RTDETR
 <br><br>
--- a/docs/reference/models/rtdetr/predict.md
+++ b/docs/reference/models/rtdetr/predict.md
@ -3,7 +3,12 @@ description: Learn how to use the RTDETRPredictor model of the Ultralytics packa
 keywords: Ultralytics, RTDETRPredictor, model documentation, guide, real-time object detection
 ---

-## RTDETRPredictor
+# Reference for `ultralytics/models/rtdetr/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/predict.py).
+
 ---
-### ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
+## ::: ultralytics.models.rtdetr.predict.RTDETRPredictor
 <br><br>
--- a/docs/reference/models/rtdetr/train.md
+++ b/docs/reference/models/rtdetr/train.md
@ -3,12 +3,16 @@ description: Get insights into RTDETRTrainer, a crucial component of Ultralytics
 keywords: Ultralytics, RTDETRTrainer, model training, Ultralytics models, PyTorch models, neural networks, machine learning, deep learning
 ---

-## RTDETRTrainer
+# Reference for `ultralytics/models/rtdetr/train.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/train.py).
+
 ---
-### ::: ultralytics.models.rtdetr.train.RTDETRTrainer
+## ::: ultralytics.models.rtdetr.train.RTDETRTrainer
 <br><br>

-## train
 ---
-### ::: ultralytics.models.rtdetr.train.train
+## ::: ultralytics.models.rtdetr.train.train
 <br><br>
--- a/docs/reference/models/rtdetr/val.md
+++ b/docs/reference/models/rtdetr/val.md
@ -3,12 +3,16 @@ description: Explore RTDETRDataset in Ultralytics Models. Learn about the RTDETR
 keywords: Ultralytics, RTDETRDataset, RTDETRValidator, real-time object detection, models documentation
 ---

-## RTDETRDataset
+# Reference for `ultralytics/models/rtdetr/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/rtdetr/val.py).
+
 ---
-### ::: ultralytics.models.rtdetr.val.RTDETRDataset
+## ::: ultralytics.models.rtdetr.val.RTDETRDataset
 <br><br>

-## RTDETRValidator
 ---
-### ::: ultralytics.models.rtdetr.val.RTDETRValidator
+## ::: ultralytics.models.rtdetr.val.RTDETRValidator
 <br><br>
--- a/docs/reference/models/sam/amg.md
+++ b/docs/reference/models/sam/amg.md
@ -3,87 +3,76 @@ description: Explore Ultralytics methods for mask data processing, transformatio
 keywords: Ultralytics, Mask Data, Transformation, Encoding, RLE encoding, Image cropping, Pytorch, SAM, AMG, Ultralytics model
 ---

-## MaskData
+# Reference for `ultralytics/models/sam/amg.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/amg.py).
+
 ---
-### ::: ultralytics.models.sam.amg.MaskData
+## ::: ultralytics.models.sam.amg.MaskData
 <br><br>

-## is_box_near_crop_edge
 ---
-### ::: ultralytics.models.sam.amg.is_box_near_crop_edge
+## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
 <br><br>

-## box_xyxy_to_xywh
 ---
-### ::: ultralytics.models.sam.amg.box_xyxy_to_xywh
+## ::: ultralytics.models.sam.amg.box_xyxy_to_xywh
 <br><br>

-## batch_iterator
 ---
-### ::: ultralytics.models.sam.amg.batch_iterator
+## ::: ultralytics.models.sam.amg.batch_iterator
 <br><br>

-## mask_to_rle_pytorch
 ---
-### ::: ultralytics.models.sam.amg.mask_to_rle_pytorch
+## ::: ultralytics.models.sam.amg.mask_to_rle_pytorch
 <br><br>

-## rle_to_mask
 ---
-### ::: ultralytics.models.sam.amg.rle_to_mask
+## ::: ultralytics.models.sam.amg.rle_to_mask
 <br><br>

-## area_from_rle
 ---
-### ::: ultralytics.models.sam.amg.area_from_rle
+## ::: ultralytics.models.sam.amg.area_from_rle
 <br><br>

-## calculate_stability_score
 ---
-### ::: ultralytics.models.sam.amg.calculate_stability_score
+## ::: ultralytics.models.sam.amg.calculate_stability_score
 <br><br>

-## build_point_grid
 ---
-### ::: ultralytics.models.sam.amg.build_point_grid
+## ::: ultralytics.models.sam.amg.build_point_grid
 <br><br>

-## build_all_layer_point_grids
 ---
-### ::: ultralytics.models.sam.amg.build_all_layer_point_grids
+## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
 <br><br>

-## generate_crop_boxes
 ---
-### ::: ultralytics.models.sam.amg.generate_crop_boxes
+## ::: ultralytics.models.sam.amg.generate_crop_boxes
 <br><br>

-## uncrop_boxes_xyxy
 ---
-### ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
+## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
 <br><br>

-## uncrop_points
 ---
-### ::: ultralytics.models.sam.amg.uncrop_points
+## ::: ultralytics.models.sam.amg.uncrop_points
 <br><br>

-## uncrop_masks
 ---
-### ::: ultralytics.models.sam.amg.uncrop_masks
+## ::: ultralytics.models.sam.amg.uncrop_masks
 <br><br>

-## remove_small_regions
 ---
-### ::: ultralytics.models.sam.amg.remove_small_regions
+## ::: ultralytics.models.sam.amg.remove_small_regions
 <br><br>

-## coco_encode_rle
 ---
-### ::: ultralytics.models.sam.amg.coco_encode_rle
+## ::: ultralytics.models.sam.amg.coco_encode_rle
 <br><br>

-## batched_mask_to_box
 ---
-### ::: ultralytics.models.sam.amg.batched_mask_to_box
+## ::: ultralytics.models.sam.amg.batched_mask_to_box
 <br><br>
--- a/docs/reference/models/sam/build.md
+++ b/docs/reference/models/sam/build.md
@ -3,32 +3,32 @@ description: Master building SAM ViT models with Ultralytics. Discover steps to
 keywords: Ultralytics, SAM, build sam, vision transformer, vits, build_sam_vit_l, build_sam_vit_b, build_sam
 ---

-## build_sam_vit_h
+# Reference for `ultralytics/models/sam/build.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/build.py).
+
 ---
-### ::: ultralytics.models.sam.build.build_sam_vit_h
+## ::: ultralytics.models.sam.build.build_sam_vit_h
 <br><br>

-## build_sam_vit_l
 ---
-### ::: ultralytics.models.sam.build.build_sam_vit_l
+## ::: ultralytics.models.sam.build.build_sam_vit_l
 <br><br>

-## build_sam_vit_b
 ---
-### ::: ultralytics.models.sam.build.build_sam_vit_b
+## ::: ultralytics.models.sam.build.build_sam_vit_b
 <br><br>

-## build_mobile_sam
 ---
-### ::: ultralytics.models.sam.build.build_mobile_sam
+## ::: ultralytics.models.sam.build.build_mobile_sam
 <br><br>

-## _build_sam
 ---
-### ::: ultralytics.models.sam.build._build_sam
+## ::: ultralytics.models.sam.build._build_sam
 <br><br>

-## build_sam
 ---
-### ::: ultralytics.models.sam.build.build_sam
+## ::: ultralytics.models.sam.build.build_sam
 <br><br>
--- a/docs/reference/models/sam/model.md
+++ b/docs/reference/models/sam/model.md
@ -3,7 +3,12 @@ description: Dive into the SAM model details in the Ultralytics YOLO documentati
 keywords: Ultralytics, YOLO, SAM Model, Documentations, Machine Learning, AI, Convolutional neural network
 ---

-## SAM
+# Reference for `ultralytics/models/sam/model.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/model.py).
+
 ---
-### ::: ultralytics.models.sam.model.SAM
+## ::: ultralytics.models.sam.model.SAM
 <br><br>
--- a/docs/reference/models/sam/modules/decoders.md
+++ b/docs/reference/models/sam/modules/decoders.md
@ -3,12 +3,16 @@ description: Explore MaskDecoder, a part of the Ultralytics models. Gain insight
 keywords: Ultralytics, MaskDecoder, SAM modules, decoders, MLP, YOLO, machine learning, image recognition
 ---

-## MaskDecoder
+# Reference for `ultralytics/models/sam/modules/decoders.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/decoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/decoders.py).
+
 ---
-### ::: ultralytics.models.sam.modules.decoders.MaskDecoder
+## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
 <br><br>

-## MLP
 ---
-### ::: ultralytics.models.sam.modules.decoders.MLP
+## ::: ultralytics.models.sam.modules.decoders.MLP
 <br><br>
--- a/docs/reference/models/sam/modules/encoders.md
+++ b/docs/reference/models/sam/modules/encoders.md
@ -3,52 +3,48 @@ description: Discover detailed information on ImageEncoderViT, PositionEmbedding
 keywords: Ultralytics, Encoders, Modules, Documentation, ImageEncoderViT, PositionEmbeddingRandom, Attention, window_partition, get_rel_pos
 ---

-## ImageEncoderViT
+# Reference for `ultralytics/models/sam/modules/encoders.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/encoders.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/encoders.py).
+
 ---
-### ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
+## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
 <br><br>

-## PromptEncoder
 ---
-### ::: ultralytics.models.sam.modules.encoders.PromptEncoder
+## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
 <br><br>

-## PositionEmbeddingRandom
 ---
-### ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
+## ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
 <br><br>

-## Block
 ---
-### ::: ultralytics.models.sam.modules.encoders.Block
+## ::: ultralytics.models.sam.modules.encoders.Block
 <br><br>

-## Attention
 ---
-### ::: ultralytics.models.sam.modules.encoders.Attention
+## ::: ultralytics.models.sam.modules.encoders.Attention
 <br><br>

-## PatchEmbed
 ---
-### ::: ultralytics.models.sam.modules.encoders.PatchEmbed
+## ::: ultralytics.models.sam.modules.encoders.PatchEmbed
 <br><br>

-## window_partition
 ---
-### ::: ultralytics.models.sam.modules.encoders.window_partition
+## ::: ultralytics.models.sam.modules.encoders.window_partition
 <br><br>

-## window_unpartition
 ---
-### ::: ultralytics.models.sam.modules.encoders.window_unpartition
+## ::: ultralytics.models.sam.modules.encoders.window_unpartition
 <br><br>

-## get_rel_pos
 ---
-### ::: ultralytics.models.sam.modules.encoders.get_rel_pos
+## ::: ultralytics.models.sam.modules.encoders.get_rel_pos
 <br><br>

-## add_decomposed_rel_pos
 ---
-### ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos
+## ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos
 <br><br>
--- a/docs/reference/models/sam/modules/sam.md
+++ b/docs/reference/models/sam/modules/sam.md
@ -3,7 +3,12 @@ description: Explore the Sam module of Ultralytics. Discover detailed methods, c
 keywords: Ultralytics, Sam module, deep learning, model training, Ultralytics documentation
 ---

-## Sam
+# Reference for `ultralytics/models/sam/modules/sam.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/sam.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/sam.py).
+
 ---
-### ::: ultralytics.models.sam.modules.sam.Sam
+## ::: ultralytics.models.sam.modules.sam.Sam
 <br><br>
--- a/docs/reference/models/sam/modules/tiny_encoder.md
+++ b/docs/reference/models/sam/modules/tiny_encoder.md
@ -3,57 +3,52 @@ description: Get in-depth insights about Ultralytics Tiny Encoder Modules such a
 keywords: Ultralytics, Tiny Encoder, Conv2d_BN, MBConv, ConvLayer, Attention, BasicLayer, TinyViT, Machine learning modules, Ultralytics models
 ---

-## Conv2d_BN
+# Reference for `ultralytics/models/sam/modules/tiny_encoder.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/tiny_encoder.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/tiny_encoder.py).
+
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
+## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
 <br><br>

-## PatchEmbed
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
+## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
 <br><br>

-## MBConv
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
+## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
 <br><br>

-## PatchMerging
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
+## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
 <br><br>

-## ConvLayer
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
+## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
 <br><br>

-## Mlp
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
+## ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
 <br><br>

-## Attention
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.Attention
+## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
 <br><br>

-## TinyViTBlock
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
+## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
 <br><br>

-## BasicLayer
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
+## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
 <br><br>

-## LayerNorm2d
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
+## ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
 <br><br>

-## TinyViT
 ---
-### ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
+## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
 <br><br>
--- a/docs/reference/models/sam/modules/transformer.md
+++ b/docs/reference/models/sam/modules/transformer.md
@ -3,17 +3,20 @@ description: Learn about TwoWayTransformer and Attention modules in Ultralytics.
 keywords: Ultralytics, TwoWayTransformer, Attention, AI models, transformers
 ---

-## TwoWayTransformer
+# Reference for `ultralytics/models/sam/modules/transformer.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/modules/transformer.py).
+
 ---
-### ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
+## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
 <br><br>

-## TwoWayAttentionBlock
 ---
-### ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
+## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
 <br><br>

-## Attention
 ---
-### ::: ultralytics.models.sam.modules.transformer.Attention
+## ::: ultralytics.models.sam.modules.transformer.Attention
 <br><br>
--- a/docs/reference/models/sam/predict.md
+++ b/docs/reference/models/sam/predict.md
@ -3,7 +3,12 @@ description: Master the ultralytics.models.sam.predict.Predictor class with our
 keywords: Ultralytics, predictor, models, sam.predict.Predictor, AI, machine learning, predictive models
 ---

-## Predictor
+# Reference for `ultralytics/models/sam/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/sam/predict.py).
+
 ---
-### ::: ultralytics.models.sam.predict.Predictor
+## ::: ultralytics.models.sam.predict.Predictor
 <br><br>
--- a/docs/reference/models/utils/loss.md
+++ b/docs/reference/models/utils/loss.md
@ -3,12 +3,16 @@ description: Learn to use the DETRLoss function provided by Ultralytics YOLO. Un
 keywords: Ultralytics, YOLO, Documentation, DETRLoss, Detection Loss, Loss function, DETR, RTDETR Detection Models
 ---

-## DETRLoss
+# Reference for `ultralytics/models/utils/loss.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/loss.py).
+
 ---
-### ::: ultralytics.models.utils.loss.DETRLoss
+## ::: ultralytics.models.utils.loss.DETRLoss
 <br><br>

-## RTDETRDetectionLoss
 ---
-### ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
+## ::: ultralytics.models.utils.loss.RTDETRDetectionLoss
 <br><br>
--- a/docs/reference/models/utils/ops.md
+++ b/docs/reference/models/utils/ops.md
@ -3,17 +3,20 @@ description: Discover details for "HungarianMatcher" & "inverse_sigmoid" functio
 keywords: Ultralytics, YOLO, HungarianMatcher, inverse_sigmoid, detection models, model utilities, ops
 ---

-## HungarianMatcher
+# Reference for `ultralytics/models/utils/ops.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/utils/ops.py).
+
 ---
-### ::: ultralytics.models.utils.ops.HungarianMatcher
+## ::: ultralytics.models.utils.ops.HungarianMatcher
 <br><br>

-## get_cdn_group
 ---
-### ::: ultralytics.models.utils.ops.get_cdn_group
+## ::: ultralytics.models.utils.ops.get_cdn_group
 <br><br>

-## inverse_sigmoid
 ---
-### ::: ultralytics.models.utils.ops.inverse_sigmoid
+## ::: ultralytics.models.utils.ops.inverse_sigmoid
 <br><br>
--- a/docs/reference/models/yolo/classify/predict.md
+++ b/docs/reference/models/yolo/classify/predict.md
@ -3,12 +3,16 @@ description: Explore the Ultralytics ClassificationPredictor guide for model pre
 keywords: Ultralytics, classification predictor, predict, YOLO, AI models, model visualization
 ---

-## ClassificationPredictor
+# Reference for `ultralytics/models/yolo/classify/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/predict.py).
+
 ---
-### ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
+## ::: ultralytics.models.yolo.classify.predict.ClassificationPredictor
 <br><br>

-## predict
 ---
-### ::: ultralytics.models.yolo.classify.predict.predict
+## ::: ultralytics.models.yolo.classify.predict.predict
 <br><br>
--- a/docs/reference/models/yolo/classify/train.md
+++ b/docs/reference/models/yolo/classify/train.md
@ -3,12 +3,16 @@ description: Delve into Classification Trainer at Ultralytics YOLO docs and opti
 keywords: Ultralytics, YOLO, Classification Trainer, deep learning, training process, AI models, documentation
 ---

-## ClassificationTrainer
+# Reference for `ultralytics/models/yolo/classify/train.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/train.py).
+
 ---
-### ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
+## ::: ultralytics.models.yolo.classify.train.ClassificationTrainer
 <br><br>

-## train
 ---
-### ::: ultralytics.models.yolo.classify.train.train
+## ::: ultralytics.models.yolo.classify.train.train
 <br><br>
--- a/docs/reference/models/yolo/classify/val.md
+++ b/docs/reference/models/yolo/classify/val.md
@ -3,12 +3,16 @@ description: Explore YOLO ClassificationValidator, a key element of Ultralytics
 keywords: Ultralytics, YOLO, ClassificationValidator, model validation, model fine-tuning, deep learning, computer vision
 ---

-## ClassificationValidator
+# Reference for `ultralytics/models/yolo/classify/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/classify/val.py).
+
 ---
-### ::: ultralytics.models.yolo.classify.val.ClassificationValidator
+## ::: ultralytics.models.yolo.classify.val.ClassificationValidator
 <br><br>

-## val
 ---
-### ::: ultralytics.models.yolo.classify.val.val
+## ::: ultralytics.models.yolo.classify.val.val
 <br><br>
--- a/docs/reference/models/yolo/detect/predict.md
+++ b/docs/reference/models/yolo/detect/predict.md
@ -3,12 +3,16 @@ description: Explore the guide to using the DetectionPredictor in Ultralytics YO
 keywords: Ultralytics, YOLO, DetectionPredictor, detect, predict, object detection, analysis
 ---

-## DetectionPredictor
+# Reference for `ultralytics/models/yolo/detect/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/predict.py).
+
 ---
-### ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
+## ::: ultralytics.models.yolo.detect.predict.DetectionPredictor
 <br><br>

-## predict
 ---
-### ::: ultralytics.models.yolo.detect.predict.predict
+## ::: ultralytics.models.yolo.detect.predict.predict
 <br><br>
--- a/docs/reference/models/yolo/detect/train.md
+++ b/docs/reference/models/yolo/detect/train.md
@ -3,12 +3,16 @@ description: Maximize your model's potential with Ultralytics YOLO Detection Tra
 keywords: Ultralytics YOLO, YOLO, Detection Trainer, Model Training, Machine Learning, Deep Learning, Computer Vision
 ---

-## DetectionTrainer
+# Reference for `ultralytics/models/yolo/detect/train.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/train.py).
+
 ---
-### ::: ultralytics.models.yolo.detect.train.DetectionTrainer
+## ::: ultralytics.models.yolo.detect.train.DetectionTrainer
 <br><br>

-## train
 ---
-### ::: ultralytics.models.yolo.detect.train.train
+## ::: ultralytics.models.yolo.detect.train.train
 <br><br>
--- a/docs/reference/models/yolo/detect/val.md
+++ b/docs/reference/models/yolo/detect/val.md
@ -3,12 +3,16 @@ description: Discover function valuation of your YOLO models with the Ultralytic
 keywords: Ultralytics, YOLO, Detection Validator, model valuation, precision, recall
 ---

-## DetectionValidator
+# Reference for `ultralytics/models/yolo/detect/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/detect/val.py).
+
 ---
-### ::: ultralytics.models.yolo.detect.val.DetectionValidator
+## ::: ultralytics.models.yolo.detect.val.DetectionValidator
 <br><br>

-## val
 ---
-### ::: ultralytics.models.yolo.detect.val.val
+## ::: ultralytics.models.yolo.detect.val.val
 <br><br>
--- a/docs/reference/models/yolo/model.md
+++ b/docs/reference/models/yolo/model.md
@ -3,7 +3,12 @@ description: Discover the Ultralytics YOLO model class. Learn advanced technique
 keywords: Ultralytics YOLO, YOLO, YOLO model, Model Training, Machine Learning, Deep Learning, Computer Vision
 ---

-## YOLO
+# Reference for `ultralytics/models/yolo/model.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/model.py).
+
 ---
-### ::: ultralytics.models.yolo.model.YOLO
+## ::: ultralytics.models.yolo.model.YOLO
 <br><br>
--- a/docs/reference/models/yolo/pose/predict.md
+++ b/docs/reference/models/yolo/pose/predict.md
@ -3,12 +3,16 @@ description: Discover how to use PosePredictor in the Ultralytics YOLO model. In
 keywords: Ultralytics, YOLO, PosePredictor, machine learning, AI, predictive models
 ---

-## PosePredictor
+# Reference for `ultralytics/models/yolo/pose/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/predict.py).
+
 ---
-### ::: ultralytics.models.yolo.pose.predict.PosePredictor
+## ::: ultralytics.models.yolo.pose.predict.PosePredictor
 <br><br>

-## predict
 ---
-### ::: ultralytics.models.yolo.pose.predict.predict
+## ::: ultralytics.models.yolo.pose.predict.predict
 <br><br>
--- a/docs/reference/models/yolo/pose/train.md
+++ b/docs/reference/models/yolo/pose/train.md
@ -3,12 +3,16 @@ description: Explore Ultralytics PoseTrainer for YOLO models. Get a step-by-step
 keywords: Ultralytics, YOLO, PoseTrainer, pose training, AI modeling, custom data training
 ---

-## PoseTrainer
+# Reference for `ultralytics/models/yolo/pose/train.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/train.py).
+
 ---
-### ::: ultralytics.models.yolo.pose.train.PoseTrainer
+## ::: ultralytics.models.yolo.pose.train.PoseTrainer
 <br><br>

-## train
 ---
-### ::: ultralytics.models.yolo.pose.train.train
+## ::: ultralytics.models.yolo.pose.train.train
 <br><br>
--- a/docs/reference/models/yolo/pose/val.md
+++ b/docs/reference/models/yolo/pose/val.md
@ -3,12 +3,16 @@ description: Explore the PoseValidator—review how Ultralytics YOLO validates p
 keywords: PoseValidator, Ultralytics, YOLO, Object detection, Pose validation
 ---

-## PoseValidator
+# Reference for `ultralytics/models/yolo/pose/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/pose/val.py).
+
 ---
-### ::: ultralytics.models.yolo.pose.val.PoseValidator
+## ::: ultralytics.models.yolo.pose.val.PoseValidator
 <br><br>

-## val
 ---
-### ::: ultralytics.models.yolo.pose.val.val
+## ::: ultralytics.models.yolo.pose.val.val
 <br><br>
--- a/docs/reference/models/yolo/segment/predict.md
+++ b/docs/reference/models/yolo/segment/predict.md
@ -3,12 +3,16 @@ description: Discover how to utilize the YOLO Segmentation Predictor in Ultralyt
 keywords: YOLO, Ultralytics, object detection, segmentation predictor
 ---

-## SegmentationPredictor
+# Reference for `ultralytics/models/yolo/segment/predict.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/predict.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/predict.py).
+
 ---
-### ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
+## ::: ultralytics.models.yolo.segment.predict.SegmentationPredictor
 <br><br>

-## predict
 ---
-### ::: ultralytics.models.yolo.segment.predict.predict
+## ::: ultralytics.models.yolo.segment.predict.predict
 <br><br>
--- a/docs/reference/models/yolo/segment/train.md
+++ b/docs/reference/models/yolo/segment/train.md
@ -3,12 +3,16 @@ description: Maximize your YOLO model's performance with our SegmentationTrainer
 keywords: Ultralytics, YOLO, SegmentationTrainer, image segmentation, object detection, model training, YOLO model
 ---

-## SegmentationTrainer
+# Reference for `ultralytics/models/yolo/segment/train.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/train.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/train.py).
+
 ---
-### ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
+## ::: ultralytics.models.yolo.segment.train.SegmentationTrainer
 <br><br>

-## train
 ---
-### ::: ultralytics.models.yolo.segment.train.train
+## ::: ultralytics.models.yolo.segment.train.train
 <br><br>
--- a/docs/reference/models/yolo/segment/val.md
+++ b/docs/reference/models/yolo/segment/val.md
@ -3,12 +3,16 @@ description: Get practical insights about our SegmentationValidator in YOLO Ultr
 keywords: Ultralytics, YOLO, SegmentationValidator, model segmentation, image classification, object detection
 ---

-## SegmentationValidator
+# Reference for `ultralytics/models/yolo/segment/val.py`
+
+!!! note
+
+    Full source code for this file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/val.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/models/yolo/segment/val.py).
+
 ---
-### ::: ultralytics.models.yolo.segment.val.SegmentationValidator
+## ::: ultralytics.models.yolo.segment.val.SegmentationValidator
 <br><br>

-## val
 ---
-### ::: ultralytics.models.yolo.segment.val.val
+## ::: ultralytics.models.yolo.segment.val.val
 <br><br>