docs/development.md
Install prerequisites:
Then build and run Ollama from the root directory of the repository:
go run . serve
[!NOTE] Ollama includes native code compiled with CGO. From time to time these data structures can change and CGO can get out of sync resulting in unexpected crashes. You can force a full build of the native code by running
go clean -cachefirst.
macOS Apple Silicon supports Metal which is built-in to the Ollama binary. No additional steps are required.
Install prerequisites:
brew install cmakeThen, configure and build the project:
cmake -B build
cmake --build build
Lastly, run Ollama:
go run . serve
Install prerequisites:
Then, configure and build the project:
cmake -B build
cmake --build build --config Release
Building for Vulkan requires VULKAN_SDK environment variable:
PowerShell
powershell$env:VULKAN_SDK="C:\VulkanSDK\<version>"CMD
cmdset VULKAN_SDK=C:\VulkanSDK\<version>
[!IMPORTANT] Building for ROCm requires additional flags:
cmake -B build -G Ninja -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ cmake --build build --config Release
Lastly, run Ollama:
go run . serve
Windows ARM does not support additional acceleration libraries at this time. Do not use cmake, simply go run or go build.
Install prerequisites:
sudo apt install cmake or sudo dnf install cmakesudo apt install vulkan-sdk (Ubuntu/Debian) or sudo dnf install vulkan-sdk (Fedora/CentOS)sudo apt install libopenblas-dev liblapack-dev liblapacke-dev (Ubuntu/Debian)[!IMPORTANT] Ensure prerequisites are in
PATHbefore running CMake.
Then, configure and build the project:
cmake -B build
cmake --build build
Lastly, run Ollama:
go run . serve
The MLX engine enables running safetensor based models. It requires building the MLX and MLX-C shared libraries separately via CMake. On MacOS, MLX leverages the Metal library to run on the GPU, and on Windows and Linux, runs on NVIDIA GPUs via CUDA v13.
Requires the Metal toolchain. Install Xcode first, then:
xcodebuild -downloadComponent MetalToolchain
Verify it's installed correctly (should print "no input files"):
xcrun metal
Then build:
cmake -B build --preset MLX
cmake --build build --preset MLX --parallel
cmake --install build --component MLX
[!NOTE] Without the Metal toolchain, cmake will silently complete with Metal disabled. Check the cmake output for
Setting MLX_BUILD_METAL=OFFwhich indicates the toolchain is missing.
Requires CUDA 13+ and cuDNN 9+.
cmake -B build --preset "MLX CUDA 13"
cmake --build build --target mlx --target mlxc --config Release --parallel
cmake --install build --component MLX --strip
To build against a local checkout of MLX and/or MLX-C (useful for development), set environment variables before running CMake:
export OLLAMA_MLX_SOURCE=/path/to/mlx
export OLLAMA_MLX_C_SOURCE=/path/to/mlx-c
For example, using the helper scripts with local mlx and mlx-c repos:
OLLAMA_MLX_SOURCE=../mlx OLLAMA_MLX_C_SOURCE=../mlx-c ./scripts/build_linux.sh
OLLAMA_MLX_SOURCE=../mlx OLLAMA_MLX_C_SOURCE=../mlx-c ./scripts/build_darwin.sh
$env:OLLAMA_MLX_SOURCE="../mlx"
$env:OLLAMA_MLX_C_SOURCE="../mlx-c"
./scripts/build_darwin.ps1
docker build .
docker build --build-arg FLAVOR=rocm .
To run tests, use go test:
go test ./...
Ollama looks for acceleration libraries in the following paths relative to the ollama executable:
./lib/ollama (Windows)../lib/ollama (Linux). (macOS)build/lib/ollama (for development)If the libraries are not found, Ollama will not run with any acceleration libraries.