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

6
docs/en/reference/nn/autobackend.md
View file

@ -9,15 +9,15 @@ keywords: Ultralytics, AutoBackend, check_class_names, YOLO, YOLO models, optimi
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/autobackend.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/nn/autobackend.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.autobackend.AutoBackend
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.autobackend.check_class_names
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.autobackend.default_class_names

78
docs/en/reference/nn/modules/block.md
View file

@ -9,159 +9,159 @@ keywords: Ultralytics, YOLO, neural networks, block modules, DFL, Proto, HGStem,
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/block.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/nn/modules/block.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.modules.block.DFL
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Proto
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.HGStem
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.HGBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPPF
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C1
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2f
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3x
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepC3
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3TR
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C3Ghost
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.GhostBottleneck
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Bottleneck
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.BottleneckCSP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ResNetBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ResNetLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.MaxSigmoidAttnBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fAttn
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ImagePoolingAttn
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ContrastiveHead
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.BNContrastiveHead
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepBottleneck
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepCSP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepNCSPELAN4
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ELAN1
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.AConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.ADown
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SPPELAN
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CBLinear
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CBFuse
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.RepVGGDW
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.CIB
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.C2fCIB
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.Attention
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.PSA
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.block.SCDown

28
docs/en/reference/nn/modules/conv.md
View file

@ -9,59 +9,59 @@ keywords: Ultralytics, convolution modules, Conv, LightConv, GhostConv, YOLO, de
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/conv.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/nn/modules/conv.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.modules.conv.Conv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Conv2
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.LightConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.DWConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.DWConvTranspose2d
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.ConvTranspose
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Focus
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.GhostConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.RepConv
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.ChannelAttention
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.SpatialAttention
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.CBAM
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.Concat
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.conv.autopad

16
docs/en/reference/nn/modules/head.md
View file

@ -9,35 +9,35 @@ keywords: Ultralytics, YOLO, Detection, Pose, RTDETRDecoder, nn modules, guides
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/head.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/nn/modules/head.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.modules.head.Detect
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Segment
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.OBB
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Pose
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.Classify
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.WorldDetect
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.RTDETRDecoder
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.head.v10Detect

20
docs/en/reference/nn/modules/transformer.md
View file

@ -9,43 +9,43 @@ keywords: Ultralytics, Ultralytics documentation, TransformerEncoderLayer, Trans
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/transformer.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/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/nn/modules/transformer.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.AIFI
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.TransformerLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.TransformerBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MLPBlock
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MLP
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.LayerNorm2d
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.MSDeformAttn
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoder

10
docs/en/reference/nn/modules/utils.md
View file

@ -9,23 +9,23 @@ keywords: Ultralytics, PyTorch, utils, initialization, inverse sigmoid, multisca
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/modules/utils.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/nn/modules/utils.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.modules.utils._get_clones
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.bias_init_with_prob
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.linear_init
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.inverse_sigmoid
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch

34
docs/en/reference/nn/tasks.md
View file

@ -9,71 +9,71 @@ keywords: Ultralytics, YOLO, nn tasks, DetectionModel, PoseModel, RTDETRDetectio
This file is available at [https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.py](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/nn/tasks.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/nn/tasks.py) 🛠️. Thank you 🙏!
<br><br>
<br>
## ::: ultralytics.nn.tasks.BaseModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.DetectionModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.OBBModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.SegmentationModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.PoseModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.ClassificationModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.RTDETRDetectionModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.WorldModel
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.Ensemble
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.temporary_modules
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.torch_safe_load
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.attempt_load_weights
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.attempt_load_one_weight
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.parse_model
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.yaml_model_load
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.guess_model_scale
<br><br>
<br><br><hr><br>
## ::: ultralytics.nn.tasks.guess_model_task