Enable ml-service and ml-offloading

 - Add ml-service and ml-offloading feature
 - Update doc for ml-service build
 - Add deviceMLOps.MLAgent repo as submodule

Signed-off-by: Gichan Jang <[email protected]>

.gitmodules

@@ -13,3 +13,6 @@
 [submodule "externals/llama2.c"]
 	path = externals/llama2.c
 	url = https://github.com/nnsuite/llama2.c
+[submodule "externals/deviceMLOps.MLAgent"]
+	path = externals/deviceMLOps.MLAgent
+	url = https://github.com/nnstreamer/deviceMLOps.MLAgent.git

documentation/getting_started.md

@@ -434,16 +434,18 @@ $ ./sdkmanager --sdk_root=${HOME}/Android/Sdk --install "platforms;android-34" "
 #### Cloning the GitHub Repository
 
 The Android app's GitHub repository can be found here. To build it, you need to clone the repository
-first.
+first. If you clone with recursive option, you can receive the submodule together.
 
 ```bash
-$ git clone https://github.com/nnstreamer/nnstreamer-android
+$ git clone --recursive https://github.com/nnstreamer/nnstreamer-android
 
 $ ls nnstreamer-android/
 build.gradle.kts  externals  gradle  gradle.properties  gradlew  gradlew.bat  LICENSE  ml_inference_offloading  nnstreamer-api  README.md  settings.gradle.kts
 $ cd nnstreamer-android
 ```
 
+To build the application with ml-service feature, you need to set the feature ```feature.mlService=true``` in the [gradle.properties](/gradle.properties).
+
 #### Building the Android App using Gradle
 
 In the `nnstreamer-android` directory, `Gradle Wrapper` files have already been generated. You can

externals/build.gradle.kts

@@ -28,12 +28,17 @@ tasks {
     }
 
     fun downloadFile(url: URL, outputFileName: String) {
-        url.openStream().use {
-            Channels.newChannel(it).use { rbc ->
-                FileOutputStream(outputFileName).use { fos ->
-                    fos.channel.transferFrom(rbc, 0, Long.MAX_VALUE)
+        val outFile = File(outputFileName)
+        if (!outFile.exists()) {
+            url.openStream().use {
+                Channels.newChannel(it).use { rbc ->
+                    FileOutputStream(outputFileName).use { fos ->
+                        fos.channel.transferFrom(rbc, 0, Long.MAX_VALUE)
+                    }
                 }
             }
+        } else {
+            println("$outputFileName already exists. Skip download.")
         }
     }
 
@@ -106,6 +111,32 @@ tasks {
         }
     }
 
+    val curlVersion = libs.versions.curl.get()
+    val enabledCurl = when {
+        !project.hasProperty("feature.mlService") -> {
+            false
+        }
+        project.properties["feature.mlService"].toString() == "false" -> {
+            false
+        }
+        else -> {
+            true
+        }
+    }
+
+    val sqliteVersion = libs.versions.sqlite.get()
+    val enabledSqlite = when {
+        !project.hasProperty("feature.mlService") -> {
+            false
+        }
+        project.properties["feature.mlService"].toString() == "false" -> {
+            false
+        }
+        else -> {
+            true
+        }
+    }
+
     val tfliteDownloadable =
         Downloadable(
             "tensorflow-lite-$tfliteVersion.tar",
@@ -116,6 +147,26 @@ tasks {
         )
     downloadables.add(tfliteDownloadable)
 
+    val curlDownloadable =
+        Downloadable(
+            "curl-$curlVersion.tar",
+            "ml-api/java/android/nnstreamer/src/main/jni",
+            "https://raw.githubusercontent.com/nnstreamer/nnstreamer-android-resource/master/external",
+            enabledCurl,
+            ".xz"
+        )
+    downloadables.add(curlDownloadable)
+
+    val sqliteDownloadable =
+        Downloadable(
+            "sqlite-$sqliteVersion.tar",
+            "ml-api/java/android/nnstreamer/src/main/jni",
+            "https://raw.githubusercontent.com/nnstreamer/nnstreamer-android-resource/master/external",
+            enabledSqlite,
+            ".xz"
+        )
+    downloadables.add(sqliteDownloadable)
+
 
     register("prepareDownloadable") {
         if (!downloadablePath.isDirectory()) {
@@ -125,13 +176,11 @@ tasks {
 
         for (downloadable in downloadables) {
             val (tarFileName, targetDir, url, isEnabled, downloadableFormat, digestFileName) = downloadable
-            val targetPath = projectDir.toPath().resolve(targetDir)
 
-            if (!isEnabled || targetPath.isDirectory()) {
+            if (!isEnabled) {
                 continue
             }
 
-            println("Could not find $targetPath")
             println("...downloading from $url")
             println("This step may take some time to complete...")
 
@@ -192,10 +241,6 @@ tasks {
                 val tree = tarTree(tarPath)
                 var intoPath = projectDir.toPath().resolve(targetDir)
 
-                if (intoPath.exists()) {
-                    continue
-                }
-
                 tree.visit {
                     if (this.relativePath.startsWith(targetDir)) {
                         intoPath = projectDir.toPath()
@@ -211,6 +256,7 @@ tasks {
                 tarPath.deleteIfExists()
             }
         }
+        dependsOn("updateGitSubmodules")
         dependsOn("prepareDownloadable")
     }
 
@@ -244,5 +290,4 @@ tasks {
 
 tasks.named("build") {
     dependsOn("copyFromTar")
-    dependsOn("updateGitSubmodules")
 }

gradle.properties

@@ -1,10 +1,11 @@
-org.gradle.jvmargs=-Xmx4096M -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
+org.gradle.jvmargs=-Xmx4096M -Xms4096M -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8
 dir.externals=externals
 dir.downloadable=downloadable
 dir.gstAndroid=gst-1.0-android-universal
 dir.tfliteAndroid=tensorflow-lite
 dir.nnstreamer=nnstreamer
 dir.nnstreamerEdge=nnstreamer-edge
+dir.mlopsAgent=deviceMLOps.MLAgent
 dir.mlApi=ml-api
 # To use llama2.c uncomment the line below
 # dir.llama2c=llama2.c
@@ -13,4 +14,6 @@ dir.mlApi=ml-api
 kotlin.code.style=official
 android.useAndroidX=true
 android.enableJetifier=true
+feature.mlOffloading=true
+feature.mlService=true
 #NOTE: Do not change the lines above

gradle/libs.versions.toml

@@ -31,6 +31,8 @@ uiTestJunit4Android = "1.7.5"
 xyz-simple-git-plugin = "2.0.3"
 cameraCore = "1.4.0"
 firebaseCrashlyticsBuildtools = "3.0.2"
+curl = "7.60.0"
+sqlite = "3.48.0"
 
 [libraries]
 commons-compress = { group = "org.apache.commons", name = "commons-compress", version.ref = "commons-compress-lib" }

nnstreamer-api/build.gradle.kts

@@ -21,6 +21,12 @@ android {
     val nnsEdgeDir = properties["dir.nnstreamerEdge"].toString()
     val nnsEdgeRootPath = externalDirPath.resolve(nnsEdgeDir)
 
+    val mlopsAgentDir = properties["dir.mlopsAgent"].toString()
+    val mlopsAgentRootPath = externalDirPath.resolve(mlopsAgentDir)
+
+    val mlOffloadingFeature = properties["feature.mlOffloading"].toString()
+    val mlServiceFeature = properties["feature.mlService"].toString()
+
     val mlApiDir = properties["dir.mlApi"].toString()
     val mlApiRootPath = externalDirPath.resolve(mlApiDir)
     val mlApiNNSJniPath = mlApiRootPath.resolve("java/android/nnstreamer/src/main/jni")
@@ -41,7 +47,10 @@ android {
                     "GSTREAMER_ROOT_ANDROID=$gstRootPath",
                     "NNSTREAMER_ROOT=$nnsRootPath",
                     "NNSTREAMER_EDGE_ROOT=$nnsEdgeRootPath",
-                    "ML_API_ROOT=$mlApiRootPath"
+                    "MLOPS_AGENT_ROOT=$mlopsAgentRootPath",
+                    "ML_API_ROOT=$mlApiRootPath",
+                    "ENABLE_ML_OFFLOADING=$mlOffloadingFeature",
+                    "ENABLE_ML_SERVICE=$mlServiceFeature"
                 )
                 targets("nnstreamer-native")