Skip to content

ONNX

Tensor - CreateTensor_FromData_Float

Constructs a Tensor with the specified shape and data. Note: This constructor creates a Tensor from a shape Array and a data Array. The shape defines the dimensions of the Tensor, and the data array provides the initial values for the Tensor elements. The data type of the Tensor is inferred from the type of the input data array. The size of inData must match the product of the dimensions specified in inShape.

IN

Name Type Description
InShape IntArray An array of integers specifying the dimensions of the Tensor.
InData FloatArray An array of values to initialize the Tensor elements. Its type determines the Tensor's element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromData_Int

Constructs a Tensor with the specified shape and data. Note: This constructor creates a Tensor from a shape Array and a data Array. The shape defines the dimensions of the Tensor, and the data array provides the initial values for the Tensor elements. The data type of the Tensor is inferred from the type of the input data array. The size of inData must match the product of the dimensions specified in inShape.

IN

Name Type Description
InShape IntArray An array of integers specifying the dimensions of the Tensor.
InData IntArray An array of values to initialize the Tensor elements. Its type determines the Tensor's element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromData_Int16

Constructs a Tensor with the specified shape and data. Note: This constructor creates a Tensor from a shape Array and a data Array. The shape defines the dimensions of the Tensor, and the data array provides the initial values for the Tensor elements. The data type of the Tensor is inferred from the type of the input data array. The size of inData must match the product of the dimensions specified in inShape.

IN

Name Type Description
InShape IntArray An array of integers specifying the dimensions of the Tensor.
InData Int16Array An array of values to initialize the Tensor elements. Its type determines the Tensor's element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromData_Int8

Constructs a Tensor with the specified shape and data. Note: This constructor creates a Tensor from a shape Array and a data Array. The shape defines the dimensions of the Tensor, and the data array provides the initial values for the Tensor elements. The data type of the Tensor is inferred from the type of the input data array. The size of inData must match the product of the dimensions specified in inShape.

IN

Name Type Description
InShape IntArray An array of integers specifying the dimensions of the Tensor.
InData SByteArray An array of values to initialize the Tensor elements. Its type determines the Tensor's element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromData_UInt16

Constructs a Tensor with the specified shape and data. Note: This constructor creates a Tensor from a shape Array and a data Array. The shape defines the dimensions of the Tensor, and the data array provides the initial values for the Tensor elements. The data type of the Tensor is inferred from the type of the input data array. The size of inData must match the product of the dimensions specified in inShape.

IN

Name Type Description
InShape IntArray An array of integers specifying the dimensions of the Tensor.
InData UInt16Array An array of values to initialize the Tensor elements. Its type determines the Tensor's element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromData_UInt8

Constructs a Tensor with the specified shape and data. Note: This constructor creates a Tensor from a shape Array and a data Array. The shape defines the dimensions of the Tensor, and the data array provides the initial values for the Tensor elements. The data type of the Tensor is inferred from the type of the input data array. The size of inData must match the product of the dimensions specified in inShape.

IN

Name Type Description
InShape IntArray An array of integers specifying the dimensions of the Tensor.
InData ByteArray An array of values to initialize the Tensor elements. Its type determines the Tensor's element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromImage

Constructs a Tensor from a single Image using a specified configuration. Note: This constructor creates a Tensor by converting Image data into a Tensor format according to the provided TensorConfig. The resulting Tensor shape and element values depend on the dimensions of the input Image and the parameters specified in the TensorConfig.

IN

Name Type Description
InImage Image The input image to convert into a Tensor.
InConfig TensorConfig The configuration object defining preprocessing and conversion parameters.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - CreateTensor_FromImages

Constructs a Tensor from an array of Images using a specified configuration. Note: This constructor creates a Tensor by converting the array of Images into a Tensor format according to the provided TensorConfig. The resulting Tensor shape and element values depend on the dimensions of the input Image and the parameters specified in the TensorConfig.

IN

Name Type Description
InImages ImageArray The input images to convert into a Tensor.
InConfig TensorConfig The configuration object defining preprocessing and conversion parameters.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor The Tensor instance.
Error ErrorState Gets the execution error message

Tensor - GetBatchElement

Retrieves a copy of sub-Tensor from a batched Tensor. Note: This method returns a Tensor corresponding to the specified batch index. It is useful when working with batched data, allowing access to individual samples within the batch without modifying the original tensor. The returned Tensor shares the same data type as the original batch tensor, but its shape corresponds to a single element of the batch.

IN

Name Type Description
InTensor Tensor The input Tensor
InBatchIndex Int The index of the batch element to retrieve.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor A tensor representing the element at the specified batch index.
Error ErrorState Gets the execution error message

Tensor - GetDimension

Returns the Tensor dimension (or rank).

IN

Name Type Description
InTensor Tensor The input Tensor
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutInt Int The Tensor dimension.
Error ErrorState Gets the execution error message

Tensor - GetElementType

Returns the Tensor element data type.

IN

Name Type Description
InTensor Tensor The input Tensor
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorDataType Enum < TensorDataType > The Tensor element data type.
Error ErrorState Gets the execution error message

Tensor - GetShape

Returns the Tensor shape.

IN

Name Type Description
InTensor Tensor The input Tensor
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutInt IntArray An array of integers representing the Tensor shape.
Error ErrorState Gets the execution error message

Tensor - GetTensorElement

Get the TensorElement at the given index.

IN

Name Type Description
InTensor Tensor The input Tensor
InIndex0 Int Axis-0 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement Selected Tensor element.
Error ErrorState Gets the execution error message

Tensor - GetTensorElement2

Get the TensorElement at the given indices.

IN

Name Type Description
InTensor Tensor The input Tensor
InIndex0 Int Axis-0 index.
InIndex1 Int Axis-1 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement Selected Tensor element.
Error ErrorState Gets the execution error message

Tensor - GetTensorElement3

Get the TensorElement at the given indices.

IN

Name Type Description
InTensor Tensor The input Tensor
InIndex0 Int Axis-0 index.
InIndex1 Int Axis-1 index.
InIndex2 Int Axis-2 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement Selected Tensor element.
Error ErrorState Gets the execution error message

Tensor - GetTensorElement4

Get the TensorElement at the given indices.

IN

Name Type Description
InTensor Tensor The input Tensor
InIndex0 Int Axis-0 index.
InIndex1 Int Axis-1 index.
InIndex2 Int Axis-2 index.
InIndex3 Int Axis-3 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement Selected Tensor element.
Error ErrorState Gets the execution error message

TensorTypeInfo - CreateTensorTypeInfo

Constructs a new TensorTypeInfo object from given shape and element type.

IN

Name Type Description
InShape IntArray Shape.
InElementType Enum < TensorDataType > Element type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorTypeInfo TensorTypeInfo The TensorTypeInfo instance.
Error ErrorState Gets the execution error message

TensorTypeInfo - GetElementType

Returns the type of the tensor.

IN

Name Type Description
InTensorTypeInfo TensorTypeInfo The input TensorTypeInfo
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorDataType Enum < TensorDataType > The tensor element type.
Error ErrorState Gets the execution error message

TensorTypeInfo - GetShape

Returns the shape of the tensor.

IN

Name Type Description
InTensorTypeInfo TensorTypeInfo The input TensorTypeInfo
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Outint IntArray The tensor shape.
Error ErrorState Gets the execution error message

TensorOperations - GetArgMax

Returns the indices of the maximum values along a specified axis.

IN

Name Type Description
InTensor Tensor Input Tensor.
InAxis Int The axis along which to compute the Arg Max.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor A tensor containing the indices of the maximum values along the specified axis.
Error ErrorState Gets the execution error message

TensorOperations - GetArgMin

Returns the indices of the minimum values along a specified axis.

IN

Name Type Description
InTensor Tensor Input Tensor.
InAxis Int The axis along which to compute the Arg Min.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor A tensor containing the indices of the minimum values along the specified axis.
Error ErrorState Gets the execution error message

TensorOperations - Reshape

Returns a new tensor with the shape specified by inShape

IN

Name Type Description
InTensor Tensor The input tensor to be reshaped.
InShape IntArray An array defining the desired shape of the output tensor.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor A tensor containing the same data as inTensor but reshaped to the specified dimensions.
Error ErrorState Gets the execution error message

TensorOperations - Softmax

Apply softmax along a given axis of the input Tensor. Note: The softmax function applied to a vector \f$ \vec{x} = {x_0,\dots, x_K} \f$ is defined as: \f[ \sigma(\vec{x})j = \frac{e^{x_j}}{\sum \f] where: - \f}^K e^{x_k}\(j\f\) indexes the elements along the specified axis. - \f\(k\f\) runs over all indices along that axis.

IN

Name Type Description
IoTensor Tensor Input Tensor.
InAxis Int Axis to compute the function along.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutIoTensor Tensor The modified Core.Data.Types.Tensor
Error ErrorState Gets the execution error message

TensorOperations - ConvertTensorToImage

Convert a Tensor to an Image.

IN

Name Type Description
InTensor Tensor Input Tensor.
InLayout Enum < ChannelsLayout > Tensor ChannelsLayout::Type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage Image Converted tensor.
Error ErrorState Gets the execution error message

TensorOperations - ConvertTensorToImageArray

Convert a Tensor of rank N into N single-channel Images.

IN

Name Type Description
InTensor Tensor Input Tensor.
InLayout Enum < ChannelsLayout > Tensor ChannelsLayout::Type.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutImage ImageArray Array that contains all the single-channel images.
Error ErrorState Gets the execution error message

TensorElement - AddFloat

Adds an unsigned 32-bit float value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Float float value to add.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - AddInt

Adds an unsigned 32-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int int value to add.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - AddInt16

Adds an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int16 short value to add.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - AddInt8

Adds an 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue SByte sbyte value to add.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - AddUInt16

Adds an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue UInt16 ushort value to add.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - AddUInt8

Adds an unsigned 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Byte byte value to add.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - CastToDouble

Converts the TensorElement to a 64-bit double.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutDouble Double The value of the underlying Tensor element as a double.
Error ErrorState Gets the execution error message

TensorElement - CastToFloat

Converts the TensorElement to a 32-bit float.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The value of the underlying Tensor element as a float.
Error ErrorState Gets the execution error message

TensorElement - CastToInt

Converts the TensorElement to a 32-bit integer.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutInt Int The value of the underlying Tensor element as an int.
Error ErrorState Gets the execution error message

TensorElement - CastToInt16

Converts the TensorElement to a 16-bit integer.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutInt16 Int16 The value of the underlying Tensor element as a short.
Error ErrorState Gets the execution error message

TensorElement - CastToInt8

Converts the TensorElement to an 8-bit integer.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSByte SByte The value of the underlying Tensor element as a sbyte.
Error ErrorState Gets the execution error message

TensorElement - CastToUInt16

Converts the TensorElement to an unsigned 16-bit integer.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUInt16 UInt16 The value of the underlying Tensor element as a ushort.
Error ErrorState Gets the execution error message

TensorElement - CastToUInt8

Converts the TensorElement to an unsigned 8-bit integer.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutByte Byte The value of the underlying Tensor element as a byte.
Error ErrorState Gets the execution error message

TensorElement - CreateTensorElement_From1DTensor

Constructs a new Tensor Element object.

IN

Name Type Description
InTensor Tensor Input Tensor.
InIndex0 Int Axis-0 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The TensorElement instance.
Error ErrorState Gets the execution error message

TensorElement - CreateTensorElement_From2DTensor

Constructs a new Tensor Element object.

IN

Name Type Description
InTensor Tensor Input Tensor.
InIndex0 Int Axis-0 index.
InIndex1 Int Axis-1 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The TensorElement instance.
Error ErrorState Gets the execution error message

TensorElement - CreateTensorElement_From3DTensor

Constructs a new Tensor Element object.

IN

Name Type Description
InTensor Tensor Input Tensor.
InIndex0 Int Axis-0 index.
InIndex1 Int Axis-1 index.
InIndex2 Int Axis-2 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The TensorElement instance.
Error ErrorState Gets the execution error message

TensorElement - CreateTensorElement_From4DTensor

Constructs a new Tensor Element object.

IN

Name Type Description
InTensor Tensor Input Tensor.
InIndex0 Int Axis-0 index.
InIndex1 Int Axis-1 index.
InIndex2 Int Axis-2 index.
InIndex3 Int Axis-3 index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The TensorElement instance.
Error ErrorState Gets the execution error message

TensorElement - DivideFloat

Divide an unsigned 32-bit float value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Float float value to use as divider.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - DivideInt

Divide an unsigned 32-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int int value to use as divider.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - DivideInt16

Divide an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int16 short value to use as divider.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - DivideInt8

Divide an 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue SByte sbyte value to use as divider.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - DivideUInt16

Divide an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue UInt16 ushort value to use as divider.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - DivideUInt8

Divide an unsigned 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Byte byte value to use as divider.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - MultiplyFloat

Multiply an unsigned 32-bit float value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Float float value to use as multiplier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - MultiplyInt

Multiply an unsigned 32-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int int value to use as multiplier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - MultiplyInt16

Multiply an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int16 short value to use as multiplier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - MultiplyInt8

Multiply an 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue SByte sbyte value to use as multiplier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - MultiplyUInt16

Multiply an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue UInt16 ushort value to use as multiplier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - MultiplyUInt8

Multiply an unsigned 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Byte byte value to use as multiplier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - SubtractFloat

Subtract an unsigned 32-bit float value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Float float value to subtract.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - SubtractInt

Subtract an unsigned 32-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int int value to subtract.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - SubtractInt16

Subtract an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Int16 short value to subtract.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - SubtractInt8

Subtract an 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue SByte sbyte value to subtract.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - SubtractUInt16

Subtract an unsigned 16-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue UInt16 ushort value to subtract.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorElement - SubtractUInt8

Subtract an unsigned 8-bit integer value to this TensorElement.

IN

Name Type Description
InTensorElement TensorElement The input TensorElement
InValue Byte byte value to subtract.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorElement TensorElement The modified Core.Data.Types.TensorElement
Error ErrorState Gets the execution error message

TensorConfig - CreateTensorConfig

Constructs a new TensorConfig object.

IN

Name Type Description
InRescaleFactor Float float rescale factor applied to the input Image.
InMean FloatArray Mean values used for tensor normalization.
InSwapRB Bool Whether the red and blue channels are swapped.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorConfig TensorConfig The TensorConfig instance.
Error ErrorState Gets the execution error message

TensorConfig - GetCropSize

Retrieves the Image to Tensor crop size.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorConfig TensorConfig The modified Core.Data.Types.TensorConfig
Error ErrorState Gets the execution error message

TensorConfig - GetMean

Retrieves the mean values used for Tensor normalization.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat FloatArray The mean values.
Error ErrorState Gets the execution error message

TensorConfig - GetRescaleFactor

Retrieves the current rescale factor applied to the Tensor.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutFloat Float The rescale factor.
Error ErrorState Gets the execution error message

TensorConfig - GetSwapRB

Checks whether the red and blue channels are swapped.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBool Bool True if RB swapping is enabled, false otherwise.
Error ErrorState Gets the execution error message

TensorConfig - SetCropSize

Enables or disables cropping for the input Image.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorConfig TensorConfig The modified Core.Data.Types.TensorConfig
Error ErrorState Gets the execution error message

TensorConfig - SetMean

Sets the mean values for Tensor normalization.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
InMean FloatArray An array of mean values to apply.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorConfig TensorConfig The modified Core.Data.Types.TensorConfig
Error ErrorState Gets the execution error message

TensorConfig - SetRescaleFactor

Sets the rescale factor for the Tensor.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
InRescaleFactor Float The new rescale factor to apply.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorConfig TensorConfig The modified Core.Data.Types.TensorConfig
Error ErrorState Gets the execution error message

TensorConfig - SetSwapRB

Enables or disables swapping of red and blue channels.

IN

Name Type Description
InTensorConfig TensorConfig The input TensorConfig
InSwapRB Bool Set to true to swap the red and blue channels, false otherwise.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorConfig TensorConfig The modified Core.Data.Types.TensorConfig
Error ErrorState Gets the execution error message

RunOptions - CreateRunOptions

Constructs a new RunOptions object from specific tag.

IN

Name Type Description
InTag String Run Tag.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRunOptions RunOptions The RunOptions instance.
Error ErrorState Gets the execution error message

RunOptions - SetRunTag

Sets a new Run Tag.

IN

Name Type Description
InRunOptions RunOptions The input RunOptions
InTag String A ov::String that will be used as Run tag.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRunOptions RunOptions The modified Core.Data.Types.RunOptions
Error ErrorState Gets the execution error message

RunOptions - SetTerminate

Sets the 'terminate' flag.

IN

Name Type Description
InRunOptions RunOptions The input RunOptions
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRunOptions RunOptions The modified Core.Data.Types.RunOptions
Error ErrorState Gets the execution error message

RunOptions - UnsetTerminate

Clears the 'terminate' flag.

IN

Name Type Description
InRunOptions RunOptions The input RunOptions
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutRunOptions RunOptions The modified Core.Data.Types.RunOptions
Error ErrorState Gets the execution error message

Model - CreateModel

Constructs a new Model from .onnx file and configuration.

IN

Name Type Description
InFile PathFile Path to the model .onnx file.
InModelConfig OnnxModelConfig Model configuration.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModel OnnxModel The Model instance.
Error ErrorState Gets the execution error message

Model - GetInputNames

Returns the Input Names.

IN

Name Type Description
InModel OnnxModel The input Model
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutString StringArray An array containing all the input layers names.
Error ErrorState Gets the execution error message

Model - GetInputsCount

Returns the number of Inputs layers.

IN

Name Type Description
InModel OnnxModel The input Model
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUInt64 UInt64 The number of Inputs layers.
Error ErrorState Gets the execution error message

Model - GetInputType

Returns the Input Type for layer with index inIndex.

IN

Name Type Description
InModel OnnxModel The input Model
InIndex UInt64 Input layer index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutONNXType Enum < ONNXType > Type of the input layer with index inIndex.
Error ErrorState Gets the execution error message

Model - GetOutputNames

Returns the Output Names.

IN

Name Type Description
InModel OnnxModel The input Model
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutString StringArray An array containing all the output layers names.
Error ErrorState Gets the execution error message

Model - GetOutputsCount

Returns the Outputs Count.

IN

Name Type Description
InModel OnnxModel The input Model
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutUInt64 UInt64 The number of outputs layers.
Error ErrorState Gets the execution error message

Model - GetOutputType

Returns the Output Type for layer with index inIndex.

IN

Name Type Description
InModel OnnxModel The input Model
InIndex UInt64 Output layer index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutONNXType Enum < ONNXType > Type of the output layer with index inIndex.
Error ErrorState Gets the execution error message

Model - GetTensorInputTypeInfo

Returns the Tensor Input Type Info.

IN

Name Type Description
InModel OnnxModel The input Model
InIndex UInt64 Input layer index.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorTypeInfo TensorTypeInfo The TensorTypeInfo of the input layer with index inIndex.
Error ErrorState Gets the execution error message

Model - GetTensorOutputTypeInfo

Returns the Tensor Output Type Info.

IN

Name Type Description
InModel OnnxModel The input Model
InIndex UInt64 Output layer index
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensorTypeInfo TensorTypeInfo The TensorTypeInfo of the output layer with index inIndex.
Error ErrorState Gets the execution error message

Model - Run_MultipleToMultiple

Run model inference with multiple input / multiple output.

IN

Name Type Description
InModel OnnxModel The input Model
InTensors TensorArray Input tensors.
InRunOptions RunOptions Model run options.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensors TensorArray Output tensors.
Error ErrorState Gets the execution error message

Model - Run_SingleToMultiple

Run model inference with single input / multiple output.

IN

Name Type Description
InModel OnnxModel The input Model
InTensor Tensor Input tensor.
InRunOptions RunOptions Model run options.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensors TensorArray Output tensors.
Error ErrorState Gets the execution error message

Model - Run_SingleToSingle

Run model inference with single input / single output.

IN

Name Type Description
InModel OnnxModel The input Model
InTensor Tensor Input tensor.
InRunOptions RunOptions Model run options.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutTensor Tensor Output tensor.
Error ErrorState Gets the execution error message

ModelConfig - AddCUDAExecutionProvider

Add the CUDA execution provider using the specified configuration options.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InCUDAProviderOptions CUDAProviderOptions The CUDA provider configuration settings.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - CreateModelConfig

Constructs a new ModelConfig object from the given values.

IN

Name Type Description
InGraphOptimizationLevel Enum < GraphOptimizationLevel > Graph optimization level to apply.
InLogID String Log identifier.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The ModelConfig instance.
Error ErrorState Gets the execution error message

ModelConfig - CudaProviderIsAvailable

Check whether the CUDA execution provider is available.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBool Bool True if the CUDA provider is available on this system, otherwise false.
Error ErrorState Gets the execution error message

ModelConfig - DisableCpuMemArena

Disable the memory arena on CPU.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - DisableMemPattern

Enable the memory pattern optimization.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - DisablePerSessionThreads

Use global thread pool on a session.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - DisableProfiling

Disable profiling.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - EnableCpuMemArena

Enable the memory arena on CPU.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - EnableMemPattern

Enable the memory pattern optimization. If the input shapes are the same, is possible to trace the internal memory allocations and record a memory pattern for future requests. Then, on subsequent runs, instead of performing many small allocations, is possible to allocate one large contiguous block to cover all internal memory needs.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - EnableProfiling

Enable profiling.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InProfileFilePrefix String Profile filename prefix.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - GetAvailableExecutionProviders

Get the list of available execution providers supported at runtime.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutExecutionProvider EnumArray < ExecutionProvider > Array containing the types of available execution providers.
Error ErrorState Gets the execution error message

ModelConfig - SetGraphOptimizationLevel

Set the optimization level to be applied to the model graph.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InGraphOptimizationLevel Enum < GraphOptimizationLevel > The optimization level.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - SetInterOpNumThreads

Configures the maximum number of threads to use for parallel execution of graph nodes that can run concurrently.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InThreads Int maximum number of threads.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - SetIntraOpNumThreads

Sets the number of threads used to parallelize the execution within nodes.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InThreads Int Number of threads to use. A value of 0 selects the default thread count.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - SetLogId

Set log ID.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InLogID String Input log ID.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - SetLogSeverityLevel

Sets a new Log Severity Level.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InLogSeverity Enum < ONNXLoggingLevel > Desired ONNXLoggingLevel.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

ModelConfig - SetOptimizedModelFilePath

Set the file path of the optimized model.

IN

Name Type Description
InModelConfig OnnxModelConfig The input ModelConfig
InFile PathFile Optimized model file path.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutModelConfig OnnxModelConfig The modified OnnxModelConfig
Error ErrorState Gets the execution error message

CUDAProviderOptions - CreateCUDAProviderOptions

Construct CUDA provider options with the given configuration values.

IN

Name Type Description
InGpuMemoryLimit UInt64 The maximum GPU memory (in bytes) allowed for allocation.
InArenaExtendStrategy Int Strategy used to extend memory arenas.
InDoCopyInDefaultStream Bool true to perform memory copy operations on the default CUDA stream, false otherwise.
InEnableTunableOp Bool true to enable support for tunable operators, false to disable.
InEnableTunableOpTuning Bool true to enable tuning of tunable operators, false otherwise.
InTunableOpMaxTuningDurationMs Int Maximum allowed tuning duration for tunable operators (in milliseconds).
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutCUDAProviderOptions CUDAProviderOptions The CUDAProviderOptions instance.
Error ErrorState Gets the execution error message