Package ai.onnxruntime

Interface OnnxValue

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

OnnxMap, OnnxSequence, OnnxSparseTensor, OnnxTensor, OnnxTensorLike

public interface OnnxValue
extends java.lang.AutoCloseable

Top interface for input and output values from ONNX models. Currently implemented by OnnxTensor, OnnxSparseTensor, OnnxSequence and OnnxMap. Will be sealed to these types one day.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OnnxValue.OnnxValueType	The type of the OnnxValue, mirroring the id in the C API.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the OnnxValue, freeing its native memory.
static void	close(java.lang.Iterable<? extends OnnxValue> itr)	Calls close on each element of the iterable.
static void	close(java.util.Map<java.lang.String,? extends OnnxValue> map)	Calls close on each OnnxValue in the map.
ValueInfo	getInfo()	Gets the type info object associated with this OnnxValue.
OnnxValue.OnnxValueType	getType()	Gets the type of this OnnxValue.
java.lang.Object	getValue()	Returns the value as a Java object copying it out of the native heap.
boolean	isClosed()	Checks if this value is closed (i.e., the native object has been released).

Method Detail

getType

OnnxValue.OnnxValueType getType()

Gets the type of this OnnxValue.

Returns:

The value type.

getValue

java.lang.Object getValue()
                   throws OrtException

Returns the value as a Java object copying it out of the native heap. This operation can be quite slow for high dimensional tensors, where you should prefer OnnxTensor.getByteBuffer() etc.

Overridden by the subclasses with a more specific type if available.

Returns:

The value.

Throws:

OrtException - If an error occurred reading the value.

getInfo

ValueInfo getInfo()

Gets the type info object associated with this OnnxValue.

Returns:

The type information.

isClosed

boolean isClosed()

Checks if this value is closed (i.e., the native object has been released).

Returns:

True if the value is closed and the native object has been released.

close

void close()

Closes the OnnxValue, freeing its native memory.

Specified by:

close in interface java.lang.AutoCloseable

close

static void close(java.lang.Iterable<? extends OnnxValue> itr)

Calls close on each element of the iterable.

Parameters:

itr - An iterable of closeable OnnxValues.

close

static void close(java.util.Map<java.lang.String,? extends OnnxValue> map)

Calls close on each OnnxValue in the map.

Parameters:

map - A map of OnnxValues.