Mkdocs annotations fixes (#7600)

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

View file

@ -108,6 +108,7 @@ YOLO detection models, such as `yolov8n.pt`, can return JSON responses from loca
!!! Example "Detect Model JSON Response"
=== "Local"
```python
from ultralytics import YOLO
@ -122,6 +123,7 @@ YOLO detection models, such as `yolov8n.pt`, can return JSON responses from loca
```
=== "CLI API"
```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \
-H "x-api-key: API_KEY" \
@ -132,6 +134,7 @@ YOLO detection models, such as `yolov8n.pt`, can return JSON responses from loca
```
=== "Python API"
```python
import requests
@ -153,6 +156,7 @@ YOLO detection models, such as `yolov8n.pt`, can return JSON responses from loca
```
=== "JSON Response"
```json
{
"success": True,
@ -202,6 +206,7 @@ YOLO segmentation models, such as `yolov8n-seg.pt`, can return JSON responses fr
!!! Example "Segment Model JSON Response"
=== "Local"
```python
from ultralytics import YOLO
@ -216,6 +221,7 @@ YOLO segmentation models, such as `yolov8n-seg.pt`, can return JSON responses fr
```
=== "CLI API"
```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \
-H "x-api-key: API_KEY" \
@ -226,6 +232,7 @@ YOLO segmentation models, such as `yolov8n-seg.pt`, can return JSON responses fr
```
=== "Python API"
```python
import requests
@ -247,6 +254,7 @@ YOLO segmentation models, such as `yolov8n-seg.pt`, can return JSON responses fr
```
=== "JSON Response"
Note `segments` `x` and `y` lengths may vary from one object to another. Larger or more complex objects may have more segment points.
```json
{
@ -339,6 +347,7 @@ YOLO pose models, such as `yolov8n-pose.pt`, can return JSON responses from loca
!!! Example "Pose Model JSON Response"
=== "Local"
```python
from ultralytics import YOLO
@ -353,6 +362,7 @@ YOLO pose models, such as `yolov8n-pose.pt`, can return JSON responses from loca
```
=== "CLI API"
```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \
-H "x-api-key: API_KEY" \
@ -363,6 +373,7 @@ YOLO pose models, such as `yolov8n-pose.pt`, can return JSON responses from loca
```
=== "Python API"
```python
import requests
@ -384,6 +395,7 @@ YOLO pose models, such as `yolov8n-pose.pt`, can return JSON responses from loca
```
=== "JSON Response"
Note COCO-keypoints pretrained models will have 17 human keypoints. The `visible` part of the keypoints indicates whether a keypoint is visible or obscured. Obscured keypoints may be outside the image or may not be visible, i.e. a person's eyes facing away from the camera.
```json
{