mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-18 21:21:17 +00:00
7cb9077043
* Delete mobile page Moved to: https://www.onnxruntime.ai/docs/how-to/deploy-on-mobile.html * Delete ONNX_Runtime_Mobile_NNAPI_perf_considerations.md Moved to: https://www.onnxruntime.ai/docs/reference/execution-providers/NNAPI-ExecutionProvider.html#performance-tuning * Fix links to website docs * Update some summary text * Add space
63 lines
7.4 KiB
Markdown
63 lines
7.4 KiB
Markdown
<p align="center"><img width="50%" src="docs/images/ONNX_Runtime_logo_dark.png" /></p>
|
|
|
|
**ONNX Runtime is a cross-platform inference and training machine-learning accelerator**.
|
|
|
|
**ONNX Runtime inference** can enable faster customer experiences and lower costs, supporting models from deep learning frameworks such as PyTorch and TensorFlow/Keras as well as classical machine learning libraries such as scikit-learn, LightGBM, XGBoost, etc. ONNX Runtime is compatible with different hardware, drivers, and operating systems, and provides optimal performance by leveraging hardware accelerators where applicable alongside graph optimizations and transforms. [Learn more →](https://www.onnxruntime.ai/docs/#onnx-runtime-for-inferencing)
|
|
|
|
**ONNX Runtime training** can accelerate the model training time on multi-node NVIDIA GPUs for transformer models with a one-line addition for existing PyTorch training scripts. [Learn more →](https://www.onnxruntime.ai/docs/#onnx-runtime-for-training)
|
|
|
|
|
|
## Get Started
|
|
|
|
**http://onnxruntime.ai/**
|
|
* [Overview](https://www.onnxruntime.ai/docs/)
|
|
* [Tutorials](https://www.onnxruntime.ai/docs/tutorials/)
|
|
* [Inferencing](https://www.onnxruntime.ai/docs/tutorials/inferencing/)
|
|
* [Training](https://www.onnxruntime.ai/docs/tutorials/training/)
|
|
* [How To](https://www.onnxruntime.ai/docs/how-to)
|
|
* [Install](https://www.onnxruntime.ai/docs/how-to/install.html)
|
|
* [Build](https://www.onnxruntime.ai/docs/how-to/build/)
|
|
* [Tune performance](https://www.onnxruntime.ai/docs/how-to/tune-performance.html)
|
|
* [Quantize models](https://www.onnxruntime.ai/docs/how-to/quantization.html)
|
|
* [Deploy on mobile](https://www.onnxruntime.ai/docs/how-to/deploy-on-mobile.html)
|
|
* [Use custom ops](https://www.onnxruntime.ai/docs/how-to/add-custom-op.html)
|
|
* [Add a new EP](https://www.onnxruntime.ai/docs/how-to/add-execution-provider.html)
|
|
* [Reference](https://www.onnxruntime.ai/docs/reference)
|
|
* [API documentation](https://www.onnxruntime.ai/docs/reference/api/)
|
|
* [Execution Providers](https://www.onnxruntime.ai/docs/reference/execution-providers/)
|
|
* [Releases and servicing](https://www.onnxruntime.ai/docs/reference/releases-servicing.html)
|
|
* [Citing](https://www.onnxruntime.ai/docs/reference/citing.html)
|
|
* [Additional resources](https://www.onnxruntime.ai/docs/resources/)
|
|
|
|
## Build Pipeline Status
|
|
|System|CPU|GPU|EPs|
|
|
|---|---|---|---|
|
|
|Windows|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=9)|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=10)|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=47)|
|
|
|Linux|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=11)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=64)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=110)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=78)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=86)|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=12)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=45)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=140)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=84)|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=110)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=108)|
|
|
|Mac|[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=13)<br>[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=65)|||
|
|
|Android|||[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=53)|
|
|
|iOS|||[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=134)|
|
|
|WebAssembly|||[](https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=161)|
|
|
|
|
|
|
## Data/Telemetry
|
|
|
|
Windows distributions of this project may collect usage data and send it to Microsoft to help improve our products and services. See the [privacy statement](docs/Privacy.md) for more details.
|
|
|
|
## Contributions and Feedback
|
|
|
|
We welcome contributions! Please see the [contribution guidelines](CONTRIBUTING.md).
|
|
|
|
For feature requests or bug reports, please file a [GitHub Issue](https://github.com/Microsoft/onnxruntime/issues).
|
|
|
|
For general discussion or questions, please use [Github Discussions](https://github.com/microsoft/onnxruntime/discussions).
|
|
|
|
## Code of Conduct
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
|
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
|
|
|
## License
|
|
|
|
This project is licensed under the [MIT License](LICENSE).
|