Add ORT Extensions to Java and build with Gradle

[HossamAmer12]

Describe the documentation issue

I saw your tutorial here:
https://onnxruntime.ai/docs/extensions/

I added:
implementation("com.microsoft.onnxruntime:onnxruntime-extensions-android:latest.release")

I added:
import ai.onnxruntime.*

I added:
sessionOptions.registerCustomOpLibrary(OrtxPackage.getLibraryPath());

the last file gives me the error saying that the OrtxPackage does not exist. What is missing?

Page / URL

No response

[Craigacp]

Did you import ai.onnxruntime.extensions.*?

[HossamAmer12]

Thanks @Craigacp. Btw, I am adding the onnx code in a Kotlin file. I think that it should not matter much.

I have this now in App.kt:

import ai.onnxruntime.OnnxTensor
import ai.onnxruntime.OrtEnvironment
import ai.onnxruntime.OrtSession
import ai.onnxruntime.extensions.*
public class Predictor {

    val env = OrtEnvironment.getEnvironment()
    val sessionOptions = OrtSession.SessionOptions()
    /* Register the custom ops from onnxruntime-extensions */
    sessionOptions.registerCustomOpLibrary(OrtxPackage.getLibraryPath());
}

and in build.gradle.kts:

// onnx deps
implementation("com.microsoft.onnxruntime:onnxruntime-android:1.15.1")
implementation("com.microsoft.onnxruntime:onnxruntime:latest.release")
implementation("com.microsoft.onnxruntime:onnxruntime-extensions-android:latest.release")

The errors are:

Unresolved reference: extensions
Expecting member declaration

If I add:
implementation("com.microsoft.onnxruntime:onnxruntime-extensions:latest.release")
in build.gradle.kts. I get the following error:

Error while evaluating property 'filteredArgumentsMap' of task ':app:compileKotlin'.
Could not resolve all files for configuration ':app:compileClasspath'.
> Could not find any matches for com.microsoft.onnxruntime:onnxruntime-extensions:latest.release as no versions of com.microsoft.onnxruntime:onnxruntime-extensions are available.

Any clue?

[Craigacp]

I don't think it's a good idea to have both onnxruntime-android and onnxruntime as dependencies. It's clearly not adding the dependency for onnxruntime-extensions-android correctly, possibly due to something in the aar packaging, but I don't understand Android packaging so I'm not sure what is going wrong.

[HossamAmer12]

Please note that the code that I am writing is a simple Kotlin and Jave code and not android code.

I am wondering if this

implementation("com.microsoft.onnxruntime:onnxruntime-extensions-android:latest.release")

only works for Android and not Kotlin+Java. Any other alternatives to run this? Do I have to run in Android? Can I just run it on my laptop?

[Craigacp]

You shouldn't mix the Android and the regular Java jars, they aren't compatible. The Java source code itself is (mostly) the same, but the native code underneath is compiled differently. Unfortunately there aren't any Java binaries available for onnxruntime-extensions yet (see microsoft/onnxruntime-extensions#597), so you'll need to compile it from source on the platforms you care about. This isn't too hard, and in practice you don't even need to build the extensions jar you can just compile the extensions native library and load it as a custom op library.

[HossamAmer12]

This isn't too hard, and in practice you don't even need to build the extensions jar you can just compile the extensions native library and load it as a custom op library.

Is it simply adding these files and compile them via gradle?

[HossamAmer12]

@Craigacp I did some work on the other issue. Let's try to get some help over there