-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add better native nuget package readme (#21889)
### Description <!-- Describe your changes. --> Request from Nuget team to add a better readme to the nuget package so it is displayed nicely on nuget.org. Previously we were using the ORT repo readme.md but that a) doesn't display correctly due to limited markdown support on nuget.org, and b) has a lot of irrelevant info like build pipeline status. - Created a generic readme.md that includes the ORT description from the main readme, includes the ORT logo via an acceptable link, and lists the native nuget packages so the file can be included in any of them as-is. - Updated the nuget packaging script to add the `readme` tag and use this file. ### Motivation and Context <!-- - Why is this change required? What problem does it solve? - If it fixes an open issue, please link to the issue here. --> Request from MS Nuget team to MS package owners to add.
- Loading branch information
1 parent
c7d0ded
commit 20c802a
Showing
2 changed files
with
60 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
## About | ||
|
||
![ONNX Runtime Logo](https://raw.githubusercontent.com/microsoft/onnxruntime/main/docs/images/ONNX_Runtime_logo_dark.png) | ||
|
||
**ONNX Runtime is a cross-platform machine-learning inferencing accelerator**. | ||
|
||
**ONNX Runtime** 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 → [here](https://www.onnxruntime.ai/docs) | ||
|
||
## NuGet Packages | ||
|
||
### ONNX Runtime Native packages | ||
|
||
#### Microsoft.ML.OnnxRuntime | ||
- Native libraries for all supported platforms | ||
- CPU Execution Provider | ||
- CoreML Execution Provider on macOS/iOS | ||
- https://onnxruntime.ai/docs/execution-providers/CoreML-ExecutionProvider.html | ||
- XNNPACK Execution Provider on Android/iOS | ||
- https://onnxruntime.ai/docs/execution-providers/Xnnpack-ExecutionProvider.html | ||
|
||
#### Microsoft.ML.OnnxRuntime.Gpu | ||
- Windows and Linux | ||
- TensorRT Execution Provider | ||
- https://onnxruntime.ai/docs/execution-providers/TensorRT-ExecutionProvider.html | ||
- CUDA Execution Provider | ||
- https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html | ||
- CPU Execution Provider | ||
|
||
#### Microsoft.ML.OnnxRuntime.DirectML | ||
- Windows | ||
- DirectML Execution Provider | ||
- https://onnxruntime.ai/docs/execution-providers/DirectML-ExecutionProvider.html | ||
- CPU Execution Provider | ||
|
||
#### Microsoft.ML.OnnxRuntime.QNN | ||
- 64-bit Windows | ||
- QNN Execution Provider | ||
- https://onnxruntime.ai/docs/execution-providers/QNN-ExecutionProvider.html | ||
- CPU Execution Provider | ||
|
||
|
||
### Other packages | ||
|
||
#### Microsoft.ML.OnnxRuntime.Managed | ||
- C# language bindings | ||
|
||
#### Microsoft.ML.OnnxRuntime.Extensions | ||
- Custom operators for pre/post processing on all supported platforms. | ||
- https://github.com/microsoft/onnxruntime-extensions |