Skip to content

Install

Use the instructions here for your operating system or deployment strategy. They will walk you through building the project as a python environment for your OS.

OpenArc supports most OpenVINO devices (including AMD CPUs). You can use CPUs, NPUs, and GPUs; however these require different drivers.

Visit OpenVINO System Requirments for the latest information on drivers for your device and OS.

  1. Install uv from astral

  2. After cloning use:

    uv sync
    
  3. Activate your environment with:

    source .venv/bin/activate
    

    Build latest optimum

    uv pip install "optimum-intel[openvino] @ git+https://github.com/huggingface/optimum-intel"
    

    Build latest OpenVINO and OpenVINO GenAI from nightly wheels

    uv pip install --pre -U openvino-genai --extra-index-url https://storage.openvinotoolkit.org/simple/wheels/nightly
    

  4. Set your API key as an environment variable:

    export OPENARC_API_KEY=api-key
    

  5. To get started, run:

    openarc --help
    
  1. Install uv from astral

  2. Clone OpenArc, enter the directory and run:

    uv sync
    

  3. Activate your environment with:

    .venv\Scripts\activate
    

    Build latest optimum

    uv pip install "optimum-intel[openvino] @ git+https://github.com/huggingface/optimum-intel"
    

    Build latest OpenVINO and OpenVINO GenAI from nightly wheels

    uv pip install --pre -U openvino-genai --extra-index-url https://storage.openvinotoolkit.org/simple/wheels/nightly
    

  4. Set your API key as an environment variable:

    setx OPENARC_API_KEY openarc-api-key
    

  5. To get started, run:

    openarc --help
    

Instead of fighting with Intel's own docker images, we built our own which is as close to boilerplate as possible. For a primer on docker check out this video.

Build and run the container:

docker-compose up --build -d

Run the container:

docker run -d -p 8000:8000 openarc:latest
Enter the container:
docker exec -it openarc /bin/bash

Environment Variables

``bash export OPENARC_API_KEY="openarc-api-key" # default, set it to whatever you want export OPENARC_AUTOLOAD_MODEL="model_name" # model_name to load on startup export MODEL_PATH="/path/to/your/models" # mount your models to/models` inside the container docker-compose up --build -d

```

Take a look at the [Dockerfile](Dockerfile) and [docker-compose](docker-compose.yaml) for more details.