HongChuang/ultralytics-ascend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Engine Model and Results Docs improvements (#14564)

Browse source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Felipe Parodi <fparodi@pennmedicine.upenn.edu>
This commit is contained in:
Glenn Jocher 2024-07-21 20:14:49 +02:00 • committed by GitHub
parent e59376b55f
commit 291883a23f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
123 changed files with 3789 additions and 1368 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/en/reference/models/sam/amg.md
View file

@ -9,47 +9,47 @@ keywords: Ultralytics, SAM, AMG, API Reference, models, mask stability, crop box
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/amg.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.batch_iterator
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.calculate_stability_score
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.build_point_grid
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.generate_crop_boxes
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_points
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.uncrop_masks
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.remove_small_regions
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.amg.batched_mask_to_box

12
docs/en/reference/models/sam/build.md
View file

@ -9,27 +9,27 @@ keywords: Ultralytics, SAM model, Segment Anything Model, SAM ViT, Mobile-SAM, m
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/build.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.build.build_sam_vit_h
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_l
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam_vit_b
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_mobile_sam
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build._build_sam
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.build.build_sam

2
docs/en/reference/models/sam/model.md
View file

@ -9,7 +9,7 @@ keywords: Ultralytics, SAM, Segment Anything Model, image segmentation, real-tim
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/model.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.model.SAM

4
docs/en/reference/models/sam/modules/decoders.md
View file

@ -9,11 +9,11 @@ keywords: Ultralytics, MaskDecoder, MLP, machine learning, transformer architect
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/decoders.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.decoders.MLP

20
docs/en/reference/models/sam/modules/encoders.md
View file

@ -9,43 +9,43 @@ keywords: Ultralytics, SAM encoder, ImageEncoderViT, PromptEncoder, PositionEmbe
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/encoders.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.Block
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.Attention
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.PatchEmbed
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.window_partition
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.window_unpartition
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.get_rel_pos
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos

2
docs/en/reference/models/sam/modules/sam.md
View file

@ -9,7 +9,7 @@ keywords: Ultralytics, Sam Module, object segmentation, image encoder, mask deco
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/sam.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.modules.sam.Sam

22
docs/en/reference/models/sam/modules/tiny_encoder.md
View file

@ -9,47 +9,47 @@ keywords: Ultralytics, TinyViT, Conv2d_BN, PatchEmbed, MBConv, Attention, PyTorc
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/tiny_encoder.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT

6
docs/en/reference/models/sam/modules/transformer.md
View file

@ -9,15 +9,15 @@ keywords: Ultralytics, TwoWayTransformer, module, deep learning, transformer, ob
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/modules/transformer.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.models.sam.modules.transformer.Attention

2
docs/en/reference/models/sam/predict.md
View file

@ -9,7 +9,7 @@ keywords: Ultralytics, SAM, Segment Anything Model, image segmentation, real-tim
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). If you spot a problem please help fix it by [contributing](https://docs.ultralytics.com/help/contributing/) a [Pull Request](https://github.com/ultralytics/ultralytics/edit/main/ultralytics/models/sam/predict.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.models.sam.predict.Predictor