Elgato_dark/ultralytics
1
0
Fork 0
mirror of https://github.com/ultralytics/ultralytics synced 2026-04-21 14:07:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Merge remote-tracking branch 'origin/docs/update-platform-docs' into docs/update-platform-docs

Browse source 
# Conflicts:
#	docs/en/platform/explore.md
#	docs/en/platform/index.md
#	docs/en/platform/quickstart.md
This commit is contained in:
Glenn Jocher 2026-04-20 20:04:46 +02:00
commit 32ac53d60a
6 changed files with 52 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/en/platform/account/index.md
View file

@ -35,28 +35,28 @@ The Account section helps you:
## Account Features
| Feature | Description |
| ------------ | -------------------------------------------------------- |
| **Settings** | Profile, emails, social links, and data region |
| Feature | Description |
| ------------ | ----------------------------------------------------------- |
| **Settings** | Profile, emails, social links, and data region |
| **API Keys** | Generate AES-256-GCM encrypted keys for programmatic access |
| **Plans** | Free, Pro, and Enterprise plan comparison |
| **Billing** | Credits, payment methods, and transaction history |
| **Teams** | Members, roles, invites, and seat management |
| **Trash** | Recover deleted items within 30 days |
| **Activity** | Event log with inbox, archive, search, and undo |
| **Plans** | Free, Pro, and Enterprise plan comparison |
| **Billing** | Credits, payment methods, and transaction history |
| **Teams** | Members, roles, invites, and seat management |
| **Trash** | Recover deleted items within 30 days |
| **Activity** | Event log with inbox, archive, search, and undo |
## Settings Tabs
Account management is organized into six tabs within `Settings` (in order):
| Tab | Description |
| ------------ | --------------------------------------------------------------------- |
| `Profile` | Display name, bio, company, use case, emails, social links, data region |
| `API Keys` | Create and manage API keys for remote training and programmatic access |
| `Plans` | Compare Free, Pro, and Enterprise plans |
| `Billing` | Credit balance, top-up, payment methods, transactions |
| `Teams` | Member list, roles, invites, seat allocation |
| `Trash` | Soft-deleted projects, datasets, and models (30-day recovery) |
| Tab | Description |
| ---------- | ----------------------------------------------------------------------- |
| `Profile` | Display name, bio, company, use case, emails, social links, data region |
| `API Keys` | Create and manage API keys for remote training and programmatic access |
| `Plans` | Compare Free, Pro, and Enterprise plans |
| `Billing` | Credit balance, top-up, payment methods, transactions |
| `Teams` | Member list, roles, invites, seat allocation |
| `Trash` | Soft-deleted projects, datasets, and models (30-day recovery) |
## Security

20
docs/en/platform/api/index.md
View file

@ -535,17 +535,17 @@ GET /api/datasets/{datasetId}/images
**Query Parameters:**
| Parameter | Type | Description |
| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| `split` | string | Filter by split: `train`, `val`, `test` |
| `offset` | int | Pagination offset (default: 0) |
| `limit` | int | Items per page (default: 50, max: 5000) |
| Parameter | Type | Description |
| ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `split` | string | Filter by split: `train`, `val`, `test` |
| `offset` | int | Pagination offset (default: 0) |
| `limit` | int | Items per page (default: 50, max: 5000) |
| `sort` | string | Sort order: `newest`, `oldest`, `name-asc`, `name-desc`, `height-asc`, `height-desc`, `width-asc`, `width-desc`, `size-asc`, `size-desc`, `labels-asc`, `labels-desc` (some disabled for >100k image datasets) |
| `hasLabel` | string | Filter by label status (`true` or `false`) |
| `hasError` | string | Filter by error status (`true` or `false`) |
| `search` | string | Search by filename or image hash |
| `includeThumbnails` | string | Include signed thumbnail URLs (default: `true`) |
| `includeImageUrls` | string | Include signed full image URLs (default: `false`) |
| `hasLabel` | string | Filter by label status (`true` or `false`) |
| `hasError` | string | Filter by error status (`true` or `false`) |
| `search` | string | Search by filename or image hash |
| `includeThumbnails` | string | Include signed thumbnail URLs (default: `true`) |
| `includeImageUrls` | string | Include signed full image URLs (default: `false`) |
#### Get Signed Image URLs

12
docs/en/platform/data/annotation.md
View file

@ -179,13 +179,13 @@ Annotate poses using skeleton templates. Select a template from the toolbar, cli
The editor includes 5 built-in templates:
| Template | Keypoints | Description |
| ---------- | --------- | ------------------------------------------------------------------------------------------------------------------- |
| Template | Keypoints | Description |
| ---------- | --------- | ---------------------------------------------------------------------------------------------------------------------- |
| **Person** | 17 | [COCO human body pose](../../datasets/pose/coco.md) — nose, eyes, ears, shoulders, elbows, wrists, hips, knees, ankles |
| **Hand** | 21 | [Ultralytics Hand Keypoints](../../datasets/pose/hand-keypoints.md) — wrist, thumb, index, middle, ring, pinky joints |
| **Face** | 68 | [iBUG 300W](https://ibug.doc.ic.ac.uk/resources/300-W/) facial landmarks — jaw, eyebrows, nose, eyes, mouth |
| **Dog** | 18 | AP-10K animal pose — nose, head, neck, shoulders, tailbase, tail, and 4 legs (elbows, knees, paws) |
| **Box** | 4 | Corner keypoints — top-left, top-right, bottom-right, bottom-left |
| **Hand** | 21 | [Ultralytics Hand Keypoints](../../datasets/pose/hand-keypoints.md) — wrist, thumb, index, middle, ring, pinky joints |
| **Face** | 68 | [iBUG 300W](https://ibug.doc.ic.ac.uk/resources/300-W/) facial landmarks — jaw, eyebrows, nose, eyes, mouth |
| **Dog** | 18 | AP-10K animal pose — nose, head, neck, shoulders, tailbase, tail, and 4 legs (elbows, knees, paws) |
| **Box** | 4 | Corner keypoints — top-left, top-right, bottom-right, bottom-left |
![Ultralytics Platform Annotate Pose Keypoints Skeleton](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/platform-annotate-pose-keypoints-skeleton.avif)

18
docs/en/platform/deploy/endpoints.md
View file

@ -344,15 +344,15 @@ Dedicated endpoints are **not subject to the Platform API rate limits**. Request
### Request Parameters
| Parameter | Type | Default | Range | Description |
| ----------- | ----- | ------- | ----------- | ------------------------------------------ |
| `file` | file | - | - | Image or video file (required) |
| `conf` | float | 0.25 | 0.01 – 1.0 | Minimum confidence threshold |
| `iou` | float | 0.7 | 0.0 – 0.95 | NMS IoU threshold |
| `imgsz` | int | 640 | 32 – 1280 | Input image size in pixels |
| `normalize` | bool | false | - | Return bounding box coordinates as 0 – 1 |
| `decimals` | int | 5 | 0 – 10 | Decimal precision for coordinate values |
| `source` | string| - | - | Image URL or base64 string (alternative to `file`) |
| Parameter | Type | Default | Range | Description |
| ----------- | ------ | ------- | ---------- | -------------------------------------------------- |
| `file` | file | - | - | Image or video file (required) |
| `conf` | float | 0.25 | 0.01 – 1.0 | Minimum confidence threshold |
| `iou` | float | 0.7 | 0.0 – 0.95 | NMS IoU threshold |
| `imgsz` | int | 640 | 32 – 1280 | Input image size in pixels |
| `normalize` | bool | false | - | Return bounding box coordinates as 0 – 1 |
| `decimals` | int | 5 | 0 – 10 | Decimal precision for coordinate values |
| `source` | string | - | - | Image URL or base64 string (alternative to `file`) |
!!! tip "Video Inference"

10
docs/en/platform/deploy/inference.md
View file

@ -103,11 +103,11 @@ Adjust detection behavior with parameters in the collapsible **Parameters** sect
![Ultralytics Platform Predict Tab Parameters Sliders](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/predict-tab-parameters-sliders.avif)
| Parameter | Range | Default | Description |
| -------------- | -------------------------- | ------- | ---------------------------------------------------------- |
| **Confidence** | 0.01 – 1.0 | 0.25 | Minimum confidence threshold |
| **IoU** | 0.0 – 0.95 | 0.7 | NMS IoU threshold |
| **Image Size** | 320, 640, 1280 (UI toggle) | 640 | Input resize dimension (API accepts any value 32 – 1280) |
| Parameter | Range | Default | Description |
| -------------- | -------------------------- | ------- | -------------------------------------------------------- |
| **Confidence** | 0.01 – 1.0 | 0.25 | Minimum confidence threshold |
| **IoU** | 0.0 – 0.95 | 0.7 | NMS IoU threshold |
| **Image Size** | 320, 640, 1280 (UI toggle) | 640 | Input resize dimension (API accepts any value 32 – 1280) |
!!! note "Auto-Rerun"

12
docs/en/platform/train/cloud-training.md
View file

@ -62,12 +62,12 @@ Choose a dataset to train on (see [Datasets](../data/datasets.md)):
Set core training parameters:
| Parameter | Description | Default |
| -------------- | --------------------------------------------------------------------------- | --------- |
| **Epochs** | Number of training iterations | 100 |
| **Batch Size** | Samples per iteration | -1 (auto) |
| **Image Size** | Input resolution (320/416/512/640/1280 dropdown, any multiple of 32 from 32-4096 in YAML editor) | 640 |
| **Run Name** | Optional name for the training run | auto |
| Parameter | Description | Default |
| -------------- | ------------------------------------------------------------------------------------------------ | --------- |
| **Epochs** | Number of training iterations | 100 |
| **Batch Size** | Samples per iteration | -1 (auto) |
| **Image Size** | Input resolution (320/416/512/640/1280 dropdown, any multiple of 32 from 32-4096 in YAML editor) | 640 |
| **Run Name** | Optional name for the training run | auto |
### Step 4: Advanced Settings (Optional)