From 817aca355efe17178dabedf595965aedfdb45adc Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Tue, 7 Apr 2026 21:51:06 +0200 Subject: [PATCH] Platform docs updates (#24157) Co-authored-by: UltralyticsAssistant --- docs/en/platform/account/activity.md | 12 +++-- docs/en/platform/account/api-keys.md | 6 +-- docs/en/platform/account/billing.md | 2 +- docs/en/platform/account/index.md | 2 +- docs/en/platform/account/settings.md | 2 +- docs/en/platform/account/teams.md | 16 ++---- docs/en/platform/account/trash.md | 6 ++- docs/en/platform/api/index.md | 48 ++++++++++++----- docs/en/platform/data/annotation.md | 48 ++++++++--------- docs/en/platform/data/datasets.md | 68 ++++++++++++++++++------ docs/en/platform/data/index.md | 6 ++- docs/en/platform/deploy/endpoints.md | 12 ++--- docs/en/platform/deploy/index.md | 30 +++++------ docs/en/platform/deploy/monitoring.md | 2 +- docs/en/platform/explore.md | 4 +- docs/en/platform/index.md | 12 ++--- docs/en/platform/quickstart.md | 6 +-- docs/en/platform/train/cloud-training.md | 22 ++++---- docs/en/platform/train/index.md | 2 +- docs/en/platform/train/models.md | 18 ++++--- docs/en/platform/train/projects.md | 2 +- 21 files changed, 192 insertions(+), 134 deletions(-) diff --git a/docs/en/platform/account/activity.md b/docs/en/platform/account/activity.md index 9504e099..93ddd7f4 100644 --- a/docs/en/platform/account/activity.md +++ b/docs/en/platform/account/activity.md @@ -103,7 +103,7 @@ Use the search bar to find events by resource name or event description. Filter by time period using the date range picker: - Select a start and end date -- No default date filter (shows all events) +- The page defaults to the last 30 days - Custom date ranges supported ![Ultralytics Platform Activity Page Date Range Picker Expanded](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/activity-page-date-range-picker-expanded.avif) @@ -123,7 +123,7 @@ Each event displays: Some actions support undo directly from the Activity feed: -- **Settings changes**: Click **Undo** next to a settings update event to revert the change +- **Settings changes**: Click **Undo** next to a recent settings update event to revert the change - Undo is available for a short time window after the action ## Pagination @@ -134,9 +134,13 @@ The Activity feed supports pagination: - Navigate between pages using the pagination controls - Page size is configurable via URL query parameter -## API Access +## API Routes -Access activity programmatically via the [REST API](../api/index.md#activity-api): +The Activity feed is powered by browser-authenticated routes — it is not exposed as a public API and cannot be accessed with an API key. The route shapes are listed below for reference; to view, mark, or archive activity, use the Activity feed in the platform UI. + +!!! note "Browser Session Only" + + The routes shown below require an active platform browser session. The `Authorization: Bearer YOUR_API_KEY` header in the examples will not authenticate these routes — they are documented only to describe how the in-app feed talks to the server. === "List Activity" diff --git a/docs/en/platform/account/api-keys.md b/docs/en/platform/account/api-keys.md index 4ef9e8cc..3f2e8e6d 100644 --- a/docs/en/platform/account/api-keys.md +++ b/docs/en/platform/account/api-keys.md @@ -115,10 +115,10 @@ Enable metric streaming with your key. !!! warning "Package Version Requirement" - Platform integration requires **ultralytics>=8.4.14**. Lower versions will NOT work with Platform. + Platform integration requires **ultralytics>=8.4.35**. Lower versions will NOT work with Platform. ```bash - pip install "ultralytics>=8.4.14" + pip install "ultralytics>=8.4.35" ``` ```bash @@ -208,7 +208,7 @@ Solutions: 1. Verify key is copied correctly (including the `ul_` prefix) 2. Check key hasn't been revoked 3. Confirm environment variable is set -4. Ensure you're using `ultralytics>=8.4.14` +4. Ensure you're using `ultralytics>=8.4.35` ### Permission Denied diff --git a/docs/en/platform/account/billing.md b/docs/en/platform/account/billing.md index fb1b438d..2cc39a4e 100644 --- a/docs/en/platform/account/billing.md +++ b/docs/en/platform/account/billing.md @@ -84,7 +84,7 @@ For organizations with advanced needs: - SLA guarantees (coming soon) - Enterprise support -Contact [sales@ultralytics.com](mailto:sales@ultralytics.com) for Enterprise pricing. +See [Ultralytics Licensing](https://www.ultralytics.com/licensing) for Enterprise plan details. ## Credits diff --git a/docs/en/platform/account/index.md b/docs/en/platform/account/index.md index 7871d349..d26e0df5 100644 --- a/docs/en/platform/account/index.md +++ b/docs/en/platform/account/index.md @@ -129,7 +129,7 @@ Yes, Ultralytics Platform implements: No, data region is selected during signup and cannot be changed. To use a different region: 1. Export your data -2. Create a new account in desired region +2. Create a new account in the desired region 3. Re-upload your data This ensures data residency compliance. diff --git a/docs/en/platform/account/settings.md b/docs/en/platform/account/settings.md index ad396537..61c9a30f 100644 --- a/docs/en/platform/account/settings.md +++ b/docs/en/platform/account/settings.md @@ -237,7 +237,7 @@ From this tab you can: - **Compare features** across Free, Pro, and Enterprise tiers - **Upgrade to Pro** to unlock more storage, models, team collaboration, and priority GPU access -- **Contact Sales** for Enterprise needs including SSO/SAML and commercial licensing +- **Review Enterprise** capabilities including SSO/SAML, RBAC, and commercial licensing — see [Ultralytics Licensing](https://www.ultralytics.com/licensing) See [Billing](billing.md) for detailed plan information, pricing, and upgrade instructions. diff --git a/docs/en/platform/account/teams.md b/docs/en/platform/account/teams.md index 13baa905..ae7b8633 100644 --- a/docs/en/platform/account/teams.md +++ b/docs/en/platform/account/teams.md @@ -21,7 +21,7 @@ Teams allow multiple users to work together under a shared workspace: !!! note "Plan Requirement" - Creating a team requires a [Pro or Enterprise plan](billing.md#plans). You can upgrade from Settings or when clicking **+ Create Team** in the workspace switcher. + Team workspaces require a [Pro or Enterprise plan](billing.md#plans). You can start team setup before upgrading, but the workspace must be on a Pro or Enterprise plan to use team features. ## Creating a Team @@ -87,7 +87,7 @@ Admins and Owners can invite new members to the team: ![Ultralytics Platform Teams Invite Member Dialog](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/settings-teams-invite-member-dialog.avif) -The invitee receives an email invitation with a link to accept and join the team. Invitations expire after 7 days. Once accepted, the team workspace appears in the invitee's workspace switcher. +The invitee receives an email invitation with a link to accept and join the team. Invitations expire after 7 days. Once accepted, the team workspace appears in the invitee's workspace switcher. If an invite is missed, resend or cancel it from the Teams tab and send a fresh invite. !!! note "Admin Invites" @@ -101,17 +101,11 @@ Enterprise plans include additional capabilities for organizations with advanced !!! warning "License Expiration" - If your Enterprise license expires, workspace access is blocked until renewed. Contact [sales@ultralytics.com](mailto:sales@ultralytics.com) to renew. + If your Enterprise license expires, workspace access is blocked until the license is renewed. See [Ultralytics Licensing](https://www.ultralytics.com/licensing) for details. ### Getting Started with Enterprise -Enterprise plans are provisioned by the Ultralytics team: - -1. Contact [sales@ultralytics.com](mailto:sales@ultralytics.com) -2. Discuss your team size, credit needs, and compliance requirements -3. Receive a provisioning invite with your enterprise configuration -4. Accept the invite to become the team Owner -5. Invite your team members +Enterprise plans are provisioned by the Ultralytics team. See [Ultralytics Licensing](https://www.ultralytics.com/licensing) for plan details. Once your enterprise configuration is set up, you'll receive a provisioning invite to accept as the team Owner, after which you can invite your team members. ## FAQ @@ -129,4 +123,4 @@ All team members share a single credit balance. The Owner and Admins can top up ### How do I upgrade from Pro to Enterprise? -Contact [sales@ultralytics.com](mailto:sales@ultralytics.com) to discuss Enterprise pricing and provisioning. The Ultralytics team will handle the upgrade and configuration. +Enterprise pricing and provisioning are handled directly by the Ultralytics team. See [Ultralytics Licensing](https://www.ultralytics.com/licensing) for plan details. diff --git a/docs/en/platform/account/trash.md b/docs/en/platform/account/trash.md index 97d70a89..d8a320bf 100644 --- a/docs/en/platform/account/trash.md +++ b/docs/en/platform/account/trash.md @@ -87,6 +87,8 @@ Recover a deleted item: The item returns to its original location with all data intact. +If the original slug is already taken, the platform restores the item with a unique available slug so you can access it immediately. + ### Restore Behavior | Resource | Restore Behavior | @@ -115,7 +117,7 @@ Permanently delete all items immediately: !!! warning "Irreversible Action" - Emptying Trash permanently deletes all items immediately. This action cannot be undone and all data will be lost. + Emptying Trash permanently deletes all items immediately. This action cannot be undone and all data will be lost, including attached deployments, export jobs, and stored files tied to the trashed resources. ### Delete Single Item Permanently @@ -125,6 +127,8 @@ To permanently delete one item without waiting: 2. Click the **Delete** button 3. Confirm deletion +For projects, permanent deletion also removes related deployments and export files that belong to the deleted workspace resources. + ## Storage and Trash Items in Trash still count toward your storage quota: diff --git a/docs/en/platform/api/index.md b/docs/en/platform/api/index.md index 517294c7..7c6cd4f9 100644 --- a/docs/en/platform/api/index.md +++ b/docs/en/platform/api/index.md @@ -52,7 +52,7 @@ graph LR ## Authentication -Most API requests require authentication via API key. Public endpoints (listing public datasets, projects, and models) support anonymous read access without a key. +Resource APIs such as datasets, projects, models, training, exports, and predictions use API-key authentication. Public endpoints (listing public datasets, projects, and models) support anonymous read access without a key. Account-oriented routes — including activity, settings, teams, billing, and GDPR flows — currently require an authenticated browser session and are not available via API key. ### Get API Key @@ -145,7 +145,7 @@ Each category has an independent counter per API key. For example, making 20 pre ### Dedicated Endpoints (Unlimited) -[Dedicated endpoints](../deploy/endpoints.md) are **not subject to API key rate limits**. When you deploy a model to a dedicated endpoint, requests to that endpoint URL (e.g., `https://predict-abc123.run.app/predict`) go directly to your dedicated service with no rate limiting from the Platform. You're paying for the compute, so you get unlimited throughput up to your endpoint's scaling configuration. +[Dedicated endpoints](../deploy/endpoints.md) are **not subject to API key rate limits**. When you deploy a model to a dedicated endpoint, requests to that endpoint URL (e.g., `https://predict-abc123.run.app/predict`) go directly to your dedicated service with no rate limiting from the Platform. You're paying for the compute, so you get throughput from your dedicated service configuration rather than the shared API limits. !!! tip "Handling Rate Limits" @@ -965,7 +965,7 @@ Terminates the running compute instance and marks the job as cancelled. ## Deployments API -Deploy models to dedicated inference endpoints with auto-scaling, health checks, and monitoring. See [Endpoints documentation](../deploy/endpoints.md). +Deploy models to dedicated inference endpoints with health checks and monitoring. New deployments use scale-to-zero by default, and the API accepts an optional `resources` object. See [Endpoints documentation](../deploy/endpoints.md). ```mermaid graph LR @@ -1015,15 +1015,19 @@ POST /api/deployments } ``` -| Field | Type | Required | Description | -| ----------- | ------ | -------- | ------------------------------------------------------------------ | -| `modelId` | string | Yes | Model ID to deploy | -| `name` | string | Yes | Deployment name | -| `region` | string | Yes | Deployment region | -| `resources` | object | No | Resource configuration (cpu, memoryGi, minInstances, maxInstances) | +| Field | Type | Required | Description | +| ----------- | ------ | -------- | -------------------------------------------------------------------------- | +| `modelId` | string | Yes | Model ID to deploy | +| `name` | string | Yes | Deployment name | +| `region` | string | Yes | Deployment region | +| `resources` | object | No | Resource configuration (`cpu`, `memoryGi`, `minInstances`, `maxInstances`) | Creates a dedicated inference endpoint in the specified region. The endpoint is globally accessible via a unique URL. +!!! note "Default Resources" + + The deployment dialog currently submits fixed defaults of `cpu=1`, `memoryGi=2`, `minInstances=0`, and `maxInstances=1`. The API route accepts a `resources` object, but plan limits cap `minInstances` at `0` and `maxInstances` at `1`. + !!! tip "Region Selection" Choose a region close to your users for lowest latency. The platform UI shows latency estimates for all 43 available regions. @@ -1224,6 +1228,10 @@ POST /api/exports/{exportId}/track-download View a feed of recent actions on your account — training runs, uploads, and more. See [Activity documentation](../account/activity.md). +!!! note "Browser Session Only" + + The Activity routes are powered by browser-authenticated requests from the platform UI. They are not exposed as a public API, do not accept API-key authentication, and the route shapes below are documented only for reference. Use the Activity feed in the platform UI to view, mark, or archive events. + ### List Activity ``` @@ -1348,6 +1356,10 @@ DELETE /api/trash/empty Permanently deletes all items in trash. +!!! note "Authentication" + + `DELETE /api/trash/empty` requires an authenticated browser session and is not available via API key. Use the **Empty Trash** button in the UI instead. + --- ## Billing API @@ -1451,13 +1463,21 @@ Creates a checkout session for Pro subscription upgrade. | `billingCycle` | string | No | Billing cycle: `monthly` (default) or `yearly` | | `owner` | string | No | Team username for workspace upgrades (requires admin role) | -### Create Portal Session +### Cancel or Resume Subscription ``` -POST /api/billing/portal-session +DELETE /api/billing/subscription-checkout ``` -Returns URL to billing portal for subscription management. +Cancels a Pro subscription at period end by default. Send `{"resume": true}` to resume an already scheduled cancellation before the billing period ends. + +**Body:** + +```json +{ + "resume": true +} +``` ### Auto Top-Up @@ -2022,7 +2042,7 @@ yolo check !!! warning "Package Version Requirement" - Platform integration requires **ultralytics>=8.4.14**. Lower versions will NOT work with Platform. + Platform integration requires **ultralytics>=8.4.35**. Lower versions will NOT work with Platform. ### Authentication @@ -2163,7 +2183,7 @@ Webhooks notify your server of Platform events via HTTP POST callbacks: **All plans**: Training webhooks via the Python SDK (real-time metrics, completion notifications) work automatically on every plan -- no configuration required. - **Enterprise only**: Custom webhook endpoints that send HTTP POST callbacks to your own server URL require an Enterprise plan. [Contact sales](https://www.ultralytics.com/contact) for details. + **Enterprise only**: Custom webhook endpoints that send HTTP POST callbacks to your own server URL require an Enterprise plan. See [Ultralytics Licensing](https://www.ultralytics.com/licensing) for details. --- diff --git a/docs/en/platform/data/annotation.md b/docs/en/platform/data/annotation.md index d9eea4cb..c30fa14c 100644 --- a/docs/en/platform/data/annotation.md +++ b/docs/en/platform/data/annotation.md @@ -243,10 +243,9 @@ Smart annotation adds model-assisted annotation to the editor. In Smart mode, yo With a SAM model selected: 1. Enter edit mode and select `Smart` or press `S` -2. **Left-click** to add positive points (include this area) -3. **Right-click** to add negative points (exclude this area) -4. SAM generates a precise mask in real-time -5. Press `Enter` or `Escape` to save the annotation, or enable **auto-apply** for one-click workflows +2. Click on the object you want to annotate — SAM generates an initial mask in real-time +3. Refine the mask with additional clicks: click **outside** the current mask to add coverage, or click **inside** the current mask to subtract regions +4. Press `Enter` or `Escape` to save the annotation, or enable **auto-apply** for one-click workflows ![Ultralytics Platform Annotate Sam Positive Negative Points Mask](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/platform-annotate-sam-positive-negative-points-mask.avif) @@ -269,14 +268,13 @@ graph LR !!! tip "SAM Tips" - - Start with a positive click on the object center - - Add negative clicks to exclude background - - Hold `Alt`/`Option` to invert click behavior (left-click becomes negative, right-click becomes positive) - - Enable **auto-apply** (`A`) for one-click annotation — the mask saves automatically after each click + - Start with a click on the object center + - Click again outside the mask to expand coverage + - Click inside the mask to subtract unwanted regions + - Enable **auto-apply** (`A`) for one-click annotation - Hold `Shift` while auto-apply is on to place multiple points before the mask is applied - - Positive and negative points appear as square markers with `+` and `−` symbols on the canvas - Works best for distinct objects with clear edges - - Use 2-3 positive points for elongated objects + - Use a few refinement clicks for elongated or overlapping objects SAM smart annotation can generate: @@ -292,11 +290,11 @@ SAM smart annotation can generate: Auto-apply mode speeds up Smart annotation by automatically saving the SAM mask after each click — no need to press `Enter`. Toggle it with the auto-apply button in the toolbar or press `A`. -| Mode | Behavior | -| --------------------------- | ---------------------------------------------------- | -| **Auto-apply ON** (default) | Mask applies automatically after each click | -| **Auto-apply ON + `Shift`** | Place multiple points first, mask applies on release | -| **Auto-apply OFF** | Place points freely, press `Enter` to apply | +| Mode | Behavior | +| ---------------------------- | ---------------------------------------------------- | +| **Auto-apply ON** | Mask applies automatically after each click | +| **Auto-apply ON + `Shift`** | Place multiple points first, mask applies on release | +| **Auto-apply OFF** (default) | Place points freely, press `Enter` to apply | ![Ultralytics Platform Annotate Sam Auto Apply Toggle](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/platform-annotate-sam-auto-apply-toggle.avif) @@ -308,13 +306,13 @@ Auto-apply mode speeds up Smart annotation by automatically saving the SAM mask When Smart mode is active, a model picker appears in the toolbar. Five SAM models are available — choose based on the speed vs. accuracy trade-off that suits your dataset: -| Model | Size | Speed | Notes | -| ----------------- | ------- | -------- | ------------------------ | -| **SAM 2.1 Tiny** | 74.5 MB | Fastest | | -| **SAM 2.1 Small** | 88 MB | Fast | Default | -| **SAM 2.1 Base** | 154 MB | Moderate | | -| **SAM 2.1 Large** | 428 MB | Slower | Most accurate of SAM 2.1 | -| **SAM 3** | 3.45 GB | Slowest | Latest generation | +| Model | Size | Speed | Notes | +| ----------------- | ------- | -------- | -------------------------- | +| **SAM 2.1 Tiny** | 74.5 MB | Fastest | | +| **SAM 2.1 Small** | 88 MB | Fast | | +| **SAM 2.1 Base** | 154 MB | Moderate | | +| **SAM 2.1 Large** | 428 MB | Slower | Most accurate of SAM 2.1 | +| **SAM 3** | 3.45 GB | Slowest | Default, latest generation | ![Ultralytics Platform Annotate Sam Model Selector](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/platform-annotate-sam-model-selector.avif) @@ -382,7 +380,7 @@ In edit mode, a crosshair overlay tracks the cursor position and displays pixel ## SAM Hover Preview -In Smart mode for **segment** tasks, SAM provides a real-time mask preview as you hover over the image — before clicking any points. This lets you see the predicted segmentation boundary and decide where to click. Once you add positive or negative points, the preview updates to reflect your refinements. +In Smart mode, SAM provides a real-time hover preview before you click any points. This preview is available for **detect**, **segment**, and **OBB** tasks. Once you add refinement clicks, the preview updates to reflect the current mask and the annotation type for the active task. ## Polygon Vertex Editing @@ -526,7 +524,7 @@ SAM provides high-quality masks for most objects. Accuracy depends on: - Image quality and resolution - Number of positive/negative points provided -For best results, start with a positive point on the object center and add negative points to exclude nearby objects. +For best results, start with a click on the object center, then use outside-mask clicks to add coverage and inside-mask clicks to subtract nearby objects or background. ### Can I import existing annotations? @@ -552,7 +550,7 @@ Yes, but for best results: ### Which SAM model should I use? -Start with **SAM 2.1 Small** (the default) — it's fast and accurate for most objects. Switch to **SAM 2.1 Large** when you need higher mask precision on complex shapes. Use **SAM 2.1 Tiny** for maximum speed on simple, high-contrast objects. **SAM 3** is the latest generation model and may produce better results on challenging images, but is significantly slower. +**SAM 3** is the default and the latest generation model — start there for the highest quality masks. Switch to **SAM 2.1 Small** for a faster interactive workflow on common objects, or **SAM 2.1 Large** when you need higher mask precision on complex shapes. Use **SAM 2.1 Tiny** for maximum speed on simple, high-contrast objects. ### Which tasks support SAM smart annotation? diff --git a/docs/en/platform/data/datasets.md b/docs/en/platform/data/datasets.md index ff4abae7..649951e3 100644 --- a/docs/en/platform/data/datasets.md +++ b/docs/en/platform/data/datasets.md @@ -6,7 +6,7 @@ keywords: Ultralytics Platform, datasets, dataset management, dataset versioning # Datasets -[Ultralytics Platform](https://platform.ultralytics.com) datasets provide a streamlined solution for managing your training data. Once uploaded, datasets can be immediately used for model training, with automatic processing and statistics generation. +[Ultralytics Platform](https://platform.ultralytics.com) datasets provide a streamlined solution for managing your training data. After upload, the platform processes images, labels, and statistics automatically. A dataset is ready to train once processing has completed and it has at least one image in the `train` split, at least one image in either the `val` or `test` split, and at least one labeled image. ## Upload Dataset @@ -58,7 +58,7 @@ Ultralytics Platform accepts multiple upload formats for flexibility. ### Preparing Your Dataset -The Platform supports two annotation formats plus raw uploads: [Ultralytics YOLO](../../datasets/detect/index.md#ultralytics-yolo-format), [COCO](https://cocodataset.org/#format-data), and raw (unannotated images): +The Platform supports [Ultralytics YOLO](../../datasets/detect/index.md#ultralytics-yolo-format), [COCO](https://cocodataset.org/#format-data), [Ultralytics NDJSON](../../datasets/detect/index.md#ultralytics-ndjson-format), and raw (unannotated) uploads: === "YOLO Format" @@ -125,17 +125,43 @@ The Platform supports two annotation formats plus raw uploads: [Ultralytics YOLO COCO annotations are automatically converted during upload. Detection (`bbox`), segmentation (`segmentation` polygons), and pose (`keypoints`) tasks are supported. Category IDs are remapped to a dense 0-indexed sequence across all annotation files. For converting between formats, see [format conversion tools](../../datasets/detect/index.md#port-or-convert-label-formats). +=== "Classification Layouts" + + Classification uploads are auto-detected from common folder layouts: + + ```text + split/class/image.jpg + class/split/image.jpg + class/image.jpg + ``` + + Example: + + ```text + my-classify-dataset/ + ├── train/ + │ ├── cats/ + │ └── dogs/ + └── val/ + ├── cats/ + └── dogs/ + ``` + +=== "NDJSON" + + Ultralytics NDJSON exports can be uploaded directly back into Platform. This is useful for moving datasets between workspaces while preserving metadata, classes, splits, and annotations. + !!! tip "Raw Uploads" **Raw**: Upload unannotated images (no labels). Useful when you plan to annotate directly on the platform using the [annotation editor](annotation.md). !!! tip "Flat Directory Structure" - You can also upload images without the train/val folder structure. Images uploaded without split folders are assigned to the `train` split by default. You can reassign them later using the bulk move-to-split feature. + You can also upload images without explicit split folders. Platform respects the active split target during upload, and for non-classify datasets it may automatically create a validation split from part of the training set when no split information is provided. You can always reassign images later with bulk move-to-split or split redistribution. !!! tip "Format Auto-Detection" - The format is detected automatically: datasets with a `data.yaml` containing `names`, `train`, or `val` keys are treated as YOLO. Datasets with COCO JSON files (containing `images`, `annotations`, and `categories` arrays) are treated as COCO. Datasets with only images and no annotations are treated as raw. + The format is detected automatically: datasets with a `data.yaml` containing `names`, `train`, or `val` keys are treated as YOLO. Datasets with COCO JSON files (containing `images`, `annotations`, and `categories` arrays) are treated as COCO. `.ndjson` exports are imported as Ultralytics NDJSON. Datasets with only images and no annotations are treated as raw. For task-specific format details, see [supported tasks](index.md#supported-tasks) and the [Datasets Overview](../../datasets/index.md). @@ -259,7 +285,7 @@ Filter images by their dataset split: ## Dataset Tabs -Each dataset page has six tabs accessible from the tab bar: +Each dataset page can show up to six tabs, depending on the dataset state and your permissions: ### Images Tab @@ -267,6 +293,8 @@ The default view showing the image gallery with annotation overlays. Supports gr ### Classes Tab +This tab appears when the dataset has images. + Manage annotation classes for your dataset: - **Class histogram**: Bar chart showing annotation count per class with linear/log scale toggle @@ -283,6 +311,8 @@ Manage annotation classes for your dataset: ### Charts Tab +This tab appears when the dataset has images. + Automatic statistics computed from your dataset: | Chart | Description | @@ -324,6 +354,8 @@ View all models trained on this dataset in a searchable table: ### Errors Tab +This tab appears only when one or more files fail processing. + Images that failed processing are listed here with: - **Error banner**: Total count of failed images and guidance @@ -360,10 +392,15 @@ To create a version: 1. Open the **Versions** tab 2. Optionally enter a description (e.g., "Added 500 training images" or "Fixed mislabeled classes") 3. Click **+ New Version** -4. The NDJSON snapshot is generated and downloads automatically +4. The new version appears in the table +5. Download the version separately from the table when needed Each version is numbered sequentially (v1, v2, v3...) and stored permanently. You can download any previous version at any time from the versions table. +!!! note "Ready Datasets Only" + + Version creation is available after the dataset reaches `ready` status. + !!! tip "When to Create Versions" Create a version before and after major changes to your dataset — adding images, fixing annotations, or rebalancing splits. This lets you compare model performance across different dataset states. @@ -374,20 +411,13 @@ Each version is numbered sequentially (v1, v2, v3...) and stored permanently. Yo ## Export Dataset -Export your dataset for offline use. The Platform supports multiple export formats: - -| Format | Description | -| -------------- | -------------------------------------------------- | -| **YOLO** | Standard YOLO format with images and `.txt` labels | -| **COCO** | COCO JSON format with annotation arrays | -| **Pascal VOC** | XML annotation files per image | -| **NDJSON** | One JSON object per line (lightweight metadata) | +Export your dataset for offline use with an NDJSON download from the dataset header or the Versions tab. To export: 1. Click the **Export** button in the dataset header -2. Select the desired format -3. The export job runs asynchronously — you'll be notified when the download is ready +2. Download the current NDJSON snapshot directly +3. Use the **Versions** tab when you want an immutable numbered snapshot you can re-download later ![Ultralytics Platform Datasets Export Ndjson Download](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/platform-datasets-export-ndjson-download.avif) @@ -633,7 +663,7 @@ Use the bulk move-to-split feature: ### What label formats are supported? -Ultralytics Platform supports two annotation formats for upload: +Ultralytics Platform supports YOLO labels, COCO JSON, Ultralytics NDJSON, and raw image uploads: === "YOLO Format" @@ -653,6 +683,10 @@ Ultralytics Platform supports two annotation formats for upload: JSON files with `images`, `annotations`, and `categories` arrays. Supports detection (`bbox`), segmentation (polygon), and pose (`keypoints`) tasks. COCO uses absolute pixel coordinates which are automatically converted to normalized format during upload. +=== "NDJSON" + + Ultralytics NDJSON exports can be re-imported into Platform. This is the most complete way to move dataset metadata, splits, and annotations between workspaces. + ### Can I annotate the same dataset for multiple task types? Yes. Each image stores annotations for all 5 task types (detect, segment, pose, OBB, classify) together. You can switch the dataset's active task type at any time without losing existing annotations. Only annotations matching the active task type are shown in the editor and included in exports and training — annotations for other tasks are preserved and reappear when you switch back. diff --git a/docs/en/platform/data/index.md b/docs/en/platform/data/index.md index 0b1ab78b..abfef237 100644 --- a/docs/en/platform/data/index.md +++ b/docs/en/platform/data/index.md @@ -65,7 +65,7 @@ Ultralytics Platform supports all 5 YOLO task types: !!! info "Task Type Selection" - The task type is set when creating a dataset and determines which annotation tools are available. You can change it later from the dataset settings, but incompatible annotations won't be displayed after switching. + The task type is set when creating a dataset and determines which annotation tools are available. You can change it later from the dataset header task selector, but incompatible annotations won't be displayed after switching. ## Key Features @@ -102,7 +102,7 @@ Create immutable NDJSON snapshots of your dataset for reproducible training. Eac ### Dataset Tabs -Every dataset page provides six tabs: +Dataset pages can show up to six tabs, depending on the dataset state and your permissions: | Tab | Description | | ------------ | ---------------------------------------------------------------------------- | @@ -113,6 +113,8 @@ Every dataset page provides six tabs: | **Versions** | Create and download immutable NDJSON snapshots for reproducible training | | **Errors** | Images that failed processing with error details and fix guidance | +`Classes` and `Charts` appear when the dataset has images. `Errors` appears only when processing failures exist. `Versions` appears for owners, or for non-owners when versions already exist. + ### Statistics and Visualization The `Charts` tab provides automatic analysis including: diff --git a/docs/en/platform/deploy/endpoints.md b/docs/en/platform/deploy/endpoints.md index d88b9047..c6a4afea 100644 --- a/docs/en/platform/deploy/endpoints.md +++ b/docs/en/platform/deploy/endpoints.md @@ -1,12 +1,12 @@ --- comments: true -description: Deploy YOLO models to dedicated endpoints in 43 global regions with auto-scaling and monitoring on Ultralytics Platform. +description: Deploy YOLO models to dedicated endpoints in 43 global regions with scale-to-zero behavior and monitoring on Ultralytics Platform. keywords: Ultralytics Platform, deployment, endpoints, YOLO, production, scaling, global regions --- # Dedicated Endpoints -[Ultralytics Platform](https://platform.ultralytics.com) enables deployment of YOLO models to dedicated endpoints in 43 global regions. Each endpoint is a single-tenant service with auto-scaling, a unique endpoint URL, and independent monitoring. +[Ultralytics Platform](https://platform.ultralytics.com) enables deployment of YOLO models to dedicated endpoints in 43 global regions. Each endpoint is a single-tenant service with scale-to-zero behavior, a unique endpoint URL, and independent monitoring. ![Ultralytics Platform Model Deploy Tab With Region Map And Table](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/model-deploy-tab-with-region-map-and-table.avif) @@ -30,7 +30,7 @@ Create a deployment from the global `Deploy` page in the sidebar: 1. Click **New Deployment** 2. Select a model from the model selector 3. Select a region from the map or table -4. Optionally customize the deployment name and resources +4. Review the auto-generated deployment name (editable) and the default resources 5. Click **Deploy Model** ![Ultralytics Platform New Deployment Dialog With Model Selector And Region Map](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/new-deployment-dialog-with-model-selector-and-region-map.avif) @@ -157,12 +157,12 @@ The `New Deployment` dialog provides: | **Model** | Select from completed models | - | | **Region** | Deployment region | - | | **Deployment Name** | Auto-generated, editable | - | -| **CPU Cores** | CPU allocation (1-8) | 1 | -| **Memory (GB)** | Memory allocation (1-32 GB) | 2 | +| **CPU Cores** | Fixed default | 1 | +| **Memory (GB)** | Fixed default | 2 | ![Ultralytics Platform New Deployment Dialog Resources Panel Expanded](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/new-deployment-dialog-resources-panel-expanded.avif) -Resource settings are available under the collapsible **Resources** section. Deployments use scale-to-zero by default (min instances = 0, max instances = 1) — you only pay for active inference time. +Deployments use fixed defaults of `1 CPU`, `2 GiB` memory, `minInstances = 0`, and `maxInstances = 1`. They scale to zero when idle, so you only pay for active inference time. !!! note "Auto-Generated Names" diff --git a/docs/en/platform/deploy/index.md b/docs/en/platform/deploy/index.md index 8045f6be..a3807c2e 100644 --- a/docs/en/platform/deploy/index.md +++ b/docs/en/platform/deploy/index.md @@ -26,7 +26,7 @@ The Deployment section helps you: - **Test** models directly in the browser with the `Predict` tab - **Deploy** to dedicated endpoints in 43 global regions - **Monitor** request metrics, logs, and health checks -- **Scale** automatically with traffic (including scale-to-zero) +- **Scale to zero** when idle (deployments currently run a single active instance) ![Ultralytics Platform Deploy Page World Map With Overview Cards](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/deploy-page-world-map-with-overview-cards.avif) @@ -54,12 +54,12 @@ graph LR style D fill:#9C27B0,color:#fff ``` -| Stage | Description | -| ------------- | ------------------------------------------------------------------------ | -| **Test** | Validate model with the [`Predict` tab](inference.md) | -| **Configure** | Select region, resources, and deployment name | -| **Deploy** | Create a dedicated endpoint from the [`Deploy` tab](endpoints.md) | -| **Monitor** | Track requests, latency, errors, and logs in [Monitoring](monitoring.md) | +| Stage | Description | +| ------------- | --------------------------------------------------------------------------- | +| **Test** | Validate model with the [`Predict` tab](inference.md) | +| **Configure** | Select region and deployment name (deployments use fixed default resources) | +| **Deploy** | Create a dedicated endpoint from the [`Deploy` tab](endpoints.md) | +| **Monitor** | Track requests, latency, errors, and logs in [Monitoring](monitoring.md) | ## Architecture @@ -100,8 +100,8 @@ Deploy to 43 regions worldwide on Ultralytics Cloud: Each endpoint is a single-tenant service with: -- Dedicated compute resources (configurable CPU and memory) -- Auto-scaling (scale-to-zero when idle) +- Default resources of `1 CPU`, `2 GiB` memory, `minInstances=0`, `maxInstances=1` +- Scale-to-zero when idle - Unique endpoint URL - Independent monitoring, logs, and health checks @@ -118,7 +118,7 @@ Access the global deployments page from the sidebar under `Deploy`. This page sh !!! info "Automatic Polling" - The page polls every 30 seconds for metric updates. When deployments are in a transitional state (creating, deploying, stopping), polling increases to every 2-3 seconds for near-instant feedback. + The page polls every 15 seconds normally. When deployments are in a transitional state (`creating`, `deploying`, or `stopping`), polling increases to every 3 seconds for faster feedback. ## Key Features @@ -130,12 +130,12 @@ Deploy close to your users with 43 regions covering: - Europe, Middle East, Africa - Asia Pacific, Oceania -### Auto-Scaling +### Scaling Behavior -Endpoints scale automatically: +Endpoints currently behave as follows: - **Scale to zero**: No cost when idle (default) -- **Scale up**: Handle traffic spikes automatically +- **Single active instance**: `maxInstances` is currently capped at `1` on all plans !!! tip "Cost Savings" @@ -189,7 +189,7 @@ Deploy a model in under 2 minutes: | ----------- | --------------- | ------------------------------------ | | **Latency** | Variable | Consistent | | **Cost** | Free (included) | Free (basic), usage-based (advanced) | -| **Scale** | Limited | Configurable | +| **Scale** | Limited | Scale-to-zero, single instance | | **Regions** | 3 | 43 | | **URL** | Generic | Custom | | **Rate** | 20 req/min | Unlimited | @@ -204,7 +204,7 @@ Dedicated endpoint deployment typically takes 1-2 minutes: ### Can I deploy multiple models? -Yes, each model can have multiple endpoints in different regions. There's no limit on total endpoints (subject to your plan). +Yes, each model can have multiple endpoints in different regions. Deployment counts are limited by plan: Free `3`, Pro `10`, Enterprise `unlimited`. ### What happens when an endpoint is idle? diff --git a/docs/en/platform/deploy/monitoring.md b/docs/en/platform/deploy/monitoring.md index ec27cd1c..997ad7d0 100644 --- a/docs/en/platform/deploy/monitoring.md +++ b/docs/en/platform/deploy/monitoring.md @@ -79,7 +79,7 @@ Below the overview cards, the deployments list shows all endpoints across your p !!! tip "Real-Time Updates" - The dashboard polls every 30 seconds for deployment status updates. When deployments are in a transitional state (creating, deploying), polling increases to every 3 seconds. Metric charts refresh every 60 seconds. Click the refresh button for immediate updates. + The dashboard polls every 15 seconds for deployment status updates. When deployments are in a transitional state (`creating`, `deploying`, or `stopping`), polling increases to every 3 seconds. Metric charts refresh every 60 seconds. Click the refresh button for immediate updates. ## Per-Deployment Metrics diff --git a/docs/en/platform/explore.md b/docs/en/platform/explore.md index ea08a03d..2176e5cf 100644 --- a/docs/en/platform/explore.md +++ b/docs/en/platform/explore.md @@ -343,12 +343,12 @@ Contact creators for commercial licensing. To report inappropriate content: 1. Navigate to the public page containing the content (project or dataset), if accessible -2. Click the **Feedback** button in the sidebar +2. Open the **Help** page from the sidebar 3. Select **General** as the feedback type 4. Describe the content and the issue, including a link to the page 5. Submit the report -If the content is no longer accessible, use the **Feedback** button from any page and include as much detail as possible (URL, username, or description). +If the content is no longer accessible, use the **Help** page from any page and include as much detail as possible (URL, username, or description). Our team reviews reports within 24-48 hours. diff --git a/docs/en/platform/index.md b/docs/en/platform/index.md index 91778b90..062ecc2e 100644 --- a/docs/en/platform/index.md +++ b/docs/en/platform/index.md @@ -68,7 +68,7 @@ graph LR | **Annotate** | Manual tools for all 5 task types, plus [Smart Annotation](data/annotation.md#smart-annotation) with SAM and YOLO models for detect, segment, and OBB (see [supported tasks](data/index.md#supported-tasks)) | | **Train** | Cloud GPUs (20 free + 3 Pro-exclusive), real-time metrics, project organization | | **Export** | [17 deployment formats](../modes/export.md) (ONNX, TensorRT, CoreML, TFLite, etc.; see [supported formats](train/models.md#supported-formats)) | -| **Deploy** | 43 global regions with dedicated endpoints, auto-scaling, monitoring | +| **Deploy** | 43 global regions with dedicated endpoints, scale-to-zero behavior, and monitoring | **What you can do:** @@ -146,7 +146,7 @@ You can train models either through the web UI (cloud training) or from your own ```bash # Install ultralytics - pip install "ultralytics>=8.4.14" + pip install "ultralytics>=8.4.35" # Set your API key export ULTRALYTICS_API_KEY="YOUR_API_KEY" @@ -177,7 +177,7 @@ You can train models either through the web UI (cloud training) or from your own ### Deployment - **Inference Testing**: Test models directly in the browser with custom images -- **Dedicated Endpoints**: Deploy to 43 global regions with auto-scaling +- **Dedicated Endpoints**: Deploy to 43 global regions with scale-to-zero behavior - **Monitoring**: Real-time metrics, request logs, and performance dashboards ```mermaid @@ -315,10 +315,10 @@ You can train models on your own hardware and stream real-time metrics to the pl !!! warning "Package Version Requirement" - Platform integration requires **ultralytics>=8.4.14**. Lower versions will NOT work with Platform. + Platform integration requires **ultralytics>=8.4.35**. Lower versions will NOT work with Platform. ```bash - pip install "ultralytics>=8.4.14" + pip install "ultralytics>=8.4.35" ``` === "CLI" @@ -473,4 +473,4 @@ See [Models Export](train/models.md#export-model), the [Export mode guide](../mo ??? question "Can I use Platform models commercially?" - Free and Pro plans use AGPL license. For commercial use without AGPL requirements, contact sales@ultralytics.com for Enterprise licensing. + Free and Pro plans use the AGPL license. For commercial use without AGPL requirements, see [Ultralytics Licensing](https://www.ultralytics.com/licensing). diff --git a/docs/en/platform/quickstart.md b/docs/en/platform/quickstart.md index bcd8dd99..ea65e24c 100644 --- a/docs/en/platform/quickstart.md +++ b/docs/en/platform/quickstart.md @@ -105,7 +105,7 @@ The sidebar provides access to all Platform sections: | | Deploy | Your active deployments | | **Bottom** | Trash | Deleted items (recoverable for 30 days) | | | Settings | Account, billing, and preferences | -| | Feedback | Send feedback to Ultralytics | +| | Help | Open help, docs, and feedback tools | ### Welcome Card @@ -352,7 +352,7 @@ graph LR Your endpoint will be ready in about a minute with: - **Unique URL**: HTTPS endpoint for API calls -- **Auto-Scaling**: Scales with traffic automatically +- **Scale-to-zero behavior**: No idle compute cost (deployments currently run a single active instance) - **Monitoring**: Request metrics and logs !!! info "Deployment Lifecycle" @@ -384,7 +384,7 @@ Read more about [API keys](account/api-keys.md), [dataset URIs](data/datasets.md ## Feedback & Help -Use the **Help** page in the sidebar footer to send feedback directly to Ultralytics. You can rate your experience, choose a feedback type (bug report, feature request, or general), and attach screenshots. +The **Help** page in the sidebar footer includes an in-app feedback form. You can rate your experience, choose a feedback type (bug, feature request, or general), and attach screenshots. If you need more help: diff --git a/docs/en/platform/train/cloud-training.md b/docs/en/platform/train/cloud-training.md index fd75d806..8f15aa18 100644 --- a/docs/en/platform/train/cloud-training.md +++ b/docs/en/platform/train/cloud-training.md @@ -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 | 16 | -| **Image Size** | Input resolution (320/416/512/640/1280 dropdown, or 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, or 32-4096 in YAML editor) | 640 | +| **Run Name** | Optional name for the training run | auto | ### Step 4: Advanced Settings (Optional) @@ -169,11 +169,7 @@ Real-time GPU utilization, memory, temperature, CPU, and disk usage. ### Checkpoints -Checkpoints are saved automatically: - -- **Every epoch**: Latest weights saved -- **Best model**: Highest mAP checkpoint preserved -- **Final model**: Weights at training completion +After training completes, the **best model** (`best.pt`, the highest-mAP checkpoint) is uploaded to the platform and made available for download, export, and deployment. ## Cancel Training @@ -181,7 +177,7 @@ Click **Cancel Training** on the model page to stop a running job: - The compute instance is terminated - Credits stop being charged -- Checkpoints saved up to that point are preserved +- The best checkpoint remains available if it was reached before cancellation ## Remote Training @@ -201,7 +197,7 @@ Train on your own hardware while streaming metrics to the platform. !!! warning "Package Version Requirement" - Platform integration requires **ultralytics>=8.4.14**. Lower versions will NOT work with Platform. + Platform integration requires **ultralytics>=8.4.35**. Lower versions will NOT work with Platform. ```bash pip install -U ultralytics diff --git a/docs/en/platform/train/index.md b/docs/en/platform/train/index.md index 33ef59cd..5bb557eb 100644 --- a/docs/en/platform/train/index.md +++ b/docs/en/platform/train/index.md @@ -105,7 +105,7 @@ graph LR !!! info "Automatic Checkpoints" - The Platform automatically saves checkpoints at every epoch. The **best model** (highest mAP) and **final model** are always preserved. + For cloud training, the **best model** (`best.pt`, the highest-mAP checkpoint) is saved automatically and made available for download, export, and deployment after training completes. ## Quick Start diff --git a/docs/en/platform/train/models.md b/docs/en/platform/train/models.md index 8df7d14d..787a53e3 100644 --- a/docs/en/platform/train/models.md +++ b/docs/en/platform/train/models.md @@ -139,7 +139,7 @@ GPU and system metrics during training: Run interactive inference directly in the browser: -- Upload an image, paste a URL, or use webcam +- Upload an image, use example images, or use webcam - Results display with bounding boxes, masks, or keypoints - Auto-inference when an image is provided - Supports all task types ([detect](../../tasks/detect.md), [segment](../../tasks/segment.md), [pose](../../tasks/pose.md), [OBB](../../tasks/obb.md), [classify](../../tasks/classify.md)) @@ -269,11 +269,17 @@ Export jobs progress through the following statuses: Some export formats have architecture or task restrictions: -| Format | Restriction | -| ---------------- | --------------------------------------------------------------- | -| **IMX500** | Only available for YOLOv8 and YOLO11 models | -| **Axelera** | Not available for YOLO26 segmentation models | -| **PaddlePaddle** | Not available for YOLO26 detection/segmentation/pose/OBB models | +| Format | Restriction | +| ---------------- | ------------------------------------------------------- | +| **IMX500** | Available only for `YOLOv8n` and `YOLO11n` | +| **Axelera** | Detect models only | +| **PaddlePaddle** | Not available for YOLO26 detect/segment/pose/OBB models | + +!!! note "Additional Export Rules" + + - Classification exports do not include NMS. + - CoreML exports with batch sizes greater than `1` use `dynamic=true`. + - Unsupported format/model combinations are disabled in the export dialog before you launch. ## Clone Model diff --git a/docs/en/platform/train/projects.md b/docs/en/platform/train/projects.md index 061c191c..8757654a 100644 --- a/docs/en/platform/train/projects.md +++ b/docs/en/platform/train/projects.md @@ -40,7 +40,7 @@ Enter your project details: - **Name**: A descriptive name for your project (a random name is auto-generated) - **Description**: Optional notes about the project purpose - **Visibility**: Public (anyone can view) or Private (only you can access) -- **License**: Optional license for your project (AGPL-3.0, Apache-2.0, MIT, GPL-3.0, BSD-3-Clause, LGPL-3.0, MPL-2.0, EUPL-1.1, Unlicense, Ultralytics-Enterprise, and more). The **Ultralytics-Enterprise** license is for commercial use without AGPL requirements — contact [sales@ultralytics.com](mailto:sales@ultralytics.com) for details. +- **License**: Optional license for your project (AGPL-3.0, Apache-2.0, MIT, GPL-3.0, BSD-3-Clause, LGPL-3.0, MPL-2.0, EUPL-1.1, Unlicense, Ultralytics-Enterprise, and more). The **Ultralytics-Enterprise** license is for commercial use without AGPL requirements and is available with an Enterprise plan — see [Ultralytics Licensing](https://www.ultralytics.com/licensing). ![Ultralytics Platform New Project Dialog Name Visibility License](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/platform-new-project-dialog-name-visibility-license.avif)