From 99bee2f6be9f36513bc661c765b8b86d9d01bb40 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Thu, 9 Apr 2026 14:44:16 +0200 Subject: [PATCH] Label Docs non-text code fences (#24176) Co-authored-by: UltralyticsAssistant --- docs/en/guides/nvidia-dgx-spark.md | 2 +- docs/en/help/contributing.md | 4 +- docs/en/integrations/axelera.md | 2 +- docs/en/integrations/executorch.md | 2 +- docs/en/modes/predict.md | 2 +- docs/en/platform/account/api-keys.md | 13 +- docs/en/platform/account/settings.md | 12 +- docs/en/platform/api/index.md | 220 +++++++++--------- docs/en/platform/data/datasets.md | 4 +- docs/en/platform/deploy/inference.md | 4 +- docs/en/platform/deploy/monitoring.md | 8 +- docs/en/platform/quickstart.md | 2 +- docs/en/platform/train/cloud-training.md | 2 +- .../tutorials/comet_logging_integration.md | 2 +- docs/en/yolov5/tutorials/model_ensembling.md | 6 +- docs/en/yolov5/tutorials/model_export.md | 2 +- .../tutorials/model_pruning_and_sparsity.md | 4 +- .../tutorials/test_time_augmentation.md | 6 +- 18 files changed, 148 insertions(+), 149 deletions(-) diff --git a/docs/en/guides/nvidia-dgx-spark.md b/docs/en/guides/nvidia-dgx-spark.md index ead67294..362e122d 100644 --- a/docs/en/guides/nvidia-dgx-spark.md +++ b/docs/en/guides/nvidia-dgx-spark.md @@ -143,7 +143,7 @@ pip install torch torchvision --index-url https://download.pytorch.org/whl/cu130 When running PyTorch 2.9.1 on NVIDIA DGX Spark, you may encounter the following `UserWarning` when initializing CUDA (e.g. running `yolo checks`, `yolo predict`, etc.): - ```text + ``` UserWarning: Found GPU0 NVIDIA GB10 which is of cuda capability 12.1. Minimum and Maximum cuda capability supported by this version of PyTorch is (8.0) - (12.0) ``` diff --git a/docs/en/help/contributing.md b/docs/en/help/contributing.md index 75795dba..32e930ef 100644 --- a/docs/en/help/contributing.md +++ b/docs/en/help/contributing.md @@ -42,7 +42,7 @@ Before we can merge your pull request, you must sign our [Contributor License Ag After submitting your pull request, the CLA bot will guide you through the signing process. To sign the CLA, simply add a comment in your PR stating: -```text +``` I have read the CLA Document and I sign the CLA ``` @@ -295,7 +295,7 @@ Contributing to Ultralytics YOLO open-source repositories improves the software, To sign the Contributor License Agreement (CLA), follow the instructions provided by the CLA bot after submitting your pull request. This process ensures that your contributions are properly licensed under the AGPL-3.0 license, maintaining the legal integrity of the open-source project. Add a comment in your pull request stating: -```text +``` I have read the CLA Document and I sign the CLA ``` diff --git a/docs/en/integrations/axelera.md b/docs/en/integrations/axelera.md index 408880e7..1f72aa71 100644 --- a/docs/en/integrations/axelera.md +++ b/docs/en/integrations/axelera.md @@ -161,7 +161,7 @@ For all export options, see the [Export Mode documentation](https://docs.ultraly ### Output Structure -```text +``` yolo26n_axelera_model/ ├── yolo26n.axm # Axelera model file └── metadata.yaml # Model metadata (classes, image size, etc.) diff --git a/docs/en/integrations/executorch.md b/docs/en/integrations/executorch.md index 640f4bdc..9c7b1cd7 100644 --- a/docs/en/integrations/executorch.md +++ b/docs/en/integrations/executorch.md @@ -110,7 +110,7 @@ When exporting to ExecuTorch format, you can specify the following arguments: The ExecuTorch export creates a directory containing the model and metadata: -```text +``` yolo26n_executorch_model/ ├── yolo26n.pte # ExecuTorch model file └── metadata.yaml # Model metadata (classes, image size, etc.) diff --git a/docs/en/modes/predict.md b/docs/en/modes/predict.md index efd333c3..3ebf0a94 100644 --- a/docs/en/modes/predict.md +++ b/docs/en/modes/predict.md @@ -367,7 +367,7 @@ Below are code examples for using each source type: Example `.streams` text file: - ```text + ``` rtsp://example.com/media1.mp4 rtsp://example.com/media2.mp4 rtmp://example2.com/live diff --git a/docs/en/platform/account/api-keys.md b/docs/en/platform/account/api-keys.md index 3f2e8e6d..434cf7fa 100644 --- a/docs/en/platform/account/api-keys.md +++ b/docs/en/platform/account/api-keys.md @@ -14,11 +14,10 @@ keywords: Ultralytics Platform, API keys, authentication, remote training, secur Create a new API key: -1. Go to **Settings > Profile** -2. Scroll to the **API Keys** section -3. Click **Create Key** -4. Enter a name for the key (e.g., "Training Server") -5. Click **Create Key** +1. Go to **Settings > API Keys** +2. Click **Create Key** +3. Enter a name for the key (e.g., "Training Server") +4. Click **Create Key** ![Ultralytics Platform Settings Profile Tab Create Api Key Dialog](https://cdn.jsdelivr.net/gh/ultralytics/assets@main/docs/platform/settings-profile-tab-create-api-key-dialog.avif) @@ -132,7 +131,7 @@ See [Cloud Training](../train/cloud-training.md#remote-training) for the complet ### View Keys -All keys are listed in `Settings > Profile` under the API Keys section: +All keys are listed on the `Settings > API Keys` tab: Each key card shows the key name, the full decrypted key value (copyable), relative creation time, and a revoke button. @@ -246,7 +245,7 @@ Keys don't expire automatically. They remain valid until revoked. Consider imple ### Can I see my key after creation? -Yes, full key values are visible in the key list on `Settings > Profile`. The Platform decrypts and displays your keys so you can copy them anytime. +Yes, full key values are visible in the key list on `Settings > API Keys`. The Platform decrypts and displays your keys so you can copy them anytime. ### Are keys region-specific? diff --git a/docs/en/platform/account/settings.md b/docs/en/platform/account/settings.md index 61c9a30f..7a126c40 100644 --- a/docs/en/platform/account/settings.md +++ b/docs/en/platform/account/settings.md @@ -8,11 +8,11 @@ keywords: Ultralytics Platform, settings, profile, preferences, GDPR, data expor [Ultralytics Platform](https://platform.ultralytics.com) settings allow you to configure your profile, social links, workspace preferences, and manage your data with GDPR-compliant export and deletion options. -Settings is organized into five tabs: `Profile`, `Plans`, `Billing`, `Teams`, and `Trash`. +Settings is organized into six tabs: `Profile`, `API Keys`, `Plans`, `Billing`, `Teams`, and `Trash`. ## Profile Tab -The `Profile` tab contains your profile information, social links, API keys, data region, and account management options. +The `Profile` tab contains your profile information, social links, data region, and account management options. ### Profile Information @@ -95,10 +95,6 @@ Manage email addresses linked to your account in the `Profile` tab: Your primary email is used for notifications and account recovery. Only verified emails can be set as primary. -### API Keys - -API keys are managed directly on the `Profile` tab. See [API Keys](api-keys.md) for full documentation. - ### Data Region View your data region on the `Profile` tab: @@ -221,6 +217,10 @@ Permanently delete your account: - Server logs (90 days) - Legal compliance records +## API Keys Tab + +The `API Keys` tab lets you create and manage API keys for remote training and inference. See [API Keys](api-keys.md) for full documentation. + ## Plans Tab The `Plans` tab lets you compare available plans and upgrade or downgrade your subscription. diff --git a/docs/en/platform/api/index.md b/docs/en/platform/api/index.md index 7c6cd4f9..8497b1fa 100644 --- a/docs/en/platform/api/index.md +++ b/docs/en/platform/api/index.md @@ -56,7 +56,7 @@ Resource APIs such as datasets, projects, models, training, exports, and predict ### Get API Key -1. Go to `Settings` > `Profile` (API Keys section) +1. Go to `Settings` > `API Keys` 2. Click `Create Key` 3. Copy the generated key @@ -66,7 +66,7 @@ See [API Keys](../account/api-keys.md) for detailed instructions. Include your API key in all requests: -``` +```http Authorization: Bearer YOUR_API_KEY ``` @@ -122,7 +122,7 @@ The API uses a two-layer rate limiting system to protect against abuse while kee When throttled, the API returns `429` with retry metadata: -``` +```http Retry-After: 12 X-RateLimit-Reset: 2026-02-21T12:34:56.000Z ``` @@ -192,7 +192,7 @@ Create, browse, and manage labeled image datasets for training YOLO models. See ### List Datasets -``` +```http GET /api/datasets ``` @@ -262,7 +262,7 @@ GET /api/datasets ### Get Dataset -``` +```http GET /api/datasets/{datasetId} ``` @@ -270,7 +270,7 @@ Returns full dataset details including metadata, class names, and split counts. ### Create Dataset -``` +```http POST /api/datasets ``` @@ -293,7 +293,7 @@ POST /api/datasets ### Update Dataset -``` +```http PATCH /api/datasets/{datasetId} ``` @@ -309,7 +309,7 @@ PATCH /api/datasets/{datasetId} ### Delete Dataset -``` +```http DELETE /api/datasets/{datasetId} ``` @@ -317,7 +317,7 @@ Soft-deletes the dataset (moved to [trash](../account/trash.md), recoverable for ### Clone Dataset -``` +```http POST /api/datasets/{datasetId}/clone ``` @@ -336,7 +336,7 @@ Creates a copy of the dataset with all images and labels. Only public datasets c ### Export Dataset -``` +```http GET /api/datasets/{datasetId}/export ``` @@ -359,7 +359,7 @@ Returns a JSON response with a signed download URL for the latest dataset export ### Create Dataset Version -``` +```http POST /api/datasets/{datasetId}/export ``` @@ -386,7 +386,7 @@ All fields are optional. The `description` field is a user-provided label for th ### Update Version Description -``` +```http PATCH /api/datasets/{datasetId}/export ``` @@ -411,7 +411,7 @@ Update the description of an existing version. Owner-only. ### Get Class Statistics -``` +```http GET /api/datasets/{datasetId}/class-stats ``` @@ -454,7 +454,7 @@ Returns class distribution, location heatmap, and dimension statistics. Results ### Get Models Trained on Dataset -``` +```http GET /api/datasets/{datasetId}/models ``` @@ -495,7 +495,7 @@ Returns models that were trained using this dataset. ### Auto-Annotate Dataset -``` +```http POST /api/datasets/{datasetId}/predict ``` @@ -512,7 +512,7 @@ Run YOLO inference on dataset images to auto-generate annotations. Uses a select ### Dataset Ingest -``` +```http POST /api/datasets/ingest ``` @@ -532,7 +532,7 @@ graph LR #### List Images -``` +```http GET /api/datasets/{datasetId}/images ``` @@ -552,7 +552,7 @@ GET /api/datasets/{datasetId}/images #### Get Signed Image URLs -``` +```http POST /api/datasets/{datasetId}/images/urls ``` @@ -560,13 +560,13 @@ Get signed URLs for a batch of image hashes (for display in the browser). #### Delete Image -``` +```http DELETE /api/datasets/{datasetId}/images/{hash} ``` #### Get Image Labels -``` +```http GET /api/datasets/{datasetId}/images/{hash}/labels ``` @@ -574,7 +574,7 @@ Returns annotations and class names for a specific image. #### Update Image Labels -``` +```http PUT /api/datasets/{datasetId}/images/{hash}/labels ``` @@ -594,13 +594,13 @@ PUT /api/datasets/{datasetId}/images/{hash}/labels Move images between splits (train/val/test) within a dataset: -``` +```http PATCH /api/datasets/{datasetId}/images/bulk ``` Bulk delete images: -``` +```http DELETE /api/datasets/{datasetId}/images/bulk ``` @@ -612,7 +612,7 @@ Organize your models into projects. Each model belongs to one project. See [Proj ### List Projects -``` +```http GET /api/projects ``` @@ -626,13 +626,13 @@ GET /api/projects ### Get Project -``` +```http GET /api/projects/{projectId} ``` ### Create Project -``` +```http POST /api/projects ``` @@ -659,13 +659,13 @@ POST /api/projects ### Update Project -``` +```http PATCH /api/projects/{projectId} ``` ### Delete Project -``` +```http DELETE /api/projects/{projectId} ``` @@ -673,7 +673,7 @@ Soft-deletes the project (moved to [trash](../account/trash.md)). ### Clone Project -``` +```http POST /api/projects/{projectId}/clone ``` @@ -681,13 +681,13 @@ POST /api/projects/{projectId}/clone Upload a project icon (multipart form with image file): -``` +```http POST /api/projects/{projectId}/icon ``` Remove the project icon: -``` +```http DELETE /api/projects/{projectId}/icon ``` @@ -699,7 +699,7 @@ Manage trained YOLO models — view metrics, download weights, run inference, an ### List Models -``` +```http GET /api/models ``` @@ -714,7 +714,7 @@ GET /api/models ### List Completed Models -``` +```http GET /api/models/completed ``` @@ -722,13 +722,13 @@ Returns models that have finished training (for use in model selectors and deplo ### Get Model -``` +```http GET /api/models/{modelId} ``` ### Create Model -``` +```http POST /api/models ``` @@ -748,19 +748,19 @@ POST /api/models ### Update Model -``` +```http PATCH /api/models/{modelId} ``` ### Delete Model -``` +```http DELETE /api/models/{modelId} ``` ### Download Model Files -``` +```http GET /api/models/{modelId}/files ``` @@ -768,7 +768,7 @@ Returns signed download URLs for model files. ### Clone Model -``` +```http POST /api/models/{modelId}/clone ``` @@ -794,7 +794,7 @@ Clone a public model to one of your projects. ### Track Download -``` +```http POST /api/models/{modelId}/track-download ``` @@ -802,7 +802,7 @@ Track model download analytics. ### Run Inference -``` +```http POST /api/models/{modelId}/predict ``` @@ -863,7 +863,7 @@ POST /api/models/{modelId}/predict ### Get Predict Token -``` +```http POST /api/models/{modelId}/predict/token ``` @@ -871,7 +871,7 @@ Get a short-lived token for direct prediction requests. The token bypasses the A ### Warmup Model -``` +```http POST /api/models/{modelId}/predict/warmup ``` @@ -895,7 +895,7 @@ graph LR ### Start Training -``` +```http POST /api/training/start ``` @@ -947,7 +947,7 @@ POST /api/training/start ### Get Training Status -``` +```http GET /api/models/{modelId}/training ``` @@ -955,7 +955,7 @@ Returns the current training job status, metrics, and progress for a model. ### Cancel Training -``` +```http DELETE /api/models/{modelId}/training ``` @@ -980,7 +980,7 @@ graph LR ### List Deployments -``` +```http GET /api/deployments ``` @@ -995,7 +995,7 @@ GET /api/deployments ### Create Deployment -``` +```http POST /api/deployments ``` @@ -1034,19 +1034,19 @@ Creates a dedicated inference endpoint in the specified region. The endpoint is ### Get Deployment -``` +```http GET /api/deployments/{deploymentId} ``` ### Delete Deployment -``` +```http DELETE /api/deployments/{deploymentId} ``` ### Start Deployment -``` +```http POST /api/deployments/{deploymentId}/start ``` @@ -1054,7 +1054,7 @@ Resume a stopped deployment. ### Stop Deployment -``` +```http POST /api/deployments/{deploymentId}/stop ``` @@ -1062,7 +1062,7 @@ Pause a running deployment (stops billing). ### Health Check -``` +```http GET /api/deployments/{deploymentId}/health ``` @@ -1070,7 +1070,7 @@ Returns the health status of the deployment endpoint. ### Run Inference on Deployment -``` +```http POST /api/deployments/{deploymentId}/predict ``` @@ -1087,7 +1087,7 @@ Send an image directly to a deployment endpoint for inference. Functionally equi ### Get Metrics -``` +```http GET /api/deployments/{deploymentId}/metrics ``` @@ -1102,7 +1102,7 @@ Returns request counts, latency, and error rate metrics with sparkline data. ### Get Logs -``` +```http GET /api/deployments/{deploymentId}/logs ``` @@ -1120,7 +1120,7 @@ GET /api/deployments/{deploymentId}/logs ### Aggregated Metrics -``` +```http GET /api/monitoring ``` @@ -1134,7 +1134,7 @@ Convert models to optimized formats like ONNX, TensorRT, CoreML, and TFLite for ### List Exports -``` +```http GET /api/exports ``` @@ -1148,7 +1148,7 @@ GET /api/exports ### Create Export -``` +```http POST /api/exports ``` @@ -1206,19 +1206,19 @@ POST /api/exports ### Get Export Status -``` +```http GET /api/exports/{exportId} ``` ### Cancel Export -``` +```http DELETE /api/exports/{exportId} ``` ### Track Export Download -``` +```http POST /api/exports/{exportId}/track-download ``` @@ -1234,7 +1234,7 @@ View a feed of recent actions on your account — training runs, uploads, and mo ### List Activity -``` +```http GET /api/activity ``` @@ -1249,7 +1249,7 @@ GET /api/activity ### Mark Events Seen -``` +```http POST /api/activity/mark-seen ``` @@ -1271,7 +1271,7 @@ Or pass specific IDs: ### Archive Events -``` +```http POST /api/activity/archive ``` @@ -1301,7 +1301,7 @@ View and restore deleted items. Items are permanently removed after 30 days. See ### List Trash -``` +```http GET /api/trash ``` @@ -1316,7 +1316,7 @@ GET /api/trash ### Restore Item -``` +```http POST /api/trash ``` @@ -1331,7 +1331,7 @@ POST /api/trash ### Permanently Delete Item -``` +```http DELETE /api/trash ``` @@ -1350,7 +1350,7 @@ DELETE /api/trash ### Empty Trash -``` +```http DELETE /api/trash/empty ``` @@ -1372,7 +1372,7 @@ Check your credit balance, purchase credits, view transaction history, and confi ### Get Balance -``` +```http GET /api/billing/balance ``` @@ -1397,7 +1397,7 @@ GET /api/billing/balance ### Get Usage Summary -``` +```http GET /api/billing/usage-summary ``` @@ -1405,7 +1405,7 @@ Returns plan details, limits, and usage metrics. ### Get Transactions -``` +```http GET /api/billing/transactions ``` @@ -1419,7 +1419,7 @@ Returns transaction history (most recent first). ### Create Checkout Session -``` +```http POST /api/billing/checkout-session ``` @@ -1441,7 +1441,7 @@ Creates a checkout session for credit purchase. ### Create Subscription Checkout -``` +```http POST /api/billing/subscription-checkout ``` @@ -1465,7 +1465,7 @@ Creates a checkout session for Pro subscription upgrade. ### Cancel or Resume Subscription -``` +```http DELETE /api/billing/subscription-checkout ``` @@ -1485,7 +1485,7 @@ Automatically add credits when balance falls below a threshold. #### Get Auto Top-Up Config -``` +```http GET /api/billing/auto-topup ``` @@ -1497,7 +1497,7 @@ GET /api/billing/auto-topup #### Update Auto Top-Up Config -``` +```http PATCH /api/billing/auto-topup ``` @@ -1515,13 +1515,13 @@ PATCH /api/billing/auto-topup #### List Payment Methods -``` +```http GET /api/billing/payment-methods ``` #### Create Setup Intent -``` +```http POST /api/billing/payment-methods/setup ``` @@ -1529,7 +1529,7 @@ Returns a client secret for adding a new payment method. #### Set Default Payment Method -``` +```http POST /api/billing/payment-methods/default ``` @@ -1543,7 +1543,7 @@ POST /api/billing/payment-methods/default #### Update Billing Info -``` +```http PATCH /api/billing/payment-methods ``` @@ -1564,7 +1564,7 @@ PATCH /api/billing/payment-methods #### Delete Payment Method -``` +```http DELETE /api/billing/payment-methods/{id} ``` @@ -1576,7 +1576,7 @@ Check your storage usage breakdown by category (datasets, models, exports) and s ### Get Storage Info -``` +```http GET /api/storage ``` @@ -1625,7 +1625,7 @@ GET /api/storage ### Recalculate Storage -``` +```http POST /api/storage ``` @@ -1639,7 +1639,7 @@ Upload files directly to cloud storage using signed URLs for fast, reliable tran ### Get Signed Upload URL -``` +```http POST /api/upload/signed-url ``` @@ -1679,7 +1679,7 @@ Request a signed URL for uploading a file directly to cloud storage. The signed ### Complete Upload -``` +```http POST /api/upload/complete ``` @@ -1705,13 +1705,13 @@ Manage your API keys for programmatic access. See [API Keys documentation](../ac ### List API Keys -``` +```http GET /api/api-keys ``` ### Create API Key -``` +```http POST /api/api-keys ``` @@ -1725,7 +1725,7 @@ POST /api/api-keys ### Delete API Key -``` +```http DELETE /api/api-keys ``` @@ -1751,13 +1751,13 @@ Create team workspaces, invite members, and manage roles for collaboration. See ### List Teams -``` +```http GET /api/teams ``` ### Create Team -``` +```http POST /api/teams/create ``` @@ -1772,7 +1772,7 @@ POST /api/teams/create ### List Members -``` +```http GET /api/members ``` @@ -1780,7 +1780,7 @@ Returns members of the current workspace. ### Invite Member -``` +```http POST /api/members ``` @@ -1805,19 +1805,19 @@ POST /api/members ### Update Member Role -``` +```http PATCH /api/members/{userId} ``` ### Remove Member -``` +```http DELETE /api/members/{userId} ``` ### Transfer Ownership -``` +```http POST /api/members/transfer-ownership ``` @@ -1825,13 +1825,13 @@ POST /api/members/transfer-ownership #### Accept Invite -``` +```http POST /api/invites/accept ``` #### Get Invite Info -``` +```http GET /api/invites/info ``` @@ -1843,13 +1843,13 @@ GET /api/invites/info #### Revoke Invite -``` +```http DELETE /api/invites/{inviteId} ``` #### Resend Invite -``` +```http POST /api/invites/{inviteId}/resend ``` @@ -1861,7 +1861,7 @@ Search and browse public datasets and projects shared by the community. See [Exp ### Search Public Content -``` +```http GET /api/explore/search ``` @@ -1876,7 +1876,7 @@ GET /api/explore/search ### Sidebar Data -``` +```http GET /api/explore/sidebar ``` @@ -1890,7 +1890,7 @@ Manage your profile, API keys, storage usage, and data privacy settings. See [Se ### Get User by Username -``` +```http GET /api/users ``` @@ -1902,7 +1902,7 @@ GET /api/users ### Follow or Unfollow User -``` +```http PATCH /api/users ``` @@ -1917,7 +1917,7 @@ PATCH /api/users ### Check Username Availability -``` +```http GET /api/username/check ``` @@ -1930,7 +1930,7 @@ GET /api/username/check ### Settings -``` +```http GET /api/settings POST /api/settings ``` @@ -1939,7 +1939,7 @@ Get or update user profile settings (display name, bio, social links, etc.). ### Profile Icon -``` +```http POST /api/settings/icon DELETE /api/settings/icon ``` @@ -1948,7 +1948,7 @@ Upload or remove profile avatar. ### Onboarding -``` +```http POST /api/onboarding ``` @@ -1962,7 +1962,7 @@ Request an export of all your data or permanently delete your account. See [Sett ### Get GDPR Job Status -``` +```http GET /api/gdpr ``` @@ -1976,7 +1976,7 @@ Returns job status. For completed export jobs, response includes a `downloadUrl` ### Start Export or Delete Flow -``` +```http POST /api/gdpr ``` diff --git a/docs/en/platform/data/datasets.md b/docs/en/platform/data/datasets.md index 649951e3..e9c4c5bd 100644 --- a/docs/en/platform/data/datasets.md +++ b/docs/en/platform/data/datasets.md @@ -129,7 +129,7 @@ The Platform supports [Ultralytics YOLO](../../datasets/detect/index.md#ultralyt Classification uploads are auto-detected from common folder layouts: - ```text + ``` split/class/image.jpg class/split/image.jpg class/image.jpg @@ -137,7 +137,7 @@ The Platform supports [Ultralytics YOLO](../../datasets/detect/index.md#ultralyt Example: - ```text + ``` my-classify-dataset/ ├── train/ │ ├── cats/ diff --git a/docs/en/platform/deploy/inference.md b/docs/en/platform/deploy/inference.md index c4729b2c..94fb381a 100644 --- a/docs/en/platform/deploy/inference.md +++ b/docs/en/platform/deploy/inference.md @@ -147,11 +147,11 @@ Authorization: Bearer YOUR_API_KEY !!! warning "API Key Required" - To run inference from your own scripts, notebooks, or apps, include an API key. Generate one in [`Settings`](../account/api-keys.md) (API Keys section on the Profile tab). + To run inference from your own scripts, notebooks, or apps, include an API key. Generate one in [`Settings > API Keys`](../account/api-keys.md). ### Endpoint -``` +```http POST https://platform.ultralytics.com/api/models/{modelId}/predict ``` diff --git a/docs/en/platform/deploy/monitoring.md b/docs/en/platform/deploy/monitoring.md index 997ad7d0..e580034e 100644 --- a/docs/en/platform/deploy/monitoring.md +++ b/docs/en/platform/deploy/monitoring.md @@ -230,7 +230,7 @@ The `Predict` tab on each deployment card provides an inline predict panel — t ### Monitoring Overview -``` +```http GET /api/monitoring ``` @@ -238,7 +238,7 @@ Returns aggregated metrics for all deployments owned by the authenticated user. ### Deployment Metrics -``` +```http GET /api/deployments/{deploymentId}/metrics?sparkline=true&range=24h ``` @@ -251,7 +251,7 @@ Returns sparkline data and summary metrics for a specific deployment. Refresh in ### Deployment Logs -``` +```http GET /api/deployments/{deploymentId}/logs?limit=50&severity=ERROR,WARNING ``` @@ -265,7 +265,7 @@ Returns recent log entries with optional severity filter and pagination. ### Deployment Health -``` +```http GET /api/deployments/{deploymentId}/health ``` diff --git a/docs/en/platform/quickstart.md b/docs/en/platform/quickstart.md index ea65e24c..a202c5e2 100644 --- a/docs/en/platform/quickstart.md +++ b/docs/en/platform/quickstart.md @@ -367,7 +367,7 @@ Read more about [endpoints](deploy/endpoints.md). If you prefer to train on your own hardware, you can stream metrics to the platform using your API key. This works like Weights & Biases — train anywhere, monitor on the platform. -1. Generate an API key in [`Settings > Profile`](account/api-keys.md) (API Keys section) +1. Generate an API key in [`Settings > API Keys`](account/api-keys.md) 2. Set the environment variable and train with a `project/name` format: ```bash diff --git a/docs/en/platform/train/cloud-training.md b/docs/en/platform/train/cloud-training.md index 8f15aa18..6dc078d4 100644 --- a/docs/en/platform/train/cloud-training.md +++ b/docs/en/platform/train/cloud-training.md @@ -205,7 +205,7 @@ Train on your own hardware while streaming metrics to the platform. ### Setup API Key -1. Go to [`Settings > Profile`](../account/api-keys.md) (API Keys section) +1. Go to [`Settings > API Keys`](../account/api-keys.md) 2. Create a new key (or the platform auto-creates one when you open the Local Training tab) 3. Set the environment variable: diff --git a/docs/en/yolov5/tutorials/comet_logging_integration.md b/docs/en/yolov5/tutorials/comet_logging_integration.md index 67da1059..e9a68aa1 100644 --- a/docs/en/yolov5/tutorials/comet_logging_integration.md +++ b/docs/en/yolov5/tutorials/comet_logging_integration.md @@ -41,7 +41,7 @@ Or create a `.comet.config` file in your working directory and set your credenti **Comet Configuration File** -``` +```ini [comet] api_key=YOUR_API_KEY project_name=YOUR_COMET_PROJECT_NAME # This will default to 'yolov5' diff --git a/docs/en/yolov5/tutorials/model_ensembling.md b/docs/en/yolov5/tutorials/model_ensembling.md index f2418b95..d1cc654f 100644 --- a/docs/en/yolov5/tutorials/model_ensembling.md +++ b/docs/en/yolov5/tutorials/model_ensembling.md @@ -32,7 +32,7 @@ python val.py --weights yolov5x.pt --data coco.yaml --img 640 --half Output: -```text +``` val: data=./data/coco.yaml, weights=['yolov5x.pt'], batch_size=32, imgsz=640, conf_thres=0.001, iou_thres=0.65, task=val, device=, single_cls=False, augment=False, verbose=False, save_txt=False, save_conf=False, save_json=True, project=runs/val, name=exp, exist_ok=False, half=True YOLOv5 🚀 v5.0-267-g6a3ee7c torch 1.9.0+cu102 CUDA:0 (Tesla P100-PCIE-16GB, 16280.875MB) @@ -76,7 +76,7 @@ You can list as many checkpoints as you would like, including custom weights suc Output: -```text +``` val: data=./data/coco.yaml, weights=['yolov5x.pt', 'yolov5l6.pt'], batch_size=32, imgsz=640, conf_thres=0.001, iou_thres=0.6, task=val, device=, single_cls=False, augment=False, verbose=False, save_txt=False, save_conf=False, save_json=True, project=runs/val, name=exp, exist_ok=False, half=True YOLOv5 🚀 v5.0-267-g6a3ee7c torch 1.9.0+cu102 CUDA:0 (Tesla P100-PCIE-16GB, 16280.875MB) @@ -117,7 +117,7 @@ python detect.py --weights yolov5x.pt yolov5l6.pt --img 640 --source data/images Output: -```text +``` YOLOv5 🚀 v5.0-267-g6a3ee7c torch 1.9.0+cu102 CUDA:0 (Tesla P100-PCIE-16GB, 16280.875MB) Fusing layers... diff --git a/docs/en/yolov5/tutorials/model_export.md b/docs/en/yolov5/tutorials/model_export.md index 39c3010d..c1e2a1ca 100644 --- a/docs/en/yolov5/tutorials/model_export.md +++ b/docs/en/yolov5/tutorials/model_export.md @@ -112,7 +112,7 @@ python export.py --weights yolov5s.pt --include torchscript onnx Output: -```text +``` export: data=data/coco128.yaml, weights=['yolov5s.pt'], imgsz=[640, 640], batch_size=1, device=cpu, half=False, inplace=False, train=False, keras=False, optimize=False, int8=False, dynamic=False, simplify=False, opset=12, verbose=False, workspace=4, nms=False, agnostic_nms=False, topk_per_class=100, topk_all=100, iou_thres=0.45, conf_thres=0.25, include=['torchscript', 'onnx'] YOLOv5 🚀 v6.2-104-ge3e5122 Python-3.8.0 torch-1.12.1+cu113 CPU diff --git a/docs/en/yolov5/tutorials/model_pruning_and_sparsity.md b/docs/en/yolov5/tutorials/model_pruning_and_sparsity.md index 4ec6b885..0c12305d 100644 --- a/docs/en/yolov5/tutorials/model_pruning_and_sparsity.md +++ b/docs/en/yolov5/tutorials/model_pruning_and_sparsity.md @@ -39,7 +39,7 @@ python val.py --weights yolov5x.pt --data coco.yaml --img 640 --half Output: -```text +``` val: data=/content/yolov5/data/coco.yaml, weights=['yolov5x.pt'], batch_size=32, imgsz=640, conf_thres=0.001, iou_thres=0.65, task=val, device=, workers=8, single_cls=False, augment=False, verbose=False, save_txt=False, save_conf=False, save_json=True, project=runs/val, name=exp, exist_ok=False, half=True, dnn=False YOLOv5 🚀 v6.0-224-g4c40933 torch 1.10.0+cu111 CUDA:0 (Tesla V100-SXM2-16GB, 16160MiB) @@ -75,7 +75,7 @@ We can apply pruning to the model using the `torch_utils.prune()` command define 30% pruned output: -```text +``` val: data=/content/yolov5/data/coco.yaml, weights=['yolov5x.pt'], batch_size=32, imgsz=640, conf_thres=0.001, iou_thres=0.65, task=val, device=, workers=8, single_cls=False, augment=False, verbose=False, save_txt=False, save_conf=False, save_json=True, project=runs/val, name=exp, exist_ok=False, half=True, dnn=False YOLOv5 🚀 v6.0-224-g4c40933 torch 1.10.0+cu111 CUDA:0 (Tesla V100-SXM2-16GB, 16160MiB) diff --git a/docs/en/yolov5/tutorials/test_time_augmentation.md b/docs/en/yolov5/tutorials/test_time_augmentation.md index 97117483..d9f73578 100644 --- a/docs/en/yolov5/tutorials/test_time_augmentation.md +++ b/docs/en/yolov5/tutorials/test_time_augmentation.md @@ -28,7 +28,7 @@ python val.py --weights yolov5x.pt --data coco.yaml --img 640 --half Output: -```text +``` val: data=./data/coco.yaml, weights=['yolov5x.pt'], batch_size=32, imgsz=640, conf_thres=0.001, iou_thres=0.65, task=val, device=, single_cls=False, augment=False, verbose=False, save_txt=False, save_conf=False, save_json=True, project=runs/val, name=exp, exist_ok=False, half=True YOLOv5 🚀 v5.0-267-g6a3ee7c torch 1.9.0+cu102 CUDA:0 (Tesla P100-PCIE-16GB, 16280.875MB) @@ -67,7 +67,7 @@ python val.py --weights yolov5x.pt --data coco.yaml --img 832 --augment --half Output: -```text +``` val: data=./data/coco.yaml, weights=['yolov5x.pt'], batch_size=32, imgsz=832, conf_thres=0.001, iou_thres=0.6, task=val, device=, single_cls=False, augment=True, verbose=False, save_txt=False, save_conf=False, save_json=True, project=runs/val, name=exp, exist_ok=False, half=True YOLOv5 🚀 v5.0-267-g6a3ee7c torch 1.9.0+cu102 CUDA:0 (Tesla P100-PCIE-16GB, 16280.875MB) @@ -107,7 +107,7 @@ python detect.py --weights yolov5s.pt --img 832 --source data/images --augment Output: -```text +``` YOLOv5 🚀 v5.0-267-g6a3ee7c torch 1.9.0+cu102 CUDA:0 (Tesla P100-PCIE-16GB, 16280.875MB) Downloading https://github.com/ultralytics/yolov5/releases/download/v5.0/yolov5s.pt to yolov5s.pt...