单目3D初始代码
This commit is contained in:
zhao.zhu
196
docs/en/platform/account/activity.md
Executable file
196
docs/en/platform/account/activity.md
Executable file
@@ -0,0 +1,196 @@
|
||||
---
|
||||
comments: true
|
||||
description: Track all account activity and events on Ultralytics Platform with the activity feed, including training, uploads, and system events.
|
||||
keywords: Ultralytics Platform, activity feed, audit log, notifications, event tracking, activity history
|
||||
---
|
||||
|
||||
# Activity Feed
|
||||
|
||||
[Ultralytics Platform](https://platform.ultralytics.com) provides a comprehensive activity feed that tracks all events and actions across your account. Monitor training progress and system events in one centralized location.
|
||||
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
The Activity Feed serves as your central hub for:
|
||||
|
||||
- **Training updates**: Job started, completed, failed, or cancelled
|
||||
- **Data changes**: Datasets created, modified, or deleted
|
||||
- **Model events**: Model creation, exports, and deployments
|
||||
- **Project events**: Project creation, updates, and deletion
|
||||
- **API key events**: Key creation and revocation
|
||||
- **Settings changes**: Profile and account updates
|
||||
- **System alerts**: Onboarding and account notifications
|
||||
|
||||
## Accessing Activity
|
||||
|
||||
Navigate to the Activity Feed:
|
||||
|
||||
1. Click **Activity** in the sidebar
|
||||
2. Or navigate directly to `/activity`
|
||||
|
||||
|
||||
|
||||
## Activity Types
|
||||
|
||||
The Platform tracks the following resource types and actions:
|
||||
|
||||
| Resource Type | Description | Icon Color |
|
||||
| -------------- | ------------------------------------------- | ------------------- |
|
||||
| **project** | [Project](../train/projects.md) events | Blue |
|
||||
| **dataset** | [Dataset](../data/datasets.md) events | Green |
|
||||
| **model** | [Model](../train/models.md) events | Purple |
|
||||
| **training** | Training job events | Blue/Green/Red/Gray |
|
||||
| **settings** | Account settings changes | Gray |
|
||||
| **api_key** | [API key](api-keys.md) creation/revocation | Amber |
|
||||
| **export** | Model export events | Amber |
|
||||
| **deployment** | [Deployment](../deploy/endpoints.md) events | Blue |
|
||||
| **onboarding** | Onboarding completion | Green |
|
||||
|
||||
### Action Types
|
||||
|
||||
Each event includes one of the following action types:
|
||||
|
||||
| Action | Description |
|
||||
| ------------- | -------------------------------------------- |
|
||||
| **created** | Resource was created |
|
||||
| **updated** | Resource was modified |
|
||||
| **deleted** | Resource was permanently deleted |
|
||||
| **trashed** | Resource was moved to trash |
|
||||
| **restored** | Resource was restored from trash |
|
||||
| **started** | Training or export job was started |
|
||||
| **completed** | Training or export job finished successfully |
|
||||
| **failed** | Training or export job failed |
|
||||
| **cancelled** | Training or export job was cancelled |
|
||||
| **uploaded** | Data was uploaded (images, model weights) |
|
||||
| **shared** | Resource visibility changed to public |
|
||||
| **unshared** | Resource visibility changed to private |
|
||||
| **exported** | Model was exported to a deployment format |
|
||||
| **cloned** | Resource was cloned to another location |
|
||||
|
||||
## Inbox and Archive
|
||||
|
||||
Organize your activity with two tabs:
|
||||
|
||||
### Inbox
|
||||
|
||||
The Inbox shows recent activity:
|
||||
|
||||
- New events appear here automatically
|
||||
- Unseen events are highlighted with a colored background
|
||||
- Events are automatically marked as seen when you view the page
|
||||
- Click **Archive** on individual events to move them out of Inbox
|
||||
|
||||
### Archive
|
||||
|
||||
Move events to Archive to keep your Inbox clean:
|
||||
|
||||
- Click **Archive** on individual events
|
||||
- Click **Archive all** to archive all Inbox events at once
|
||||
- Access archived events via the `Archive` tab
|
||||
- Click **Restore** on archived events to move them back to Inbox
|
||||
|
||||
## Search and Filtering
|
||||
|
||||
Find specific events quickly:
|
||||
|
||||
### Search
|
||||
|
||||
Use the search bar to find events by resource name or event description.
|
||||
|
||||
### Date Range
|
||||
|
||||
Filter by time period using the date range picker:
|
||||
|
||||
- Select a start and end date
|
||||
- No default date filter (shows all events)
|
||||
- Custom date ranges supported
|
||||
|
||||
|
||||
|
||||
## Event Details
|
||||
|
||||
Each event displays:
|
||||
|
||||
| Field | Description |
|
||||
| --------------- | -------------------------------------------------- |
|
||||
| **Icon** | Resource type indicator |
|
||||
| **Description** | What happened (e.g., "Created project my-project") |
|
||||
| **Timestamp** | Relative time (e.g., "2 hours ago") |
|
||||
| **Metadata** | Additional context when available |
|
||||
|
||||
## Undo Support
|
||||
|
||||
Some actions support undo directly from the Activity feed:
|
||||
|
||||
- **Settings changes**: Click **Undo** next to a settings update event to revert the change
|
||||
- Undo is available for a short time window after the action
|
||||
|
||||
## Pagination
|
||||
|
||||
The Activity feed supports pagination:
|
||||
|
||||
- Default page size: 20 events
|
||||
- Navigate between pages using the pagination controls
|
||||
- Page size is configurable via URL query parameter
|
||||
|
||||
## API Access
|
||||
|
||||
Access activity programmatically via the [REST API](../api/index.md#activity-api):
|
||||
|
||||
=== "List Activity"
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
https://platform.ultralytics.com/api/activity
|
||||
```
|
||||
|
||||
=== "Filter and Search"
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
"https://platform.ultralytics.com/api/activity?archived=false&search=model&page=1&limit=20"
|
||||
```
|
||||
|
||||
=== "Mark Seen"
|
||||
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"all": true}' \
|
||||
https://platform.ultralytics.com/api/activity/mark-seen
|
||||
```
|
||||
|
||||
=== "Archive"
|
||||
|
||||
```bash
|
||||
# Archive specific events
|
||||
curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"eventIds": ["event_id_here"], "archive": true}' \
|
||||
https://platform.ultralytics.com/api/activity/archive
|
||||
|
||||
# Archive all events
|
||||
curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"all": true, "archive": true}' \
|
||||
https://platform.ultralytics.com/api/activity/archive
|
||||
```
|
||||
|
||||
## FAQ
|
||||
|
||||
### How long is activity history retained?
|
||||
|
||||
Activity history is retained indefinitely for your account. Archived events are also kept permanently.
|
||||
|
||||
### Can I export my activity history?
|
||||
|
||||
Yes, use the GDPR data export feature in [`Settings > Profile`](settings.md#gdpr-compliance) to download all account data including activity history.
|
||||
|
||||
### What happens to activity when I delete a resource?
|
||||
|
||||
The activity event remains in your history with a note that the resource was deleted. You can still see what happened even after deletion.
|
||||
|
||||
### Does activity work with team workspaces?
|
||||
|
||||
Yes, the Activity feed shows events for the currently active workspace. Switch workspaces in the sidebar to see activity for different workspaces.
|
||||
257
docs/en/platform/account/api-keys.md
Executable file
257
docs/en/platform/account/api-keys.md
Executable file
@@ -0,0 +1,257 @@
|
||||
---
|
||||
comments: true
|
||||
description: Create and manage API keys for Ultralytics Platform with secure AES-256-GCM encryption for remote training and programmatic access.
|
||||
keywords: Ultralytics Platform, API keys, authentication, remote training, security, access control
|
||||
---
|
||||
|
||||
# API Keys
|
||||
|
||||
[Ultralytics Platform](https://platform.ultralytics.com) API keys enable secure programmatic access for remote training, inference, and automation. Create named keys with AES-256-GCM encryption for different use cases.
|
||||
|
||||
|
||||
|
||||
## Create API Key
|
||||
|
||||
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**
|
||||
|
||||
|
||||
|
||||
### Key Name
|
||||
|
||||
Give your key a descriptive name:
|
||||
|
||||
- `training-server` - For remote training machines
|
||||
- `ci-pipeline` - For CI/CD integration
|
||||
- `local-dev` - For local development
|
||||
|
||||
### Key Display
|
||||
|
||||
After creation, the key is displayed once:
|
||||
|
||||
|
||||
|
||||
!!! tip "Copy Your Key"
|
||||
|
||||
Copy your key after creation for easy reference. Keys are also visible in the key list — the platform decrypts and displays full key values so you can copy them anytime.
|
||||
|
||||
## Key Format
|
||||
|
||||
API keys follow this format:
|
||||
|
||||
```
|
||||
ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4
|
||||
```
|
||||
|
||||
- **Prefix**: `ul_` identifies Ultralytics keys
|
||||
- **Body**: 40 random hexadecimal characters
|
||||
- **Total**: 43 characters
|
||||
|
||||
### Key Security
|
||||
|
||||
- Keys are stored with **AES-256-GCM encryption**
|
||||
- Authentication uses SHA-256 hash for fast prefix lookup and hash comparison
|
||||
- Full key values are never stored in plaintext
|
||||
|
||||
## Using API Keys
|
||||
|
||||
### Environment Variable
|
||||
|
||||
Set your key as an environment variable:
|
||||
|
||||
=== "Linux/macOS"
|
||||
|
||||
```bash
|
||||
export ULTRALYTICS_API_KEY="ul_your_key_here"
|
||||
```
|
||||
|
||||
=== "Windows"
|
||||
|
||||
```powershell
|
||||
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"
|
||||
```
|
||||
|
||||
### YOLO CLI
|
||||
|
||||
Set the key using the YOLO CLI:
|
||||
|
||||
```bash
|
||||
yolo settings api_key="ul_your_key_here"
|
||||
```
|
||||
|
||||
### In Code
|
||||
|
||||
Use the key in your Python scripts:
|
||||
|
||||
```python
|
||||
import os
|
||||
|
||||
# From environment (recommended)
|
||||
api_key = os.environ.get("ULTRALYTICS_API_KEY")
|
||||
|
||||
# Or directly (not recommended for production)
|
||||
api_key = "ul_your_key_here"
|
||||
```
|
||||
|
||||
### HTTP Headers
|
||||
|
||||
Include the key in API requests:
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: Bearer ul_your_key_here" \
|
||||
https://platform.ultralytics.com/api/...
|
||||
```
|
||||
|
||||
See the [REST API Reference](../api/index.md) for all available endpoints.
|
||||
|
||||
### Remote Training
|
||||
|
||||
Enable metric streaming with your key.
|
||||
|
||||
!!! warning "Package Version Requirement"
|
||||
|
||||
Platform integration requires **ultralytics>=8.4.14**. Lower versions will NOT work with Platform.
|
||||
|
||||
```bash
|
||||
pip install "ultralytics>=8.4.14"
|
||||
```
|
||||
|
||||
```bash
|
||||
export ULTRALYTICS_API_KEY="ul_your_key_here"
|
||||
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1
|
||||
```
|
||||
|
||||
See [Cloud Training](../train/cloud-training.md#remote-training) for the complete remote training guide.
|
||||
|
||||
## Manage Keys
|
||||
|
||||
### View Keys
|
||||
|
||||
All keys are listed in `Settings > Profile` under the API Keys section:
|
||||
|
||||
Each key card shows the key name, the full decrypted key value (copyable), relative creation time, and a revoke button.
|
||||
|
||||
### Revoke Key
|
||||
|
||||
Revoke a key that's compromised or no longer needed:
|
||||
|
||||
1. Find the key in the API Keys section
|
||||
2. Click the **Revoke** (trash) button
|
||||
3. Confirm revocation
|
||||
|
||||
!!! warning "Immediate Effect"
|
||||
|
||||
Revocation is immediate. Any applications using the key will stop working.
|
||||
|
||||
### Regenerate Key
|
||||
|
||||
If a key is compromised:
|
||||
|
||||
1. Create a new key with the same name
|
||||
2. Update your applications
|
||||
3. Revoke the old key
|
||||
|
||||
## Workspace API Keys
|
||||
|
||||
API keys are scoped to the currently active workspace:
|
||||
|
||||
- **Personal workspace**: Keys authenticate as your personal account
|
||||
- **Team workspace**: Keys authenticate within the team context
|
||||
|
||||
When switching workspaces in the sidebar, the API Keys section shows keys for that workspace. Editor role or higher is required to manage workspace API keys. See [Teams](settings.md#teams-tab) for role details.
|
||||
|
||||
## Security Best Practices
|
||||
|
||||
### Do
|
||||
|
||||
- Store keys in environment variables
|
||||
- Use separate keys for different environments
|
||||
- Revoke unused keys promptly
|
||||
- Rotate keys periodically
|
||||
- Use descriptive names to identify key purposes
|
||||
|
||||
### Don't
|
||||
|
||||
- Commit keys to version control
|
||||
- Share keys between applications
|
||||
- Log keys in application output
|
||||
- Embed keys in client-side code
|
||||
|
||||
### Key Rotation
|
||||
|
||||
Rotate keys periodically for security:
|
||||
|
||||
1. Create new key with same name
|
||||
2. Update applications to use new key
|
||||
3. Verify applications work correctly
|
||||
4. Revoke old key
|
||||
|
||||
!!! tip "Rotation Schedule"
|
||||
|
||||
Consider rotating keys every 90 days for sensitive applications.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Invalid Key Error
|
||||
|
||||
```
|
||||
Error: Invalid API key
|
||||
```
|
||||
|
||||
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`
|
||||
|
||||
### Permission Denied
|
||||
|
||||
```
|
||||
Error: Permission denied for this operation
|
||||
```
|
||||
|
||||
Solutions:
|
||||
|
||||
1. Verify you're the resource owner or have appropriate workspace access
|
||||
2. Check the key belongs to the correct workspace
|
||||
3. Create a new key if needed
|
||||
|
||||
### Rate Limited
|
||||
|
||||
```
|
||||
Error: Rate limit exceeded
|
||||
```
|
||||
|
||||
Solutions:
|
||||
|
||||
1. Reduce request frequency — see the [rate limit table](../api/index.md#per-api-key-limits) for per-endpoint limits
|
||||
2. Implement exponential backoff using the `Retry-After` header
|
||||
3. Use a [dedicated endpoint](../deploy/endpoints.md) for unlimited inference throughput
|
||||
|
||||
## FAQ
|
||||
|
||||
### How many keys can I create?
|
||||
|
||||
There's no hard limit on API keys. Create as many as needed for different applications and environments.
|
||||
|
||||
### Do keys expire?
|
||||
|
||||
Keys don't expire automatically. They remain valid until revoked. Consider implementing rotation for security.
|
||||
|
||||
### 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.
|
||||
|
||||
### Are keys region-specific?
|
||||
|
||||
Keys work across regions but access data in your account's region only.
|
||||
|
||||
### Can I share keys with team members?
|
||||
|
||||
Better practice: Have each team member create their own key. For team workspaces, each member with Editor role or higher can create keys scoped to that workspace.
|
||||
312
docs/en/platform/account/billing.md
Executable file
312
docs/en/platform/account/billing.md
Executable file
@@ -0,0 +1,312 @@
|
||||
---
|
||||
comments: true
|
||||
description: Manage credits, payments, and subscriptions on Ultralytics Platform with transparent pricing for cloud training and deployments.
|
||||
keywords: Ultralytics Platform, billing, credits, pricing, subscription, payments, training costs
|
||||
---
|
||||
|
||||
# Billing
|
||||
|
||||
[Ultralytics Platform](https://platform.ultralytics.com) uses a credit-based billing system for cloud training and dedicated endpoints. Add credits, track usage, and manage your subscription from `Settings > Billing`.
|
||||
|
||||
|
||||
|
||||
## Plans
|
||||
|
||||
Choose the plan that fits your needs. Compare plans in `Settings > Plans`:
|
||||
|
||||
|
||||
|
||||
| Feature | Free | Pro ($29/mo) | Enterprise |
|
||||
| -------------------------- | ---------- | --------------- | ---------- |
|
||||
| **Signup Credit** | $5 / $25\* | - | Custom |
|
||||
| **Monthly Credit** | - | $30/seat/month | Custom |
|
||||
| **Models** | 100 | 500 | Unlimited |
|
||||
| **Concurrent Trainings** | 3 | 10 | Unlimited |
|
||||
| **Storage** | 100 GB | 500 GB | Unlimited |
|
||||
| **Deployments** | 3 | 10 (warm-start) | Unlimited |
|
||||
| **Teams** | - | Up to 5 members | Up to 50 |
|
||||
| **Best GPUs (H200, B200)** | - | Yes | Yes |
|
||||
| **SSO / SAML** | - | - | Yes |
|
||||
| **Enterprise License** | - | - | Yes |
|
||||
| **License** | AGPL-3.0 | AGPL-3.0 | Enterprise |
|
||||
|
||||
\*Free plan: $5 at signup, or $25 if you verify a company/work email address.
|
||||
|
||||
### Free Plan
|
||||
|
||||
Get started at no cost:
|
||||
|
||||
- $5 signup credit ($25 for verified company/work emails)
|
||||
- Unlimited public and private projects and datasets
|
||||
- 100 models
|
||||
- 3 concurrent cloud trainings
|
||||
- 3 deployments
|
||||
- 100 GB storage
|
||||
- Model export to all formats
|
||||
- Manual annotation
|
||||
- Community support
|
||||
|
||||
!!! tip "Company Email Bonus"
|
||||
|
||||
Sign up with a company email address (not gmail.com, outlook.com, etc.) to receive $25 in signup credits instead of $5.
|
||||
|
||||
### Pro Plan
|
||||
|
||||
For professionals and small teams ($29/month or $290/year):
|
||||
|
||||
- $30/seat/month in credits (recurring)
|
||||
- 500 models
|
||||
- 10 concurrent cloud trainings
|
||||
- 500 GB storage
|
||||
- 10 warm-start deployments (faster cold starts)
|
||||
- Team collaboration (up to 5 members)
|
||||
- Access to the best GPUs (H200, B200)
|
||||
- Priority support
|
||||
|
||||
!!! tip "Save with Yearly Billing"
|
||||
|
||||
Choose yearly billing ($290/year) to save 17% compared to monthly billing.
|
||||
|
||||
### Enterprise
|
||||
|
||||
For organizations with advanced needs:
|
||||
|
||||
- $1,000/month in credits (starting allocation)
|
||||
- Custom credit allocation
|
||||
- Unlimited models, storage, trainings, and deployments
|
||||
- Enterprise License (commercial use, non-AGPL)
|
||||
- SSO / SAML authentication
|
||||
- RBAC with 4 roles (Owner, Admin, Editor, Viewer)
|
||||
- Custom roles with granular permissions
|
||||
- On-premise deployment options
|
||||
- Compliance (ISO/SOC)
|
||||
- SLA guarantees
|
||||
- Enterprise support
|
||||
|
||||
Contact [sales@ultralytics.com](mailto:sales@ultralytics.com) for Enterprise pricing.
|
||||
|
||||
## Credits
|
||||
|
||||
Credits are the currency for Platform compute services.
|
||||
|
||||
### Credit Balance
|
||||
|
||||
View your balance in `Settings > Billing`:
|
||||
|
||||
|
||||
|
||||
| Balance Type | Description |
|
||||
| ----------------------- | ------------------------------------- |
|
||||
| **Total Balance** | Available credits for cloud training |
|
||||
| **Promotional Credits** | Credits from signup or monthly grants |
|
||||
|
||||
### Credit Uses
|
||||
|
||||
Credits are consumed by:
|
||||
|
||||
| Service | Rate |
|
||||
| ------------------ | ---------------- |
|
||||
| **Cloud Training** | GPU rate x hours |
|
||||
|
||||
## Add Credits
|
||||
|
||||
Top up your balance:
|
||||
|
||||
1. Go to **Settings > Billing**
|
||||
2. Click **Top Up**
|
||||
3. Select or enter amount ($5 - $1,000)
|
||||
4. Complete payment
|
||||
|
||||
|
||||
|
||||
### Top-Up Presets
|
||||
|
||||
| Amount |
|
||||
| ------ |
|
||||
| $10 |
|
||||
| $20 |
|
||||
| $50 |
|
||||
| $100 |
|
||||
| $500 |
|
||||
|
||||
Custom amounts between $5 and $1,000 are also supported.
|
||||
|
||||
### Auto Top-Up
|
||||
|
||||
Enable automatic credit purchases when your balance drops below a threshold:
|
||||
|
||||
1. Go to **Settings > Billing**
|
||||
2. Toggle **Auto Top-Up** on
|
||||
3. Set **Threshold** (balance level that triggers a top-up)
|
||||
4. Set **Amount** (credits to purchase when triggered)
|
||||
5. Click **Save**
|
||||
|
||||
Default settings: threshold $20, amount $100.
|
||||
|
||||
!!! tip "Uninterrupted Training"
|
||||
|
||||
Enable auto top-up to ensure training jobs are never interrupted by insufficient credits.
|
||||
|
||||
### Payment Methods
|
||||
|
||||
Manage payment methods in `Settings > Billing`:
|
||||
|
||||
- **Add Card**: Click **Add Card** to add a credit or debit card
|
||||
- **Set Default**: Set a default payment method for top-ups and subscriptions
|
||||
- **Remove**: Remove payment methods you no longer need
|
||||
|
||||
### Billing Address
|
||||
|
||||
Set a billing address for invoices:
|
||||
|
||||
1. Go to **Settings > Billing**
|
||||
2. Click **Add Address** (or **Edit** if already set)
|
||||
3. Enter your billing details (name, address, country)
|
||||
4. Click **Save**
|
||||
|
||||
## Training Cost Flow
|
||||
|
||||
Cloud training estimates cost before start and charges for actual GPU time used.
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
A[Start Training] --> B[Estimate Cost]
|
||||
B --> C[Run Training]
|
||||
C --> D[Charge Actual Usage]
|
||||
```
|
||||
|
||||
### How It Works
|
||||
|
||||
1. **Estimate**: Platform calculates estimated cost based on model size, dataset size, epochs, and GPU
|
||||
2. **Authorize Start**: Your available balance is checked before training starts
|
||||
3. **Train**: Job runs on the selected GPU
|
||||
4. **Charge**: On completion (or cancellation), billing uses actual runtime
|
||||
|
||||
!!! success "Consumer Protection"
|
||||
|
||||
You pay for actual compute time used, including partial runs that are cancelled.
|
||||
|
||||
## Training Costs
|
||||
|
||||
Cloud training costs depend on GPU selection:
|
||||
|
||||
| GPU | VRAM | Rate/Hour |
|
||||
| ------------ | ------ | --------- |
|
||||
| RTX 2000 Ada | 16 GB | $0.24 |
|
||||
| RTX A4500 | 20 GB | $0.24 |
|
||||
| RTX A5000 | 24 GB | $0.26 |
|
||||
| RTX 4000 Ada | 20 GB | $0.38 |
|
||||
| L4 | 24 GB | $0.39 |
|
||||
| A40 | 48 GB | $0.40 |
|
||||
| RTX 3090 | 24 GB | $0.46 |
|
||||
| RTX A6000 | 48 GB | $0.49 |
|
||||
| RTX 4090 | 24 GB | $0.59 |
|
||||
| RTX 6000 Ada | 48 GB | $0.77 |
|
||||
| L40S | 48 GB | $0.86 |
|
||||
| RTX 5090 | 32 GB | $0.89 |
|
||||
| L40 | 48 GB | $0.99 |
|
||||
| A100 PCIe | 80 GB | $1.39 |
|
||||
| A100 SXM | 80 GB | $1.49 |
|
||||
| RTX PRO 6000 | 96 GB | $1.89 |
|
||||
| H100 PCIe | 80 GB | $2.39 |
|
||||
| H100 SXM | 80 GB | $2.69 |
|
||||
| H100 NVL | 94 GB | $3.07 |
|
||||
| H200 NVL | 143 GB | $3.39 |
|
||||
| H200 SXM | 141 GB | $3.59 |
|
||||
| B200 | 180 GB | $4.99 |
|
||||
|
||||
See [Cloud Training](../train/cloud-training.md) for complete GPU options and pricing.
|
||||
|
||||
### Cost Calculation
|
||||
|
||||
```
|
||||
Total Cost = GPU Rate x Training Time (hours)
|
||||
```
|
||||
|
||||
Example: Training for 2.5 hours on RTX PRO 6000
|
||||
|
||||
```
|
||||
$1.89 x 2.5 = $4.73
|
||||
```
|
||||
|
||||
## Upgrade to Pro
|
||||
|
||||
Upgrade for more features and monthly credits:
|
||||
|
||||
1. Go to **Settings > Plans**
|
||||
2. Click **Upgrade to Pro**
|
||||
3. Choose billing cycle (Monthly or Yearly)
|
||||
4. Complete checkout
|
||||
|
||||
<!-- Screenshot: settings-plans-tab-upgrade-to-pro-dialog.avif -->
|
||||
|
||||
### Pro Benefits
|
||||
|
||||
After upgrading:
|
||||
|
||||
- $30/seat/month credit added immediately and each month
|
||||
- Storage increased to 500 GB
|
||||
- 500 models
|
||||
- 10 concurrent cloud trainings
|
||||
- 10 warm-start deployments
|
||||
- Team collaboration (up to 5 members)
|
||||
- Access to best GPUs
|
||||
- Priority support
|
||||
|
||||
### Cancel Pro
|
||||
|
||||
Cancel anytime from the billing portal:
|
||||
|
||||
1. Go to **Settings > Billing**
|
||||
2. Click **Manage Subscription**
|
||||
3. Select **Cancel**
|
||||
4. Confirm cancellation
|
||||
|
||||
!!! note "Cancellation Timing"
|
||||
|
||||
Pro features remain active until the end of your billing period. Monthly credits stop at cancellation.
|
||||
|
||||
## Transaction History
|
||||
|
||||
View all transactions in `Settings > Billing`:
|
||||
|
||||
|
||||
|
||||
| Column | Description |
|
||||
| ----------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| **Date** | Transaction date |
|
||||
| **Type** | Signup Bonus, Credit Purchase, Monthly Grant, Training, Refund, Adjustment, Auto Top-Up, Auto Top-Up Failed |
|
||||
| **Amount** | Transaction value (green for credits, red for charges) |
|
||||
| **Balance** | Resulting balance after transaction |
|
||||
| **Details** | Additional context (model link, receipt, period) |
|
||||
|
||||
## FAQ
|
||||
|
||||
### What happens when I run out of credits?
|
||||
|
||||
- **Active training**: Cannot start new training jobs
|
||||
- **Deployments**: Continue running
|
||||
- **New training**: Requires credits to start
|
||||
|
||||
Add credits or enable auto top-up to continue training.
|
||||
|
||||
### Are unused credits refundable?
|
||||
|
||||
- **Purchased credits**: No refunds
|
||||
- **Signup/monthly credits**: No refunds (use it or lose it)
|
||||
|
||||
### Can I transfer credits?
|
||||
|
||||
Credits are not transferable between accounts.
|
||||
|
||||
### How do I get an invoice?
|
||||
|
||||
Transaction receipts are available in the transaction history. Click the receipt icon next to any purchase transaction.
|
||||
|
||||
### What if training fails?
|
||||
|
||||
You're only charged for completed compute time. Failed jobs don't charge for unused time.
|
||||
|
||||
### Is there a free trial?
|
||||
|
||||
The Free plan includes $5 signup credit ($25 with a company email) -- essentially a free trial. No credit card required to start.
|
||||
123
docs/en/platform/account/index.md
Executable file
123
docs/en/platform/account/index.md
Executable file
@@ -0,0 +1,123 @@
|
||||
---
|
||||
comments: true
|
||||
description: Manage your Ultralytics Platform account including API keys, billing, and user settings with security and GDPR compliance.
|
||||
keywords: Ultralytics Platform, account, settings, API keys, billing, security, GDPR
|
||||
---
|
||||
|
||||
# Account Management
|
||||
|
||||
[Ultralytics Platform](https://platform.ultralytics.com) provides comprehensive account management for API keys, billing, teams, and user settings. Manage your account securely with GDPR-compliant data handling.
|
||||
|
||||
## Overview
|
||||
|
||||
The Account section helps you:
|
||||
|
||||
- **Configure** your profile, social links, and workspace preferences
|
||||
- **Create** and manage API keys for remote training and programmatic access
|
||||
- **Track** credit balance, payments, and billing
|
||||
- **Collaborate** with team members using shared workspaces
|
||||
- **Monitor** account activity and audit events
|
||||
- **Recover** deleted items from Trash within 30 days
|
||||
- **Export** your data for GDPR compliance
|
||||
|
||||
|
||||
|
||||
## Account Features
|
||||
|
||||
| Feature | Description |
|
||||
| ------------ | -------------------------------------------------------- |
|
||||
| **Settings** | Profile, social links, emails, data region, and API keys |
|
||||
| **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 |
|
||||
| **Emails** | Add, remove, verify, and set primary email address |
|
||||
| **Activity** | Event log with inbox, archive, search, and undo |
|
||||
|
||||
## Settings Tabs
|
||||
|
||||
Account management is organized into tabs within `Settings`:
|
||||
|
||||
| Tab | Description |
|
||||
| --------- | ---------------------------------------------------------------- |
|
||||
| `Profile` | Display name, bio, company, use case, emails, social links, keys |
|
||||
| `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 |
|
||||
|
||||
## Security
|
||||
|
||||
Ultralytics Platform implements multiple security measures:
|
||||
|
||||
### Authentication
|
||||
|
||||
- **OAuth2**: Sign in with Google or GitHub
|
||||
- **Email/password**: Sign in with email and password
|
||||
- **Session management**: Secure, expiring sessions
|
||||
|
||||
### Data Protection
|
||||
|
||||
- **Encryption**: All data encrypted at rest and in transit
|
||||
- **API Keys**: AES-256-GCM encrypted storage
|
||||
- **Region isolation**: Data stays in your selected region (US, EU, or AP)
|
||||
|
||||
### Access Control
|
||||
|
||||
- **Per-key management**: Create and revoke API keys per workspace
|
||||
- **Team roles**: Owner, Admin, Editor, and Viewer roles (Pro and Enterprise)
|
||||
- **Audit logging**: Track all account activity in the Activity feed
|
||||
|
||||
## Quick Links
|
||||
|
||||
- [**Settings**](settings.md): Profile, social links, data region, and account management
|
||||
- [**Billing**](billing.md): Credits, plans, and payment management
|
||||
- [**API Keys**](api-keys.md): Create and manage API keys
|
||||
- [**Activity**](activity.md): Track account events and notifications
|
||||
- [**Trash**](trash.md): Recover deleted projects, datasets, and models
|
||||
|
||||
## FAQ
|
||||
|
||||
### How do I change my username?
|
||||
|
||||
Usernames cannot be changed after account creation. Your username is set during onboarding and is permanent.
|
||||
|
||||
### How do I change my email?
|
||||
|
||||
Manage your email addresses directly on the platform:
|
||||
|
||||
1. Go to `Settings > Profile`
|
||||
2. Scroll to the **Emails** section
|
||||
3. Add a new email, verify it, and set it as primary
|
||||
|
||||
### How do I delete my account?
|
||||
|
||||
Account deletion is available in Settings:
|
||||
|
||||
1. Go to `Settings > Profile`
|
||||
2. Scroll to the bottom
|
||||
3. Click **Delete Account**
|
||||
4. Confirm deletion
|
||||
|
||||
!!! warning "Permanent Action"
|
||||
|
||||
Account deletion is permanent. All data, models, and deployments are removed. Export your data first if needed.
|
||||
|
||||
### Is my data secure?
|
||||
|
||||
Yes, Ultralytics Platform implements:
|
||||
|
||||
- Secure encrypted connections (HTTPS)
|
||||
- AES-256-GCM encryption for API keys
|
||||
- Encryption at rest for all stored data
|
||||
- Regional data isolation (US, EU, AP)
|
||||
|
||||
### Can I change my data region?
|
||||
|
||||
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
|
||||
3. Re-upload your data
|
||||
|
||||
This ensures data residency compliance.
|
||||
297
docs/en/platform/account/settings.md
Executable file
297
docs/en/platform/account/settings.md
Executable file
@@ -0,0 +1,297 @@
|
||||
---
|
||||
comments: true
|
||||
description: Configure your Ultralytics Platform profile, preferences, and data settings with GDPR-compliant data export and deletion options.
|
||||
keywords: Ultralytics Platform, settings, profile, preferences, GDPR, data export, privacy
|
||||
---
|
||||
|
||||
# Settings
|
||||
|
||||
[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`.
|
||||
|
||||
## Profile Tab
|
||||
|
||||
The `Profile` tab contains your profile information, social links, API keys, data region, and account management options.
|
||||
|
||||
### Profile Information
|
||||
|
||||
Update your profile information:
|
||||
|
||||
|
||||
|
||||
| Field | Description |
|
||||
| ---------------- | ----------------------------------------- |
|
||||
| **Display Name** | Your public name |
|
||||
| **Username** | Unique identifier (set at signup) |
|
||||
| **Company** | Company or organization name |
|
||||
| **Use Case** | Primary application (select from list) |
|
||||
| **Bio** | Short description (minimum 10 characters) |
|
||||
| **Profile Icon** | Avatar with color, initials, or image |
|
||||
|
||||
#### Username Rules
|
||||
|
||||
- 4-32 characters
|
||||
- Lowercase letters, numbers, hyphens
|
||||
- Cannot start/end with hyphen
|
||||
- Must be unique
|
||||
|
||||
!!! note "Username is Permanent"
|
||||
|
||||
Your username is set during onboarding and cannot be changed. It appears in all your public URLs (e.g., `platform.ultralytics.com/username`).
|
||||
|
||||
#### Use Case Options
|
||||
|
||||
| Use Case | Description |
|
||||
| ----------------------- | -------------------------- |
|
||||
| Manufacturing & QC | Quality control workflows |
|
||||
| Retail & Inventory | Retail and inventory tasks |
|
||||
| Security & Surveillance | Security monitoring |
|
||||
| Healthcare & Medical | Medical imaging |
|
||||
| Automotive & Robotics | Self-driving and robotics |
|
||||
| Agriculture | Agricultural monitoring |
|
||||
| Research & Academia | Academic research |
|
||||
| Personal Project | Personal or hobby projects |
|
||||
|
||||
### Edit Profile
|
||||
|
||||
1. Go to **Settings > Profile**
|
||||
2. Update fields (display name, company, use case, bio)
|
||||
3. Click **Save Changes**
|
||||
|
||||
### Social Links
|
||||
|
||||
Connect your professional profiles:
|
||||
|
||||
|
||||
|
||||
| Platform | Format |
|
||||
| ------------------ | -------------------- |
|
||||
| **GitHub** | username |
|
||||
| **LinkedIn** | profile-slug |
|
||||
| **X (Twitter)** | username |
|
||||
| **YouTube** | channel-handle |
|
||||
| **Bilibili** | user-id |
|
||||
| **Google Scholar** | user-id |
|
||||
| **Discord** | username |
|
||||
| **WeChat** | username |
|
||||
| **Website** | https://yoursite.com |
|
||||
|
||||
Social links appear on your public profile page.
|
||||
|
||||
### Emails
|
||||
|
||||
Manage email addresses linked to your account in the `Profile` tab:
|
||||
|
||||
<!-- Screenshot: settings-profile-tab-emails-section.avif -->
|
||||
|
||||
| Action | Description |
|
||||
| ------------------ | ---------------------------------------------- |
|
||||
| **Add Email** | Add a new email address to your account |
|
||||
| **Remove** | Remove a non-primary email address |
|
||||
| **Verify** | Send a verification email to confirm ownership |
|
||||
| **Set as Primary** | Set a verified email as your primary address |
|
||||
|
||||
!!! note "Primary Email"
|
||||
|
||||
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:
|
||||
|
||||
| Region | Location | Best For |
|
||||
| ------ | ------------- | ------------------------------- |
|
||||
| **US** | United States | Americas users |
|
||||
| **EU** | Europe | European users, GDPR compliance |
|
||||
| **AP** | Asia Pacific | Asia-Pacific users |
|
||||
|
||||
!!! note "Region is Permanent"
|
||||
|
||||
Data region is selected during signup and cannot be changed. All your data stays in this region.
|
||||
|
||||
### Storage Usage
|
||||
|
||||
Monitor your storage consumption on the `Profile` tab:
|
||||
|
||||
|
||||
|
||||
| Type | Description |
|
||||
| ------------ | ----------------------- |
|
||||
| **Datasets** | Image and label storage |
|
||||
| **Models** | Checkpoint storage |
|
||||
| **Exports** | Exported model formats |
|
||||
|
||||
#### Storage Limits
|
||||
|
||||
| Plan | Limit |
|
||||
| ---------- | --------- |
|
||||
| Free | 100 GB |
|
||||
| Pro | 500 GB |
|
||||
| Enterprise | Unlimited |
|
||||
|
||||
#### Reduce Storage
|
||||
|
||||
To free up storage:
|
||||
|
||||
1. Delete unused datasets
|
||||
2. Remove old model checkpoints
|
||||
3. Delete exported formats
|
||||
4. Empty trash ([`Settings > Trash`](trash.md))
|
||||
|
||||
### Security
|
||||
|
||||
The `Profile` tab includes a Security card at the bottom:
|
||||
|
||||
- **Two-Factor Authentication**: Coming soon. Currently handled by your OAuth provider (Google, GitHub)
|
||||
- **Connected Accounts**: Shows your linked OAuth provider (e.g., Google)
|
||||
|
||||
### GDPR Compliance
|
||||
|
||||
Ultralytics Platform supports GDPR rights:
|
||||
|
||||
#### Data Export
|
||||
|
||||
Download all your data:
|
||||
|
||||
1. Go to **Settings > Profile**
|
||||
2. Scroll to the bottom section
|
||||
3. Click **Export Data**
|
||||
4. Receive download link via email
|
||||
|
||||
Export includes:
|
||||
|
||||
- Profile information
|
||||
- Dataset metadata
|
||||
- Model metadata
|
||||
- Training history
|
||||
- API key metadata (not secrets)
|
||||
|
||||
#### Account Deletion
|
||||
|
||||
Permanently delete your account:
|
||||
|
||||
1. Go to **Settings > Profile**
|
||||
2. Scroll to the bottom section
|
||||
3. Click **Delete Account**
|
||||
4. Confirm deletion
|
||||
|
||||
!!! warning "Irreversible Action"
|
||||
|
||||
Account deletion is permanent. All data is removed within 30 days per GDPR requirements.
|
||||
|
||||
##### What's Deleted
|
||||
|
||||
- All projects and trained models
|
||||
- All datasets and images
|
||||
- All API keys and credentials
|
||||
- All activity history
|
||||
- Credit balance
|
||||
|
||||
##### What's Retained
|
||||
|
||||
- Anonymized analytics
|
||||
- Server logs (90 days)
|
||||
- Legal compliance records
|
||||
|
||||
## Plans Tab
|
||||
|
||||
Compare available plans. See [Billing](billing.md) for detailed plan information and pricing.
|
||||
|
||||
## Billing Tab
|
||||
|
||||
Manage credits, payment methods, and view transaction history. See [Billing](billing.md) for full documentation.
|
||||
|
||||
## Teams Tab
|
||||
|
||||
Manage workspace members, roles, and invitations. Teams are available on [Pro and Enterprise plans](billing.md#plans).
|
||||
|
||||
### Team Overview
|
||||
|
||||
The Teams tab displays:
|
||||
|
||||
- Workspace name and avatar
|
||||
- Seat usage summary (used / available)
|
||||
- Member list with roles
|
||||
- Pending invitations
|
||||
|
||||
### Member Roles
|
||||
|
||||
| Role | Permissions |
|
||||
| ---------- | ------------------------------------------------------ |
|
||||
| **Owner** | Full control, transfer ownership, delete workspace |
|
||||
| **Admin** | Manage members, billing, settings, content |
|
||||
| **Editor** | Create and manage projects, datasets, models, API keys |
|
||||
| **Viewer** | Read-only access to workspace resources |
|
||||
|
||||
!!! note "Role Availability"
|
||||
|
||||
Owner, Admin, Editor, and Viewer roles are available on all team plans (Pro and Enterprise).
|
||||
|
||||
### Invite Members
|
||||
|
||||
1. Go to **Settings > Teams**
|
||||
2. Click **Invite**
|
||||
3. Enter email address
|
||||
4. Select role
|
||||
5. Send invitation
|
||||
|
||||
The invitee receives an email and can accept the invitation to join the workspace. Invitations expire after 7 days. Inviting members requires the Admin role or higher.
|
||||
|
||||
### Manage Members
|
||||
|
||||
Owners and admins can manage the team:
|
||||
|
||||
- **Change roles**: Click the role dropdown next to a member (only the owner can assign/remove the admin role)
|
||||
- **Remove members**: Click the menu and select **Remove**
|
||||
- **Cancel invites**: Cancel pending invitations that haven't been accepted
|
||||
- **Resend invites**: Resend invitation emails
|
||||
- **Transfer ownership**: Transfer workspace ownership to another member (Owner only)
|
||||
|
||||
## Trash Tab
|
||||
|
||||
Manage deleted items. See [Trash](trash.md) for full documentation.
|
||||
|
||||
## FAQ
|
||||
|
||||
### How do I change my email?
|
||||
|
||||
Manage your email addresses directly on the platform:
|
||||
|
||||
1. Go to **Settings > Profile**
|
||||
2. Scroll to the **Emails** section
|
||||
3. Add a new email, verify it, and set it as primary
|
||||
|
||||
### Can I have multiple accounts?
|
||||
|
||||
You can create accounts in different regions, but:
|
||||
|
||||
- Each needs a unique email
|
||||
- Data doesn't transfer between accounts
|
||||
- Billing is separate
|
||||
|
||||
### How do I change my password?
|
||||
|
||||
If you signed up with email and password, use the password reset flow on the sign-in page. If you signed up with an OAuth provider, manage your password through that provider:
|
||||
|
||||
- **Google**: accounts.google.com
|
||||
- **GitHub**: github.com/settings/security
|
||||
|
||||
### Is two-factor authentication available?
|
||||
|
||||
2FA is handled by your OAuth provider. Enable 2FA in:
|
||||
|
||||
- Google Account settings
|
||||
- GitHub Security settings
|
||||
|
||||
### How long until deleted data is removed?
|
||||
|
||||
| Type | Timeline |
|
||||
| -------------------- | ------------- |
|
||||
| **Trash items** | 30 days |
|
||||
| **Account deletion** | Up to 30 days |
|
||||
| **Backups** | 90 days |
|
||||
190
docs/en/platform/account/trash.md
Executable file
190
docs/en/platform/account/trash.md
Executable file
@@ -0,0 +1,190 @@
|
||||
---
|
||||
comments: true
|
||||
description: Learn how to recover deleted projects, datasets, and models from Trash on Ultralytics Platform with the 30-day soft delete policy.
|
||||
keywords: Ultralytics Platform, trash, restore, soft delete, recover, deleted items, data recovery
|
||||
---
|
||||
|
||||
# Trash and Restore
|
||||
|
||||
[Ultralytics Platform](https://platform.ultralytics.com) implements a 30-day soft delete policy, allowing you to recover accidentally deleted projects, datasets, and models. Deleted items are moved to Trash where they can be restored before permanent deletion.
|
||||
|
||||
|
||||
|
||||
## Soft Delete Policy
|
||||
|
||||
When you delete a resource on the platform:
|
||||
|
||||
1. **Immediate**: Item moves to Trash (not permanently deleted)
|
||||
2. **30 Days**: Item remains recoverable in Trash
|
||||
3. **After 30 Days**: Item is permanently deleted automatically
|
||||
|
||||
!!! success "Recovery Window"
|
||||
|
||||
You have 30 days to restore any deleted item. After this period, the item and all associated data are permanently removed and cannot be recovered.
|
||||
|
||||
## Accessing Trash
|
||||
|
||||
Navigate to your Trash:
|
||||
|
||||
1. Go to **Settings** and click the **Trash** tab
|
||||
2. Or navigate directly to `/trash` (redirects to `Settings > Trash`)
|
||||
|
||||
|
||||
|
||||
## Trash Contents
|
||||
|
||||
The Trash shows all soft-deleted resources with filter options:
|
||||
|
||||
| Filter | Shows |
|
||||
| ------------ | ----------------- |
|
||||
| **All** | All trashed items |
|
||||
| **Projects** | Trashed projects |
|
||||
| **Datasets** | Trashed datasets |
|
||||
| **Models** | Trashed models |
|
||||
|
||||
### Viewing Trash Items
|
||||
|
||||
Each item in Trash displays:
|
||||
|
||||
| Field | Description |
|
||||
| ------------------ | ---------------------------------------- |
|
||||
| **Name** | Original resource name |
|
||||
| **Type** | Project, Dataset, or Model (color-coded) |
|
||||
| **Deleted** | Date and time of deletion |
|
||||
| **Days Remaining** | Time until permanent deletion |
|
||||
| **Size** | Storage used by the item |
|
||||
| **Cascaded Items** | Number of child items included |
|
||||
| **Parent Project** | Parent project (for models) |
|
||||
|
||||
### Cascade Behavior
|
||||
|
||||
When deleting a parent resource, child resources are also moved to Trash:
|
||||
|
||||
| Resource Type | What's Included When Deleted |
|
||||
| ------------------------------------ | ------------------------------------------ |
|
||||
| [**Projects**](../train/projects.md) | Project + all models inside |
|
||||
| [**Datasets**](../data/datasets.md) | Dataset + all images and annotations |
|
||||
| [**Models**](../train/models.md) | Model weights + training history + exports |
|
||||
|
||||
### Storage Treemap
|
||||
|
||||
The Trash tab includes a storage visualization (treemap) showing the relative size of trashed items, color-coded by type:
|
||||
|
||||
- **Blue**: Projects
|
||||
- **Green**: Datasets
|
||||
- **Purple**: Models
|
||||
|
||||
## Restoring Items
|
||||
|
||||
Recover a deleted item:
|
||||
|
||||
1. Navigate to **Settings > Trash**
|
||||
2. Find the item you want to restore
|
||||
3. Click the **Restore** button (undo icon)
|
||||
4. Confirm restoration
|
||||
|
||||
|
||||
|
||||
The item returns to its original location with all data intact.
|
||||
|
||||
### Restore Behavior
|
||||
|
||||
| Resource | Restore Behavior |
|
||||
| -------- | ----------------------------------------------------------- |
|
||||
| Project | Restores project and all contained models |
|
||||
| Dataset | Restores dataset with all images and annotations |
|
||||
| Model | Restores model to original project if the project is active |
|
||||
|
||||
!!! warning "Parent Project Required"
|
||||
|
||||
Restoring a model fails if its parent project is in Trash. You'll see the error: "Cannot restore model while its parent project is in trash. Restore the project first." Always restore the parent project before restoring individual models.
|
||||
|
||||
## Permanent Deletion
|
||||
|
||||
### Automatic Deletion
|
||||
|
||||
Items in Trash are automatically and permanently deleted after 30 days. A daily cleanup job runs at 3:00 AM UTC to remove expired items.
|
||||
|
||||
### Empty Trash
|
||||
|
||||
Permanently delete all items immediately:
|
||||
|
||||
1. Navigate to **Settings > Trash**
|
||||
2. Click **Empty Trash**
|
||||
3. Confirm the action
|
||||
|
||||
!!! warning "Irreversible Action"
|
||||
|
||||
Emptying Trash permanently deletes all items immediately. This action cannot be undone and all data will be lost.
|
||||
|
||||
### Delete Single Item Permanently
|
||||
|
||||
To permanently delete one item without waiting:
|
||||
|
||||
1. Find the item in Trash
|
||||
2. Click the **Delete** button
|
||||
3. Confirm deletion
|
||||
|
||||
## Storage and Trash
|
||||
|
||||
Items in Trash still count toward your storage quota:
|
||||
|
||||
| Scenario | Storage Impact |
|
||||
| -------------------- | ------------------------------ |
|
||||
| Delete item | Storage remains allocated |
|
||||
| Restore item | No change (was still counting) |
|
||||
| Permanent deletion | Storage freed |
|
||||
| 30-day auto-deletion | Storage freed automatically |
|
||||
|
||||
!!! tip "Free Up Storage"
|
||||
|
||||
If you're running low on storage, empty Trash or permanently delete specific items to immediately reclaim space. Check your storage usage in [Settings](settings.md#storage-usage) and see [Billing](billing.md#plans) for plan storage limits.
|
||||
|
||||
## API Access
|
||||
|
||||
Access trash programmatically via the [REST API](../api/index.md#trash-api):
|
||||
|
||||
=== "List Trash"
|
||||
|
||||
```bash
|
||||
curl -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
https://platform.ultralytics.com/api/trash
|
||||
```
|
||||
|
||||
=== "Restore Item"
|
||||
|
||||
```bash
|
||||
curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"id": "item_abc123", "type": "dataset"}' \
|
||||
https://platform.ultralytics.com/api/trash
|
||||
```
|
||||
|
||||
=== "Empty Trash"
|
||||
|
||||
```bash
|
||||
curl -X DELETE -H "Authorization: Bearer YOUR_API_KEY" \
|
||||
https://platform.ultralytics.com/api/trash/empty
|
||||
```
|
||||
|
||||
## FAQ
|
||||
|
||||
### Can I restore an item after 30 days?
|
||||
|
||||
No. After 30 days, items are permanently deleted and cannot be recovered. Make sure to restore important items before the expiration date shown in Trash.
|
||||
|
||||
### What happens when I delete a project with models?
|
||||
|
||||
Both the project and all models inside it move to Trash together. Restoring the project restores all its models. You can also restore individual models separately.
|
||||
|
||||
### Do items in Trash count toward storage?
|
||||
|
||||
Yes, items in Trash continue to use storage quota. To free up space, permanently delete items or empty Trash.
|
||||
|
||||
### Can I recover a model if its project was permanently deleted?
|
||||
|
||||
No. If a project is permanently deleted, all models that were inside it are also permanently deleted. Always restore items before the 30-day window expires.
|
||||
|
||||
### How do I know when an item will be permanently deleted?
|
||||
|
||||
Each item in Trash shows a "Days Remaining" counter indicating how many days until automatic permanent deletion occurs.
|
||||
Reference in New Issue
Block a user