https://github.com/nnstreamer/nnstreamer-android

https://github.com/nnstreamer/nnstreamer-android

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/nnstreamer/nnstreamer-android
• Owner: nnstreamer
• License: apache-2.0
• Created: 2024-04-02T05:22:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T07:08:23.000Z (about 2 years ago)
• Last Synced: 2024-04-12T13:15:40.588Z (about 2 years ago)
• Language: Kotlin
• Size: 96.7 KB
• Stars: 0
• Watchers: 12
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# A Single APK integration of NNStreamer and ML API

[![Dokka](https://img.shields.io/badge/Kdoc-7F52FF.svg?style=for-the-badge&logo=kotlin&logoColor=white)](https://nnstreamer.github.io/nnstreamer-android/KDoc/)

This project offers a single Android application package (APK) solution for on-device Machine

Learning Operations (MLOps). As one of the core components, this APK includes an Android Service

that uses [ML API](https://github.com/nnstreamer/api) to maintain

[NNStreamer](https://github.com/nnstreamer/nnstreamer) pipelines and Machine Learning (ML) models

for those pipelines. The Service exposes multiple end-points to address ML computation offloading

requests from external Tizen and Android devices, as well as ML task delegation requests from other

Android applications running on the same device. The APK also provides an Android Activity that

controls the Service's features. This Activity enables users to supervise the ML models and

pipelines while hosting a user interface to visualize the results of the ML computations.

In addition, sample applications are provided as concrete examples to demonstrate how to use the

Service to perform external ML computation offloading and internal delegation of ML task requests.

## Documentation

- [KDoc](https://kotlinlang.org/docs/kotlin-doc.html) documentation generated from Kotlin source

  code is available at [here](https://nnstreamer.github.io/nnstreamer-android/KDoc/).

## Use-Case Scenarios

### Tizen-to-Android ML Offloading

#### [Getting Started](documentation/getting_started.md)

#### Component Interaction Diagram

![Component Interaction Diagram for the Tizen-to-Android Scenario](documentation/img/Tizen-to-Android.png)

## Disclaimer

Note that the license of this repository, [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html),

is only valid for the set of Android components provided this repository. Other software components

used in this project, such as: NNStreamer, ML API, TensorFlow Lite, etc. (especially, the files and

the cloned repositories under the ```externals``` directory), are provided as-is and are governed by

their respective licenses.