Back to Ultralytics

On Premise - Ultralytics Platform

docs/en/platform/integrations/on-premise.md

8.4.968.0 KB
Original Source

On Premise

On Premise lets your Enterprise workspace use datasets and compute on a Linux, macOS, or Windows computer. You keep the familiar Platform experience for browsing, annotation, and training while your images, videos, and model files stay on your computer.

Setup takes one command. Platform detects your operating system, fills in sensible folder locations, installs Docker if needed, and shows live connection progress.

How It Works

mermaid
flowchart LR
    A[Your browser] <-->|Interface, labels, and progress| B[Ultralytics Platform]
    A <-->|Previews and model downloads| C[Your On Premise computer]
    B <-->|Jobs and status only| C
    C --- D[(Dataset folder)]
    C --- E[(Models folder)]

Images, videos, and model files travel directly between your browser and your computer. They never take the Platform path.

Before You Start

Choose a computer that can access your datasets and remain powered on while Platform is using them.

MinimumRecommended
Operating system64-bit Linux, Mac with an M-series chip, or 64-bit Windows with WSL 2Current OS and Docker releases
CPU4 cores8 or more cores for training
Memory8 GB RAM16 GB or more
Storage20 GB plus space for datasets and modelsSSD with twice your working dataset size free
NetworkOutbound HTTPSStable broadband for the first Docker download

A GPU is optional. Every computer can ingest datasets and train models on its CPU. A compatible NVIDIA GPU can accelerate larger training jobs.

!!! note "Corporate networks"

If your company restricts outbound traffic, allow HTTPS access to Ultralytics Platform, Docker registries, and Python package downloads before setup.

Connect Your Computer

  1. Open Ultralytics Platform on the computer that can access your datasets.
  2. Go to Settings > Integrations and select Connect on the On Premise card.
  3. Review the prefilled settings:
    • Machine name: a recognizable name for this computer
    • Dataset folder: where you keep source datasets
    • Models folder: where Platform saves trained models
  4. Select Create install command.
  5. Open the terminal named in the dialog, copy the command, paste it, and press Enter.
  6. Leave the dialog open until the progress indicator shows Connected.

Platform fills in the folders and one-time connection token before you copy the command. The generated command follows the format below:

=== "Linux"

Open **Terminal** and paste:

```bash
curl -fsSL 'https://platform.ultralytics.com/api/workers/install?os=linux' \
  | sudo sh -s -- \
    "/datasets" \
    "/models" \
    "YOUR_CONNECTION_TOKEN"
```

=== "macOS"

Open **Terminal** and paste:

```bash
curl -fsSL 'https://platform.ultralytics.com/api/workers/install?os=macos' \
  | sh -s -- \
    "$HOME/Ultralytics/datasets" \
    "$HOME/Ultralytics/models" \
    "YOUR_CONNECTION_TOKEN"
```

=== "Windows"

Open **PowerShell** and paste:

```powershell
$installer = Invoke-RestMethod `
  'https://platform.ultralytics.com/api/workers/install?os=windows'
& ([scriptblock]::Create($installer)) `
  -DataPath "$HOME\Ultralytics\datasets" `
  -ModelsPath "$HOME\Ultralytics\models" `
  -ConnectionToken "YOUR_CONNECTION_TOKEN"
```

!!! warning "Copy your command from Platform"

Platform includes the connection token automatically. It proves this computer is allowed to connect to your workspace, expires after 10 minutes, and works once. You never enter it separately. Do not share the generated command while it is valid.

The defaults work without editing:

LinuxmacOS and Windows
Dataset folder/datasets~/Ultralytics/datasets
Models folder/models~/Ultralytics/models

The setup command creates these folders, installs and starts Docker when needed, and configures the connection to restart with your computer. Your operating system may ask you to approve installation or restart before setup can finish.

!!! info "Optional GPU acceleration"

CPU setup requires nothing beyond the guided installation. For NVIDIA GPU acceleration, install current NVIDIA drivers and enable Docker GPU support. Platform detects the GPU automatically.

Add a Dataset

  1. Put your dataset inside the configured dataset folder.
  2. In Platform, select New Dataset > On Premise.
  3. Choose the connected computer.
  4. Browse to the dataset folder, choose the task, and select Create.

Platform indexes the dataset locally and opens it in the same gallery used for uploaded and cloud-storage datasets. You can preview images, inspect labels, filter the dataset, and annotate without uploading the pixels.

Supported Data

On Premise supports the same ingest formats and computer-vision tasks as uploaded data:

  • Images and videos
  • ZIP, TAR, TAR.GZ, and TGZ archives
  • Ultralytics NDJSON and COCO JSON
  • YOLO datasets and classification folders
  • Detect, segment, pose, oriented bounding box (OBB), and classify tasks

Platform automatically recognizes common dataset layouts, classes, labels, and train/validation/test splits. Platform treats source files as read-only and never resizes, re-encodes, edits, or deletes them.

Preview and Annotate

When you open an image, your browser loads it directly from the connected computer. There is no certificate, hostname, VPN, or preview configuration.

Annotations and dataset organization are saved in your Platform workspace, but edits in Platform never change your source image or label files.

Train a Model

Start training through the normal Platform training dialog:

  1. Open a project and select Train Model.
  2. Choose the On Premise dataset.
  3. Select a model and training settings.
  4. Start training.

Platform runs the job on the connected computer. It uses an available NVIDIA GPU or falls back to CPU automatically, so a Mac can train a small model such as YOLO26n on COCO8 without dedicated GPU hardware.

Checkpoints, final weights, and other training files are saved in the configured models folder. Progress and metrics appear in Platform as usual. On Premise training does not use Platform compute credits, and Platform never sends the job to cloud compute.

Manage the Connection

Open Settings > Integrations to see whether the computer and its CPU or GPU are available. You can reconnect to refresh its access or disconnect it when it is no longer needed.

Disconnecting prevents new jobs and previews but does not delete datasets, source files, or trained models from the computer.

If Setup Does Not Finish

  • Docker asks for permission: Approve the prompt and wait for Docker to start. Setup continues automatically.
  • Windows asks for a restart: Restart the computer, return to Settings > Integrations, and create a new install command.
  • The setup command expired: Create a new install command. Each command is temporary and works once.
  • The connection stays offline: Open Docker Desktop, rerun a newly generated command, and keep the terminal open until it reports that On Premise is running.
  • Previews do not load: Open Platform in a browser on the connected computer. Previews and model downloads come directly from that computer.

Also see Datasets, Annotation, and Training.