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

Add Chinese Modes and Tasks Docs (#6274)

Browse source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher 2023-11-12 02:49:37 +01:00 • committed by GitHub
parent 795b95bdcb
commit e3a538bbde
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
293 changed files with 3681 additions and 736 deletions
Download patch file Download diff file Expand all files Collapse all files

54
docs/en/reference/models/sam/amg.md Normal file
View file

@ -0,0 +1,54 @@
---
description: Explore Ultralytics methods for mask data processing, transformation and encoding. Deepen your understanding of RLE encoding, image cropping and more.
keywords: Ultralytics, Mask Data, Transformation, Encoding, RLE encoding, Image cropping, Pytorch, SAM, AMG, Ultralytics model
---
# Reference for `ultralytics/models/sam/amg.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.amg.is_box_near_crop_edge
<br><br>
---
## ::: ultralytics.models.sam.amg.batch_iterator
<br><br>
---
## ::: ultralytics.models.sam.amg.calculate_stability_score
<br><br>
---
## ::: ultralytics.models.sam.amg.build_point_grid
<br><br>
---
## ::: ultralytics.models.sam.amg.build_all_layer_point_grids
<br><br>
---
## ::: ultralytics.models.sam.amg.generate_crop_boxes
<br><br>
---
## ::: ultralytics.models.sam.amg.uncrop_boxes_xyxy
<br><br>
---
## ::: ultralytics.models.sam.amg.uncrop_points
<br><br>
---
## ::: ultralytics.models.sam.amg.uncrop_masks
<br><br>
---
## ::: ultralytics.models.sam.amg.remove_small_regions
<br><br>
---
## ::: ultralytics.models.sam.amg.batched_mask_to_box
<br><br>

34
docs/en/reference/models/sam/build.md Normal file
View file

@ -0,0 +1,34 @@
---
description: Master building SAM ViT models with Ultralytics. Discover steps to leverage the power of SAM and Vision Transformer sessions.
keywords: Ultralytics, SAM, build sam, vision transformer, vits, build_sam_vit_l, build_sam_vit_b, build_sam
---
# Reference for `ultralytics/models/sam/build.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.build.build_sam_vit_h
<br><br>
---
## ::: ultralytics.models.sam.build.build_sam_vit_l
<br><br>
---
## ::: ultralytics.models.sam.build.build_sam_vit_b
<br><br>
---
## ::: ultralytics.models.sam.build.build_mobile_sam
<br><br>
---
## ::: ultralytics.models.sam.build._build_sam
<br><br>
---
## ::: ultralytics.models.sam.build.build_sam
<br><br>

14
docs/en/reference/models/sam/model.md Normal file
View file

@ -0,0 +1,14 @@
---
description: Dive into the SAM model details in the Ultralytics YOLO documentation. Understand, implement, and optimize your model use.
keywords: Ultralytics, YOLO, SAM Model, Documentations, Machine Learning, AI, Convolutional neural network
---
# Reference for `ultralytics/models/sam/model.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.model.SAM
<br><br>

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

@ -0,0 +1,18 @@
---
description: Explore MaskDecoder, a part of the Ultralytics models. Gain insights on how to utilize it effectively in the SAM modules decoders MLP.
keywords: Ultralytics, MaskDecoder, SAM modules, decoders, MLP, YOLO, machine learning, image recognition
---
# Reference for `ultralytics/models/sam/modules/decoders.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.modules.decoders.MaskDecoder
<br><br>
---
## ::: ultralytics.models.sam.modules.decoders.MLP
<br><br>

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

@ -0,0 +1,50 @@
---
description: Discover detailed information on ImageEncoderViT, PositionEmbeddingRandom, Attention, window_partition, get_rel_pos and more in Ultralytics models encoders documentation.
keywords: Ultralytics, Encoders, Modules, Documentation, ImageEncoderViT, PositionEmbeddingRandom, Attention, window_partition, get_rel_pos
---
# Reference for `ultralytics/models/sam/modules/encoders.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.modules.encoders.ImageEncoderViT
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.PromptEncoder
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.PositionEmbeddingRandom
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.Block
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.Attention
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.PatchEmbed
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.window_partition
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.window_unpartition
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.get_rel_pos
<br><br>
---
## ::: ultralytics.models.sam.modules.encoders.add_decomposed_rel_pos
<br><br>

14
docs/en/reference/models/sam/modules/sam.md Normal file
View file

@ -0,0 +1,14 @@
---
description: Explore the Sam module of Ultralytics. Discover detailed methods, classes, and information for efficient deep-learning model training!.
keywords: Ultralytics, Sam module, deep learning, model training, Ultralytics documentation
---
# Reference for `ultralytics/models/sam/modules/sam.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.modules.sam.Sam
<br><br>

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

@ -0,0 +1,54 @@
---
description: Get in-depth insights about Ultralytics Tiny Encoder Modules such as Conv2d_BN, MBConv, ConvLayer, Attention, BasicLayer, and TinyViT. Improve your understanding of machine learning model components.
keywords: Ultralytics, Tiny Encoder, Conv2d_BN, MBConv, ConvLayer, Attention, BasicLayer, TinyViT, Machine learning modules, Ultralytics models
---
# Reference for `ultralytics/models/sam/modules/tiny_encoder.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.modules.tiny_encoder.Conv2d_BN
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchEmbed
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.MBConv
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.PatchMerging
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.ConvLayer
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.Mlp
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.Attention
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViTBlock
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.BasicLayer
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.LayerNorm2d
<br><br>
---
## ::: ultralytics.models.sam.modules.tiny_encoder.TinyViT
<br><br>

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

@ -0,0 +1,22 @@
---
description: Learn about TwoWayTransformer and Attention modules in Ultralytics. Leverage these tools to enhance your AI models.
keywords: Ultralytics, TwoWayTransformer, Attention, AI models, transformers
---
# Reference for `ultralytics/models/sam/modules/transformer.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.modules.transformer.TwoWayTransformer
<br><br>
---
## ::: ultralytics.models.sam.modules.transformer.TwoWayAttentionBlock
<br><br>
---
## ::: ultralytics.models.sam.modules.transformer.Attention
<br><br>

14
docs/en/reference/models/sam/predict.md Normal file
View file

@ -0,0 +1,14 @@
---
description: Master the ultralytics.models.sam.predict.Predictor class with our comprehensive guide. Discover techniques to enhance your model predictions.
keywords: Ultralytics, predictor, models, sam.predict.Predictor, AI, machine learning, predictive models
---
# Reference for `ultralytics/models/sam/predict.py`
!!! note
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 🙏!
---
## ::: ultralytics.models.sam.predict.Predictor
<br><br>