/tf-lite-unity-sample

TensorFlow Lite Samples on Unity

Primary LanguageC#

TensorFlow Lite for Unity Samples

openupm

Porting of "TensorFlow Lite Examples" to Unity. and some utilities for Unity.

Tested on

  • iOS / Android / macOS / Windows
  • Unity 2019.4.24f1
  • TensorFlow 2.4.0

Samples

  • TensorFlow
    • MNIST
    • SSD Object Detection
    • DeepLab
    • PoseNet
    • Style Transfer
    • Text Classification
    • Bert Question and Answer
    • Super Resolution
  • MediaPipe
    • Hand Tracking
    • Blaze Face
    • Face Mesh
    • Blaze Pose (Upper body)
  • MLKit
    • Blaze Pose (Full body)
  • Meet Segmentation

Included prebuilt libraries

iOS Android macOS Ubuntu Windows
Core CPU ✅ ✅ ✅ ✅ ✅
Metal Delegate ✅ - ✅ - -
OpenGL Delegate - ✅ - - -
NNAPI Delegate - ✅ - - -
  • All libraries except iOS are targeted 64bit platform: arm64 or x86_64.

Install TensorFlow Lite for Unity

  • Clone this repository with examples
  • The TFLite core library is available on:
    • OpenUPM
      Run openupm add com.github.asus4.tflite from the command line.
    • Or add git URL from the Package Maneger UI: https://github.com/asus4/tf-lite-unity-sample.git?path=/Packages/com.github.asus4.tflite

Build TensorFlow Lite libraries

Pre-built libraries are included. If you want to build the latest TFLite,

  1. Clone TensorFlow library
  2. Run ./configure in the TensorFlow library
  3. Run ./build_tflite.py (Python3) to build for each platform
# Update iOS, Andoid and macOS
./build_tflte.py --tfpath ../tensorflow -ios -android -macos

# Build with XNNPACK
./build_tflte.py --tfpath ../tensorflow -macos -xnnpack
  • To build macOS Metal Delegate on TensorFlow v2.3.0 or later, You need to apply following changes the issue

TIPS

[Android] You can see logs from tflite by filtering with "tflite"

# Filtering logcat only Unity and tflite
adb logcat Unity:V tflite:V "*:S"

Show Cases

MNIST
Mnist

SSD Object Detection
SSD

DeepLab Semantic Segmentation
DeepLab

Style Transfer
styletransfter

Hand Tracking
handtracking

BERT
BERT

License

Samples folder Assets/Samples/* is licensed under MIT

MIT License

Copyright (c) 2021 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.

Other Licenses

Model Licenses

📌 : Each TensorFlow Lite model might have a different license. Please check the license of the model you use.