[go: up one dir, main page]

Skip to content

Running With Docker

Setup

Before you begin, ensure that you have Docker installed on your machine. Docker provides a containerized environment, allowing the Roboflow Inference Server to run in a consistent and isolated manner, regardless of the host system. If you haven't installed Docker yet, you can get it from Docker's official website.

Set up a Docker Inference Server via `inference server start``

Another easy way to run the Roboflow Inference Server with Docker is via the command line.

First, Install the CLI.

Running the Inference Server is as simple as running the following command:

inference server start

This will pull the appropriate Docker image for your machine and start the Inference Server on port 9001. You can then send requests to the server to get predictions from your model, as described in HTTP Inference.

Once you have your inference server running, you can check its status with the following command:

inference server status

Roboflow Inference CLI currently supports the following device targets:

  • x86 CPU
  • ARM64 CPU
  • NVIDIA GPU

For Jetson or TensorRT Runtime inference server images, pull the images directly following the instructions below.

Manually Set Up a Docker Container

Step #1: Pull from Docker Hub

If you don't wish to build the Docker image locally or prefer to use the official releases, you can directly pull the pre-built images from the Docker Hub. These images are maintained by the Roboflow team and are optimized for various hardware configurations.

docker pull

Official Roboflow Inference Server Docker Image for x86 CPU Targets.

docker pull roboflow/roboflow-inference-server-cpu

Official Roboflow Inference Server Docker Image for ARM CPU Targets.

docker pull roboflow/roboflow-inference-server-cpu

Official Roboflow Inference Server Docker Image for Nvidia GPU Targets.

docker pull roboflow/roboflow-inference-server-gpu

Official Roboflow Inference Server Docker Image for Nvidia Jetson JetPack 4.5.x Targets.

docker pull roboflow/roboflow-inference-server-jetson-4.5.0

Official Roboflow Inference Server Docker Image for Nvidia Jetson JetPack 4.6.x Targets.

docker pull roboflow/roboflow-inference-server-jetson-4.6.1

Official Roboflow Inference Server Docker Image for Nvidia Jetson JetPack 5.x Targets.

docker pull roboflow/roboflow-inference-server-jetson-5.1.1

Step #2: Run the Docker Container

Once you have a Docker image (either built locally or pulled from Docker Hub), you can run the Roboflow Inference Server in a container.

docker run

docker run -it --net=host \
roboflow/roboflow-inference-server-cpu:latest
docker run -p 9001:9001 \
roboflow/roboflow-inference-server-cpu:latest
docker run -it --network=host --gpus=all \
roboflow/roboflow-inference-server-gpu:latest
docker run --privileged --net=host --runtime=nvidia \
roboflow/roboflow-inference-server-jetson-4.5.0:latest
docker run --privileged --net=host --runtime=nvidia \
roboflow/roboflow-inference-server-jetson-4.6.1:latest
docker run --privileged --net=host --runtime=nvidia \
roboflow/roboflow-inference-server-jetson-5.1.1:latest

Note: The Jetson images come with TensorRT dependencies. To use TensorRT acceleration with your model, pass an additional environment variable at runtime -e ONNXRUNTIME_EXECUTION_PROVIDERS=TensorrtExecutionProvider. This can improve inference speed, however, this also incurs a costly startup expense when the model is loaded. Note: On Windows and macOS, you may need to use -p 9001:9001 instead of --net=host to expose the port to the host machine.

You may add the flag -e ROBOFLOW_API_KEY=<YOUR API KEY> to your docker run command so that you do not need to provide a Roboflow API key in your requests. Substitute <YOUR API KEY> with your Roboflow API key. Learn how to retrieve your Roboflow API key here.

You may add the flag -v $(pwd)/cache:/tmp/cache to create a cache folder on your home device so that you do not need to redownload or recompile model artifacts upon inference container reboot. You can also (preferably) store artificats in a docker volume named inference-cache by adding the flag -v inference-cache:/tmp/cache.

Advanced: Build a Docker Container from Scratch

To build a Docker image locally, first clone the Inference Server repository.

git clone https://github.com/roboflow/inference

Choose a Dockerfile from the following options, depending on the hardware you want to run Inference Server on.

docker build

docker build \
-f docker/dockerfiles/Dockerfile.onnx.cpu \
-t roboflow/roboflow-inference-server-cpu .
docker build \
-f docker/dockerfiles/Dockerfile.onnx.cpu \
-t roboflow/roboflow-inference-server-cpu .
docker build \
-f docker/dockerfiles/Dockerfile.onnx.gpu \
-t roboflow/roboflow-inference-server-gpu .
docker build \
-f docker/dockerfiles/Dockerfile.onnx.jetson \
-t roboflow/roboflow-inference-server-jetson-4.5.0 .
docker build \
-f docker/dockerfiles/Dockerfile.onnx.jetson \
-t roboflow/roboflow-inference-server-jetson-4.6.1 .
docker build \
-f docker/dockerfiles/Dockerfile.onnx.jetson.5.1.1 \
-t roboflow/roboflow-inference-server-jetson-5.1.1 .