saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-06-16 01:33:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[java] Fills out the javadoc so there are no more documentation warnings (#16776)

Browse source 
### Description
Adds javadoc for all protected and public members, methods and classes.

### Motivation and Context
The javadoc warnings were annoying me when running the builds. Also,
those types should have been documented.

---------

Co-authored-by: Scott McKay <Scott.McKay@microsoft.com>
This commit is contained in:
Adam Pocock 2023-07-27 02:17:03 -04:00 committed by GitHub
parent fe463d4957
commit 340f4ded73
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
19 changed files with 176 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
java/src/main/java/ai/onnxruntime/OnnxJavaType.java
View file

@ -8,19 +8,29 @@ import ai.onnxruntime.TensorInfo.OnnxTensorType;
/** An enum representing ONNX Runtime supported Java primitive types (and String). */
public enum OnnxJavaType {
/** A 32-bit floating point value. */
FLOAT(1, float.class, 4),
/** A 64-bit floating point value. */
DOUBLE(2, double.class, 8),
/** An 8-bit signed integer value. */
INT8(3, byte.class, 1),
/** A 16-bit signed integer value. */
INT16(4, short.class, 2),
/** A 32-bit signed integer value. */
INT32(5, int.class, 4),
/** A 64-bit signed integer value. */
INT64(6, long.class, 8),
/** A boolean value stored in a single byte. */
BOOL(7, boolean.class, 1),
/** A UTF-8 string. */
STRING(8, String.class, 4),
/** A 8-bit unsigned integer value. */
UINT8(9, byte.class, 1),
/** A IEEE 16-bit floating point value. */
FLOAT16(10, short.class, 2),
/** A non-IEEE 16-bit floating point value, with 8 exponent bits and 7 mantissa bits. */
BFLOAT16(11, short.class, 2),
/** An unknown type used as an error condition or a sentinel. */
UNKNOWN(0, Object.class, 0);
private static final OnnxJavaType[] values;
@ -33,8 +43,11 @@ public enum OnnxJavaType {
}
}
/** The native value of the enum. */
public final int value;
/** The Java side type used as the carrier. */
public final Class<?> clazz;
/** The number of bytes used by a single value of this type. */
public final int size;
OnnxJavaType(int value, Class<?> clazz, int size) {

14
java/src/main/java/ai/onnxruntime/OnnxMap.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -12,8 +12,8 @@ import java.util.Map;
/**
* A container for a map returned by {@link OrtSession#run(Map)}.
*
* <p>Supported types are those mentioned in "onnxruntime_c_api.h", keys: String and Long, values:
* String, Long, Float, Double.
* <p>Supported types are those mentioned in {@code onnxruntime_c_api.h}, keys: String and Long,
* values: String, Long, Float, Double.
*/
public class OnnxMap implements OnnxValue {
@ -27,11 +27,17 @@ public class OnnxMap implements OnnxValue {
/** An enum representing the Java type of the values stored in an {@link OnnxMap}. */
public enum OnnxMapValueType {
/** An invalid Map value type. */
INVALID(0),
/** A String value. */
STRING(1),
/** A 64-bit signed integer value. */
LONG(2),
/** A 32-bit floating point value. */
FLOAT(3),
/** A 64-bit floating point value. */
DOUBLE(4);
/** The native enum value. */
final int value;
OnnxMapValueType(int value) {
@ -89,8 +95,10 @@ public class OnnxMap implements OnnxValue {
}
}
/** The native pointer. */
final long nativeHandle;
/** The pointer to the allocator used by this {@code OnnxMap}. */
final long allocatorHandle;
private final MapInfo info;

2
java/src/main/java/ai/onnxruntime/OnnxRuntime.java
View file

@ -434,7 +434,7 @@ final class OnnxRuntime {
*
* <p>Throws IllegalArgumentException if a provider isn't recognised (note this exception should
* only happen during development of ONNX Runtime, if it happens at any other point, file an issue
* on Github).
* on <a href="https://github.com/microsoft/onnxruntime">GitHub</a>).
*
* @param ortApiHandle The API Handle.
* @return The enum set.

3
java/src/main/java/ai/onnxruntime/OnnxSequence.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -33,6 +33,7 @@ public class OnnxSequence implements OnnxValue {
}
}
/** The native pointer. */
final long nativeHandle;
private final long allocatorHandle;

16
java/src/main/java/ai/onnxruntime/OnnxSparseTensor.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, 2023 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -110,6 +110,16 @@ public final class OnnxSparseTensor extends OnnxTensorLike {
return createSparseTensor(env, env.defaultAllocator, tensor);
}
/**
* Creates a Sparse Tensor in ORT from the Java side representation.
*
* @param env The OrtEnvironment.
* @param allocator The memory allocator.
* @param tensor The Java side representation.
* @param <T> The buffer type.
* @return The sparse tensor in ORT.
* @throws OrtException If the tensor could not be created or was invalid.
*/
static <T extends Buffer> OnnxSparseTensor createSparseTensor(
OrtEnvironment env, OrtAllocator allocator, SparseTensor<T> tensor) throws OrtException {
if (!allocator.isClosed()) {
@ -601,6 +611,8 @@ public final class OnnxSparseTensor extends OnnxTensorLike {
*
* <p>Will be sealed to {@link COOTensor}, {@link CSRCTensor} and {@link BlockSparseTensor} one
* day.
*
* @param <T> The type of the indices buffer.
*/
public abstract static class SparseTensor<T extends Buffer> {
private final long[] indicesShape;
@ -609,7 +621,9 @@ public final class OnnxSparseTensor extends OnnxTensorLike {
private final OnnxJavaType type;
private final long numNonZero;
/** The buffer holding the indices. */
final T indices;
/** The buffer holding the values. */
final Buffer values;
SparseTensor(

5
java/src/main/java/ai/onnxruntime/OnnxTensorLike.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -19,10 +19,13 @@ public abstract class OnnxTensorLike implements OnnxValue {
}
}
/** The native pointer. */
protected final long nativeHandle;
/** The pointer to the native memory allocator. */
protected final long allocatorHandle;
/** The size and shape information for this tensor. */
protected final TensorInfo info;
/**

9
java/src/main/java/ai/onnxruntime/OnnxValue.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, 2022 Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2023 Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -15,12 +15,19 @@ public interface OnnxValue extends AutoCloseable {
/** The type of the {@link OnnxValue}, mirroring the id in the C API. */
public enum OnnxValueType {
/** An unknown OrtValue type. */
ONNX_TYPE_UNKNOWN(0),
/** A tensor. */
ONNX_TYPE_TENSOR(1),
/** A sequence of tensors or maps. */
ONNX_TYPE_SEQUENCE(2),
/** A map. */
ONNX_TYPE_MAP(3),
/** An opaque type not accessible from Java. */
ONNX_TYPE_OPAQUE(4),
/** A sparse tensor. */
ONNX_TYPE_SPARSETENSOR(5),
/** An optional input value. */
ONNX_TYPE_OPTIONAL(6);
/** The id number of this type in the C API. */

5
java/src/main/java/ai/onnxruntime/OrtAllocator.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -17,6 +17,7 @@ class OrtAllocator implements AutoCloseable {
}
}
/** The native pointer. */
final long handle;
private final boolean isDefault;
@ -53,7 +54,7 @@ class OrtAllocator implements AutoCloseable {
}
/**
* Closes the allocator, must be done after all it's child objects have been closed.
* Closes the allocator, must be done after all its child objects have been closed.
*
* <p>The default allocator is not closeable, and this operation is a no-op on that allocator.
*

8
java/src/main/java/ai/onnxruntime/OrtEnvironment.java
View file

@ -12,8 +12,9 @@ import java.util.Objects;
import java.util.logging.Logger;
/**
* The host object for the onnx-runtime system. Can create {@link OrtSession}s which encapsulate
* specific models.
* The host object for the ONNX Runtime system. Can create {@link OrtSession}s which encapsulate
* specific models. This object should be instantiated before any other ONNX Runtime classes are
* created.
*
* <p>There can be at most one OrtEnvironment object created in a JVM lifetime. This class
* implements {@link AutoCloseable} as before for backwards compatibility with 1.10 and earlier, but
@ -24,6 +25,7 @@ public final class OrtEnvironment implements AutoCloseable {
private static final Logger logger = Logger.getLogger(OrtEnvironment.class.getName());
/** The default name for ORT environments constructed from Java. */
public static final String DEFAULT_NAME = "ort-java";
static {
@ -357,7 +359,7 @@ public final class OrtEnvironment implements AutoCloseable {
/**
* Turns on or off the telemetry.
*
* @param sendTelemetry If true then send telemetry on onnxruntime usage.
* @param sendTelemetry If true then send telemetry on ONNX Runtime usage.
* @throws OrtException If the call failed.
*/
public void setTelemetry(boolean sendTelemetry) throws OrtException {

20
java/src/main/java/ai/onnxruntime/OrtException.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -8,6 +8,7 @@ package ai.onnxruntime;
public class OrtException extends Exception {
private static final long serialVersionUID = 1L;
/** The OrtErrorCode for this exception. */
private final OrtErrorCode errorCode;
/**
@ -51,22 +52,35 @@ public class OrtException extends Exception {
}
/**
* Maps the OrtErrorCode struct in "onnxruntime_c_api.h" with an additional entry for Java side
* errors.
* Maps the {@code OrtErrorCode} struct in {@code onnxruntime_c_api.h} with an additional entry
* for Java side errors.
*/
public enum OrtErrorCode {
/** An unknown error occurred in the Java API. */
ORT_JAVA_UNKNOWN(-1),
/** The operation completed without error. */
ORT_OK(0),
/** The operation failed. */
ORT_FAIL(1),
/** The operation received an invalid argument. */
ORT_INVALID_ARGUMENT(2),
/** The operation could not load the required file. */
ORT_NO_SUCHFILE(3),
/** The operation could not use the model. */
ORT_NO_MODEL(4),
/** There is an internal error in the ORT engine. */
ORT_ENGINE_ERROR(5),
/** The operation threw a runtime exception. */
ORT_RUNTIME_EXCEPTION(6),
/** The provided protobuf was invalid. */
ORT_INVALID_PROTOBUF(7),
/** The model was loaded. */
ORT_MODEL_LOADED(8),
/** The requested operation has not been implemented. */
ORT_NOT_IMPLEMENTED(9),
/** The ONNX graph is invalid. */
ORT_INVALID_GRAPH(10),
/** The ORT execution provider failed. */
ORT_EP_FAIL(11);
private final int value;

9
java/src/main/java/ai/onnxruntime/OrtLoggingLevel.java
View file

@ -1,17 +1,22 @@
/*
* Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2019, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
import java.util.logging.Logger;
/** The logging level for messages from the environment and session. */
/** The logging severity level. */
public enum OrtLoggingLevel {
/** Print all log messages. */
ORT_LOGGING_LEVEL_VERBOSE(0),
/** Print info and higher level log messages. */
ORT_LOGGING_LEVEL_INFO(1),
/** Print warning and higher level log messages. */
ORT_LOGGING_LEVEL_WARNING(2),
/** Print error log messages. */
ORT_LOGGING_LEVEL_ERROR(3),
/** Print only fatal log messages. */
ORT_LOGGING_LEVEL_FATAL(4);
private final int value;

18
java/src/main/java/ai/onnxruntime/OrtProvider.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2020, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -9,21 +9,37 @@ import java.util.Map;
/** The execution providers available through the Java API. */
public enum OrtProvider {
/** The CPU execution provider. */
CPU("CPUExecutionProvider"),
/** CUDA execution provider for Nvidia GPUs. */
CUDA("CUDAExecutionProvider"),
/** The Intel Deep Neural Network Library execution provider. */
DNNL("DnnlExecutionProvider"),
/** The OpenVINO execution provider. */
OPEN_VINO("OpenVINOExecutionProvider"),
/** The AMD/Xilinx VitisAI execution provider. */
VITIS_AI("VitisAIExecutionProvider"),
/** The TensorRT execution provider for Nvidia GPUs. */
TENSOR_RT("TensorrtExecutionProvider"),
/** The Android NNAPI execution provider. */
NNAPI("NnapiExecutionProvider"),
/** The RockChip NPU execution provider. */
RK_NPU("RknpuExecutionProvider"),
/** The Windows DirectML execution provider. */
DIRECT_ML("DmlExecutionProvider"),
/** The AMD MIGraphX execution provider. */
MI_GRAPH_X("MIGraphXExecutionProvider"),
/** The ARM Compute Library execution provider. */
ACL("ACLExecutionProvider"),
/** The ARM NN execution provider. */
ARM_NN("ArmNNExecutionProvider"),
/** The AMD ROCm execution provider. */
ROCM("ROCMExecutionProvider"),
/** The Apple CoreML execution provider. */
CORE_ML("CoreMLExecutionProvider"),
/** The XNNPACK execution provider. */
XNNPACK("XnnpackExecutionProvider"),
/** The Azure remote endpoint execution provider. */
AZURE("AzureExecutionProvider");
private static final Map<String, OrtProvider> valueMap = new HashMap<>(values().length);

3
java/src/main/java/ai/onnxruntime/OrtProviderOptions.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime;
@ -18,6 +18,7 @@ public abstract class OrtProviderOptions implements AutoCloseable {
}
}
/** The native pointer. */
protected final long nativeHandle;
/**

21
java/src/main/java/ai/onnxruntime/OrtSession.java
View file

@ -472,11 +472,25 @@ public class OrtSession implements AutoCloseable {
/**
* The optimisation level to use. Needs to be kept in sync with the GraphOptimizationLevel enum
* in the C API.
*
* <p>See <a
* href="https://onnxruntime.ai/docs/performance/model-optimizations/graph-optimizations.html">Graph
* Optimizations</a> for more details.
*/
public enum OptLevel {
/** Apply no optimizations to the ONNX graph. */
NO_OPT(0),
/**
* Apply basic optimizations such as constant folding, redundant computation elimination and
* node fusions to the ONNX graph.
*/
BASIC_OPT(1),
/**
* Applies all the basic optimizations plus more complex node fusion operations to the ONNX
* graph.
*/
EXTENDED_OPT(2),
/** Applies all available optimizations to the ONNX graph. */
ALL_OPT(99);
private final int id;
@ -499,7 +513,14 @@ public class OrtSession implements AutoCloseable {
* The execution mode to use. Needs to be kept in sync with the ExecutionMode enum in the C API.
*/
public enum ExecutionMode {
/**
* Executes all nodes sequentially.
*
* <p>This is the default, and usually provides the most speedup as intra-op parallelism
* provides the most benefit.
*/
SEQUENTIAL(0),
/** Executes some nodes in parallel. */
PARALLEL(1);
private final int id;

16
java/src/main/java/ai/onnxruntime/OrtUtil.java
View file

@ -88,8 +88,6 @@ public final class OrtUtil {
/**
* Creates a new primitive boolean array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A boolean array.
*/
@ -101,8 +99,6 @@ public final class OrtUtil {
/**
* Creates a new primitive byte array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A byte array.
*/
@ -114,8 +110,6 @@ public final class OrtUtil {
/**
* Creates a new primitive short array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A short array.
*/
@ -127,8 +121,6 @@ public final class OrtUtil {
/**
* Creates a new primitive int array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A int array.
*/
@ -140,8 +132,6 @@ public final class OrtUtil {
/**
* Creates a new primitive long array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A long array.
*/
@ -153,8 +143,6 @@ public final class OrtUtil {
/**
* Creates a new primitive float array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A float array.
*/
@ -166,8 +154,6 @@ public final class OrtUtil {
/**
* Creates a new primitive double array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A double array.
*/
@ -179,8 +165,6 @@ public final class OrtUtil {
/**
* Creates a new String array of up to 8 dimensions, using the supplied shape.
*
* <p>
*
* @param shape The shape of array to create.
* @return A double array.
*/

25
java/src/main/java/ai/onnxruntime/TensorInfo.java
View file

@ -16,24 +16,46 @@ public class TensorInfo implements ValueInfo {
/** The native element types supported by the ONNX runtime. */
public enum OnnxTensorType {
/** An undefined element type. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED(0),
/** An 8-bit unsigned integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8(1), // maps to c type uint8_t
/** An 8-bit signed integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8(2), // maps to c type int8_t
/** A 16-bit unsigned integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16(3), // maps to c type uint16_t
/** A 16-bit signed integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16(4), // maps to c type int16_t
/** A 32-bit unsigned integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32(5), // maps to c type uint32_t
/** A 32-bit signed integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32(6), // maps to c type int32_t
/** A 64-bit unsigned integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64(7), // maps to c type uint64_t
/** A 64-bit signed integer. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64(8), // maps to c type int64_t
/** An IEEE 16-bit floating point number. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16(9), // stored as a uint16_t
/** An IEEE 32-bit floating point number. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT(10), // maps to c type float
/** An IEEE 64-bit floating point number. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE(11), // maps to c type double
/** A UTF-8 string. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING(12), // maps to c++ type std::string
/** A boolean value stored in a byte. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL(13),
/** A 64-bit complex number, stored as 2 32-bit values. Not accessible from Java. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64(
14), // complex with float32 real and imaginary components
/** A 128-bit complex number, stored as 2 64-bit values. Not accessible from Java. */
ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128(
15), // complex with float64 real and imaginary components
/**
* A non-IEEE 16-bit floating point value with 8 exponent bits and 7 mantissa bits.
*
* <p>See <a href="https://en.wikipedia.org/wiki/Bfloat16_floating-point_format">Bfloat16 on
* Wikipedia</a> for more details.
*/
ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16(
16), // Non-IEEE floating-point format based on IEEE754 single-precision
ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN(
@ -43,7 +65,7 @@ public class TensorInfo implements ValueInfo {
ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2(
19), // Non-IEEE floating-point format based on IEEE754 single-precision
ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ(
20); // Non-IEEE floating-point format based on IEEE754 single-precisio
20); // Non-IEEE floating-point format based on IEEE754 single-precision
/** The int id on the native side. */
public final int value;
@ -111,6 +133,7 @@ public class TensorInfo implements ValueInfo {
}
}
/** The shape of the tensor. */
final long[] shape;
/** The Java type of this tensor. */

9
java/src/main/java/ai/onnxruntime/providers/CoreMLFlags.java
View file

@ -1,15 +1,22 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime.providers;
/** Flags for the CoreML provider. */
public enum CoreMLFlags implements OrtFlags {
/**
* Use only the CPU, disables the GPU and Apple Neural Engine. Only recommended for developer
* usage as it significantly impacts performance.
*/
CPU_ONLY(1), // COREML_FLAG_USE_CPU_ONLY(0x001)
/** Enables CoreML on subgraphs. */
ENABLE_ON_SUBGRAPH(2), // COREML_FLAG_ENABLE_ON_SUBGRAPH(0x002)
/** Only enable usage of CoreML if the device has an Apple Neural Engine. */
ONLY_ENABLE_DEVICE_WITH_ANE(4); // COREML_FLAG_ONLY_ENABLE_DEVICE_WITH_ANE(0x004),
/** The native value of the enum. */
public final int value;
CoreMLFlags(int value) {

16
java/src/main/java/ai/onnxruntime/providers/NNAPIFlags.java
View file

@ -1,16 +1,30 @@
/*
* Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2021, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime.providers;
/** Flags for the NNAPI provider. */
public enum NNAPIFlags implements OrtFlags {
/** Enables fp16 support. */
USE_FP16(1), // NNAPI_FLAG_USE_FP16(0x001)
/**
* Uses channels first format. Only recommended for developer usage to validate code changes to
* the execution provider implementation.
*/
USE_NCHW(2), // NNAPI_FLAG_USE_NCHW(0x002)
/**
* Disables NNAPI from using CPU. If an operator could be assigned to NNAPI, but NNAPI only has a
* CPU implementation of that operator on the current device, model load will fail.
*/
CPU_DISABLED(4), // NNAPI_FLAG_CPU_DISABLED(0x004)
/**
* NNAPI will only use CPU. Only recommended for developer usage as it significantly impacts
* performance.
*/
CPU_ONLY(8); // NNAPI_FLAG_CPU_ONLY(0x008)
/** The native value of the enum. */
public final int value;
NNAPIFlags(int value) {

5
java/src/main/java/ai/onnxruntime/providers/StringConfigProviderOptions.java
View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved.
* Licensed under the MIT License.
*/
package ai.onnxruntime.providers;
@ -15,6 +15,7 @@ import java.util.stream.Collectors;
* Abstract base class for provider options which are configured solely by key value string pairs.
*/
abstract class StringConfigProviderOptions extends OrtProviderOptions {
/** A Java side copy of the options. */
protected final Map<String, String> options;
protected StringConfigProviderOptions(long nativeHandle) {
@ -38,7 +39,7 @@ abstract class StringConfigProviderOptions extends OrtProviderOptions {
}
/**
* Parses the output of {@link #getOptionsString()} and adds those options to this options
* Parses the output of {@code getOptionsString()} and adds those options to this options
* instance.
*
* @param serializedForm The serialized form to parse.