ai.onnxruntime

Class OrtEnvironment

java.lang.Object

ai.onnxruntime.OrtEnvironment

All Implemented Interfaces:

java.lang.AutoCloseable

public class OrtEnvironment
extends java.lang.Object
implements java.lang.AutoCloseable

The host object for the onnx-runtime system. Can create OrtSessions which encapsulate specific models.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME

Method Summary

Modifier and Type	Method and Description
void	close() Closes the OrtEnvironment.
OrtSession	createSession(byte[] modelArray) Create a session using the default OrtSession.SessionOptions, model and the default memory allocator.
OrtSession	createSession(byte[] modelArray, OrtSession.SessionOptions options) Create a session using the specified OrtSession.SessionOptions, model and the default memory allocator.
OrtSession	createSession(java.lang.String modelPath) Create a session using the default OrtSession.SessionOptions, model and the default memory allocator.
OrtSession	createSession(java.lang.String modelPath, OrtSession.SessionOptions options) Create a session using the specified OrtSession.SessionOptions, model and the default memory allocator.
static OrtEnvironment	getEnvironment() Gets the OrtEnvironment.
static OrtEnvironment	getEnvironment(OrtLoggingLevel logLevel) Gets the OrtEnvironment.
static OrtEnvironment	getEnvironment(OrtLoggingLevel loggingLevel, java.lang.String name) Gets the OrtEnvironment.
static OrtEnvironment	getEnvironment(java.lang.String name) Gets the OrtEnvironment.
boolean	isClosed() Is this environment closed?
void	setTelemetry(boolean sendTelemetry) Turns on or off the telemetry.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

Method Detail

getEnvironment

public static OrtEnvironment getEnvironment()

Gets the OrtEnvironment. If there is not an environment currently created, it creates one using DEFAULT_NAME and OrtLoggingLevel.ORT_LOGGING_LEVEL_WARNING.

Returns:

An onnxruntime environment.

getEnvironment

public static OrtEnvironment getEnvironment(java.lang.String name)

Gets the OrtEnvironment. If there is not an environment currently created, it creates one using the supplied name and OrtLoggingLevel.ORT_LOGGING_LEVEL_WARNING.

Parameters:

name - The logging id of the environment.

Returns:

An onnxruntime environment.

getEnvironment

public static OrtEnvironment getEnvironment(OrtLoggingLevel logLevel)

Gets the OrtEnvironment. If there is not an environment currently created, it creates one using the DEFAULT_NAME and the supplied logging level.

Parameters:

logLevel - The logging level to use.

Returns:

An onnxruntime environment.

getEnvironment

public static OrtEnvironment getEnvironment(OrtLoggingLevel loggingLevel,
                                            java.lang.String name)

Gets the OrtEnvironment. If there is not an environment currently created, it creates one using the supplied name and logging level. If an environment already exists with a different name, that environment is returned and a warning is logged.

Parameters:

loggingLevel - The logging level to use.

name - The log id.

Returns:

The OrtEnvironment singleton.

createSession

public OrtSession createSession(java.lang.String modelPath)
                         throws OrtException

Create a session using the default OrtSession.SessionOptions, model and the default memory allocator.

Parameters:

modelPath - Path on disk to load the model from.

Returns:

An OrtSession with the specified model.

Throws:

OrtException - If the model failed to load, wasn't compatible or caused an error.

createSession

public OrtSession createSession(java.lang.String modelPath,
                                OrtSession.SessionOptions options)
                         throws OrtException

Create a session using the specified OrtSession.SessionOptions, model and the default memory allocator.

Parameters:

modelPath - Path on disk to load the model from.

options - The session options.

Returns:

An OrtSession with the specified model.

Throws:

OrtException - If the model failed to load, wasn't compatible or caused an error.

createSession

public OrtSession createSession(byte[] modelArray,
                                OrtSession.SessionOptions options)
                         throws OrtException

Create a session using the specified OrtSession.SessionOptions, model and the default memory allocator.

Parameters:

modelArray - Byte array representing an ONNX model.

options - The session options.

Returns:

An OrtSession with the specified model.

Throws:

OrtException - If the model failed to parse, wasn't compatible or caused an error.

createSession

public OrtSession createSession(byte[] modelArray)
                         throws OrtException

Create a session using the default OrtSession.SessionOptions, model and the default memory allocator.

Parameters:

modelArray - Byte array representing an ONNX model.

Returns:

An OrtSession with the specified model.

Throws:

OrtException - If the model failed to parse, wasn't compatible or caused an error.

setTelemetry

public void setTelemetry(boolean sendTelemetry)
                  throws OrtException

Turns on or off the telemetry.

Parameters:

sendTelemetry - If true then send telemetry on onnxruntime usage.

Throws:

OrtException - If the call failed.

isClosed

public boolean isClosed()

Is this environment closed?

Returns:

True if the environment is closed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

close

public void close()
           throws OrtException

Closes the OrtEnvironment. If this is the last reference to the environment then it closes the native handle.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

OrtException - If the close failed.