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

Docs: Inference API Updates (#16462)

Browse source 
Co-authored-by: UltralyticsAssistant <web@ultralytics.com>
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Sergiu Waxmann 2024-09-24 16:51:30 +03:00 • committed by GitHub
parent ba949830bf
commit 2f1e6e8fdc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 40 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

68
docs/en/hub/inference-api.md
View file

@ -66,14 +66,14 @@ To access the [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API u
```python ```python
import requests import requests
# API URL, use actual MODEL_ID # API URL
url = "https://api.ultralytics.com/v1/predict/MODEL_ID" url = "https://predict.ultralytics.com"
# Headers, use actual API_KEY # Headers, use actual API_KEY
headers = {"x-api-key": "API_KEY"} headers = {"x-api-key": "API_KEY"}
# Inference arguments (optional) # Inference arguments (use actual MODEL_ID)
data = {"imgsz": 640, "conf": 0.25, "iou": 0.45} data = {"model": "https://hub.ultralytics.com/models/MODEL_ID", "imgsz": 640, "conf": 0.25, "iou": 0.45}
# Load image and send request # Load image and send request
with open("path/to/image.jpg", "rb") as image_file: with open("path/to/image.jpg", "rb") as image_file:
@ -94,8 +94,9 @@ print(response.json())
To access the [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API using cURL, use the following code: To access the [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API using cURL, use the following code:
```bash ```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \ curl -X POST "https://predict.ultralytics.com" \
-H "x-api-key: API_KEY" \ -H "x-api-key: API_KEY" \
-F "model=https://hub.ultralytics.com/models/MODEL_ID" \
-F "file=@/path/to/image.jpg" \ -F "file=@/path/to/image.jpg" \
-F "imgsz=640" \ -F "imgsz=640" \
-F "conf=0.25" \ -F "conf=0.25" \
@ -145,8 +146,9 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
=== "cURL" === "cURL"
```bash ```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \ curl -X POST "https://predict.ultralytics.com" \
-H "x-api-key: API_KEY" \ -H "x-api-key: API_KEY" \
-F "model=https://hub.ultralytics.com/models/MODEL_ID" \
-F "file=@/path/to/image.jpg" \ -F "file=@/path/to/image.jpg" \
-F "imgsz=640" \ -F "imgsz=640" \
-F "conf=0.25" \ -F "conf=0.25" \
@ -158,14 +160,14 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
```python ```python
import requests import requests
# API URL, use actual MODEL_ID # API URL
url = "https://api.ultralytics.com/v1/predict/MODEL_ID" url = "https://predict.ultralytics.com"
# Headers, use actual API_KEY # Headers, use actual API_KEY
headers = {"x-api-key": "API_KEY"} headers = {"x-api-key": "API_KEY"}
# Inference arguments (optional) # Inference arguments (use actual MODEL_ID)
data = {"imgsz": 640, "conf": 0.25, "iou": 0.45} data = {"model": "https://hub.ultralytics.com/models/MODEL_ID", "imgsz": 640, "conf": 0.25, "iou": 0.45}
# Load image and send request # Load image and send request
with open("path/to/image.jpg", "rb") as image_file: with open("path/to/image.jpg", "rb") as image_file:
@ -225,8 +227,9 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
=== "cURL" === "cURL"
```bash ```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \ curl -X POST "https://predict.ultralytics.com" \
-H "x-api-key: API_KEY" \ -H "x-api-key: API_KEY" \
-F "model=https://hub.ultralytics.com/models/MODEL_ID" \
-F "file=@/path/to/image.jpg" \ -F "file=@/path/to/image.jpg" \
-F "imgsz=640" \ -F "imgsz=640" \
-F "conf=0.25" \ -F "conf=0.25" \
@ -238,14 +241,14 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
```python ```python
import requests import requests
# API URL, use actual MODEL_ID # API URL
url = "https://api.ultralytics.com/v1/predict/MODEL_ID" url = "https://predict.ultralytics.com"
# Headers, use actual API_KEY # Headers, use actual API_KEY
headers = {"x-api-key": "API_KEY"} headers = {"x-api-key": "API_KEY"}
# Inference arguments (optional) # Inference arguments (use actual MODEL_ID)
data = {"imgsz": 640, "conf": 0.25, "iou": 0.45} data = {"model": "https://hub.ultralytics.com/models/MODEL_ID", "imgsz": 640, "conf": 0.25, "iou": 0.45}
# Load image and send request # Load image and send request
with open("path/to/image.jpg", "rb") as image_file: with open("path/to/image.jpg", "rb") as image_file:
@ -311,8 +314,9 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
=== "cURL" === "cURL"
```bash ```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \ curl -X POST "https://predict.ultralytics.com" \
-H "x-api-key: API_KEY" \ -H "x-api-key: API_KEY" \
-F "model=https://hub.ultralytics.com/models/MODEL_ID" \
-F "file=@/path/to/image.jpg" \ -F "file=@/path/to/image.jpg" \
-F "imgsz=640" \ -F "imgsz=640" \
-F "conf=0.25" \ -F "conf=0.25" \
@ -324,14 +328,14 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
```python ```python
import requests import requests
# API URL, use actual MODEL_ID # API URL
url = "https://api.ultralytics.com/v1/predict/MODEL_ID" url = "https://predict.ultralytics.com"
# Headers, use actual API_KEY # Headers, use actual API_KEY
headers = {"x-api-key": "API_KEY"} headers = {"x-api-key": "API_KEY"}
# Inference arguments (optional) # Inference arguments (use actual MODEL_ID)
data = {"imgsz": 640, "conf": 0.25, "iou": 0.45} data = {"model": "https://hub.ultralytics.com/models/MODEL_ID", "imgsz": 640, "conf": 0.25, "iou": 0.45}
# Load image and send request # Load image and send request
with open("path/to/image.jpg", "rb") as image_file: with open("path/to/image.jpg", "rb") as image_file:
@ -401,8 +405,9 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
=== "cURL" === "cURL"
```bash ```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \ curl -X POST "https://predict.ultralytics.com" \
-H "x-api-key: API_KEY" \ -H "x-api-key: API_KEY" \
-F "model=https://hub.ultralytics.com/models/MODEL_ID" \
-F "file=@/path/to/image.jpg" \ -F "file=@/path/to/image.jpg" \
-F "imgsz=640" \ -F "imgsz=640" \
-F "conf=0.25" \ -F "conf=0.25" \
@ -414,14 +419,14 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
```python ```python
import requests import requests
# API URL, use actual MODEL_ID # API URL
url = "https://api.ultralytics.com/v1/predict/MODEL_ID" url = "https://predict.ultralytics.com"
# Headers, use actual API_KEY # Headers, use actual API_KEY
headers = {"x-api-key": "API_KEY"} headers = {"x-api-key": "API_KEY"}
# Inference arguments (optional) # Inference arguments (use actual MODEL_ID)
data = {"imgsz": 640, "conf": 0.25, "iou": 0.45} data = {"model": "https://hub.ultralytics.com/models/MODEL_ID", "imgsz": 640, "conf": 0.25, "iou": 0.45}
# Load image and send request # Load image and send request
with open("path/to/image.jpg", "rb") as image_file: with open("path/to/image.jpg", "rb") as image_file:
@ -501,8 +506,9 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
=== "cURL" === "cURL"
```bash ```bash
curl -X POST "https://api.ultralytics.com/v1/predict/MODEL_ID" \ curl -X POST "https://predict.ultralytics.com" \
-H "x-api-key: API_KEY" \ -H "x-api-key: API_KEY" \
-F "model=https://hub.ultralytics.com/models/MODEL_ID" \
-F "file=@/path/to/image.jpg" \ -F "file=@/path/to/image.jpg" \
-F "imgsz=640" \ -F "imgsz=640" \
-F "conf=0.25" \ -F "conf=0.25" \
@ -514,14 +520,14 @@ The [Ultralytics HUB](https://www.ultralytics.com/hub) Inference API returns a J
```python ```python
import requests import requests
# API URL, use actual MODEL_ID # API URL
url = "https://api.ultralytics.com/v1/predict/MODEL_ID" url = "https://predict.ultralytics.com"
# Headers, use actual API_KEY # Headers, use actual API_KEY
headers = {"x-api-key": "API_KEY"} headers = {"x-api-key": "API_KEY"}
# Inference arguments (optional) # Inference arguments (use actual MODEL_ID)
data = {"imgsz": 640, "conf": 0.25, "iou": 0.45} data = {"model": "https://hub.ultralytics.com/models/MODEL_ID", "imgsz": 640, "conf": 0.25, "iou": 0.45}
# Load image and send request # Load image and send request
with open("path/to/image.jpg", "rb") as image_file: with open("path/to/image.jpg", "rb") as image_file:

3
docs/mkdocs_github_authors.yaml
View file

@ -133,6 +133,9 @@ sometimesocrazy@gmail.com:
stormsson@users.noreply.github.com: stormsson@users.noreply.github.com:
avatar: https://avatars.githubusercontent.com/u/1133032?v=4 avatar: https://avatars.githubusercontent.com/u/1133032?v=4
username: stormsson username: stormsson
waxmann.sergiu@me.com:
avatar: https://avatars.githubusercontent.com/u/47978446?v=4
username: sergiuwaxmann
web@ultralytics.com: web@ultralytics.com:
avatar: https://avatars.githubusercontent.com/u/135830346?v=4 avatar: https://avatars.githubusercontent.com/u/135830346?v=4
username: UltralyticsAssistant username: UltralyticsAssistant