Java API for onnxruntime

.gitignore

@@ -39,3 +39,6 @@ onnxprofile_profile_test_*.json
 /csharp/packages
 /csharp/src/Microsoft.ML.OnnxRuntime/Microsoft.ML.OnnxRuntime.targets
 /csharp/src/Microsoft.ML.OnnxRuntime/Microsoft.ML.OnnxRuntime.props
+# Java specific ignores
+java/src/main/native/ai_onnxruntime_*.h
+java/.gradle

cmake/CMakeLists.txt

@@ -726,6 +726,11 @@ if (onnxruntime_BUILD_SERVER)
   include(onnxruntime_server.cmake)
 endif()
 
+if (onnxruntime_BUILD_JAVA)
+  message(STATUS "Java Build is enabled")
+  include(onnxruntime_java.cmake)
+endif()
+
 # some of the tests rely on the shared libs to be
 # built; hence the ordering
 if (onnxruntime_BUILD_UNIT_TESTS)
@@ -756,3 +761,4 @@ if (onnxruntime_BUILD_CSHARP)
 #  set_property(GLOBAL PROPERTY VS_DOTNET_TARGET_FRAMEWORK_VERSION "netstandard2.0")
   include(onnxruntime_csharp.cmake)
 endif()
+

cmake/onnxruntime_java.cmake

@@ -0,0 +1,97 @@
+# Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+# Licensed under the MIT License.
+
+#set(CMAKE_VERBOSE_MAKEFILE on)
+
+# Setup Java compilation
+include(FindJava)
+find_package(Java REQUIRED)
+find_package(JNI REQUIRED)
+include(UseJava)
+include_directories(${JNI_INCLUDE_DIRS})
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -std=c11")
+
+set(JAVA_ROOT ${REPO_ROOT}/java)
+set(CMAKE_JAVA_COMPILE_FLAGS "-source" "1.8" "-target" "1.8")
+if (onnxruntime_RUN_ONNX_TESTS)
+  set(JAVA_DEPENDS onnxruntime ${test_data_target})
+else()
+  set(JAVA_DEPENDS onnxruntime)
+endif()
+
+# Specify the Java source files
+set(onnxruntime4j_src
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/MapInfo.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/NodeInfo.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OnnxRuntime.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OnnxJavaType.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OnnxMap.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OnnxSequence.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OnnxTensor.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OnnxValue.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OrtAllocator.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OrtEnvironment.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OrtException.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OrtSession.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/OrtUtil.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/package-info.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/SequenceInfo.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/TensorInfo.java
+        ${REPO_ROOT}/java/src/main/java/ai/onnxruntime/ValueInfo.java
+        )
+
+# Build the jar and generate the native headers
+add_jar(onnxruntime4j SOURCES ${onnxruntime4j_src} VERSION ${ORT_VERSION} GENERATE_NATIVE_HEADERS onnxruntime4j_generated DESTINATION ${REPO_ROOT}/java/src/main/native/)
+
+# Specify the native sources (without the generated headers)
+file(GLOB onnxruntime4j_native_src 
+    "${REPO_ROOT}/java/src/main/native/*.c"
+    "${REPO_ROOT}/java/src/main/native/OrtJniUtil.h"
+    "${REPO_ROOT}/include/onnxruntime/core/session/*.h"
+    )
+
+# Build the JNI library
+add_library(onnxruntime4j_jni SHARED ${onnxruntime4j_native_src} ${onnxruntime4j_generated})
+onnxruntime_add_include_to_target(onnxruntime4j_jni onnxruntime_session)
+target_include_directories(onnxruntime4j_jni PRIVATE ${REPO_ROOT}/include ${REPO_ROOT}/java/src/main/native)
+target_link_libraries(onnxruntime4j_jni PUBLIC ${JNI_LIBRARIES} onnxruntime onnxruntime4j_generated)
+
+# Now the jar, jni binary and shared lib binary have been built, now to build the jar with the binaries added.
+
+# This blob creates the new jar name
+get_property(onnxruntime_jar_name TARGET onnxruntime4j PROPERTY JAR_FILE)
+get_filename_component(onnxruntime_jar_abs ${onnxruntime_jar_name} ABSOLUTE)
+get_filename_component(jar_path ${onnxruntime_jar_abs} DIRECTORY)
+set(onnxruntime_jar_binaries_name "${jar_path}/onnxruntime4j-${ORT_VERSION}-with-binaries.jar")
+set(onnxruntime_jar_binaries_platform "$<SHELL_PATH:${onnxruntime_jar_binaries_name}>")
+
+# Copy the current jar
+add_custom_command(TARGET onnxruntime4j_jni PRE_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy
+        ${onnxruntime_jar_name}
+        ${onnxruntime_jar_binaries_platform})
+
+# Make a temp directory to store the binaries
+add_custom_command(TARGET onnxruntime4j_jni POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/java-libs/lib")
+
+# Copy the binaries
+add_custom_command(TARGET onnxruntime4j_jni POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_FILE:onnxruntime4j_jni>" ${CMAKE_CURRENT_BINARY_DIR}/java-libs/lib/)
+add_custom_command(TARGET onnxruntime4j_jni POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_LINKER_FILE:onnxruntime>" ${CMAKE_CURRENT_BINARY_DIR}/java-libs/lib/)
+
+# Update the with-binaries jar so it includes the binaries
+add_custom_command(
+            TARGET onnxruntime4j_jni POST_BUILD
+            COMMAND ${Java_JAR_EXECUTABLE} -uf ${onnxruntime_jar_binaries_platform} -C ${CMAKE_CURRENT_BINARY_DIR}/java-libs lib/$<TARGET_FILE_NAME:onnxruntime4j_jni> -C ${CMAKE_CURRENT_BINARY_DIR}/java-libs lib/$<TARGET_LINKER_FILE_NAME:onnxruntime>
+            DEPENDS onnxruntime4j
+            COMMENT "Rebuilding Java archive ${_JAVA_TARGET_OUTPUT_NAME}"
+            VERBATIM
+        )
+
+create_javadoc(onnxruntime4j_javadoc
+           FILES ${onnxruntime4j_src}
+           DOCTITLE "Onnx Runtime Java API"
+           AUTHOR FALSE
+           USE TRUE
+           VERSION FALSE
+           )

cmake/onnxruntime_unittests.cmake

@@ -800,7 +800,6 @@ list(APPEND onnxruntime_mlas_test_libs Threads::Threads)
 target_link_libraries(onnxruntime_mlas_test PRIVATE ${onnxruntime_mlas_test_libs})
 set_target_properties(onnxruntime_mlas_test PROPERTIES FOLDER "ONNXRuntimeTest")
 
-
 add_library(custom_op_library SHARED ${REPO_ROOT}/onnxruntime/test/testdata/custom_op_library/custom_op_library.cc)
 target_include_directories(custom_op_library PRIVATE ${REPO_ROOT}/include)
 if(UNIX)
@@ -814,3 +813,38 @@ else()
   # need to ignore the linker warning 4199, due to some global linker flags failing here
 endif()
 set_property(TARGET custom_op_library APPEND_STRING PROPERTY LINK_FLAGS ${ONNXRUNTIME_CUSTOM_OP_LIB_LINK_FLAG})
+
+if (onnxruntime_BUILD_JAVA)
+    message(STATUS "Running Java tests")
+    # Build and run tests
+    set(onnxruntime4j_test_src
+        ${REPO_ROOT}/java/src/test/java/ai/onnxruntime/InferenceTest.java
+        ${REPO_ROOT}/java/src/test/java/ai/onnxruntime/TestHelpers.java
+        ${REPO_ROOT}/java/src/test/java/ai/onnxruntime/OnnxMl.java
+        ${REPO_ROOT}/java/src/test/java/ai/onnxruntime/UtilTest.java
+        )
+
+    # Create test directories
+    file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/java-tests/")
+    file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/java-tests/results")
+
+    # Download test dependencies
+    if (NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/java-tests/junit-platform-console-standalone-1.5.2.jar)
+        message("Downloading JUnit 5")
+        file(DOWNLOAD https://repo1.maven.org/maven2/org/junit/platform/junit-platform-console-standalone/1.5.2/junit-platform-console-standalone-1.5.2.jar ${CMAKE_CURRENT_BINARY_DIR}/java-tests/junit-platform-console-standalone-1.5.2.jar EXPECTED_HASH SHA1=8d937d2b461018a876836362b256629f4da5feb1)
+    endif()
+
+    if (NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/java-tests/protobuf-java-3.10.0.jar)
+        message("Downloading protobuf-java 3.10.0")
+        file(DOWNLOAD https://repo1.maven.org/maven2/com/google/protobuf/protobuf-java/3.10.0/protobuf-java-3.10.0.jar ${CMAKE_CURRENT_BINARY_DIR}/java-tests/protobuf-java-3.10.0.jar EXPECTED_HASH SHA1=410b61dd0088aab4caa05739558d43df248958c9)
+    endif()
+
+    # Build the test jar
+    add_jar(onnxruntime4j_test SOURCES ${onnxruntime4j_test_src} VERSION ${ORT_VERSION} INCLUDE_JARS ${onnxruntime_jar_name} ${CMAKE_CURRENT_BINARY_DIR}/java-tests/junit-platform-console-standalone-1.5.2.jar ${CMAKE_CURRENT_BINARY_DIR}/java-tests/protobuf-java-3.10.0.jar)
+
+    add_dependencies(onnxruntime4j_test onnxruntime4j_jni onnxruntime4j)
+    get_property(onnxruntime_test_jar_name TARGET onnxruntime4j_test PROPERTY JAR_FILE)
+
+    # Run the tests with JUnit's console launcher
+    add_test(NAME java-api COMMAND ${Java_JAVA_EXECUTABLE} -jar ${CMAKE_CURRENT_BINARY_DIR}/java-tests/junit-platform-console-standalone-1.5.2.jar -cp ${onnxruntime_test_jar_name} -cp ${onnxruntime_jar_binaries_platform} --scan-class-path --fail-if-no-tests --reports-dir=${CMAKE_CURRENT_BINARY_DIR}/java-tests/results --disable-banner WORKING_DIRECTORY ${REPO_ROOT})
+endif()

java/src/main/java/ai/onnxruntime/MapInfo.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright © 2019, Oracle and/or its affiliates. All rights reserved.
+ * Licensed under the MIT License.
+ */
+package ai.onnxruntime;
+
+/**
+ * Describes an {@link OnnxMap} object or output node.
+ */
+public class MapInfo implements ValueInfo {
+
+    /**
+     * The number of entries in this map.
+     */
+    public final int size;
+
+    /**
+     * The Java type of the keys.
+     */
+    public final OnnxJavaType keyType;
+
+    /**
+     * The Java type of the values.
+     */
+    public final OnnxJavaType valueType;
+
+    /**
+     * Construct a MapInfo with the specified key type and value type.
+     * The size is unknown and set to -1.
+     * @param keyType The Java type of the keys.
+     * @param valueType The Java type of the values.
+     */
+    MapInfo(OnnxJavaType keyType, OnnxJavaType valueType) {
+        this.size = -1;
+        this.keyType = keyType;
+        this.valueType = valueType;
+    }
+
+    /**
+     * Construct a MapInfo with the specified size, key type and value type.
+     * @param size The size.
+     * @param keyType The Java type of the keys.
+     * @param valueType The Java type of the values.
+     */
+    MapInfo(int size, OnnxJavaType keyType, OnnxJavaType valueType) {
+        this.size = size;
+        this.keyType = keyType;
+        this.valueType = valueType;
+    }
+
+    @Override
+    public String toString() {
+        String initial = size == -1 ? "MapInfo(size=UNKNOWN" : "MapInfo(size="+size;
+        return initial + ",keyType=" + keyType.toString() + ",valueType=" + valueType.toString() + ")";
+    }
+}

java/src/main/java/ai/onnxruntime/NodeInfo.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright © 2019, Oracle and/or its affiliates. All rights reserved.
+ * Licensed under the MIT License.
+ */
+package ai.onnxruntime;
+
+/**
+ * The info for an input or output node from an ONNX model.
+ */
+public class NodeInfo {
+
+    private final ValueInfo info;
+
+    private final String name;
+
+    /**
+     * Creates a node info object from the supplied name and value info.
+     *
+     * Called from native code.
+     * @param name The name of the node.
+     * @param info The ValueInfo for this node.
+     */
+    public NodeInfo(String name, ValueInfo info) {
+        this.name = name;
+        this.info = info;
+    }
+
+    /**
+     * The name of the node.
+     * @return The name.
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * The type and shape information of this node.
+     * <p>
+     * WARNING: {@link MapInfo} and {@link SequenceInfo} instances returned by this type will have insufficient information in
+     * them as it's not available from the model without an example output.
+     * @return The information of the value.
+     */
+    public ValueInfo getInfo() {
+        return info;
+    }
+
+    @Override
+    public String toString() {
+        return "NodeInfo(name="+name+",info="+info.toString()+")";
+    }
+
+}