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