mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-07-16 18:31:27 +00:00
90 lines
4 KiB
Markdown
90 lines
4 KiB
Markdown
---
|
|
title: Install
|
|
parent: Get Started
|
|
nav_order: 1
|
|
---
|
|
|
|
# Install ONNX Runtime
|
|
{: .no_toc }
|
|
|
|
## Contents
|
|
{: .no_toc }
|
|
|
|
* TOC placeholder
|
|
{:toc}
|
|
|
|
Use this guide to install ONNX Runtime and its dependencies, for your target operating system, hardware, accelerator, and language.
|
|
|
|
For an overview, see this [installation matrix](https://onnxruntime.ai).
|
|
|
|
## Prerequisites
|
|
|
|
### Linux / CPU
|
|
|
|
1. English language package with the `en_US.UTF-8` locale
|
|
|
|
* Install [language-pack-en package](https://packages.ubuntu.com/search?keywords=language-pack-en)
|
|
* Run `locale-gen en_US.UTF-8`
|
|
* Run `update-locale LANG=en_US.UTF-8`
|
|
|
|
2. OpenMP
|
|
|
|
* `apt-get install libgomp1`, which installs **libgomp.so.1**
|
|
|
|
### Linux / GPU
|
|
|
|
1. English language package with the `en_US.UTF-8` locale
|
|
|
|
* Install [language-pack-en package](https://packages.ubuntu.com/search?keywords=language-pack-en)
|
|
* Run `locale-gen en_US.UTF-8`
|
|
* Run `update-locale LANG=en_US.UTF-8`
|
|
|
|
2. CUDA 10.2 and cuDNN 8.0.3
|
|
|
|
* Version dependencies from older ONNX Runtime releases can be found in [prior release notes](https://github.com/microsoft/onnxruntime/releases).
|
|
|
|
### Windows / CPU
|
|
|
|
1. English language package with the `en_US.UTF-8` locale
|
|
|
|
2. [Visual C++ 2019 runtime](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
|
|
|
|
3. OpenMP
|
|
* Comes installed with Visual C++ runtime
|
|
* Or is also available as redist packages [vc_redist.x64.exe](https://aka.ms/vs/16/release/vc_redist.x64.exe) and [vc_redist.x86.exe](https://aka.ms/vs/16/release/vc_redist.x86.exe)
|
|
|
|
### Windows / GPU
|
|
|
|
1. English language package with the `en_US.UTF-8` locale
|
|
|
|
2. [Visual C++ 2019 runtime](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
|
|
|
|
3. CUDA 10.2** and cuDNN 8.0.3
|
|
* Version dependencies from older ONNX Runtime releases can be found in [prior release notes](https://github.com/microsoft/onnxruntime/releases).
|
|
|
|
### MacOS / CPU
|
|
|
|
1. The system must have libomp.dylib which can be installed using ``brew install libomp`.
|
|
|
|
## Install
|
|
|
|
* Default CPU Provider (Eigen + MLAS)
|
|
* GPU Provider - NVIDIA CUDA
|
|
* GPU Provider - DirectML (Windows)
|
|
* *On Windows, the [DirectML execution provider](https://github.com/microsoft/onnxruntime/tree/master/docs/execution_providers/DirectML-ExecutionProvider.md) is recommended for optimal performance and compatibility with a broad set of GPUs.*
|
|
|
|
If using pip, run `pip install --upgrade pip` prior to downloading.
|
|
|
|
|Repository|Official build|Nightly build|
|
|
|---|---|---|
|
|
|Python|CPU: [**onnxruntime**](https://pypi.org/project/onnxruntime)| [ort-nightly (dev)](https://test.pypi.org/project/ort-nightly)|
|
|
||GPU: [**onnxruntime-gpu**](https://pypi.org/project/onnxruntime-gpu) | [ort-gpu-nightly (dev)](https://test.pypi.org/project/ort-gpu-nightly)|
|
|
|C#/C/C++|CPU: [**Microsoft.ML.OnnxRuntime**](https://www.nuget.org/packages/Microsoft.ML.OnnxRuntime) | [ort-nightly (dev)](https://aiinfra.visualstudio.com/PublicPackages/_packaging?_a=feed&feed=ORT-Nightly)|
|
|
||GPU: [**Microsoft.ML.OnnxRuntime.Gpu**](https://www.nuget.org/packages/Microsoft.ML.OnnxRuntime.gpu)|[ort-nightly (dev)](https://aiinfra.visualstudio.com/PublicPackages/_packaging?_a=feed&feed=ORT-Nightly)|
|
|
|Java|CPU: [**com.microsoft.onnxruntime/onnxruntime**](https://search.maven.org/artifact/com.microsoft.onnxruntime/onnxruntime)|
|
|
||GPU: [**com.microsoft.onnxruntime/onnxruntime_gpu**](https://search.maven.org/artifact/com.microsoft.onnxruntime/onnxruntime_gpu)|
|
|
|nodejs|CPU: [**onnxruntime**](https://www.npmjs.com/package/onnxruntime)|
|
|
|Other|[Contributed non-official packages](https://docs.microsoft.com/en-us/windows/ai/windows-ml/get-started-uwp) (including Homebrew, Linuxbrew, and nixpkgs)|
|
|
||These are not maintained by the core ONNX Runtime team and may have limited support; use at your discretion.|
|
|
|
|
Note: Dev builds created from the master branch are available for testing newer changes between official releases. Please use these at your own risk. We strongly advise against deploying these to production workloads as support is limited for dev builds.
|