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

Mkdocs annotations fixes (#7600)

Browse source 
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Glenn Jocher 2024-01-15 23:37:37 +01:00 • committed by GitHub
parent 22651d01cf
commit b1282544d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 137 additions and 63 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/en/guides/distance-calculation.md
View file

@ -23,6 +23,7 @@ Measuring the gap between two objects is known as distance calculation within a
!!! Example "Distance Calculation using YOLOv8 Example"
=== "Video Stream"
```python
from ultralytics import YOLO
from ultralytics.solutions import distance_calculation
@ -68,13 +69,13 @@ Measuring the gap between two objects is known as distance calculation within a
### Optional Arguments `set_args`
| Name | Type | Default | Description |
|----------------|--------|-----------------|--------------------------------------------------------|
| names | `dict` | `None` | Classes names |
| view_img | `bool` | `False` | Display frames with counts |
| line_thickness | `int` | `2` | Increase bounding boxes thickness |
| line_color | `RGB` | `(255, 255, 0)` | Line Color for centroids mapping on two bounding boxes |
| centroid_color | `RGB` | `(255, 0, 255)` | Centroid color for each bounding box |
| Name | Type | Default | Description |
|------------------|--------|-----------------|--------------------------------------------------------|
| `names` | `dict` | `None` | Classes names |
| `view_img` | `bool` | `False` | Display frames with counts |
| `line_thickness` | `int` | `2` | Increase bounding boxes thickness |
| `line_color` | `RGB` | `(255, 255, 0)` | Line Color for centroids mapping on two bounding boxes |
| `centroid_color` | `RGB` | `(255, 0, 255)` | Centroid color for each bounding box |
### Arguments `model.track`

37
docs/en/guides/heatmaps.md
View file

@ -42,6 +42,7 @@ A heatmap generated with [Ultralytics YOLOv8](https://github.com/ultralytics/ult
!!! Example "Heatmaps using Ultralytics YOLOv8 Example"
=== "Heatmap"
```python
from ultralytics import YOLO
from ultralytics.solutions import heatmap
@ -83,6 +84,7 @@ A heatmap generated with [Ultralytics YOLOv8](https://github.com/ultralytics/ult
```
=== "Line Counting"
```python
from ultralytics import YOLO
from ultralytics.solutions import heatmap
@ -126,6 +128,7 @@ A heatmap generated with [Ultralytics YOLOv8](https://github.com/ultralytics/ult
```
=== "Region Counting"
```python
from ultralytics import YOLO
from ultralytics.solutions import heatmap
@ -170,6 +173,7 @@ A heatmap generated with [Ultralytics YOLOv8](https://github.com/ultralytics/ult
```
=== "Im0"
```python
from ultralytics import YOLO
from ultralytics.solutions import heatmap
@ -194,6 +198,7 @@ A heatmap generated with [Ultralytics YOLOv8](https://github.com/ultralytics/ult
```
=== "Specific Classes"
```python
from ultralytics import YOLO
from ultralytics.solutions import heatmap
@ -238,22 +243,22 @@ A heatmap generated with [Ultralytics YOLOv8](https://github.com/ultralytics/ult
### Arguments `set_args`
| Name | Type | Default | Description |
|---------------------|----------------|-------------------|-----------------------------------------------------------|
| view_img | `bool` | `False` | Display the frame with heatmap |
| colormap | `cv2.COLORMAP` | `None` | cv2.COLORMAP for heatmap |
| imw | `int` | `None` | Width of Heatmap |
| imh | `int` | `None` | Height of Heatmap |
| heatmap_alpha | `float` | `0.5` | Heatmap alpha value |
| count_reg_pts | `list` | `None` | Object counting region points |
| count_txt_thickness | `int` | `2` | Count values text size |
| count_txt_color | `RGB Color` | `(0, 0, 0)` | Foreground color for Object counts text |
| count_color | `RGB Color` | `(255, 255, 255)` | Background color for Object counts text |
| count_reg_color | `RGB Color` | `(255, 0, 255)` | Counting region color |
| region_thickness | `int` | `5` | Counting region thickness value |
| decay_factor | `float` | `0.99` | Decay factor for heatmap area removal after specific time |
| shape | `str` | `circle` | Heatmap shape for display "rect" or "circle" supported |
| line_dist_thresh | `int` | `15` | Euclidean Distance threshold for line counter |
| Name | Type | Default | Description |
|-----------------------|----------------|-------------------|-----------------------------------------------------------|
| `view_img` | `bool` | `False` | Display the frame with heatmap |
| `colormap` | `cv2.COLORMAP` | `None` | cv2.COLORMAP for heatmap |
| `imw` | `int` | `None` | Width of Heatmap |
| `imh` | `int` | `None` | Height of Heatmap |
| `heatmap_alpha` | `float` | `0.5` | Heatmap alpha value |
| `count_reg_pts` | `list` | `None` | Object counting region points |
| `count_txt_thickness` | `int` | `2` | Count values text size |
| `count_txt_color` | `RGB Color` | `(0, 0, 0)` | Foreground color for Object counts text |
| `count_color` | `RGB Color` | `(255, 255, 255)` | Background color for Object counts text |
| `count_reg_color` | `RGB Color` | `(255, 0, 255)` | Counting region color |
| `region_thickness` | `int` | `5` | Counting region thickness value |
| `decay_factor` | `float` | `0.99` | Decay factor for heatmap area removal after specific time |
| `shape` | `str` | `circle` | Heatmap shape for display "rect" or "circle" supported |
| `line_dist_thresh` | `int` | `15` | Euclidean Distance threshold for line counter |
### Arguments `model.track`

2
docs/en/guides/instance-segmentation-and-tracking.md
View file

@ -26,6 +26,7 @@ There are two types of instance segmentation tracking available in the Ultralyti
!!! Example "Instance Segmentation and Tracking"
=== "Instance Segmentation"
```python
import cv2
from ultralytics import YOLO
@ -68,6 +69,7 @@ There are two types of instance segmentation tracking available in the Ultralyti
```
=== "Instance Segmentation with Object Tracking"
```python
import cv2
from ultralytics import YOLO

1
docs/en/guides/object-blurring.md
View file

@ -19,6 +19,7 @@ Object blurring with [Ultralytics YOLOv8](https://github.com/ultralytics/ultraly
!!! Example "Object Blurring using YOLOv8 Example"
=== "Object Blurring"
```python
from ultralytics import YOLO
from ultralytics.utils.plotting import Annotator, colors

4
docs/en/guides/object-counting.md
View file

@ -37,6 +37,7 @@ Object counting with [Ultralytics YOLOv8](https://github.com/ultralytics/ultraly
!!! Example "Object Counting using YOLOv8 Example"
=== "Region"
```python
from ultralytics import YOLO
from ultralytics.solutions import object_counter
@ -76,10 +77,10 @@ Object counting with [Ultralytics YOLOv8](https://github.com/ultralytics/ultraly
cap.release()
video_writer.release()
cv2.destroyAllWindows()
```
=== "Line"
```python
from ultralytics import YOLO
from ultralytics.solutions import object_counter
@ -122,6 +123,7 @@ Object counting with [Ultralytics YOLOv8](https://github.com/ultralytics/ultraly
```
=== "Specific Classes"
```python
from ultralytics import YOLO
from ultralytics.solutions import object_counter

1
docs/en/guides/object-cropping.md
View file

@ -19,6 +19,7 @@ Object cropping with [Ultralytics YOLOv8](https://github.com/ultralytics/ultraly
!!! Example "Object Cropping using YOLOv8 Example"
=== "Object Cropping"
```python
from ultralytics import YOLO
from ultralytics.utils.plotting import Annotator, colors

17
docs/en/guides/speed-estimation.md
View file

@ -26,6 +26,7 @@ Speed estimation is the process of calculating the rate of movement of an object
!!! Example "Speed Estimation using YOLOv8 Example"
=== "Speed Estimation"
```python
from ultralytics import YOLO
from ultralytics.solutions import speed_estimation
@ -76,14 +77,14 @@ Speed estimation is the process of calculating the rate of movement of an object
### Optional Arguments `set_args`
| Name | Type | Default | Description |
|------------------|--------|----------------------------|---------------------------------------------------|
| reg_pts | `list` | `[(20, 400), (1260, 400)]` | Points defining the Region Area |
| names | `dict` | `None` | Classes names |
| view_img | `bool` | `False` | Display frames with counts |
| line_thickness | `int` | `2` | Increase bounding boxes thickness |
| region_thickness | `int` | `5` | Thickness for object counter region or line |
| spdl_dist_thresh | `int` | `10` | Euclidean Distance threshold for speed check line |
| Name | Type | Default | Description |
|--------------------|--------|----------------------------|---------------------------------------------------|
| `reg_pts` | `list` | `[(20, 400), (1260, 400)]` | Points defining the Region Area |
| `names` | `dict` | `None` | Classes names |
| `view_img` | `bool` | `False` | Display frames with counts |
| `line_thickness` | `int` | `2` | Increase bounding boxes thickness |
| `region_thickness` | `int` | `5` | Thickness for object counter region or line |
| `spdl_dist_thresh` | `int` | `10` | Euclidean Distance threshold for speed check line |
### Arguments `model.track`

2
docs/en/guides/vision-eye.md
View file

@ -20,6 +20,7 @@ keywords: Ultralytics, YOLOv8, Object Detection, Object Tracking, IDetection, Vi
!!! Example "VisionEye Object Mapping using YOLOv8"
=== "VisionEye Object Mapping"
```python
import cv2
from ultralytics import YOLO
@ -62,6 +63,7 @@ keywords: Ultralytics, YOLOv8, Object Detection, Object Tracking, IDetection, Vi
```
=== "VisionEye Object Mapping with Object Tracking"
```python
import cv2
from ultralytics import YOLO

18
docs/en/guides/workouts-monitoring.md
View file

@ -26,6 +26,7 @@ Monitoring workouts through pose estimation with [Ultralytics YOLOv8](https://gi
!!! Example "Workouts Monitoring Example"
=== "Workouts Monitoring"
```python
from ultralytics import YOLO
from ultralytics.solutions import ai_gym
@ -56,6 +57,7 @@ Monitoring workouts through pose estimation with [Ultralytics YOLOv8](https://gi
```
=== "Workouts Monitoring with Save Output"
```python
from ultralytics import YOLO
from ultralytics.solutions import ai_gym
@ -102,14 +104,14 @@ Monitoring workouts through pose estimation with [Ultralytics YOLOv8](https://gi
### Arguments `set_args`
| Name | Type | Default | Description |
|-----------------|--------|----------|----------------------------------------------------------------------------------------|
| kpts_to_check | `list` | `None` | List of three keypoints index, for counting specific workout, followed by keypoint Map |
| view_img | `bool` | `False` | Display the frame with counts |
| line_thickness | `int` | `2` | Increase the thickness of count value |
| pose_type | `str` | `pushup` | Pose that need to be monitored, "pullup" and "abworkout" also supported |
| pose_up_angle | `int` | `145` | Pose Up Angle value |
| pose_down_angle | `int` | `90` | Pose Down Angle value |
| Name | Type | Default | Description |
|-------------------|--------|----------|----------------------------------------------------------------------------------------|
| `kpts_to_check` | `list` | `None` | List of three keypoints index, for counting specific workout, followed by keypoint Map |
| `view_img` | `bool` | `False` | Display the frame with counts |
| `line_thickness` | `int` | `2` | Increase the thickness of count value |
| `pose_type` | `str` | `pushup` | Pose that need to be monitored, "pullup" and "abworkout" also supported |
| `pose_up_angle` | `int` | `145` | Pose Up Angle value |
| `pose_down_angle` | `int` | `90` | Pose Down Angle value |
### Arguments `model.predict`