onnxruntime/docs/get-started/install.md
Nat Kershaw (MSFT) 15291ab4c9
Migrate content from GitHub source to GitHub pages (#5053)
* Test re-using page layout from current ONNX Runtime website for docs

* Add content for documentation on website

* Fixed most broken links

* Copy just-the-docs theme sources into repo

* Remove local theme files as this did not work with GitHub

* Remove nojekyll file

* Move image assets into single location

* Add Contents to markdown files and ensure only one h1

* Update after review

* Fix img links

* Add trailing slash to main nav links

* Fix broken links on main docs page

* Re-fix broken links on main docs page

* Fix broken links #3

* Fix broken links #4

* Fix broken links #5

* Fix broken links #6

* Fix paths to global assets

* Add updates since fork

* Update custom op docs

* Fix link
2020-10-12 10:28:20 -07:00

3.9 KiB

title parent nav_order
Install Get Started 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.

Prerequisites

Linux / CPU

  1. English language package with the en_US.UTF-8 locale

  2. OpenMP

    • apt-get install libgomp1, which installs libgomp.so.1

Linux / GPU

  1. English language package with the en_US.UTF-8 locale

  2. CUDA 10.1 and cuDNN 7.6.5

Windows / CPU

  1. English language package with the en_US.UTF-8 locale

  2. Visual C++ 2019 runtime

  3. OpenMP

Windows / GPU

  1. English language package with the en_US.UTF-8 locale

  2. Visual C++ 2019 runtime

  3. CUDA 10.1 and cuDNN 7.6.5

Install

  • Default CPU Provider (Eigen + MLAS)
  • GPU Provider - NVIDIA CUDA
  • GPU Provider - DirectML (Windows)

If using pip, run pip install --upgrade pip prior to downloading.

Repository Official build Nightly build
Python CPU: onnxruntime ort-nightly (dev)
GPU: onnxruntime-gpu ort-gpu-nightly (dev)
C#/C/C++ CPU: Microsoft.ML.OnnxRuntime ort-nightly (dev)
GPU: Microsoft.ML.OnnxRuntime.Gpu ort-nightly (dev)
Java CPU: com.microsoft.onnxruntime/onnxruntime
GPU: com.microsoft.onnxruntime/onnxruntime_gpu
nodejs CPU: onnxruntime
Other Contributed non-official packages (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.