Docstrings arguments cleanup (#3229)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Glenn Jocher
2023-06-17 16:17:07 +02:00
committed by GitHub
parent 62916b3b0a
commit bd0f7ecf6f
93 changed files with 1104 additions and 1102 deletions

View File

@ -3,12 +3,12 @@ description: Ensure class names match filenames for easy imports. Use AutoBacken
keywords: AutoBackend, ultralytics, nn, autobackend, check class names, neural network
---
# AutoBackend
## AutoBackend
---
:::ultralytics.nn.autobackend.AutoBackend
### ::: ultralytics.nn.autobackend.AutoBackend
<br><br>
# check_class_names
## check_class_names
---
:::ultralytics.nn.autobackend.check_class_names
### ::: ultralytics.nn.autobackend.check_class_names
<br><br>

View File

@ -3,12 +3,12 @@ description: Detect 80+ object categories with bounding box coordinates and clas
keywords: Ultralytics, YOLO, docs, autoshape, detections, object detection, customized shapes, bounding boxes, computer vision
---
# AutoShape
## AutoShape
---
:::ultralytics.nn.autoshape.AutoShape
### ::: ultralytics.nn.autoshape.AutoShape
<br><br>
# Detections
## Detections
---
:::ultralytics.nn.autoshape.Detections
### ::: ultralytics.nn.autoshape.Detections
<br><br>

View File

@ -3,87 +3,87 @@ description: Explore ultralytics.nn.modules.block to build powerful YOLO object
keywords: Ultralytics, NN Modules, Blocks, DFL, HGStem, SPP, C1, C2f, C3x, C3TR, GhostBottleneck, BottleneckCSP, Computer Vision
---
# DFL
## DFL
---
:::ultralytics.nn.modules.block.DFL
### ::: ultralytics.nn.modules.block.DFL
<br><br>
# Proto
## Proto
---
:::ultralytics.nn.modules.block.Proto
### ::: ultralytics.nn.modules.block.Proto
<br><br>
# HGStem
## HGStem
---
:::ultralytics.nn.modules.block.HGStem
### ::: ultralytics.nn.modules.block.HGStem
<br><br>
# HGBlock
## HGBlock
---
:::ultralytics.nn.modules.block.HGBlock
### ::: ultralytics.nn.modules.block.HGBlock
<br><br>
# SPP
## SPP
---
:::ultralytics.nn.modules.block.SPP
### ::: ultralytics.nn.modules.block.SPP
<br><br>
# SPPF
## SPPF
---
:::ultralytics.nn.modules.block.SPPF
### ::: ultralytics.nn.modules.block.SPPF
<br><br>
# C1
## C1
---
:::ultralytics.nn.modules.block.C1
### ::: ultralytics.nn.modules.block.C1
<br><br>
# C2
## C2
---
:::ultralytics.nn.modules.block.C2
### ::: ultralytics.nn.modules.block.C2
<br><br>
# C2f
## C2f
---
:::ultralytics.nn.modules.block.C2f
### ::: ultralytics.nn.modules.block.C2f
<br><br>
# C3
## C3
---
:::ultralytics.nn.modules.block.C3
### ::: ultralytics.nn.modules.block.C3
<br><br>
# C3x
## C3x
---
:::ultralytics.nn.modules.block.C3x
### ::: ultralytics.nn.modules.block.C3x
<br><br>
# RepC3
## RepC3
---
:::ultralytics.nn.modules.block.RepC3
### ::: ultralytics.nn.modules.block.RepC3
<br><br>
# C3TR
## C3TR
---
:::ultralytics.nn.modules.block.C3TR
### ::: ultralytics.nn.modules.block.C3TR
<br><br>
# C3Ghost
## C3Ghost
---
:::ultralytics.nn.modules.block.C3Ghost
### ::: ultralytics.nn.modules.block.C3Ghost
<br><br>
# GhostBottleneck
## GhostBottleneck
---
:::ultralytics.nn.modules.block.GhostBottleneck
### ::: ultralytics.nn.modules.block.GhostBottleneck
<br><br>
# Bottleneck
## Bottleneck
---
:::ultralytics.nn.modules.block.Bottleneck
### ::: ultralytics.nn.modules.block.Bottleneck
<br><br>
# BottleneckCSP
## BottleneckCSP
---
:::ultralytics.nn.modules.block.BottleneckCSP
### ::: ultralytics.nn.modules.block.BottleneckCSP
<br><br>

View File

@ -3,72 +3,72 @@ description: Explore convolutional neural network modules & techniques such as L
keywords: Ultralytics, Convolutional Neural Network, Conv2, DWConv, ConvTranspose, GhostConv, ChannelAttention, CBAM, autopad
---
# Conv
## Conv
---
:::ultralytics.nn.modules.conv.Conv
### ::: ultralytics.nn.modules.conv.Conv
<br><br>
# Conv2
## Conv2
---
:::ultralytics.nn.modules.conv.Conv2
### ::: ultralytics.nn.modules.conv.Conv2
<br><br>
# LightConv
## LightConv
---
:::ultralytics.nn.modules.conv.LightConv
### ::: ultralytics.nn.modules.conv.LightConv
<br><br>
# DWConv
## DWConv
---
:::ultralytics.nn.modules.conv.DWConv
### ::: ultralytics.nn.modules.conv.DWConv
<br><br>
# DWConvTranspose2d
## DWConvTranspose2d
---
:::ultralytics.nn.modules.conv.DWConvTranspose2d
### ::: ultralytics.nn.modules.conv.DWConvTranspose2d
<br><br>
# ConvTranspose
## ConvTranspose
---
:::ultralytics.nn.modules.conv.ConvTranspose
### ::: ultralytics.nn.modules.conv.ConvTranspose
<br><br>
# Focus
## Focus
---
:::ultralytics.nn.modules.conv.Focus
### ::: ultralytics.nn.modules.conv.Focus
<br><br>
# GhostConv
## GhostConv
---
:::ultralytics.nn.modules.conv.GhostConv
### ::: ultralytics.nn.modules.conv.GhostConv
<br><br>
# RepConv
## RepConv
---
:::ultralytics.nn.modules.conv.RepConv
### ::: ultralytics.nn.modules.conv.RepConv
<br><br>
# ChannelAttention
## ChannelAttention
---
:::ultralytics.nn.modules.conv.ChannelAttention
### ::: ultralytics.nn.modules.conv.ChannelAttention
<br><br>
# SpatialAttention
## SpatialAttention
---
:::ultralytics.nn.modules.conv.SpatialAttention
### ::: ultralytics.nn.modules.conv.SpatialAttention
<br><br>
# CBAM
## CBAM
---
:::ultralytics.nn.modules.conv.CBAM
### ::: ultralytics.nn.modules.conv.CBAM
<br><br>
# Concat
## Concat
---
:::ultralytics.nn.modules.conv.Concat
### ::: ultralytics.nn.modules.conv.Concat
<br><br>
# autopad
## autopad
---
:::ultralytics.nn.modules.conv.autopad
### ::: ultralytics.nn.modules.conv.autopad
<br><br>

View File

@ -3,27 +3,27 @@ description: 'Learn about Ultralytics YOLO modules: Segment, Classify, and RTDET
keywords: Ultralytics, YOLO, object detection, pose estimation, RTDETRDecoder, modules, classes, documentation
---
# Detect
## Detect
---
:::ultralytics.nn.modules.head.Detect
### ::: ultralytics.nn.modules.head.Detect
<br><br>
# Segment
## Segment
---
:::ultralytics.nn.modules.head.Segment
### ::: ultralytics.nn.modules.head.Segment
<br><br>
# Pose
## Pose
---
:::ultralytics.nn.modules.head.Pose
### ::: ultralytics.nn.modules.head.Pose
<br><br>
# Classify
## Classify
---
:::ultralytics.nn.modules.head.Classify
### ::: ultralytics.nn.modules.head.Classify
<br><br>
# RTDETRDecoder
## RTDETRDecoder
---
:::ultralytics.nn.modules.head.RTDETRDecoder
### ::: ultralytics.nn.modules.head.RTDETRDecoder
<br><br>

View File

@ -3,52 +3,52 @@ description: Explore the Ultralytics nn modules pages on Transformer and MLP blo
keywords: Ultralytics, NN Modules, TransformerEncoderLayer, TransformerLayer, MLPBlock, LayerNorm2d, DeformableTransformerDecoderLayer, examples, code snippets, tutorials
---
# TransformerEncoderLayer
## TransformerEncoderLayer
---
:::ultralytics.nn.modules.transformer.TransformerEncoderLayer
### ::: ultralytics.nn.modules.transformer.TransformerEncoderLayer
<br><br>
# AIFI
## AIFI
---
:::ultralytics.nn.modules.transformer.AIFI
### ::: ultralytics.nn.modules.transformer.AIFI
<br><br>
# TransformerLayer
## TransformerLayer
---
:::ultralytics.nn.modules.transformer.TransformerLayer
### ::: ultralytics.nn.modules.transformer.TransformerLayer
<br><br>
# TransformerBlock
## TransformerBlock
---
:::ultralytics.nn.modules.transformer.TransformerBlock
### ::: ultralytics.nn.modules.transformer.TransformerBlock
<br><br>
# MLPBlock
## MLPBlock
---
:::ultralytics.nn.modules.transformer.MLPBlock
### ::: ultralytics.nn.modules.transformer.MLPBlock
<br><br>
# MLP
## MLP
---
:::ultralytics.nn.modules.transformer.MLP
### ::: ultralytics.nn.modules.transformer.MLP
<br><br>
# LayerNorm2d
## LayerNorm2d
---
:::ultralytics.nn.modules.transformer.LayerNorm2d
### ::: ultralytics.nn.modules.transformer.LayerNorm2d
<br><br>
# MSDeformAttn
## MSDeformAttn
---
:::ultralytics.nn.modules.transformer.MSDeformAttn
### ::: ultralytics.nn.modules.transformer.MSDeformAttn
<br><br>
# DeformableTransformerDecoderLayer
## DeformableTransformerDecoderLayer
---
:::ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
### ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoderLayer
<br><br>
# DeformableTransformerDecoder
## DeformableTransformerDecoder
---
:::ultralytics.nn.modules.transformer.DeformableTransformerDecoder
### ::: ultralytics.nn.modules.transformer.DeformableTransformerDecoder
<br><br>

View File

@ -3,27 +3,27 @@ description: 'Learn about Ultralytics NN modules: get_clones, linear_init_, and
keywords: Ultralytics, NN Utils, Docs, PyTorch, bias initialization, linear initialization, multi-scale deformable attention
---
# _get_clones
## _get_clones
---
:::ultralytics.nn.modules.utils._get_clones
### ::: ultralytics.nn.modules.utils._get_clones
<br><br>
# bias_init_with_prob
## bias_init_with_prob
---
:::ultralytics.nn.modules.utils.bias_init_with_prob
### ::: ultralytics.nn.modules.utils.bias_init_with_prob
<br><br>
# linear_init_
## linear_init_
---
:::ultralytics.nn.modules.utils.linear_init_
### ::: ultralytics.nn.modules.utils.linear_init_
<br><br>
# inverse_sigmoid
## inverse_sigmoid
---
:::ultralytics.nn.modules.utils.inverse_sigmoid
### ::: ultralytics.nn.modules.utils.inverse_sigmoid
<br><br>
# multi_scale_deformable_attn_pytorch
## multi_scale_deformable_attn_pytorch
---
:::ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch
### ::: ultralytics.nn.modules.utils.multi_scale_deformable_attn_pytorch
<br><br>

View File

@ -3,72 +3,72 @@ description: Learn how to work with Ultralytics YOLO Detection, Segmentation & C
keywords: neural network, deep learning, computer vision, object detection, image segmentation, image classification, model ensemble, PyTorch
---
# BaseModel
## BaseModel
---
:::ultralytics.nn.tasks.BaseModel
### ::: ultralytics.nn.tasks.BaseModel
<br><br>
# DetectionModel
## DetectionModel
---
:::ultralytics.nn.tasks.DetectionModel
### ::: ultralytics.nn.tasks.DetectionModel
<br><br>
# SegmentationModel
## SegmentationModel
---
:::ultralytics.nn.tasks.SegmentationModel
### ::: ultralytics.nn.tasks.SegmentationModel
<br><br>
# PoseModel
## PoseModel
---
:::ultralytics.nn.tasks.PoseModel
### ::: ultralytics.nn.tasks.PoseModel
<br><br>
# ClassificationModel
## ClassificationModel
---
:::ultralytics.nn.tasks.ClassificationModel
### ::: ultralytics.nn.tasks.ClassificationModel
<br><br>
# RTDETRDetectionModel
## RTDETRDetectionModel
---
:::ultralytics.nn.tasks.RTDETRDetectionModel
### ::: ultralytics.nn.tasks.RTDETRDetectionModel
<br><br>
# Ensemble
## Ensemble
---
:::ultralytics.nn.tasks.Ensemble
### ::: ultralytics.nn.tasks.Ensemble
<br><br>
# torch_safe_load
## torch_safe_load
---
:::ultralytics.nn.tasks.torch_safe_load
### ::: ultralytics.nn.tasks.torch_safe_load
<br><br>
# attempt_load_weights
## attempt_load_weights
---
:::ultralytics.nn.tasks.attempt_load_weights
### ::: ultralytics.nn.tasks.attempt_load_weights
<br><br>
# attempt_load_one_weight
## attempt_load_one_weight
---
:::ultralytics.nn.tasks.attempt_load_one_weight
### ::: ultralytics.nn.tasks.attempt_load_one_weight
<br><br>
# parse_model
## parse_model
---
:::ultralytics.nn.tasks.parse_model
### ::: ultralytics.nn.tasks.parse_model
<br><br>
# yaml_model_load
## yaml_model_load
---
:::ultralytics.nn.tasks.yaml_model_load
### ::: ultralytics.nn.tasks.yaml_model_load
<br><br>
# guess_model_scale
## guess_model_scale
---
:::ultralytics.nn.tasks.guess_model_scale
### ::: ultralytics.nn.tasks.guess_model_scale
<br><br>
# guess_model_task
## guess_model_task
---
:::ultralytics.nn.tasks.guess_model_task
### ::: ultralytics.nn.tasks.guess_model_task
<br><br>