ONNX Runtime examples for Unity

Examples of ONNX Runtime Unity Plugin.

Yolox-Nano

2023-12-25-onnx-yolox.mp4

NanoSAM

2024-02-16-nanosam.mp4

Tested environment

• Unity: 2022.3.20f1 (LTS)
• ONNX Runtime: 1.17.3
• macOS, iOS, Android, Windows, Linux.
  • Complete List for 🔗 Supported Execution Providers

How to Run

Try all examples

Important

Install Git-LFS to try this repository.

ONNX examples are available in the Assets/Examples folder. Pull the repository and open the project in Unity.

Following demos are available:

• MobileOne: Image classification
• Yolox: Object detection
• NanoSAM: Object Segmentation

Install pre-built ONNX Runtime via Unity Package Manager (UPM)

Add the following scopedRegistries and dependencies in Packages/manifest.json to install the ONNX Runtime plugin into your project.
Check out the asus4/onnxruntime-unity repository for more details.

  "scopedRegistries": [
    {
      "name": "NPM",
      "url": "https://registry.npmjs.com",
      "scopes": [
        "com.github.asus4"
      ]
    }
  ]
  "dependencies": {
    // Core library
    "com.github.asus4.onnxruntime": "0.1.14",
    // (Optional) Utilities for Unity
    "com.github.asus4.onnxruntime.unity": "0.1.14",
    ... other dependencies
  }

How to convert Onnx to Ort format

On the mobile platform, the *.onnx model is not recommended, although it's supported. Convert the Onnx model to Ort format.

Please refer to the ORT model format for more details.

# Recommend using python virtual environment
pip install onnx
pip install onnxruntime

# In general,
# Use --optimization_style Runtime, when running on mobile GPU
# Use --optimization_style Fixed, when running on mobile CPU
python -m onnxruntime.tools.convert_onnx_models_to_ort your_onnx_file.onnx --optimization_style Runtime

Acknowledgements

• PINTO_model_zoo: Some ORT models are converted from this repository.

License

My code is licensed under MIT.
Please refer to the original licenses of each example in the Assets/Samples/* folder.

MIT License

Copyright (c) Koki Ibukuro

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.