saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-06-11 00:49:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Faxu patch 1 (#63)

Browse source 
* Delete Roadmap.md

* Update README.md

* Update README.md

* Update README.md
This commit is contained in:
Faith Xu 2018-11-30 22:10:26 -08:00 committed by Pranav Sharma
parent 21dad1780b
commit 07253fd647
2 changed files with 30 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -10,23 +10,45 @@ ONNX Runtime is an open-source scoring engine for Open Neural Network Exchange (
ONNX is an open format for machine learning (ML) models that is supported by various ML and DNN frameworks and tools. This format makes it easier to interoperate between frameworks and to maximize the reach of your hardware optimization investments. Learn more about ONNX on [https://onnx.ai](https://onnx.ai) or view the [Github Repo](https://github.com/onnx/onnx).
# Why use ONNX Runtime
ONNX Runtime is an open architecture that is continually evolving to adapt to and address the newest developments and challenges in AI and Deep Learning. We will keep ONNX Runtime up to date with the ONNX standard, supporting all ONNX releases with future compatibliity while maintaining backwards compatibility with prior releases.
ONNX Runtime continuously strives to provide top performance for a broad and growing number of usage scenarios in Machine Learning. Our investments focus on these 3 core areas:
1. Run any ONNX model
2. High performance
3. Cross platform
## Run any ONNX model
### Alignment with ONNX Releases
ONNX Runtime provides comprehensive support of the ONNX spec and can be used to run all models based on ONNX v1.2.1 and higher. See ONNX version release details [here](https://github.com/onnx/onnx/releases).
In order to support popular and leading AI models, the runtime stays up-to-date with evolving ONNX operators and functionalities.
As of November 2018, ONNX Runtime supports the latest released version of ONNX (1.3). Once 1.4 is released, ONNX Runtime will align with the updated spec, adding support for new operators and other capabilities.
### Traditional ML support
ONNX Runtime fully supports the ONNX-ML profile of the ONNX spec for traditional ML scenarios.
## High Performance
You can use ONNX Runtime with both CPU and GPU hardware. You can also plug in additional execution providers to ONNX Runtime. With many graph optimizations and various accelerators, ONNX Runtime can often provide lower latency and higher efficiency compared to other runtimes. This provides smoother end-to-end customer experiences and lower costs from improved machine utilization.
Currently ONNX Runtime supports CUDA and MKL-DNN (with option to build with MKL) for computation acceleration. To add an execution provider, please refer to [this page](docs/AddingExecutionProvider.md).
We are continuously working to integrate new execution providers to provide improvements in latency and efficiency. We have ongoing collaborations to integrate the following with ONNX Runtime:
* Intel MKL-DNN and nGraph
* NVIDIA TensorRT
## Cross Platform
ONNX Runtime offers:
* APIs for Python, C#, and C (experimental)
* Available for Linux, Windows, and Mac 
See API documentation and package installation instructions [below](#Installation).
## High Performance
You can use ONNX Runtime with both CPU and GPU hardware. You can also plug in additional execution providers to ONNX Runtime. With many graph optimizations and various accelerators, ONNX Runtime can often provide lower latency and higher efficiency compared to other runtimes. This provides smoother end-to-end customer experiences and lower costs from improved machine utilization.
Currently ONNX Runtime supports CUDA and MKL-DNN (with option to build with MKL) for computation acceleration, with more coming soon. To add an execution provider, please refer to [this page](docs/AddingExecutionProvider.md).
Looking ahead: To broaden the reach of the runtime, we will continue investments to make ONNX Runtime available and compatible with more platforms. These include but are not limited to:
* C# for Linux, Mac
* C# supporting GPU
* C packages
* ARM
# Getting Started
If you need a model:
* Check out the [ONNX Model Zoo](https://github.com/onnx/models) for ready-to-use pre-trained models.
@ -41,9 +63,7 @@ If you already have an ONNX model, just [install the runtime](#Installation) for
| [Python](https://docs.microsoft.com/en-us/python/api/overview/azure/onnx/intro?view=azure-onnx-py) | [Windows](https://pypi.org/project/onnxruntime/)<br>[Linux](https://pypi.org/project/onnxruntime/)<br>[Mac](https://pypi.org/project/onnxruntime/)| [Windows](https://pypi.org/project/onnxruntime-gpu)<br>[Linux](https://pypi.org/project/onnxruntime-gpu/) |
| [C#](docs/CSharp_API.md) | [Windows](https://www.nuget.org/packages/Microsoft.ML.OnnxRuntime/)<br>Linux - Coming Soon<br>Mac - Coming Soon| Coming Soon |
| [C (experimental)](docs/C_API.md) | Coming Soon | Coming Soon |
<br><br>
ONNX Runtime also provides a non ABI [C++ API](onnxruntime/core/session/inference_session.h)
| [C++](onnxruntime/core/session/inference_session.h) | TBD | TBD |
## Build Details
For details on the build configurations and information on how to create a build, see [Build ONNX Runtime](BUILD.md).

3
docs/Roadmap.md
View file

@ -1,3 +0,0 @@
# Roadmap
TBD