[Docs]: Link buttons, add autobackend, BaseModel and ops (#130)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
15
docs/reference/nn.md
Normal file
15
docs/reference/nn.md
Normal file
@ -0,0 +1,15 @@
|
||||
# nn Module
|
||||
Ultralytics nn module contains 3 main components:
|
||||
|
||||
1. **AutoBackend**: A module that can run inference on all popular model formats
|
||||
2. **BaseModel**: `BaseModel` class defines the operations supported by tasks like Detection and Segmentation
|
||||
3. **modules**: Optimized and reusable neural network blocks built on PyTorch.
|
||||
|
||||
## AutoBackend
|
||||
:::ultralytics.nn.autobackend.AutoBackend
|
||||
|
||||
## BaseModel
|
||||
:::ultralytics.nn.tasks.BaseModel
|
||||
|
||||
## Modules
|
||||
TODO
|
162
docs/reference/ops.md
Normal file
162
docs/reference/ops.md
Normal file
@ -0,0 +1,162 @@
|
||||
This module contains optimized deep learning related operations used in the Ultralytics YOLO framework
|
||||
## Non-max suppression
|
||||
:::ultralytics.ops.non_max_suppression
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## Scale boxes
|
||||
:::ultralytics.ops.scale_boxes
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## Scale image
|
||||
:::ultralytics.ops.scale_image
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## clip boxes
|
||||
:::ultralytics.ops.clip_boxes
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
# Box Format Conversion
|
||||
## xyxy2xywh
|
||||
:::ultralytics.ops.xyxy2xywh
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## xywh2xyxy
|
||||
:::ultralytics.ops.xywh2xyxy
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## xywhn2xyxy
|
||||
:::ultralytics.ops.xywhn2xyxy
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## xyxy2xywhn
|
||||
:::ultralytics.ops.xyxy2xywhn
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## xyn2xy
|
||||
:::ultralytics.ops.xyn2xy
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## xywh2ltwh
|
||||
:::ultralytics.ops.xywh2ltwh
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## xyxy2ltwh
|
||||
:::ultralytics.ops.xyxy2ltwh
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## ltwh2xywh
|
||||
:::ultralytics.ops.ltwh2xywh
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## ltwh2xyxy
|
||||
:::ultralytics.ops.ltwh2xyxy
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## segment2box
|
||||
:::ultralytics.ops.segment2box
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
# Mask Operations
|
||||
## resample_segments
|
||||
:::ultralytics.ops.resample_segments
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## crop_mask
|
||||
:::ultralytics.ops.crop_mask
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## process_mask_upsample
|
||||
:::ultralytics.ops.process_mask_upsample
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## process_mask
|
||||
:::ultralytics.ops.process_mask
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## process_mask_native
|
||||
:::ultralytics.ops.process_mask_native
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## scale_segments
|
||||
:::ultralytics.ops.scale_segments
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## masks2segments
|
||||
:::ultralytics.ops.masks2segments
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
## clip_segments
|
||||
:::ultralytics.ops.clip_segments
|
||||
handler: python
|
||||
options:
|
||||
show_source: false
|
||||
show_root_toc_entry: false
|
||||
---
|
||||
|
||||
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user