Package ai.onnxruntime

Enum OrtModelCompilationOptions.OrtCompileApiFlags

java.lang.Object

java.lang.Enum<OrtModelCompilationOptions.OrtCompileApiFlags>

ai.onnxruntime.OrtModelCompilationOptions.OrtCompileApiFlags

All Implemented Interfaces:

OrtFlags, java.io.Serializable, java.lang.Comparable<OrtModelCompilationOptions.OrtCompileApiFlags>

Enclosing class:

OrtModelCompilationOptions

public static enum OrtModelCompilationOptions.OrtCompileApiFlags
extends java.lang.Enum<OrtModelCompilationOptions.OrtCompileApiFlags>
implements OrtFlags

Flags representing options when compiling a model.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ERROR_IF_NO_NODES_COMPILED	Force compilation to return an error (ORT_FAIL) if no nodes were compiled.
ERROR_IF_OUTPUT_FILE_EXISTS	Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists.
NONE	Default.

Field Summary

Fields

Modifier and Type	Field	Description
int	value	The native value of the enum.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Gets the underlying flag value.
static OrtModelCompilationOptions.OrtCompileApiFlags	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static OrtModelCompilationOptions.OrtCompileApiFlags[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final OrtModelCompilationOptions.OrtCompileApiFlags NONE

Default. Do not enable any additional compilation options.

ERROR_IF_NO_NODES_COMPILED

public static final OrtModelCompilationOptions.OrtCompileApiFlags ERROR_IF_NO_NODES_COMPILED

Force compilation to return an error (ORT_FAIL) if no nodes were compiled. Otherwise, a model with basic optimizations (ORT_ENABLE_BASIC) is still generated by default.

ERROR_IF_OUTPUT_FILE_EXISTS

public static final OrtModelCompilationOptions.OrtCompileApiFlags ERROR_IF_OUTPUT_FILE_EXISTS

Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists. Otherwise, compilation will automatically overwrite the output file if it exists.

Field Detail

value

public final int value

The native value of the enum.

Method Detail

values

public static OrtModelCompilationOptions.OrtCompileApiFlags[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OrtModelCompilationOptions.OrtCompileApiFlags c : OrtModelCompilationOptions.OrtCompileApiFlags.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OrtModelCompilationOptions.OrtCompileApiFlags valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Description copied from interface: OrtFlags

Gets the underlying flag value.

Specified by:

getValue in interface OrtFlags

Returns:

The flag value.