onnxruntime/docs/how-to/install.md
Yulong Wang 25b2aa6d04
[doc] update a part of the documents for ORT JavaScript (#7935)
* update api-basics.md

* update install.md

* add placeholder for "build for web"

* update js api

* add more sections in js-api.md

* update "coming soon" for how-to-build-web

* Update "Web" -> "web" in title of web.md

* Update install.md
2021-06-08 10:47:27 -07:00

4.3 KiB

title parent nav_order
Install ORT How to 1

Install ONNX Runtime

{: .no_toc }

See the installation matrix for recommended instructions for desired combinations of target operating system, hardware, accelerator, and language.

Details on OS versions, compilers, language versions, dependent libraries , etc can be found under Compatibility.

Contents

{: .no_toc }

  • TOC placeholder {:toc}

Inference

The following build variants are available as officially supported packages. Others can be built from source from each release branch.

  1. Default CPU Provider
  2. GPU Provider - NVIDIA CUDA
  3. GPU Provider - DirectML (Windows) - recommended for optimized performance and compatibility with a broad set of GPUs on Windows devices
Official build Nightly build
Python If using pip, run pip install --upgrade pip prior to downloading.
CPU: onnxruntime ort-nightly (dev)
GPU: onnxruntime-gpu ort-gpu-nightly (dev)
C#/C/C++ CPU: Microsoft.ML.OnnxRuntime ort-nightly (dev)
GPU - CUDA: Microsoft.ML.OnnxRuntime.Gpu ort-nightly (dev)
GPU - DirectML: Microsoft.ML.OnnxRuntime.DirectML ort-nightly (dev)
WinML Microsoft.AI.MachineLearning
Java CPU: com.microsoft.onnxruntime:onnxruntime
GPU: com.microsoft.onnxruntime:onnxruntime_gpu
Android com.microsoft.onnxruntime:onnxruntime-mobile
iOS (C/C++) CocoaPods: onnxruntime-mobile-c
Objective-C CocoaPods: onnxruntime-mobile-objc
Node.js onnxruntime-node
Web onnxruntime-web

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.

Requirements

{: .no_toc }

Training

Official build Nightly build
PyTorch (CUDA 10.2) onnxruntime-training onnxruntime_nightly_cu102
PyTorch (CUDA 11.1) onnxruntime_stable_cu111 onnxruntime_nightly_cu111
[Preview] PyTorch (ROCm 4.2) onnxruntime_stable_rocm42 onnxruntime_nightly_rocm42