# Python Runtime for ONNX operators¶

The main function instantiates a runtime class which computes the outputs of a specific node.

`mlprodict.onnxrt.ops.load_op`

(*onnx_node*, *desc* = None, *options* = None, *variables* = None, *dtype* = None)

Sets up a class for a specific ONNX operator.

Other sections documents available operators. This project was mostly started to show a way to implement a custom runtime, do some benchmarks, test, exepriment…

## Python¶

### Abs¶

`mlprodict.onnxrt.ops_cpu.op_abs.Abs`

(*self*, *onnx_node*, *desc* = None, *options*)

Absolute takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the absolute is, y = abs(x), is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to all numeric tensors.

Version

Onnx name:AbsThis version of the operator has been available since version 13.

Runtime implementation:`Abs`

### Add¶

`mlprodict.onnxrt.ops_cpu.op_add.Add`

(*self*, *onnx_node*, *desc* = None, *options*)

Performs element-wise binary addition (with Numpy-style broadcasting support).

This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First operand.

B(heterogeneous)T: Second operand.

Outputs

C(heterogeneous)T: Result, has same element type as two inputs

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to high-precision numeric tensors.

Version

Onnx name:AddThis version of the operator has been available since version 13.

Runtime implementation:`Add`

### And¶

`mlprodict.onnxrt.ops_cpu.op_and.And`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the tensor resulted from performing the and logical operation elementwise on the input tensors A and B (with Numpy-style broadcasting support).

This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First input operand for the logical operator.

B(heterogeneous)T: Second input operand for the logical operator.

Outputs

C(heterogeneous)T1: Result tensor.

Type Constraints

T tensor(bool): Constrains input to boolean tensor.

T1 tensor(bool): Constrains output to boolean tensor.

Version

Onnx name:AndThis version of the operator has been available since version 7.

Runtime implementation:`And`

### ArgMax_12¶

`mlprodict.onnxrt.ops_cpu.op_argmax.ArgMax_12`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the indices of the max elements of the input tensor’s element along the provided axis. The resulting tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulting tensor have the reduced dimension pruned. If select_last_index is True (default False), the index of the last occurrence of the max is selected if the max appears more than once in the input. Otherwise the index of the first occurrence is selected. The type of the output tensor is integer.

Attributes

axis: The axis in which to compute the arg indices. Accepted range is [-r, r-1] where r = rank(data). Default value is`nameaxisi0typeINT`

(INT)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

select_last_index: Whether to select the last index or the first index if the {name} appears in multiple indices, default is False (first index). Default value is`nameselectlastindexi0typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)tensor(int64): Reduced output tensor with integer data type.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrain input and output types to all numeric tensors.

Version

Onnx name:ArgMaxThis version of the operator has been available since version 12.

Runtime implementation:`ArgMax`

### ArgMin_12¶

`mlprodict.onnxrt.ops_cpu.op_argmin.ArgMin_12`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the indices of the min elements of the input tensor’s element along the provided axis. The resulting tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulting tensor have the reduced dimension pruned. If select_last_index is True (default False), the index of the last occurrence of the min is selected if the min appears more than once in the input. Otherwise the index of the first occurrence is selected. The type of the output tensor is integer.

Attributes

axis: The axis in which to compute the arg indices. Accepted range is [-r, r-1] where r = rank(data). Default value is`nameaxisi0typeINT`

(INT)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

select_last_index: Whether to select the last index or the first index if the {name} appears in multiple indices, default is False (first index). Default value is`nameselectlastindexi0typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)tensor(int64): Reduced output tensor with integer data type.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrain input and output types to all numeric tensors.

Version

Onnx name:ArgMinThis version of the operator has been available since version 12.

Runtime implementation:`ArgMin`

### ArrayFeatureExtractor¶

`mlprodict.onnxrt.ops_cpu.op_array_feature_extractor.ArrayFeatureExtractor`

(*self*, *onnx_node*, *desc* = None, *options*)

Select elements of the input tensor based on the indices passed.

The indices are applied to the last axes of the tensor.

Inputs

X(heterogeneous)T: Data to be selected

Y(heterogeneous)tensor(int64): The indices, based on 0 as the first index of any dimension.

Outputs

Z(heterogeneous)T: Selected output data as an array

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32), tensor(string): The input must be a tensor of a numeric type or string. The output will be of the same tensor type.

Version

Onnx name:ArrayFeatureExtractorThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`ArrayFeatureExtractor`

### Atan¶

`mlprodict.onnxrt.ops_cpu.op_atan.Atan`

(*self*, *onnx_node*, *desc* = None, *options*)

Calculates the arctangent (inverse of tangent) of the given input tensor, element-wise.

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: The arctangent of the input tensor computed element-wise

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:AtanThis version of the operator has been available since version 7.

Runtime implementation:`Atan`

### BatchNormalization¶

`mlprodict.onnxrt.ops_cpu.op_batch_normalization.BatchNormalization`

(*self*, *onnx_node*, *desc* = None, *options*)

Carries out batch normalization as described in the paper https://arxiv.org/abs/1502.03167. Depending on the mode it is being run, there are multiple cases for the number of outputs, which we list below:

Output case #1: Y, mean, var, saved_mean, saved_var (training mode) Output case #2: Y (test mode)

For previous (depreciated) non-spatial cases, implementors are suggested to flatten the input shape to (N x C*D1*D2 ..*Dn) before a BatchNormalization Op. This operator has

optionalinputs/outputs. See ONNX for more details about the representation of optional arguments. An empty string may be used in the place of an actual argument’s name to indicate a missing argument. Trailing optional arguments (those not followed by an argument that is present) may also be simply omitted.

Attributes

epsilon: The epsilon value to use to avoid division by zero. Default value is`nameepsilonf9.999999747378752e-06typeFLOAT`

(FLOAT)

momentum: Factor used in computing the running mean and variance.e.g., running_mean = running_mean * momentum + mean * (1 - momentum). Default value is`namemomentumf0.8999999761581421typeFLOAT`

(FLOAT)

Inputs

X(heterogeneous)T: Input data tensor from the previous operator; dimensions are in the form of (N x C x D1 x D2 … Dn), where N is the batch size, C is the number of channels. Statistics are computed for every channel of C over N and D1 to Dn dimensions. For image data, input dimensions become (N x C x H x W). The op also accepts single dimension input of size N in which case C is assumed to be 1

scale(heterogeneous)T: Scale tensor of shape (C).

B(heterogeneous)T: Bias tensor of shape (C).

mean(heterogeneous)T: running (training) or estimated (testing) mean tensor of shape (C).

var(heterogeneous)T: running (training) or estimated (testing) variance tensor of shape (C).

OutputsBetween 1 and 5 outputs.

Y(heterogeneous)T: The output tensor of the same shape as X

mean(optional, heterogeneous)T: The running mean after the BatchNormalization operator.

var(optional, heterogeneous)T: The running variance after the BatchNormalization operator.

saved_mean(optional, heterogeneous)T: Saved mean used during training to speed up gradient computation.

saved_var(optional, heterogeneous)T: Saved variance used during training to speed up gradient computation.

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:BatchNormalizationThis version of the operator has been available since version 9.

Runtime implementation:`BatchNormalization`

### Binarizer¶

`mlprodict.onnxrt.ops_cpu.op_binarizer.Binarizer`

(*self*, *onnx_node*, *desc* = None, *options*)

Maps the values of the input tensor to either 0 or 1, element-wise, based on the outcome of a comparison against a threshold value.

Attributes

threshold: Values greater than this are mapped to 1, others to 0. Default value is`namethresholdf0.0typeFLOAT`

(FLOAT)

Inputs

X(heterogeneous)T: Data to be binarized

Outputs

Y(heterogeneous)T: Binarized output data

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input must be a tensor of a numeric type. The output will be of the same tensor type.

Version

Onnx name:BinarizerThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`Binarizer`

### CDist¶

`mlprodict.onnxrt.ops_cpu.op_cdist.CDist`

(*self*, *onnx_node*, *desc* = None, *options*)

Version

Onnx name:CDistThis version of the operator has been available since version of domain mlprodict.

Runtime implementation:`CDist`

### Cast¶

`mlprodict.onnxrt.ops_cpu.op_cast.Cast`

(*self*, *onnx_node*, *desc* = None, *options*)

The operator casts the elements of a given input tensor to a data type specified by the ‘to’ argument and returns an output tensor of the same size in the converted type. The ‘to’ argument must be one of the data types specified in the ‘DataType’ enum field in the TensorProto message.

Casting from string tensor in plain (e.g., “3.14” and “1000”) and scientific numeric representations (e.g., “1e-5” and “1E8”) to float types is supported. For example, converting string “100.5” to an integer may result 100. There are some string literals reserved for special floating-point values; “+INF” (and “INF”), “-INF”, and “NaN” are positive infinity, negative infinity, and not-a-number, respectively. Any string which can exactly match “+INF” in a case-insensitive way would be mapped to positive infinite. Similarly, this case-insensitive rule is applied to “INF” and “NaN”. When casting from numeric tensors to string tensors, plain floating-point representation (such as “314.15926”) would be used. Converting non-numerical-literal string such as “Hello World!” is an undefined behavior. Cases of converting string representing floating-point arithmetic value, such as “2.718”, to INT is an undefined behavior.

Conversion from a numerical type to any numerical type is always allowed. User must be aware of precision loss and value change caused by range difference between two types. For example, a 64-bit float 3.1415926459 may be round to a 32-bit float 3.141592. Similarly, converting an integer 36 to Boolean may produce 1 because we truncate bits which can’t be stored in the targeted type.

Attributes

to(required): The data type to which the elements of the input tensor are cast. Strictly must be one of the types from DataType enum in TensorProtodefault value cannot be automatically retrieved(INT)

Inputs

input(heterogeneous)T1: Input tensor to be cast.

Outputs

output(heterogeneous)T2: Output tensor with the same shape as input with type specified by the ‘to’ argument

Type Constraints

T1 tensor(float16), tensor(float), tensor(double), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(bool), tensor(string), tensor(bfloat16): Constrain input types. Casting from complex is not supported.

T2 tensor(float16), tensor(float), tensor(double), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(bool), tensor(string), tensor(bfloat16): Constrain output types. Casting to complex is not supported.

Version

Onnx name:CastThis version of the operator has been available since version 13.

Runtime implementation:`Cast`

### Ceil¶

`mlprodict.onnxrt.ops_cpu.op_ceil.Ceil`

(*self*, *onnx_node*, *desc* = None, *options*)

Ceil takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the ceil is, y = ceil(x), is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

T tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to float tensors.

Version

Onnx name:CeilThis version of the operator has been available since version 13.

Runtime implementation:`Ceil`

### Celu¶

`mlprodict.onnxrt.ops_cpu.op_celu.Celu`

(*self*, *onnx_node*, *desc* = None, *options*)

Continuously Differentiable Exponential Linear Units: Perform the linear unit element-wise on the input tensor X using formula…

### Clip_11¶

`mlprodict.onnxrt.ops_cpu.op_clip.Clip_11`

(*self*, *onnx_node*, *desc* = None, *options*)

Clip operator limits the given input within an interval. The interval is specified by the inputs ‘min’ and ‘max’. They default to numeric_limits::lowest() and numeric_limits::max(), respectively.

InputsBetween 1 and 3 inputs.

input(heterogeneous)T: Input tensor whose elements to be clipped

min(optional, heterogeneous)T: Minimum value, under which element is replaced by min. It must be a scalar(tensor of empty shape).

max(optional, heterogeneous)T: Maximum value, above which element is replaced by max. It must be a scalar(tensor of empty shape).

Outputs

output(heterogeneous)T: Output tensor with clipped input elements

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:ClipThis version of the operator has been available since version 11.

Runtime implementation:`Clip`

### Clip_6¶

`mlprodict.onnxrt.ops_cpu.op_clip.Clip_6`

(*self*, *onnx_node*, *desc* = None, *options*)

Clip operator limits the given input within an interval. The interval is specified with arguments ‘min’ and ‘max’. They default to numeric_limits::lowest() and numeric_limits::max() respectively.

Attributes

max: Maximum value, above which element is replaced by max Default value is`namemaxf3.4028234663852886e+38typeFLOAT`

(FLOAT)

min: Minimum value, under which element is replaced by min Default value is`nameminf-3.4028234663852886e+38typeFLOAT`

(FLOAT)

Inputs

input(heterogeneous)T: Input tensor whose elements to be clipped

Outputs

output(heterogeneous)T: Output tensor with clipped input elements

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:ClipThis version of the operator has been available since version 6.

Runtime implementation:`Clip`

### Concat¶

`mlprodict.onnxrt.ops_cpu.op_concat.Concat`

(*self*, *onnx_node*, *desc* = None, *options*)

Concatenate a list of tensors into a single tensor. All input tensors must have the same shape, except for the dimension size of the axis to concatenate on.

Attributes

axis(required): Which axis to concat on. A negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(inputs)..default value cannot be automatically retrieved(INT)

InputsBetween 1 and 2147483647 inputs.

inputs(variadic, heterogeneous)T: List of tensors for concatenation

Outputs

concat_result(heterogeneous)T: Concatenated tensor

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain output types to any tensor type.

Version

Onnx name:ConcatThis version of the operator has been available since version 13.

Runtime implementation:`Concat`

### ConstantOfShape¶

`mlprodict.onnxrt.ops_cpu.op_constant_of_shape.ConstantOfShape`

(*self*, *onnx_node*, *desc* = None, *options*)

Generate a tensor with given value and shape.

Attributes

value: (Optional) The value of the output elements.Should be a one-element tensor. If not specified, it defaults to a tensor of value 0 and datatype float32default value cannot be automatically retrieved(TENSOR)

Inputs

input(heterogeneous)T1: 1D tensor. The shape of the expected output tensor. If empty tensor is given, the output would be a scalar. All values must be >= 0.

Outputs

output(heterogeneous)T2: Output tensor of shape specified by ‘input’.If attribute ‘value’ is specified, the value and datatype of the output tensor is taken from ‘value’.If attribute ‘value’ is not specified, the value in the output defaults to 0, and the datatype defaults to float32.

Type Constraints

T1 tensor(int64): Constrain input types.

T2 tensor(float16), tensor(float), tensor(double), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(bool): Constrain output types to be numerics.

Version

Onnx name:ConstantOfShapeThis version of the operator has been available since version 9.

Runtime implementation:`ConstantOfShape`

### Constant_12¶

`mlprodict.onnxrt.ops_cpu.op_constant.Constant_12`

(*self*, *onnx_node*, *desc* = None, *options*)

This operator produces a constant tensor. Exactly one of the provided attributes, either value, sparse_value, or value_* must be specified.

Attributes

sparse_value: The value for the elements of the output tensor in sparse format.default value cannot be automatically retrieved(SPARSE_TENSOR)

value: The value for the elements of the output tensor.default value cannot be automatically retrieved(TENSOR)

value_float: The value for the sole element for the scalar, float32, output tensor.default value cannot be automatically retrieved(FLOAT)

value_floats: The values for the elements for the 1D, float32, output tensor.default value cannot be automatically retrieved(FLOATS)

value_int: The value for the sole element for the scalar, int64, output tensor.default value cannot be automatically retrieved(INT)

value_ints: The values for the elements for the 1D, int64, output tensor.default value cannot be automatically retrieved(INTS)

value_string: The value for the sole element for the scalar, UTF-8 string, output tensor.default value cannot be automatically retrieved(STRING)

value_strings: The values for the elements for the 1D, UTF-8 string, output tensor.default value cannot be automatically retrieved(STRINGS)

Outputs

output(heterogeneous)T: Output tensor containing the same value of the provided tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain input and output types to all tensor types.

Version

Onnx name:ConstantThis version of the operator has been available since version 12.

Runtime implementation:`Constant`

### Conv¶

`mlprodict.onnxrt.ops_cpu.op_conv.Conv`

(*self*, *onnx_node*, *desc* = None, *options*)

The convolution operator consumes an input tensor and a filter, and computes the output.

Attributes

auto_pad: auto_pad must be either NOTSET, SAME_UPPER, SAME_LOWER or VALID. Where default value is NOTSET, which means explicit padding is used. SAME_UPPER or SAME_LOWER mean pad the input so that the output spatial size match the input.In case of odd number add the extra padding at the end for SAME_UPPER and at the beginning for SAME_LOWER. VALID mean no padding. Default value is`nameautopadsNOTSETtypeSTRING`

(STRING)

dilations: dilation value along each spatial axis of the filter. If not present, the dilation defaults is 1 along each spatial axis.default value cannot be automatically retrieved(INTS)

group: number of groups input channels and output channels are divided into. Default value is`namegroupi1typeINT`

(INT)

kernel_shape: The shape of the convolution kernel. If not present, should be inferred from input W.default value cannot be automatically retrieved(INTS)

pads: Padding for the beginning and ending along each spatial axis, it can take any value greater than or equal to 0. The value represent the number of pixels added to the beginning and end part of the corresponding axis. pads format should be as follow [x1_begin, x2_begin…x1_end, x2_end,…], where xi_begin the number of pixels added at the beginning of axis i and xi_end, the number of pixels added at the end of axis i. This attribute cannot be used simultaneously with auto_pad attribute. If not present, the padding defaults to 0 along start and end of each spatial axis.default value cannot be automatically retrieved(INTS)

strides: Stride along each spatial axis. If not present, the stride defaults is 1 along each spatial axis.default value cannot be automatically retrieved(INTS)

InputsBetween 2 and 3 inputs.

X(heterogeneous)T: Input data tensor from previous layer; has size (N x C x H x W), where N is the batch size, C is the number of channels, and H and W are the height and width. Note that this is for the 2D image. Otherwise the size is (N x C x D1 x D2 … x Dn). Optionally, if dimension denotation is in effect, the operation expects input data tensor to arrive with the dimension denotation of [DATA_BATCH, DATA_CHANNEL, DATA_FEATURE, DATA_FEATURE …].

W(heterogeneous)T: The weight tensor that will be used in the convolutions; has size (M x C/group x kH x kW), where C is the number of channels, and kH and kW are the height and width of the kernel, and M is the number of feature maps. For more than 2 dimensions, the kernel shape will be (M x C/group x k1 x k2 x … x kn), where (k1 x k2 x … kn) is the dimension of the kernel. Optionally, if dimension denotation is in effect, the operation expects the weight tensor to arrive with the dimension denotation of [FILTER_OUT_CHANNEL, FILTER_IN_CHANNEL, FILTER_SPATIAL, FILTER_SPATIAL …]. X.shape[1] == (W.shape[1] * group) == C (assuming zero based indices for the shape array). Or in other words FILTER_IN_CHANNEL should be equal to DATA_CHANNEL.

B(optional, heterogeneous)T: Optional 1D bias to be added to the convolution, has size of M.

Outputs

Y(heterogeneous)T: Output data tensor that contains the result of the convolution. The output dimensions are functions of the kernel size, stride size, and pad lengths.

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:ConvThis version of the operator has been available since version 11.

Runtime implementation:`Conv`

### ConvTranspose¶

`mlprodict.onnxrt.ops_cpu.op_conv_transpose.ConvTranspose`

(*self*, *onnx_node*, *desc* = None, *options*)

The convolution transpose operator consumes an input tensor and a filter, and computes the output.

If the pads parameter is provided the shape of the output is calculated via the following equation:

output_shape[i] = stride[i] * (input_size[i] - 1) + output_padding[i] + ((kernel_shape[i] - 1) * dilations[i] + 1) - pads[start_i] - pads[end_i]

output_shape can also be explicitly specified in which case pads values are auto generated using these equations:

total_padding[i] = stride[i] * (input_size[i] - 1) + output_padding[i] + ((kernel_shape[i] - 1) * dilations[i] + 1) - output_shape[i] If (auto_pads != SAME_UPPER): pads[start_i] = total_padding[i]/2; pads[end_i] = total_padding[i] - (total_padding[i]/2) Else: pads[start_i] = total_padding[i] - (total_padding[i]/2); pads[end_i] = (total_padding[i]/2).

Attributes

auto_pad: auto_pad must be either NOTSET, SAME_UPPER, SAME_LOWER or VALID. Where default value is NOTSET, which means explicit padding is used. SAME_UPPER or SAME_LOWER mean pad the input so that the output spatial size match the input.In case of odd number add the extra padding at the end for SAME_UPPER and at the beginning for SAME_LOWER. VALID mean no padding. Default value is`nameautopadsNOTSETtypeSTRING`

(STRING)

dilations: dilation value along each spatial axis of the filter. If not present, the dilation defaults to 1 along each spatial axis.default value cannot be automatically retrieved(INTS)

group: number of groups input channels and output channels are divided into. Default value is`namegroupi1typeINT`

(INT)

kernel_shape: The shape of the convolution kernel. If not present, should be inferred from input W.default value cannot be automatically retrieved(INTS)

output_padding: Additional elements added to the side with higher coordinate indices in the output. Each padding value in “output_padding” must be less than the corresponding stride/dilation dimension. By default, this attribute is a zero vector. Note that this attribute doesn’t directly affect the computed output values. It only controls the selection of the computed values, so changing this attribute only adds or removes output elements. If “output_shape” is explicitly provided, “output_padding” does not contribute additional size to “output_shape” but participates in the computation of the needed padding amount. This is also called adjs or adjustment in some frameworks.default value cannot be automatically retrieved(INTS)

output_shape: The shape of the output can be explicitly set which will cause pads values to be auto generated. If output_shape is specified pads values are ignored. See doc for details for equations to generate padsdefault value cannot be automatically retrieved(INTS)

pads: Padding for the beginning and ending along each spatial axis, it can take any value greater than or equal to 0. The value represent the number of pixels added to the beginning and end part of the corresponding axis. pads format should be as follow [x1_begin, x2_begin…x1_end, x2_end,…], where xi_begin the number of pixels added at the beginning of axis i and xi_end, the number of pixels added at the end of axis i. This attribute cannot be used simultaneously with auto_pad attribute. If not present, the padding defaults to 0 along start and end of each spatial axis.default value cannot be automatically retrieved(INTS)

strides: Stride along each spatial axis. If not present, the stride defaults to 1 along each spatial axis.default value cannot be automatically retrieved(INTS)

InputsBetween 2 and 3 inputs.

X(heterogeneous)T: Input data tensor from previous layer; has size (N x C x H x W), where N is the batch size, C is the number of channels, and H and W are the height and width. Note that this is for the 2D image. Otherwise the size is (N x C x D1 x D2 … x Dn)

W(heterogeneous)T: The weight tensor that will be used in the convolutions; has size (C x M/group x kH x kW), where C is the number of channels, and kH and kW are the height and width of the kernel, and M is the number of feature maps. For more than 2 dimensions, the weight shape will be (C x M/group x k1 x k2 x … x kn), where (k1 x k2 x … x kn) is the dimension of the kernel. The number of channels in the output should be equal to W.shape[1] * group (assuming zero based indices of the shape array)

B(optional, heterogeneous)T: Optional 1D bias to be added to the convolution, has size of M.

Outputs

Y(heterogeneous)T: Output data tensor that contains the result of the convolution. The output dimensions are functions of the kernel size, stride size, pad lengths and group count. The number of channels in the output should be equal to W.shape[1] * group (assuming zero based indices of the shape array)

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:ConvTransposeThis version of the operator has been available since version 11.

Runtime implementation:`ConvTranspose`

### CumSum¶

`mlprodict.onnxrt.ops_cpu.op_cum_sum.CumSum`

(*self*, *onnx_node*, *desc* = None, *options*)

Performs cumulative sum of the input elements along the given axis. By default, it will do the sum inclusively meaning the first element is copied as is. Through an exclusive attribute, this behavior can change to exclude the first element. It can also perform summation in the opposite direction of the axis. For that, set reverse attribute to 1.

Example…

### DequantizeLinear¶

`mlprodict.onnxrt.ops_cpu.op_dequantize_linear.DequantizeLinear`

(*self*, *onnx_node*, *desc* = None, *options*)

The linear dequantization operator. It consumes a quantized tensor, a scale, and a zero point to compute the full precision tensor. The dequantization formula is y = (x - x_zero_point) * x_scale. ‘x_scale’ and ‘x_zero_point’ must have same shape, and can be either a scalar for per-tensor / per layer quantization, or a 1-D tensor for per-axis quantizations. ‘x_zero_point’ and ‘x’ must have same type. ‘x’ and ‘y’ must have same shape. In the case of dequantizing int32, there’s no zero point (zero point is supposed to be 0).

Attributes

axis: (Optional) The axis of the dequantizing dimension of the input tensor. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(input) Default value is`nameaxisi1typeINT`

(INT)

InputsBetween 2 and 3 inputs.

x(heterogeneous)T: N-D quantized input tensor to be de-quantized.

x_scale(heterogeneous)tensor(float): Scale for input ‘x’. It can be a scalar, which means a per-tensor/layer dequantization, or a 1-D tensor for per-axis dequantization.

x_zero_point(optional, heterogeneous)T: Zero point for input ‘x’. It can be a scalar, which means a per-tensor/layer dequantization, or a 1-D tensor for per-axis dequantization. It’s optional. 0 is the default value when it’s not specified.

Outputs

y(heterogeneous)tensor(float): N-D full precision output tensor. It has same shape as input ‘x’.

Type Constraints

T tensor(int8), tensor(uint8), tensor(int32): Constrain ‘x_zero_point’ and ‘x’ to 8-bit/32-bit integer tensor.

Version

Onnx name:DequantizeLinearThis version of the operator has been available since version 13.

Runtime implementation:`DequantizeLinear`

### DictVectorizer¶

`mlprodict.onnxrt.ops_cpu.op_dict_vectorizer.DictVectorizer`

(*self*, *onnx_node*, *desc* = None, *options*)

Uses an index mapping to convert a dictionary to an array.

Given a dictionary, each key is looked up in the vocabulary attribute corresponding to the key type. The index into the vocabulary array at which the key is found is then used to index the output 1-D tensor ‘Y’ and insert into it the value found in the dictionary ‘X’.

The key type of the input map must correspond to the element type of the defined vocabulary attribute. Therefore, the output array will be equal in length to the index mapping vector parameter. All keys in the input dictionary must be present in the index mapping vector. For each item in the input dictionary, insert its value in the output array. Any keys not present in the input dictionary, will be zero in the output array.

For example: if the

`string_vocabulary`

parameter is set to`["a", "c", "b", "z"]`

, then an input of`{"a": 4, "c": 8}`

will produce an output of`[4, 8, 0, 0]`

.

Attributes

int64_vocabulary: An integer vocabulary array. One and only one of the vocabularies must be defined.default value cannot be automatically retrieved(INTS)

string_vocabulary: A string vocabulary array. One and only one of the vocabularies must be defined.default value cannot be automatically retrieved(STRINGS)

Inputs

X(heterogeneous)T1: A dictionary.

Outputs

Y(heterogeneous)T2: A 1-D tensor holding values from the input dictionary.

Type Constraints

T1 map(string, int64), map(int64, string), map(int64, float), map(int64, double), map(string, float), map(string, double): The input must be a map from strings or integers to either strings or a numeric type. The key and value types cannot be the same.

T2 tensor(int64), tensor(float), tensor(double), tensor(string): The output will be a tensor of the value type of the input map. It’s shape will be [1,C], where C is the length of the input dictionary.

Version

Onnx name:DictVectorizerThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`DictVectorizer`

### Div¶

`mlprodict.onnxrt.ops_cpu.op_div.Div`

(*self*, *onnx_node*, *desc* = None, *options*)

Performs element-wise binary division (with Numpy-style broadcasting support).

This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First operand.

B(heterogeneous)T: Second operand.

Outputs

C(heterogeneous)T: Result, has same element type as two inputs

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to high-precision numeric tensors.

Version

Onnx name:DivThis version of the operator has been available since version 13.

Runtime implementation:`Div`

### Dropout_12¶

`mlprodict.onnxrt.ops_cpu.op_dropout.Dropout_12`

(*self*, *onnx_node*, *desc* = None, *options*)

Dropout takes an input floating-point tensor, an optional input ratio (floating-point scalar) and an optional input training_mode (boolean scalar). It produces two tensor outputs, output (floating-point tensor) and mask (optional Tensor<bool>). If training_mode is true then the output Y will be a random dropout; Note that this Dropout scales the masked input data by the following equation, so to convert the trained model into inference mode, the user can simply not pass training_mode input or set it to false.

### Dropout_7¶

`mlprodict.onnxrt.ops_cpu.op_dropout.Dropout_7`

(*self*, *onnx_node*, *desc* = None, *options*)

Dropout takes one input data (Tensor<float>) and produces two Tensor outputs, output (Tensor<float>) and mask (Tensor<bool>). Depending on whether it is in test mode or not, the output Y will either be a random dropout, or a simple copy of the input. Note that our implementation of Dropout does scaling in the training phase, so during testing nothing needs to be done. This operator has

optionalinputs/outputs. See ONNX for more details about the representation of optional arguments. An empty string may be used in the place of an actual argument’s name to indicate a missing argument. Trailing optional arguments (those not followed by an argument that is present) may also be simply omitted.

Attributes

ratio: The ratio of random dropout Default value is`nameratiof0.5typeFLOAT`

(FLOAT)

Inputs

data(heterogeneous)T: The input data as Tensor.

OutputsBetween 1 and 2 outputs.

output(heterogeneous)T: The output.

mask(optional, heterogeneous)T: The output mask.

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:DropoutThis version of the operator has been available since version 7.

Runtime implementation:`Dropout`

### Einsum¶

`mlprodict.onnxrt.ops_cpu.op_einsum.Einsum`

(*self*, *onnx_node*, *desc* = None, *options*)

An einsum of the form

``term1, term2 -> output-term``

produces an output tensor using the following equation

### Equal¶

`mlprodict.onnxrt.ops_cpu.op_equal.Equal`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the tensor resulted from performing the equal logical operation elementwise on the input tensors A and B (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First input operand for the logical operator.

B(heterogeneous)T: Second input operand for the logical operator.

Outputs

C(heterogeneous)T1: Result tensor.

Type Constraints

T tensor(bool), tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrains input types to all numeric tensors.

T1 tensor(bool): Constrains output to boolean tensor.

Version

Onnx name:EqualThis version of the operator has been available since version 13.

Runtime implementation:`Equal`

### Erf¶

`mlprodict.onnxrt.ops_cpu.op_erf.Erf`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the error function of the given input tensor element-wise.

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: The error function of the input tensor computed element-wise. It has the same shape and type of the input.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to all numeric tensors.

Version

Onnx name:ErfThis version of the operator has been available since version 13.

Runtime implementation:`Erf`

### Exp¶

`mlprodict.onnxrt.ops_cpu.op_exp.Exp`

(*self*, *onnx_node*, *desc* = None, *options*)

Calculates the exponential of the given input tensor, element-wise.

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: The exponential of the input tensor computed element-wise

Type Constraints

T tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to float tensors.

Version

Onnx name:ExpThis version of the operator has been available since version 13.

Runtime implementation:`Exp`

### EyeLike¶

`mlprodict.onnxrt.ops_cpu.op_eyelike.EyeLike`

(*self*, *onnx_node*, *desc* = None, *options*)

Generate a 2D tensor (matrix) with ones on the diagonal and zeros everywhere else. Only 2D tensors are supported, i.e. input T1 must be of rank 2. The shape of the output tensor is the same as the input tensor. The data type can be specified by the ‘dtype’ argument. If ‘dtype’ is not specified, then the type of input tensor is used. By default, the main diagonal is populated with ones, but attribute ‘k’ can be used to populate upper or lower diagonals. The ‘dtype’ argument must be one of the data types specified in the ‘DataType’ enum field in the TensorProto message and be valid as an output type.

Attributes

dtype: (Optional) The data type for the elements of the output tensor. If not specified,the data type of the input tensor T1 is used. If input tensor T1 is also notspecified, then type defaults to ‘float’.default value cannot be automatically retrieved(INT)

k: (Optional) Index of the diagonal to be populated with ones. Default is 0. If T2 is the output, this op sets T2[i, i+k] = 1. k = 0 populates the main diagonal, k > 0 populates an upper diagonal, and k < 0 populates a lower diagonal. Default value is`nameki0typeINT`

(INT)

Inputs

input(heterogeneous)T1: 2D input tensor to copy shape, and optionally, type information from.

Outputs

output(heterogeneous)T2: Output tensor, same shape as input tensor T1.

Type Constraints

T1 tensor(float16), tensor(float), tensor(double), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(bool): Constrain input types. Strings and complex are not supported.

T2 tensor(float16), tensor(float), tensor(double), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(bool): Constrain output types. Strings and complex are not supported.

Version

Onnx name:EyeLikeThis version of the operator has been available since version 9.

Runtime implementation:`EyeLike`

### Flatten¶

`mlprodict.onnxrt.ops_cpu.op_flatten.Flatten`

(*self*, *onnx_node*, *desc* = None, *options*)

Flattens the input tensor into a 2D matrix. If input tensor has shape (d_0, d_1, … d_n) then the output will have shape (d_0 X d_1 … d_(axis-1), d_axis X d_(axis+1) … X dn).

Attributes

axis: Indicate up to which input dimensions (exclusive) should be flattened to the outer dimension of the output. The value for axis must be in the range [-r, r], where r is the rank of the input tensor. Negative value means counting dimensions from the back. When axis = 0, the shape of the output tensor is (1, (d_0 X d_1 … d_n), where the shape of the input tensor is (d_0, d_1, … d_n). Default value is`nameaxisi1typeINT`

(INT)

Inputs

input(heterogeneous)T: A tensor of rank >= axis.

Outputs

output(heterogeneous)T: A 2D tensor with the contents of the input tensor, with input dimensions up to axis flattened to the outer dimension of the output and remaining input dimensions flattened into the inner dimension of the output.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain input and output to all tensor types.

Version

Onnx name:FlattenThis version of the operator has been available since version 13.

Runtime implementation:`Flatten`

### Floor¶

`mlprodict.onnxrt.ops_cpu.op_floor.Floor`

(*self*, *onnx_node*, *desc* = None, *options*)

Floor takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the floor is, y = floor(x), is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

T tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to float tensors.

Version

Onnx name:FloorThis version of the operator has been available since version 13.

Runtime implementation:`Floor`

### Gather¶

`mlprodict.onnxrt.ops_cpu.op_gather.Gather`

(*self*, *onnx_node*, *desc* = None, *options*)

Given data tensor of rank r >= 1, and indices tensor of rank q, gather entries of the axis dimension of data (by default outer-most one as axis=0) indexed by indices, and concatenates them in an output tensor of rank q + (r - 1).

axis = 0 :

Let k = indices[i_{0}, …, i_{q-1}] Then output[i_{0}, …, i_{q-1}, j_{0}, …, j_{r-2}] = input[k , j_{0}, …, j_{r-2}]

### GatherElements¶

`mlprodict.onnxrt.ops_cpu.op_gather_elements.GatherElements`

(*self*, *onnx_node*, *desc* = None, *options*)

GatherElements takes two inputs data and indices of the same rank r >= 1 and an optional attribute axis that identifies an axis of data (by default, the outer-most axis, that is axis 0). It is an indexing operation that produces its output by indexing into the input data tensor at index positions determined by elements of the indices tensor. Its output shape is the same as the shape of indices and consists of one value (gathered from the data) for each element in indices.

For instance, in the 3-D case (r = 3), the output produced is determined by the following equations…

### Gemm¶

`mlprodict.onnxrt.ops_cpu.op_gemm.Gemm`

(*self*, *onnx_node*, *desc* = None, *options*)

General Matrix multiplication: https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms#Level_3

A’ = transpose(A) if transA else A

B’ = transpose(B) if transB else B

Compute Y = alpha * A’ * B’ + beta * C, where input tensor A has shape (M, K) or (K, M), input tensor B has shape (K, N) or (N, K), input tensor C is broadcastable to shape (M, N), and output tensor Y has shape (M, N). A will be transposed before doing the computation if attribute transA is non-zero, same for B and transB. This operator supports

unidirectional broadcasting(tensor C should be unidirectional broadcastable to tensor A * B); for more details please check Broadcasting in ONNX. This operator hasoptionalinputs/outputs. See ONNX for more details about the representation of optional arguments. An empty string may be used in the place of an actual argument’s name to indicate a missing argument. Trailing optional arguments (those not followed by an argument that is present) may also be simply omitted.

Attributes

alpha: Scalar multiplier for the product of input tensors A * B. Default value is`namealphaf1.0typeFLOAT`

(FLOAT)

beta: Scalar multiplier for input tensor C. Default value is`namebetaf1.0typeFLOAT`

(FLOAT)

transA: Whether A should be transposed Default value is`nametransAi0typeINT`

(INT)

transB: Whether B should be transposed Default value is`nametransBi0typeINT`

(INT)

InputsBetween 2 and 3 inputs.

A(heterogeneous)T: Input tensor A. The shape of A should be (M, K) if transA is 0, or (K, M) if transA is non-zero.

B(heterogeneous)T: Input tensor B. The shape of B should be (K, N) if transB is 0, or (N, K) if transB is non-zero.

C(optional, heterogeneous)T: Optional input tensor C. If not specified, the computation is done as if C is a scalar 0. The shape of C should be unidirectional broadcastable to (M, N).

Outputs

Y(heterogeneous)T: Output tensor of shape (M, N).

Type Constraints

T tensor(float16), tensor(float), tensor(double), tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(bfloat16): Constrain input and output types to float/int tensors.

Version

Onnx name:GemmThis version of the operator has been available since version 13.

Runtime implementation:`Gemm`

### GlobalAveragePool¶

`mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalAveragePool`

(*self*, *onnx_node*, *desc* = None, *options*)

GlobalAveragePool consumes an input tensor X and applies average pooling across the values in the same channel. This is equivalent to AveragePool with kernel size equal to the spatial dimension of input tensor.

Inputs

X(heterogeneous)T: Input data tensor from the previous operator; dimensions for image case are (N x C x H x W), where N is the batch size, C is the number of channels, and H and W are the height and the width of the data. For non image case, the dimensions are in the form of (N x C x D1 x D2 … Dn), where N is the batch size.

Outputs

Y(heterogeneous)T: Output data tensor from pooling across the input tensor. The output tensor has the same rank as the input. The first two dimensions of output shape are the same as the input (N x C), while the other dimensions are all 1.

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:GlobalAveragePoolThis version of the operator has been available since version 1.

Runtime implementation:`GlobalAveragePool`

### Greater¶

`mlprodict.onnxrt.ops_cpu.op_greater.Greater`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the tensor resulted from performing the greater logical operation elementwise on the input tensors A and B (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First input operand for the logical operator.

B(heterogeneous)T: Second input operand for the logical operator.

Outputs

C(heterogeneous)T1: Result tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrains input types to all numeric tensors.

T1 tensor(bool): Constrains output to boolean tensor.

Version

Onnx name:GreaterThis version of the operator has been available since version 13.

Runtime implementation:`Greater`

### GreaterOrEqual¶

`mlprodict.onnxrt.ops_cpu.op_greater_or_equal.GreaterOrEqual`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the tensor resulted from performing the greater_equal logical operation elementwise on the input tensors A and B (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First input operand for the logical operator.

B(heterogeneous)T: Second input operand for the logical operator.

Outputs

C(heterogeneous)T1: Result tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrains input types to all numeric tensors.

T1 tensor(bool): Constrains output to boolean tensor.

Version

Onnx name:GreaterOrEqualThis version of the operator has been available since version 12.

Runtime implementation:`GreaterOrEqual`

### Identity¶

`mlprodict.onnxrt.ops_cpu.op_identity.Identity`

(*self*, *onnx_node*, *desc* = None, *options*)

Identity operator

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: Tensor to copy input into.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain input and output types to all tensor types.

Version

Onnx name:IdentityThis version of the operator has been available since version 13.

Runtime implementation:`Identity`

### If¶

`mlprodict.onnxrt.ops_cpu.op_if.If`

(*self*, *onnx_node*, *desc* = None, *options*)

If conditional

Attributes

else_branch(required): Graph to run if condition is false. Has N outputs: values you wish to be live-out to the enclosing scope. The number of outputs must match the number of outputs in the then_branch.default value cannot be automatically retrieved(GRAPH)

then_branch(required): Graph to run if condition is true. Has N outputs: values you wish to be live-out to the enclosing scope. The number of outputs must match the number of outputs in the else_branch.default value cannot be automatically retrieved(GRAPH)

Inputs

cond(heterogeneous)B: Condition for the if

OutputsBetween 1 and 2147483647 outputs.

outputs(variadic)V: Values that are live-out to the enclosing scope. The return values in the then_branch and else_branch must be of the same data type. The then_branch and else_branch may produce tensors with the same element type and different shapes. If corresponding outputs from the then-branch and the else-branch have static shapes S1 and S2, then the shape of the corresponding output variable of the if-node (if present) must be compatible with both S1 and S2 as it represents the union of both possible shapes.For example, if in a model file, the the first output of then_branch is typed float tensor with shape [2] and the first output of else_branch is another float tensor with shape [3], If’s first output should have (a) no shape set, or (b) a shape of rank 1 with neither dim_value nor dim_param set, or (c) a shape of rank 1 with a unique dim_param. In contrast, the first output cannot have the shape [2] since [2] and [3] are not compatible.

Type Constraints

V tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128), seq(tensor(uint8)), seq(tensor(uint16)), seq(tensor(uint32)), seq(tensor(uint64)), seq(tensor(int8)), seq(tensor(int16)), seq(tensor(int32)), seq(tensor(int64)), seq(tensor(float16)), seq(tensor(float)), seq(tensor(double)), seq(tensor(string)), seq(tensor(bool)), seq(tensor(complex64)), seq(tensor(complex128)): All Tensor and Sequence types

B tensor(bool): Only bool

Version

Onnx name:IfThis version of the operator has been available since version 13.

Runtime implementation:`If`

### Imputer¶

`mlprodict.onnxrt.ops_cpu.op_imputer.Imputer`

(*self*, *onnx_node*, *desc* = None, *options*)

Replaces inputs that equal one value with another, leaving all other elements alone.

This operator is typically used to replace missing values in situations where they have a canonical representation, such as -1, 0, NaN, or some extreme value.

One and only one of imputed_value_floats or imputed_value_int64s should be defined – floats if the input tensor holds floats, integers if the input tensor holds integers. The imputed values must all fit within the width of the tensor element type. One and only one of the replaced_value_float or replaced_value_int64 should be defined, which one depends on whether floats or integers are being processed.

The imputed_value attribute length can be 1 element, or it can have one element per input feature. In other words, if the input tensor has the shape [*,F], then the length of the attribute array may be 1 or F. If it is 1, then it is broadcast along the last dimension and applied to each feature.

Attributes

imputed_value_floats: Value(s) to change todefault value cannot be automatically retrieved(FLOATS)

imputed_value_int64s: Value(s) to change to.default value cannot be automatically retrieved(INTS)

replaced_value_float: A value that needs replacing. Default value is`namereplacedvaluefloatf0.0typeFLOAT`

(FLOAT)

replaced_value_int64: A value that needs replacing. Default value is`namereplacedvalueint64i0typeINT`

(INT)

Inputs

X(heterogeneous)T: Data to be processed.

Outputs

Y(heterogeneous)T: Imputed output data

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input type must be a tensor of a numeric type, either [N,C] or [C]. The output type will be of the same tensor type and shape.

Version

Onnx name:ImputerThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`Imputer`

### IsNaN¶

`mlprodict.onnxrt.ops_cpu.op_isnan.IsNaN`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns which elements of the input are NaN.

Inputs

X(heterogeneous)T1: input

Outputs

Y(heterogeneous)T2: output

Type Constraints

T1 tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input types to float tensors.

T2 tensor(bool): Constrain output types to boolean tensors.

Version

Onnx name:IsNaNThis version of the operator has been available since version 13.

Runtime implementation:`IsNaN`

### LabelEncoder¶

`mlprodict.onnxrt.ops_cpu.op_label_encoder.LabelEncoder`

(*self*, *onnx_node*, *desc* = None, *options*)

Maps each element in the input tensor to another value.

The mapping is determined by the two parallel attributes, ‘keys_*’ and ‘values_*’ attribute. The i-th value in the specified ‘keys_*’ attribute would be mapped to the i-th value in the specified ‘values_*’ attribute. It implies that input’s element type and the element type of the specified ‘keys_*’ should be identical while the output type is identical to the specified ‘values_*’ attribute. If an input element can not be found in the specified ‘keys_*’ attribute, the ‘default_*’ that matches the specified ‘values_*’ attribute may be used as its output value.

Let’s consider an example which maps a string tensor to an integer tensor. Assume and ‘keys_strings’ is [“Amy”, “Sally”], ‘values_int64s’ is [5, 6], and ‘default_int64’ is ‘-1’. The input [“Dori”, “Amy”, “Amy”, “Sally”, “Sally”] would be mapped to [-1, 5, 5, 6, 6].

Since this operator is an one-to-one mapping, its input and output shapes are the same. Notice that only one of ‘keys_*’/’values_*’ can be set.

For key look-up, bit-wise comparison is used so even a float NaN can be mapped to a value in ‘values_*’ attribute.

Attributes

default_float: A float. Default value is`namedefaultfloatf-0.0typeFLOAT`

(FLOAT)

default_int64: An integer. Default value is`namedefaultint64i-1typeINT`

(INT)

default_string: A string. Default value is`namedefaultstringsUnusedtypeSTRING`

(STRING)

keys_floats: A list of floats.default value cannot be automatically retrieved(FLOATS)

keys_int64s: A list of ints.default value cannot be automatically retrieved(INTS)

keys_strings: A list of strings. One and only one of ‘keys_*’s should be set.default value cannot be automatically retrieved(STRINGS)

values_floats: A list of floats.default value cannot be automatically retrieved(FLOATS)

values_int64s: A list of ints.default value cannot be automatically retrieved(INTS)

values_strings: A list of strings. One and only one of ‘value_*’s should be set.default value cannot be automatically retrieved(STRINGS)

Inputs

X(heterogeneous)T1: Input data. It can be either tensor or scalar.

Outputs

Y(heterogeneous)T2: Output data.

Type Constraints

T1 tensor(string), tensor(int64), tensor(float): The input type is a tensor of any shape.

T2 tensor(string), tensor(int64), tensor(float): Output type is determined by the specified ‘values_*’ attribute.

Version

Onnx name:LabelEncoderThis version of the operator has been available since version 2 of domain ai.onnx.ml.

Runtime implementation:`LabelEncoder`

### Less¶

`mlprodict.onnxrt.ops_cpu.op_less.Less`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the tensor resulted from performing the less logical operation elementwise on the input tensors A and B (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First input operand for the logical operator.

B(heterogeneous)T: Second input operand for the logical operator.

Outputs

C(heterogeneous)T1: Result tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrains input types to all numeric tensors.

T1 tensor(bool): Constrains output to boolean tensor.

Version

Onnx name:LessThis version of the operator has been available since version 13.

Runtime implementation:`Less`

### LinearClassifier¶

`mlprodict.onnxrt.ops_cpu.op_linear_classifier.LinearClassifier`

(*self*, *onnx_node*, *desc* = None, *options*)

Linear classifier

Attributes

classlabels_ints: Class labels when using integer labels. One and only one ‘classlabels’ attribute must be defined.default value cannot be automatically retrieved(INTS)

classlabels_strings: Class labels when using string labels. One and only one ‘classlabels’ attribute must be defined.default value cannot be automatically retrieved(STRINGS)

coefficients(required): A collection of weights of the model(s).default value cannot be automatically retrieved(FLOATS)

intercepts: A collection of intercepts.default value cannot be automatically retrieved(FLOATS)

multi_class: Indicates whether to do OvR or multinomial (0=OvR is the default). Default value is`namemulticlassi0typeINT`

(INT)

post_transform: Indicates the transform to apply to the scores vector. One of ‘NONE,’ ‘SOFTMAX,’ ‘LOGISTIC,’ ‘SOFTMAX_ZERO,’ or ‘PROBIT’ Default value is`nameposttransformsNONEtypeSTRING`

(STRING)

Inputs

X(heterogeneous)T1: Data to be classified.

Outputs

Y(heterogeneous)T2: Classification outputs (one class per example).

Z(heterogeneous)tensor(float): Classification scores ([N,E] - one score for each class and example

Type Constraints

T1 tensor(float), tensor(double), tensor(int64), tensor(int32): The input must be a tensor of a numeric type, and of of shape [N,C] or [C]. In the latter case, it will be treated as [1,C]

T2 tensor(string), tensor(int64): The output will be a tensor of strings or integers.

Version

Onnx name:LinearClassifierThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`LinearClassifier`

### LinearRegressor¶

`mlprodict.onnxrt.ops_cpu.op_linear_regressor.LinearRegressor`

(*self*, *onnx_node*, *desc* = None, *options*)

Generalized linear regression evaluation.

If targets is set to 1 (default) then univariate regression is performed.

If targets is set to M then M sets of coefficients must be passed in as a sequence and M results will be output for each input n in N.

The coefficients array is of length n, and the coefficients for each target are contiguous. Intercepts are optional but if provided must match the number of targets.

Attributes

coefficients: Weights of the model(s).default value cannot be automatically retrieved(FLOATS)

intercepts: Weights of the intercepts, if used.default value cannot be automatically retrieved(FLOATS)

post_transform: Indicates the transform to apply to the regression output vector. One of ‘NONE,’ ‘SOFTMAX,’ ‘LOGISTIC,’ ‘SOFTMAX_ZERO,’ or ‘PROBIT’ Default value is`nameposttransformsNONEtypeSTRING`

(STRING)

targets: The total number of regression targets, 1 if not defined. Default value is`nametargetsi1typeINT`

(INT)

Inputs

X(heterogeneous)T: Data to be regressed.

Outputs

Y(heterogeneous)tensor(float): Regression outputs (one per target, per example).

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input must be a tensor of a numeric type.

Version

Onnx name:LinearRegressorThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`LinearRegressor`

### Log¶

`mlprodict.onnxrt.ops_cpu.op_log.Log`

(*self*, *onnx_node*, *desc* = None, *options*)

Calculates the natural log of the given input tensor, element-wise.

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: The natural log of the input tensor computed element-wise

Type Constraints

Version

Onnx name:LogThis version of the operator has been available since version 13.

Runtime implementation:`Log`

### Loop¶

`mlprodict.onnxrt.ops_cpu.op_loop.Loop`

(*self*, *onnx_node*, *desc* = None, *options*)

Generic Looping construct. This loop has multiple termination conditions:

Trip count. Iteration count specified at runtime. Set by specifying the input M. Optional. Set to empty string to omit. Note that a static trip count (specified at graph construction time) can be specified by passing in a constant node for input M.

Loop termination condition. This is an input to the op that determines whether to run the first iteration and also a loop-carried dependency for the body graph. The body graph must yield a value for the condition variable, whether this input is provided or not.

This table summarizes the operating modes of this operator with equivalent C-style code:

Operator inputs defined as (max_trip_count, condition_var).

- input (“”, “”):

- for (int i=0; ; ++i) {
cond = … // Note this value is ignored, but is required in the body

}

- input (“”, cond) // Note this is analogous to a while loop
bool cond = …; for (int i=0; cond; ++i) {

cond = …;

}

- input (“”, 1) // Note this is analogous to a do-while loop
bool cond = true for (int i=0; cond; ++i) {

cond = …;

}

- input (trip_count, “”) // Note this is analogous to a for loop
int trip_count = … for (int i=0; i < trip_count; ++i) {

cond = …; // ignored

}

- input (trip_count, cond)
int trip_count = …; bool cond = …; for (int i=0; i < trip_count && cond; ++i) {

cond = …;

}

Sample usage - cond as well as trip count

- graph predict-net {
%a = Constant[value = <Scalar Tensor [3]>]() %b = Constant[value = <Scalar Tensor [6]>]() %keepgoing = Constant[value = <Scalar Tensor [1]>]() %max_trip_count = Constant[value = <Scalar Tensor [10]>]() %keepgoing_out, %b_out, %user_defined_vals = Loop[body = <graph body-net>](%max_trip_count, %keepgoing, %b) return

}

- graph body-net (
%i[INT32, scalar] // iteration number %keepgoing_in[BOOL, scalar] // incoming loop-termination-condition; not used %b_in[INT32, scalar] // incoming value of loop-carried-dependency b

- ) {
%my_local = Add(%a, %b_in) %b_out = Sub(%a, %b_in) // outgoing value of loop-carried-dependency b %keepgoing_out = Greater(%my_local, %b_out) // outgoing loop-termination-condition %user_defined_val = Add(%b_in, %b_in) // scan-output value to be accumulated return %keepgoing_out, %b_out, %user_defined_val

}

Sample equivalent C code

- {
/* User-defined code (enclosing scope)

/ int a = 3, b = 6; bool keepgoing = true; // Analogous to input cond /End user-defined code *//* Implicitly-defined code

/ const int max_trip_count = 10; // Analogous to input M int user_defined_vals[]; // Imagine this is resizable /End implicitly-defined code/ /initialize loop-carried variables and scan-output variables */ bool keepgoing_out = keepgoing int b_out = b

- for (int i=0; i < max_trip_count && keepgoing_out; ++i) {

- /* Implicitly-defined code: bind actual parameter values
to formal parameter variables of loop-body */

bool keepgoing_in = keepgoing_out; bool b_in = b_out;

/* User-defined code (loop body)

/ int my_local = a + b_in; // Reading value “a” from the enclosing scope is fine b_out = a - b_in; keepgoing_out = my_local > b_out; user_defined_val = b_in + b_in; // b_in and b_out are different variables /End user-defined code *//* Implicitly defined-code */ user_defined_vals[i] = user_defined_val // accumulate scan-output values

} // int t = my_local; // Can’t do this. my_local is not accessible here.

// The values below are bound to the output variables of the loop and therefore accessible // b_out; user_defined_vals; keepgoing_out;

}

There are several things of note in this code snippet:

Values from the enclosing scope (i.e. variable “a” here) are in scope and can be referenced in the inputs of the loop.

Any values computed in the loop body that needs to be used in a subsequent iteration or after the loop are modelled using a pair of variables in the loop-body, consisting of an input variable (eg., b_in) and an output variable (eg., b_out). These are referred to as loop-carried dependences. The loop operation node supplies the input value of the input variable for the first iteration, and returns the output value of the output variable produced by the final iteration.

Scan_output variables are used to implicitly concatenate values computed across all the iterations. In the above example, the value of user_defined_val computed over all iterations are concatenated and returned as the value of user_defined_vals after the loop.

Values created in the body cannot be accessed in the enclosing scope, except using the mechanism described above.

Note that the semantics of this op support “diagonal” or “wavefront” execution. (See Step 3 here for an example: https://devblogs.nvidia.com/optimizing-recurrent-neural-networks-cudnn-5/). Frontends should emit multi-layer RNNs as a series of While operators (with time being the inner looping dimension), with each successive layer consuming the scan_outputs from the previous layer, possibly going through several point-wise operators (e.g. dropout, residual connections, linear layer).

The input/output of subgraph (produced by loop node) matching is based on order instead of name. The implementation will figure out the names based on this order.

Attributes

body(required): The graph run each iteration. It has 2+N inputs: (iteration_num, condition, loop carried dependencies…). It has 1+N+K outputs: (condition, loop carried dependencies…, scan_outputs…). Each scan_output is created by concatenating the value of the specified output value at the end of each iteration of the loop. It is an error if the dimensions or data type of these scan_outputs change across loop iterations.default value cannot be automatically retrieved(GRAPH)

InputsBetween 2 and 2147483647 inputs.

M(optional, heterogeneous)I: A maximum trip-count for the loop specified at runtime. Optional. Pass empty string to skip.

cond(optional, heterogeneous)B: A boolean termination condition. Optional. Pass empty string to skip.

v_initial(variadic)V: The initial values of any loop-carried dependencies (values that change across loop iterations)

OutputsBetween 1 and 2147483647 outputs.

v_final_and_scan_outputs(variadic)V: Final N loop carried dependency values then K scan_outputs. Scan outputs must be Tensors.

Type Constraints

V tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128), seq(tensor(uint8)), seq(tensor(uint16)), seq(tensor(uint32)), seq(tensor(uint64)), seq(tensor(int8)), seq(tensor(int16)), seq(tensor(int32)), seq(tensor(int64)), seq(tensor(float16)), seq(tensor(float)), seq(tensor(double)), seq(tensor(string)), seq(tensor(bool)), seq(tensor(complex64)), seq(tensor(complex128)): All Tensor and Sequence types

I tensor(int64): tensor of int64, which should be a scalar.

B tensor(bool): tensor of bool, which should be a scalar.

Version

Onnx name:LoopThis version of the operator has been available since version 13.

Runtime implementation:`Loop`

### LpNormalization¶

`mlprodict.onnxrt.ops_cpu.op_lp_normalization.LpNormalization`

(*self*, *onnx_node*, *desc* = None, *options*)

Given a matrix, apply Lp-normalization along the provided axis.

Attributes

axis: The axis on which to apply normalization, -1 mean last axis. Default value is`nameaxisi-1typeINT`

(INT)

p: The order of the normalization, only 1 or 2 are supported. Default value is`namepi2typeINT`

(INT)

Inputs

input(heterogeneous)T: Input matrix

Outputs

output(heterogeneous)T: Matrix after normalization

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:LpNormalizationThis version of the operator has been available since version 1.

Runtime implementation:`LpNormalization`

### MatMul¶

`mlprodict.onnxrt.ops_cpu.op_matmul.MatMul`

(*self*, *onnx_node*, *desc* = None, *options*)

Matrix product that behaves like numpy.matmul: https://docs.scipy.org/doc/numpy-1.13.0/reference/generated/numpy.matmul.html

Inputs

A(heterogeneous)T: N-dimensional matrix A

B(heterogeneous)T: N-dimensional matrix B

Outputs

Y(heterogeneous)T: Matrix multiply results from A * B

Type Constraints

T tensor(float16), tensor(float), tensor(double), tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(bfloat16): Constrain input and output types to float/int tensors.

Version

Onnx name:MatMulThis version of the operator has been available since version 13.

Runtime implementation:`MatMul`

### Max¶

`mlprodict.onnxrt.ops_cpu.op_max.Max`

(*self*, *onnx_node*, *desc* = None, *options*)

Element-wise max of each of the input tensors (with Numpy-style broadcasting support). All inputs and outputs must have the same data type. This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

InputsBetween 1 and 2147483647 inputs.

data_0(variadic, heterogeneous)T: List of tensors for max.

Outputs

max(heterogeneous)T: Output tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to numeric tensors.

Version

Onnx name:MaxThis version of the operator has been available since version 13.

Runtime implementation:`Max`

### MaxPool¶

`mlprodict.onnxrt.ops_cpu.op_max_pool.MaxPool`

(*self*, *onnx_node*, *desc* = None, *options*)

MaxPool consumes an input tensor X and applies max pooling across the tensor according to kernel sizes, stride sizes, and pad lengths. max pooling consisting of computing the max on all values of a subset of the input tensor according to the kernel size and downsampling the data into the output tensor Y for further processing. The output spatial shape will be following…

### Mean¶

`mlprodict.onnxrt.ops_cpu.op_mean.Mean`

(*self*, *onnx_node*, *desc* = None, *options*)

Element-wise mean of each of the input tensors (with Numpy-style broadcasting support). All inputs and outputs must have the same data type. This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

InputsBetween 1 and 2147483647 inputs.

data_0(variadic, heterogeneous)T: List of tensors for mean.

Outputs

mean(heterogeneous)T: Output tensor.

Type Constraints

Version

Onnx name:MeanThis version of the operator has been available since version 13.

Runtime implementation:`Mean`

### Min¶

`mlprodict.onnxrt.ops_cpu.op_min.Min`

(*self*, *onnx_node*, *desc* = None, *options*)

Element-wise min of each of the input tensors (with Numpy-style broadcasting support). All inputs and outputs must have the same data type. This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

InputsBetween 1 and 2147483647 inputs.

data_0(variadic, heterogeneous)T: List of tensors for min.

Outputs

min(heterogeneous)T: Output tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to numeric tensors.

Version

Onnx name:MinThis version of the operator has been available since version 13.

Runtime implementation:`Min`

### Mul¶

`mlprodict.onnxrt.ops_cpu.op_mul.Mul`

(*self*, *onnx_node*, *desc* = None, *options*)

Performs element-wise binary multiplication (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First operand.

B(heterogeneous)T: Second operand.

Outputs

C(heterogeneous)T: Result, has same element type as two inputs

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to high-precision numeric tensors.

Version

Onnx name:MulThis version of the operator has been available since version 13.

Runtime implementation:`Mul`

### Neg¶

`mlprodict.onnxrt.ops_cpu.op_neg.Neg`

(*self*, *onnx_node*, *desc* = None, *options*)

Neg takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where each element flipped sign, y = -x, is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

T tensor(float), tensor(int32), tensor(int8), tensor(int16), tensor(int64), tensor(float16), tensor(double), tensor(bfloat16): Constrain input and output types to signed numeric tensors.

Version

Onnx name:NegThis version of the operator has been available since version 13.

Runtime implementation:`Neg`

### Normalizer¶

`mlprodict.onnxrt.ops_cpu.op_normalizer.Normalizer`

(*self*, *onnx_node*, *desc* = None, *options*)

Normalize the input. There are three normalization modes, which have the corresponding formulas, defined using element-wise infix operators ‘/’ and ‘^’ and tensor-wide functions ‘max’ and ‘sum’:

Max: Y = X / max(X)

L1: Y = X / sum(X)

L2: Y = sqrt(X^2 / sum(X^2)}

In all modes, if the divisor is zero, Y == X.

For batches, that is, [N,C] tensors, normalization is done along the C axis. In other words, each row of the batch is normalized independently.

Attributes

norm: One of ‘MAX,’ ‘L1,’ ‘L2’ Default value is`namenormsMAXtypeSTRING`

(STRING)

Inputs

X(heterogeneous)T: Data to be encoded, a tensor of shape [N,C] or [C]

Outputs

Y(heterogeneous)tensor(float): Encoded output data

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input must be a tensor of a numeric type.

Version

Onnx name:NormalizerThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`Normalizer`

### Not¶

`mlprodict.onnxrt.ops_cpu.op_not.Not`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the negation of the input tensor element-wise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

T tensor(bool): Constrains input/output to boolean tensors.

Version

Onnx name:NotThis version of the operator has been available since version 1.

Runtime implementation:`Not`

### Or¶

`mlprodict.onnxrt.ops_cpu.op_or.Or`

(*self*, *onnx_node*, *desc* = None, *options*)

Returns the tensor resulted from performing the or logical operation elementwise on the input tensors A and B (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First input operand for the logical operator.

B(heterogeneous)T: Second input operand for the logical operator.

Outputs

C(heterogeneous)T1: Result tensor.

Type Constraints

T tensor(bool): Constrains input to boolean tensor.

T1 tensor(bool): Constrains output to boolean tensor.

Version

Onnx name:OrThis version of the operator has been available since version 7.

Runtime implementation:`Or`

### Pad¶

`mlprodict.onnxrt.ops_cpu.op_pad.Pad`

(*self*, *onnx_node*, *desc* = None, *options*)

Given a tensor containing the data to be padded (data), a tensor containing the number of start and end pad values for axis (pads), (optionally) a mode, and (optionally) constant_value, a padded tensor (output) is generated.

The three supported modes are (similar to corresponding modes supported by numpy.pad):

constant`(default) - pads with a given constant value as specified by `constant_value (which defaults to 0)

reflect - pads with the reflection of the vector mirrored on the first and last values of the vector along each axis

edge - pads with the edge values of array

- Example 1 (constant mode):
Insert 0 pads to the beginning of the second dimension.

data = [

[1.0, 1.2], [2.3, 3.4], [4.5, 5.7],

]

pads = [0, 2, 0, 0]

mode = ‘constant’

constant_value = 0.0

output = [

[0.0, 0.0, 1.0, 1.2], [0.0, 0.0, 2.3, 3.4], [0.0, 0.0, 4.5, 5.7],

]

- Example 2 (reflect mode):
data = [

[1.0, 1.2], [2.3, 3.4], [4.5, 5.7],

]

pads = [0, 2, 0, 0]

mode = ‘reflect’

output = [

[1.0, 1.2, 1.0, 1.2], [2.3, 3.4, 2.3, 3.4], [4.5, 5.7, 4.5, 5.7],

]

- Example 3 (edge mode):
data = [

[1.0, 1.2], [2.3, 3.4], [4.5, 5.7],

]

pads = [0, 2, 0, 0]

mode = ‘edge’

output = [

[1.0, 1.0, 1.0, 1.2], [2.3, 2.3, 2.3, 3.4], [4.5, 4.5, 4.5, 5.7],

]

Attributes

mode: Supported modes: constant`(default), `reflect, edge Default value is`namemodesconstanttypeSTRING`

(STRING)

InputsBetween 2 and 3 inputs.

data(heterogeneous)T: Input tensor.

pads(heterogeneous)tensor(int64): Tensor of integers indicating the number of padding elements to add or remove (if negative) at the beginning and end of each axis. For 2D input tensor, it is the number of pixels. pads should be a 1D tensor of shape [2 * input_rank]. pads format should be: [x1_begin, x2_begin,…,x1_end, x2_end,…], where xi_begin is the number of pad values added at the beginning of axis i and xi_end, the number of pad values added at the end of axis i.

constant_value(optional, heterogeneous)T: (Optional) A scalar value to be used if the mode chosen is constant (by default it is 0).

Outputs

output(heterogeneous)T: Tensor after padding.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrains input and output to only numeric types.

Version

Onnx name:PadThis version of the operator has been available since version 13.

Runtime implementation:`Pad`

### Pow¶

`mlprodict.onnxrt.ops_cpu.op_pow.Pow`

(*self*, *onnx_node*, *desc* = None, *options*)

Pow takes input data (Tensor<T>) and exponent Tensor, and produces one output data (Tensor<T>) where the function f(x) = x^exponent, is applied to the data tensor elementwise. This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

X(heterogeneous)T: First operand, base of the exponent.

Y(heterogeneous)T1: Second operand, power of the exponent.

Outputs

Z(heterogeneous)T: Output tensor

Type Constraints

T tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input X and output types to float/int tensors.

T1 tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrain input Y types to float/int tensors.

Version

Onnx name:PowThis version of the operator has been available since version 13.

Runtime implementation:`Pow`

### QuantizeLinear¶

`mlprodict.onnxrt.ops_cpu.op_quantize_linear.QuantizeLinear`

(*self*, *onnx_node*, *desc* = None, *options*)

The linear quantization operator. It consumes a high precision tensor, a scale, and a zero point to compute the low precision / quantized tensor. The scale factor can be a scalar (per-tensor/layer quantization), or a 1-D tensor for per-axis quantization. The quantization formula is y = saturate ((x / y_scale) + y_zero_point). For saturation, it saturates to [0, 255] if it’s uint8, or [-128, 127] if it’s int8. For (x / y_scale), it’s rounding to nearest ties to even. Refer to https://en.wikipedia.org/wiki/Rounding for details. ‘y_zero_point’ and ‘y’ must have same type.

Attributes

axis: (Optional) The axis of the quantization dimension of the input tensor. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(input) Default value is`nameaxisi1typeINT`

(INT)

InputsBetween 2 and 3 inputs.

x(heterogeneous)T1: N-D full precision Input tensor to be quantized.

y_scale(heterogeneous)tensor(float): Scale for doing quantization to get ‘y’. It can be a scalar, which means per-tensor/layer quantization, or a 1-D Tensor for per-axis quantization.

y_zero_point(optional, heterogeneous)T2: Zero point for doing quantization to get ‘y’. It can be a scalar, which means a per-tensor/layer quantization, or a 1-D tensor for per-axis quantization. Default value is uint8 typed 0 if it’s not specified.

Outputs

y(heterogeneous)T2: N-D quantized output tensor. It has same shape as input ‘x’.

Type Constraints

T1 tensor(float), tensor(int32): Constrain ‘x’ to float or int32 tensor.

T2 tensor(int8), tensor(uint8): Constrain ‘y_zero_point’ and ‘y’ to 8-bit integer tensor.

Version

Onnx name:QuantizeLinearThis version of the operator has been available since version 13.

Runtime implementation:`QuantizeLinear`

### RNN¶

`mlprodict.onnxrt.ops_cpu.op_rnn.RNN`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes an one-layer simple RNN. This operator is usually supported via some custom implementation such as CuDNN.

Notations:

X - input tensor

i - input gate

t - time step (t-1 means previous time step)

Wi - W parameter weight matrix for input gate

Ri - R recurrence weight matrix for input gate

Wbi - W parameter bias vector for input gate

Rbi - R parameter bias vector for input gate

WBi - W parameter weight matrix for backward input gate

RBi - R recurrence weight matrix for backward input gate

WBbi - WR bias vectors for backward input gate

RBbi - RR bias vectors for backward input gate

H - Hidden state

num_directions - 2 if direction == bidirectional else 1

Activation functions:

Relu(x) - max(0, x)

Tanh(x) - (1 - e^{-2x})/(1 + e^{-2x})

Sigmoid(x) - 1/(1 + e^{-x})

(NOTE: Below are optional)

Affine(x) - alpha*x + beta

LeakyRelu(x) - x if x >= 0 else alpha * x

ThresholdedRelu(x) - x if x >= alpha else 0

ScaledTanh(x) - alpha*Tanh(beta*x)

HardSigmoid(x) - min(max(alpha*x + beta, 0), 1)

Elu(x) - x if x >= 0 else alpha*(e^x - 1)

Softsign(x) - x/(1 + |x|)

Softplus(x) - log(1 + e^x)

Equations (Default: f=Tanh):

Ht = f(Xt*(Wi^T) + Ht-1*(Ri^T) + Wbi + Rbi)

This operator has

optionalinputs/outputs. See ONNX for more details about the representation of optional arguments. An empty string may be used in the place of an actual argument’s name to indicate a missing argument. Trailing optional arguments (those not followed by an argument that is present) may also be simply omitted.

Attributes

activation_alpha: Optional scaling values used by some activation functions. The values are consumed in the order of activation functions, for example (f, g, h) in LSTM. Default values are the same as of corresponding ONNX operators.For example with LeakyRelu, the default alpha is 0.01.default value cannot be automatically retrieved(FLOATS)

activation_beta: Optional scaling values used by some activation functions. The values are consumed in the order of activation functions, for example (f, g, h) in LSTM. Default values are the same as of corresponding ONNX operators.default value cannot be automatically retrieved(FLOATS)

activations: One (or two if bidirectional) activation function for input gate. The activation function must be one of the activation functions specified above. Optional: Default Tanh if not specified. Default value is`nameactivationsstringsTanhstringsTanhtypeSTRINGS`

(STRINGS)

clip: Cell clip threshold. Clipping bounds the elements of a tensor in the range of [-threshold, +threshold] and is applied to the input of activations. No clip if not specified.default value cannot be automatically retrieved(FLOAT)

direction: Specify if the RNN is forward, reverse, or bidirectional. Must be one of forward (default), reverse, or bidirectional. Default value is`namedirectionsforwardtypeSTRING`

(STRING)

hidden_size: Number of neurons in the hidden layerdefault value cannot be automatically retrieved(INT)

InputsBetween 3 and 6 inputs.

X(heterogeneous)T: The input sequences packed (and potentially padded) into one 3-D tensor with the shape of [seq_length, batch_size, input_size].

W(heterogeneous)T: The weight tensor for input gate. Concatenation of Wi and WBi (if bidirectional). The tensor has shape [num_directions, hidden_size, input_size].

R(heterogeneous)T: The recurrence weight tensor. Concatenation of Ri and RBi (if bidirectional). The tensor has shape [num_directions, hidden_size, hidden_size].

B(optional, heterogeneous)T: The bias tensor for input gate. Concatenation of [Wbi, Rbi] and [WBbi, RBbi] (if bidirectional). The tensor has shape [num_directions, 2*hidden_size]. Optional: If not specified - assumed to be 0.

sequence_lens(optional, heterogeneous)T1: Optional tensor specifying lengths of the sequences in a batch. If not specified - assumed all sequences in the batch to have length seq_length. It has shape [batch_size].

initial_h(optional, heterogeneous)T: Optional initial value of the hidden. If not specified - assumed to be 0. It has shape [num_directions, batch_size, hidden_size].

OutputsBetween 0 and 2 outputs.

Y(optional, heterogeneous)T: A tensor that concats all the intermediate output values of the hidden. It has shape [seq_length, num_directions, batch_size, hidden_size].

Y_h(optional, heterogeneous)T: The last output value of the hidden. It has shape [num_directions, batch_size, hidden_size].

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

T1 tensor(int32): Constrain seq_lens to integer tensor.

Version

Onnx name:RNNThis version of the operator has been available since version 7.

Runtime implementation:`RNN`

### Reciprocal¶

`mlprodict.onnxrt.ops_cpu.op_reciprocal.Reciprocal`

(*self*, *onnx_node*, *desc* = None, *options*)

Reciprocal takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the reciprocal is, y = 1/x, is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

Version

Onnx name:ReciprocalThis version of the operator has been available since version 13.

Runtime implementation:`Reciprocal`

### ReduceLogSumExp¶

`mlprodict.onnxrt.ops_cpu.op_reduce_log_sum_exp.ReduceLogSumExp`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the log sum exponent of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

The above behavior is similar to numpy, with the exception that numpy default keepdims to False instead of True.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

Version

Onnx name:ReduceLogSumExpThis version of the operator has been available since version 13.

Runtime implementation:`ReduceLogSumExp`

### ReduceMax¶

`mlprodict.onnxrt.ops_cpu.op_reduce_max.ReduceMax`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the max of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

The above behavior is similar to numpy, with the exception that numpy default keepdims to False instead of True.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16), tensor(uint8), tensor(int8): Constrain input and output types to high-precision and 8 bit numeric tensors.

Version

Onnx name:ReduceMaxThis version of the operator has been available since version 13.

Runtime implementation:`ReduceMax`

### ReduceMean¶

`mlprodict.onnxrt.ops_cpu.op_reduce_mean.ReduceMean`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the mean of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

The above behavior is similar to numpy, with the exception that numpy default keepdims to False instead of True.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

Version

Onnx name:ReduceMeanThis version of the operator has been available since version 13.

Runtime implementation:`ReduceMean`

### ReduceMin¶

`mlprodict.onnxrt.ops_cpu.op_reduce_min.ReduceMin`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the min of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16), tensor(uint8), tensor(int8): Constrain input and output types to high-precision and 8 bit numeric tensors.

Version

Onnx name:ReduceMinThis version of the operator has been available since version 13.

Runtime implementation:`ReduceMin`

### ReduceProd¶

`mlprodict.onnxrt.ops_cpu.op_reduce_prod.ReduceProd`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the product of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

Version

Onnx name:ReduceProdThis version of the operator has been available since version 13.

Runtime implementation:`ReduceProd`

### ReduceSumSquare¶

`mlprodict.onnxrt.ops_cpu.op_reduce_sum_square.ReduceSumSquare`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the sum square of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

Version

Onnx name:ReduceSumSquareThis version of the operator has been available since version 13.

Runtime implementation:`ReduceSumSquare`

### ReduceSum_1¶

`mlprodict.onnxrt.ops_cpu.op_reduce_sum.ReduceSum_1`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the sum of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor.default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrain input and output types to high-precision numeric tensors.

Version

Onnx name:ReduceSumThis version of the operator has been available since version 1.

Runtime implementation:`ReduceSum`

### ReduceSum_11¶

`mlprodict.onnxrt.ops_cpu.op_reduce_sum.ReduceSum_11`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the sum of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

Attributes

axes: A list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor. Accepted range is [-r, r-1] where r = rank(data).default value cannot be automatically retrieved(INTS)

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

T tensor(uint32), tensor(uint64), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrain input and output types to high-precision numeric tensors.

Version

Onnx name:ReduceSumThis version of the operator has been available since version 11.

Runtime implementation:`ReduceSum`

### ReduceSum_13¶

`mlprodict.onnxrt.ops_cpu.op_reduce_sum.ReduceSum_13`

(*self*, *onnx_node*, *desc* = None, *options*)

Computes the sum of the input tensor’s element along the provided axes. The resulted tensor has the same rank as the input if keepdims equal 1. If keepdims equal 0, then the resulted tensor have the reduced dimension pruned.

Attributes

keepdims: Keep the reduced dimension or not, default 1 mean keep reduced dimension. Default value is`namekeepdimsi1typeINT`

(INT)

noop_with_empty_axes: Defines behaviour if ‘axes’ is empty. Default behaviour with ‘false’ is to reduce all axes. When axes is empty and this attribute is set to true, input tensor will not be reduced,and the output tensor would be equivalent to input tensor. Default value is`namenoopwithemptyaxesi0typeINT`

(INT)

InputsBetween 1 and 2 inputs.

data(heterogeneous)T: An input tensor.

axes(optional, heterogeneous)tensor(int64): Optional input list of integers, along which to reduce. The default is to reduce over all the dimensions of the input tensor if ‘noop_with_empty_axes’ is false, else act as an Identity op when ‘noop_with_empty_axes’ is true. Accepted range is [-r, r-1] where r = rank(data).

Outputs

reduced(heterogeneous)T: Reduced output tensor.

Type Constraints

Version

Onnx name:ReduceSumThis version of the operator has been available since version 13.

Runtime implementation:`ReduceSum`

### Relu¶

`mlprodict.onnxrt.ops_cpu.op_relu.Relu`

(*self*, *onnx_node*, *desc* = None, *options*)

Relu takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the rectified linear function, y = max(0, x), is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

Version

Onnx name:ReluThis version of the operator has been available since version 13.

Runtime implementation:`Relu`

### Reshape¶

`mlprodict.onnxrt.ops_cpu.op_reshape.Reshape`

(*self*, *onnx_node*, *desc* = None, *options*)

Reshape the input tensor similar to numpy.reshape. First input is the data tensor, second input is a shape tensor which specifies the output shape. It outputs the reshaped tensor. At most one dimension of the new shape can be -1. In this case, the value is inferred from the size of the tensor and the remaining dimensions. A dimension could also be 0, in which case the actual dimension value is unchanged (i.e. taken from the input tensor).

Inputs

data(heterogeneous)T: An input tensor.

shape(heterogeneous)tensor(int64): Specified shape for output.

Outputs

reshaped(heterogeneous)T: Reshaped data.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain input and output types to all tensor types.

Version

Onnx name:ReshapeThis version of the operator has been available since version 13.

Runtime implementation:`Reshape`

### SVMClassifier¶

`mlprodict.onnxrt.ops_cpu.op_svm_classifier.SVMClassifier`

(*self*, *onnx_node*, *desc* = None, *options*)

Support Vector Machine classifier

Attributes

classlabels_ints: Class labels if using integer labels. One and only one of the ‘classlabels_*’ attributes must be defined.default value cannot be automatically retrieved(INTS)

classlabels_strings: Class labels if using string labels. One and only one of the ‘classlabels_*’ attributes must be defined.default value cannot be automatically retrieved(STRINGS)

coefficients:default value cannot be automatically retrieved(FLOATS)

kernel_params: List of 3 elements containing gamma, coef0, and degree, in that order. Zero if unused for the kernel.default value cannot be automatically retrieved(FLOATS)

kernel_type: The kernel type, one of ‘LINEAR,’ ‘POLY,’ ‘RBF,’ ‘SIGMOID’. Default value is`namekerneltypesLINEARtypeSTRING`

(STRING)

post_transform: Indicates the transform to apply to the score. One of ‘NONE,’ ‘SOFTMAX,’ ‘LOGISTIC,’ ‘SOFTMAX_ZERO,’ or ‘PROBIT’ Default value is`nameposttransformsNONEtypeSTRING`

(STRING)

prob_a: First set of probability coefficients.default value cannot be automatically retrieved(FLOATS)

prob_b: Second set of probability coefficients. This array must be same size as prob_a. If these are provided then output Z are probability estimates, otherwise they are raw scores.default value cannot be automatically retrieved(FLOATS)

rho:default value cannot be automatically retrieved(FLOATS)

support_vectors:default value cannot be automatically retrieved(FLOATS)

vectors_per_class:default value cannot be automatically retrieved(INTS)

Inputs

X(heterogeneous)T1: Data to be classified.

Outputs

Y(heterogeneous)T2: Classification outputs (one class per example).

Z(heterogeneous)tensor(float): Class scores (one per class per example), if prob_a and prob_b are provided they are probabilities for each class, otherwise they are raw scores.

Type Constraints

T1 tensor(float), tensor(double), tensor(int64), tensor(int32): The input must be a tensor of a numeric type, either [C] or [N,C].

T2 tensor(string), tensor(int64): The output type will be a tensor of strings or integers, depending on which of the the classlabels_* attributes is used. Its size will match the bactch size of the input.

Version

Onnx name:SVMClassifierThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`SVMClassifier`

### SVMClassifierDouble¶

`mlprodict.onnxrt.ops_cpu.op_svm_classifier.SVMClassifierDouble`

(*self*, *onnx_node*, *desc* = None, *options*)

Version

Onnx name:SVMClassifierDoubleThis version of the operator has been available since version of domain mlprodict.

Runtime implementation:`SVMClassifierDouble`

### SVMRegressor¶

`mlprodict.onnxrt.ops_cpu.op_svm_regressor.SVMRegressor`

(*self*, *onnx_node*, *desc* = None, *options*)

Support Vector Machine regression prediction and one-class SVM anomaly detection.

Attributes

coefficients: Support vector coefficients.default value cannot be automatically retrieved(FLOATS)

kernel_params: List of 3 elements containing gamma, coef0, and degree, in that order. Zero if unused for the kernel.default value cannot be automatically retrieved(FLOATS)

kernel_type: The kernel type, one of ‘LINEAR,’ ‘POLY,’ ‘RBF,’ ‘SIGMOID’. Default value is`namekerneltypesLINEARtypeSTRING`

(STRING)

n_supports: The number of support vectors. Default value is`namensupportsi0typeINT`

(INT)

one_class: Flag indicating whether the regression is a one-class SVM or not. Default value is`nameoneclassi0typeINT`

(INT)

post_transform: Indicates the transform to apply to the score. One of ‘NONE,’ ‘SOFTMAX,’ ‘LOGISTIC,’ ‘SOFTMAX_ZERO,’ or ‘PROBIT.’ Default value is`nameposttransformsNONEtypeSTRING`

(STRING)

rho:default value cannot be automatically retrieved(FLOATS)

support_vectors: Chosen support vectorsdefault value cannot be automatically retrieved(FLOATS)

Inputs

X(heterogeneous)T: Data to be regressed.

Outputs

Y(heterogeneous)tensor(float): Regression outputs (one score per target per example).

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input type must be a tensor of a numeric type, either [C] or [N,C].

Version

Onnx name:SVMRegressorThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`SVMRegressor`

### SVMRegressorDouble¶

`mlprodict.onnxrt.ops_cpu.op_svm_regressor.SVMRegressorDouble`

(*self*, *onnx_node*, *desc* = None, *options*)

Version

Onnx name:SVMRegressorDoubleThis version of the operator has been available since version of domain mlprodict.

Runtime implementation:`SVMRegressorDouble`

### Scaler¶

`mlprodict.onnxrt.ops_cpu.op_scaler.Scaler`

(*self*, *onnx_node*, *desc* = None, *options*)

Rescale input data, for example to standardize features by removing the mean and scaling to unit variance.

Attributes

offset: First, offset by this. Can be length of features in an [N,F] tensor or length 1, in which case it applies to all features, regardless of dimension count.default value cannot be automatically retrieved(FLOATS)

scale: Second, multiply by this. Can be length of features in an [N,F] tensor or length 1, in which case it applies to all features, regardless of dimension count. Must be same length as ‘offset’default value cannot be automatically retrieved(FLOATS)

Inputs

X(heterogeneous)T: Data to be scaled.

Outputs

Y(heterogeneous)tensor(float): Scaled output data.

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input must be a tensor of a numeric type.

Version

Onnx name:ScalerThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`Scaler`

### Scan¶

`mlprodict.onnxrt.ops_cpu.op_scan.Scan`

(*self*, *onnx_node*, *desc* = None, *options*)

Scan can be used to iterate over one or more scan_input tensors, constructing zero or more scan_output tensors. It combines ideas from general recurrences, functional programming constructs such as scan, fold, map, and zip and is intended to enable generalizations of RNN-like constructs for sequence-to-sequence processing. Other tensors (referred to as state_variables here) can be used to carry a state when iterating from one element to another (similar to hidden-state in RNNs, also referred to as loop-carried dependences in the context of loops). Many common usages involve a single scan_input tensor (where functionality similar to scan, fold and map can be obtained). When more than one scan_input is used, a behavior similar to zip is obtained.

The attribute body must be a graph, specifying the computation to be performed in every iteration. It takes as input the current values of the state_variables and the current iterated element of the scan_inputs. It must return the (updated) values of the state_variables and zero or more scan_output_element tensors. The values of the scan_output_element tensors are concatenated over all the iterations to produce the scan_output values of the scan construct (similar to the concatenated intermediate hidden-state values of RNN-like constructs). All the output tensors (state_variables as well as scan_output_element tensors) are required to have the same shape in each iteration of the loop (a restriction imposed to enable efficient memory allocation).

Note that the iterated element passed to the body subgraph does not have a sequence axis. It will have a rank one less than the rank of the corresponding scan_input.

The scan operation returns the final values of the state_variables as well as the scan_outputs.

The optional attribute scan_input_directions specifies the direction (forward or backward) for each scan input. If this attribute is omitted, all sequences are scanned in the forward direction. A bidirectional scan may be performed by specifying the same tensor input twice in the scan_inputs, once with a forward direction, and once with a backward direction.

The scan_output of the operation is produced by concatenating the scan_output_element values produced by the body in each iteration. The optional attribute scan_output_directions specifies the direction in which scan_output is constructed (by appending or prepending the scan_output_element to scan_output in each iteration) for each scan_output. If this attribute is omitted, the scan_output_element is appended to the scan_output in each iteration.

The optional attribute scan_input_axes specifies the axis to be scanned for each scan_input. If omitted, every scan_input will be scanned in axis 0. For example, if axis 0 is the batch axis and axis 1 is the time axis (to be scanned), specify an axis value of 1. Note that scanning a non-zero axis may be less efficient than scanning axis zero.

The optional attribute scan_output_axes specifies the axis along which the scan_outputs are accumulated for each scan_output. For example, if axis 1 is the time axis (to be scanned) for both inputs and outputs, specify a scan_input axis and scan_output axis value of 1.

Note that because of the ONNX restriction that only the last parameter of an operator can be variadic, the initial-states and scan-inputs are listed together as one input parameter. Similarly, the final-states and scan-outputs are listed together as one output parameter. The attribute num_scan_inputs indicates the number M of scan-inputs.

The behavior of

- Scan <
num_scan_inputs = m, body = loop-body, scan_input_axes = [axis_1, …, axis_m]

> (init_1, …, init_n, scan_1, …, scan_m)

is equivalent to the following pseudo-code:

// scan_i.shape[axis_i] denotes the (max) sequence-length of scan_i // scan_i.shape[axis_i] is required to be equal to scan_j.shape[axis_j] for all i,j. sequence_length = scan_1.shape[axis_1];

// initialize state-variables st_1 = init_1; … st_n = init_n; // initialize scan-output variables: [] denotes an empty tensor scan_out_1 = []; …; scan_out_k = []; // identify number of iterations:

// execute loop for (int t = 0; t < sequence_length; ++t) {

// generate the scan-input elements: the notation T<axis=k>[t] indicates the sub-tensor // of rank one less than T obtained by indexing T at position t along axis k. si_1 = scan_1<axis=axis_1>[t]; … ; si_m = scan_m<axis=axis_m>[t]; // execute loop-body st_1, …, st_n, so_1, …, so_k = loop-body(st_1, …, st_n, si_1, …, si_m) // accumulate the scan-output elements scan_out_1 = Concat<axis=0>(scan_out_1, so_1); … ; scan_out_k = Concat<axis=0>(scan_out_k, so_k);

}

return st_1, …, st_n, scan_out_1, …, scan_out_k;

Sample usage: Encoding RNN using a ScanThe following example shows how a simple RNN over an input tensor %X, with weight tensor %Wi, recurrence weight tensor %Ri, bias tensors %Wbi and %Rbi, and initial hidden-state %H_0 can be encoded as a ScanLoop. Note that the loop-body is a nested graph, and it directly computes %Wi, %Ri, %Wbi, and %Rbi (typically constants or initializers in the body graph). If these values are computed in the outer graph, they need to be passed in as extra state_variables.

- graph rnn-encoding {
%H_0 = … %X = … %Y_h, %Y = Scan[body = <graph rnn-cell-1>, num_scan_inputs=1](%H_0, %X) return %Y, %Y_h

}

- graph rnn-cell-1 (
%H_tminus1[FLOAT, tensor] %X_t[FLOAT, tensor]

- ) {
%Wi = … %Ri = … %Wbi = … %Rbi = … %t1 = X_t * (Wi^T) %t2 = H_tminus1*(Ri^T) %t3 = Add(%t1, %t2) %t4 = Add(%t3, %Wbi) %t5 = Add(%t4, %Rbi) %Ht = Tanh(%t5) %Accumulate = Identity(%Ht) return %Ht, %Accumulate

}

Attributes

body(required): The graph run each iteration. It has N+M inputs: (loop state variables…, scan_input_elts…). It has N+K outputs: (loop state variables…, scan_output_elts…). Each scan_output is created by concatenating the value of the specified scan_output_elt value at the end of each iteration of the loop. It is an error if the dimensions of these values change across loop iterations.default value cannot be automatically retrieved(GRAPH)

num_scan_inputs(required): An attribute specifying the number of scan_inputs M.default value cannot be automatically retrieved(INT)

scan_input_axes: An optional list of M flags. The i-th element of the list specifies the axis to be scanned (the sequence axis) for the i-th scan_input. If omitted, 0 will be used as the scan axis for every scan_input. Negative value for an axis means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(input).default value cannot be automatically retrieved(INTS)

scan_input_directions: An optional list of M flags. The i-th element of the list specifies the direction to be scanned for the i-th scan_input tensor: 0 indicates forward direction and 1 indicates reverse direction. If omitted, all scan_input tensors will be scanned in the forward direction.default value cannot be automatically retrieved(INTS)

scan_output_axes: An optional list of K flags. The i-th element of the list specifies the axis for the i-th scan_output. The scan outputs are accumulated along the specified axis. If omitted, 0 will be used as the scan axis for every scan_output. Negative value for an axis means counting dimensions from the back. Accepted range is [-r, r-1].default value cannot be automatically retrieved(INTS)

scan_output_directions: An optional list of K flags, one for each scan_output. The i-th element of the list specifies whether the i-th scan_output should be constructed by appending or prepending a new value in each iteration: 0 indicates appending and 1 indicates prepending. If omitted, all scan_output tensors will be produced by appending a value in each iteration.default value cannot be automatically retrieved(INTS)

InputsBetween 1 and 2147483647 inputs.

initial_state_and_scan_inputs(variadic)V: Initial values of the loop’s N state variables followed by M scan_inputs

OutputsBetween 1 and 2147483647 outputs.

final_state_and_scan_outputs(variadic)V: Final values of the loop’s N state variables followed by K scan_outputs

Type Constraints

I tensor(int64): Int64 tensor

V tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): All Tensor types

Version

Onnx name:ScanThis version of the operator has been available since version 11.

Runtime implementation:`Scan`

### Shape¶

`mlprodict.onnxrt.ops_cpu.op_shape.Shape`

(*self*, *onnx_node*, *desc* = None, *options*)

Takes a tensor as input and outputs an 1D int64 tensor containing the shape of the input tensor.

Inputs

data(heterogeneous)T: An input tensor.

Outputs

shape(heterogeneous)T1: Shape of the input tensor

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Input tensor can be of arbitrary type.

T1 tensor(int64): Constrain output to int64 tensor.

Version

Onnx name:ShapeThis version of the operator has been available since version 13.

Runtime implementation:`Shape`

### Sigmoid¶

`mlprodict.onnxrt.ops_cpu.op_sigmoid.Sigmoid`

(*self*, *onnx_node*, *desc* = None, *options*)

Sigmoid takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the sigmoid function, y = 1 / (1 + exp(-x)), is applied to the tensor elementwise.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

Version

Onnx name:SigmoidThis version of the operator has been available since version 13.

Runtime implementation:`Sigmoid`

### Sign¶

`mlprodict.onnxrt.ops_cpu.op_sign.Sign`

(*self*, *onnx_node*, *desc* = None, *options*)

Calculate the sign of the given input tensor element-wise. If input > 0, output 1. if input < 0, output -1. if input == 0, output 0.

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: The sign of the input tensor computed element-wise. It has the same shape and type of the input.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(bfloat16): Constrain input and output types to all numeric tensors.

Version

Onnx name:SignThis version of the operator has been available since version 13.

Runtime implementation:`Sign`

### Sin¶

`mlprodict.onnxrt.ops_cpu.op_sin.Sin`

(*self*, *onnx_node*, *desc* = None, *options*)

Calculates the sine of the given input tensor, element-wise.

Inputs

input(heterogeneous)T: Input tensor

Outputs

output(heterogeneous)T: The sine of the input tensor computed element-wise

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

Version

Onnx name:SinThis version of the operator has been available since version 7.

Runtime implementation:`Sin`

### Slice¶

`mlprodict.onnxrt.ops_cpu.op_slice.Slice`

(*self*, *onnx_node*, *desc* = None, *options*)

Produces a slice of the input tensor along multiple axes. Similar to numpy: https://docs.scipy.org/doc/numpy/reference/arrays.indexing.html Slices uses starts, ends, axes and steps inputs to specify the start and end dimension and step for each axis in the list of axes, it uses this information to slice the input data tensor. If a negative value is passed for any of the start or end indices, it represents number of elements before the end of that dimension. If the value passed to start or end is larger than the n (the number of elements in this dimension), it represents n. For slicing to the end of a dimension with unknown size, it is recommended to pass in INT_MAX when sclicing forward and ‘INT_MIN’ when slicing backward. If a negative value is passed for step, it represents slicing backward. However step value cannot be 0. If axes are omitted, they are set to [0, …, ndim-1]. If steps are omitted, they are set to [1, …, 1] of length len(starts) Example 1:

- data = [
[1, 2, 3, 4], [5, 6, 7, 8],

] axes = [0, 1] starts = [1, 0] ends = [2, 3] steps = [1, 2] result = [

[5, 7],

]

- Example 2:

- data = [
[1, 2, 3, 4], [5, 6, 7, 8],

] starts = [0, 1] ends = [-1, 1000] result = [

[2, 3, 4],

]

InputsBetween 3 and 5 inputs.

data(heterogeneous)T: Tensor of data to extract slices from.

starts(heterogeneous)Tind: 1-D tensor of starting indices of corresponding axis in axes

ends(heterogeneous)Tind: 1-D tensor of ending indices (exclusive) of corresponding axis in axes

axes(optional, heterogeneous)Tind: 1-D tensor of axes that starts and ends apply to. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(data).

steps(optional, heterogeneous)Tind: 1-D tensor of slice step of corresponding axis in axes. Negative value means slicing backward. ‘steps’ cannot be 0. Defaults to 1.

Outputs

output(heterogeneous)T: Sliced data tensor.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(bfloat16), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain input and output types to all tensor types.

Tind tensor(int32), tensor(int64): Constrain indices to integer types

Version

Onnx name:SliceThis version of the operator has been available since version 13.

Runtime implementation:`Slice`

### Softmax¶

`mlprodict.onnxrt.ops_cpu.op_softmax.Softmax`

(*self*, *onnx_node*, *desc* = None, *options*)

The operator computes the normalized exponential values for the given input:

Softmax(input, axis) = Exp(input) / ReduceSum(Exp(input), axis=axis, keepdims=1)

The input does not need to explicitly be a 2D vector. The “axis” attribute indicates the dimension along which Softmax will be performed. The output tensor has the same shape and contains the Softmax values of the corresponding input.

Attributes

axis:Describes the dimension Softmax will be performed on. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(input).,

Default value is

`nameaxisi-1typeINT`

(INT)

Inputs

input(heterogeneous)T: The input tensor that’s coerced into a 2D matrix of size (NxD) as described above.

Outputs

output(heterogeneous)T: The output values with the same shape as input tensor (the original size without coercion).

Type Constraints

Version

Onnx name:SoftmaxThis version of the operator has been available since version 13.

Runtime implementation:`Softmax`

### Sqrt¶

`mlprodict.onnxrt.ops_cpu.op_sqrt.Sqrt`

(*self*, *onnx_node*, *desc* = None, *options*)

Square root takes one input data (Tensor<T>) and produces one output data (Tensor<T>) where the square root is, y = x^0.5, is applied to the tensor elementwise. If x is negative, then it will return NaN.

Inputs

X(heterogeneous)T: Input tensor

Outputs

Y(heterogeneous)T: Output tensor

Type Constraints

Version

Onnx name:SqrtThis version of the operator has been available since version 13.

Runtime implementation:`Sqrt`

### Squeeze¶

`mlprodict.onnxrt.ops_cpu.op_squeeze.Squeeze`

(*self*, *onnx_node*, *desc* = None, *options*)

Remove single-dimensional entries from the shape of a tensor. Takes an input axes with a list of axes to squeeze. If axes is not provided, all the single dimensions will be removed from the shape. If an axis is selected with shape entry not equal to one, an error is raised.

InputsBetween 1 and 2 inputs.

data(heterogeneous)T: Tensors with at least max(dims) dimensions.

axes(optional, heterogeneous)tensor(int64): List of integers indicating the dimensions to squeeze. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(data).

Outputs

squeezed(heterogeneous)T: Reshaped tensor with same data as input.

Type Constraints

Version

Onnx name:SqueezeThis version of the operator has been available since version 13.

Runtime implementation:`Squeeze`

### Sub¶

`mlprodict.onnxrt.ops_cpu.op_sub.Sub`

(*self*, *onnx_node*, *desc* = None, *options*)

Performs element-wise binary subtraction (with Numpy-style broadcasting support).

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

Inputs

A(heterogeneous)T: First operand.

B(heterogeneous)T: Second operand.

Outputs

C(heterogeneous)T: Result, has same element type as two inputs

Type Constraints

Version

Onnx name:SubThis version of the operator has been available since version 13.

Runtime implementation:`Sub`

### Sum¶

`mlprodict.onnxrt.ops_cpu.op_sum.Sum`

(*self*, *onnx_node*, *desc* = None, *options*)

Element-wise sum of each of the input tensors (with Numpy-style broadcasting support). All inputs and outputs must have the same data type. This operator supports

multidirectional (i.e., Numpy-style) broadcasting; for more details please check Broadcasting in ONNX.

InputsBetween 1 and 2147483647 inputs.

data_0(variadic, heterogeneous)T: List of tensors for sum.

Outputs

sum(heterogeneous)T: Output tensor.

Type Constraints

Version

Onnx name:SumThis version of the operator has been available since version 13.

Runtime implementation:`Sum`

### TfIdfVectorizer¶

`mlprodict.onnxrt.ops_cpu.op_tfidfvectorizer.TfIdfVectorizer`

(*self*, *onnx_node*, *desc* = None, *options*)

This transform extracts n-grams from the input sequence and save them as a vector. Input can be either a 1-D or 2-D tensor. For 1-D input, output is the n-gram representation of that input. For 2-D input, the output is also a 2-D tensor whose i-th row is the n-gram representation of the i-th input row. More specifically, if input shape is [C], the corresponding output shape would be [max(ngram_indexes) + 1]. If input shape is [N, C], this operator produces a [N, max(ngram_indexes) + 1]-tensor.

In contrast to standard n-gram extraction, here, the indexes of extracting an n-gram from the original sequence are not necessarily consecutive numbers. The discontinuity between indexes are controlled by the number of skips. If the number of skips is 2, we should skip two tokens when scanning through the original sequence. Let’s consider an example. Assume that input sequence is [94, 17, 36, 12, 28] and the number of skips is 2. The associated 2-grams are [94, 12] and [17, 28] respectively indexed by [0, 3] and [1, 4]. If the number of skips becomes 0, the 2-grams generated are [94, 17], [17, 36], [36, 12], [12, 28] indexed by [0, 1], [1, 2], [2, 3], [3, 4], respectively.

The output vector (denoted by Y) stores the count of each n-gram; Y[ngram_indexes[i]] indicates the times that the i-th n-gram is found. The attribute ngram_indexes is used to determine the mapping between index i and the corresponding n-gram’s output coordinate. If pool_int64s is [94, 17, 17, 36], ngram_indexes is [1, 0], ngram_counts=[0, 0], then the Y[0] (first element in Y) and Y[1] (second element in Y) are the counts of [17, 36] and [94, 17], respectively. An n-gram which cannot be found in pool_strings/pool_int64s should be ignored and has no effect on the output. Note that we may consider all skips up to S when generating the n-grams.

The examples used above are true if mode is “TF”. If mode is “IDF”, all the counts larger than 1 would be truncated to 1 and the i-th element in weights would be used to scale (by multiplication) the count of the i-th n-gram in pool. If mode is “TFIDF”, this operator first computes the counts of all n-grams and then scale them by the associated values in the weights attribute.

Only one of pool_strings and pool_int64s can be set. If pool_int64s is set, the input should be an integer tensor. If pool_strings is set, the input must be a string tensor.

Attributes

max_gram_length(required): Maximum n-gram length. If this value is 3, 3-grams will be used to generate the output.default value cannot be automatically retrieved(INT)

max_skip_count(required): Maximum number of items (integers/strings) to be skipped when constructing an n-gram from X. If max_skip_count=1, min_gram_length=2, max_gram_length=3, this operator may generate 2-grams with skip_count=0 and skip_count=1, and 3-grams with skip_count=0 and skip_count=1default value cannot be automatically retrieved(INT)

min_gram_length(required): Minimum n-gram length. If this value is 2 and max_gram_length is 3, output may contain counts of 2-grams and 3-grams.default value cannot be automatically retrieved(INT)

mode(required): The weighting criteria. It can be one of “TF” (term frequency), “IDF” (inverse document frequency), and “TFIDF” (the combination of TF and IDF)default value cannot be automatically retrieved(STRING)

ngram_counts(required): The starting indexes of 1-grams, 2-grams, and so on in pool. It is useful when determining the boundary between two consecutive collections of n-grams. For example, if ngram_counts is [0, 17, 36], the first index (zero-based) of 1-gram/2-gram/3-gram in pool are 0/17/36. This format is essentially identical to CSR (or CSC) sparse matrix format, and we choose to use this due to its popularity.default value cannot be automatically retrieved(INTS)

ngram_indexes(required): list of int64s (type: AttributeProto::INTS). This list is parallel to the specified ‘pool_*’ attribute. The i-th element in ngram_indexes indicate the coordinate of the i-th n-gram in the output tensor.default value cannot be automatically retrieved(INTS)

pool_int64s: List of int64 n-grams learned from the training set. Either this or pool_strings attributes must be present but not both. It’s an 1-D tensor starting with the collections of all 1-grams and ending with the collections of n-grams. The i-th element in pool stores the n-gram that should be mapped to coordinate ngram_indexes[i] in the output vector.default value cannot be automatically retrieved(INTS)

pool_strings: List of strings n-grams learned from the training set. Either this or pool_int64s attributes must be present but not both. It’s an 1-D tensor starting with the collections of all 1-grams and ending with the collections of n-grams. The i-th element in pool stores the n-gram that should be mapped to coordinate ngram_indexes[i] in the output vector.default value cannot be automatically retrieved(STRINGS)

weights: list of floats. This attribute stores the weight of each n-gram in pool. The i-th element in weights is the weight of the i-th n-gram in pool. Its length equals to the size of ngram_indexes. By default, weights is an all-one tensor.This attribute is used when mode is “IDF” or “TFIDF” to scale the associated word counts.default value cannot be automatically retrieved(FLOATS)

Inputs

X(heterogeneous)T: Input for n-gram extraction

Outputs

Y(heterogeneous)T1: Ngram results

Type Constraints

T tensor(string), tensor(int32), tensor(int64): Input is ether string UTF-8 or int32/int64

T1 tensor(float): 1-D tensor of floats

Version

Onnx name:TfIdfVectorizerThis version of the operator has been available since version 9.

Runtime implementation:`TfIdfVectorizer`

### TopK_1¶

`mlprodict.onnxrt.ops_cpu.op_topk.TopK_1`

(*self*, *onnx_node*, *desc* = None, *options*)

Retrieve the top-K elements along a specified axis. Given an input tensor of shape [a_1, a_2, …, a_n, r] and integer argument k, return two outputs:

- -Value tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n]
which contains the values of the top k elements along the specified axis

- -Index tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] which
contains the indices of the top k elements (original indices from the input tensor).

- Given two equivalent values, this operator uses the indices along the axis as
a tiebreaker. That is, the element with the lower index will appear first.

Attributes

axis: Dimension on which to do the sort. Default value is`nameaxisi-1typeINT`

(INT)

k(required): Number of top elements to retrievedefault value cannot be automatically retrieved(INT)

Inputs

X(heterogeneous)T: Tensor of shape [a_1, a_2, …, a_n, r]

Outputs

Values(heterogeneous)T: Tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] containing top K values from the input tensor

Indices(heterogeneous)I: Tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] containing the corresponding input tensor indices for the top K values.

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

I tensor(int64): Constrain index tensor to int64

Version

Onnx name:TopKThis version of the operator has been available since version 1.

Runtime implementation:`TopK`

### TopK_10¶

`mlprodict.onnxrt.ops_cpu.op_topk.TopK_10`

(*self*, *onnx_node*, *desc* = None, *options*)

Retrieve the top-K elements along a specified axis. Given an input tensor of shape [a_1, a_2, …, a_n, r] and integer argument k, return two outputs:

- -Value tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n]
which contains the values of the top k elements along the specified axis

- -Index tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] which
contains the indices of the top k elements (original indices from the input tensor).

- Given two equivalent values, this operator uses the indices along the axis as
a tiebreaker. That is, the element with the lower index will appear first.

Attributes

axis: Dimension on which to do the sort. Default value is`nameaxisi-1typeINT`

(INT)

Inputs

X(heterogeneous)T: Tensor of shape [a_1, a_2, …, a_n, r]

K(heterogeneous)tensor(int64): A 1-D tensor containing a single positive value corresponding to the number of top elements to retrieve

Outputs

Values(heterogeneous)T: Tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] containing top K values from the input tensor

Indices(heterogeneous)I: Tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] containing the corresponding input tensor indices for the top K values.

Type Constraints

T tensor(float16), tensor(float), tensor(double): Constrain input and output types to float tensors.

I tensor(int64): Constrain index tensor to int64

Version

Onnx name:TopKThis version of the operator has been available since version 10.

Runtime implementation:`TopK`

### TopK_11¶

`mlprodict.onnxrt.ops_cpu.op_topk.TopK_11`

(*self*, *onnx_node*, *desc* = None, *options*)

Retrieve the top-K largest or smallest elements along a specified axis. Given an input tensor of shape [a_1, a_2, …, a_n, r] and integer argument k, return two outputs:

- -Value tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n]
which contains the values of the top k elements along the specified axis

- -Index tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] which
contains the indices of the top k elements (original indices from the input tensor).

If “largest” is 1 (the default value) then the k largest elements are returned. If “sorted” is 1 (the default value) then the resulting k elements will be sorted. If “sorted” is 0, order of returned ‘Values’ and ‘Indices’ are undefined.

- Given two equivalent values, this operator uses the indices along the axis as
a tiebreaker. That is, the element with the lower index will appear first.

Attributes

axis: Dimension on which to do the sort. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(input). Default value is`nameaxisi-1typeINT`

(INT)

largest: Whether to return the top-K largest or smallest elements. Default value is`namelargesti1typeINT`

(INT)

sorted: Whether to return the elements in sorted order. Default value is`namesortedi1typeINT`

(INT)

Inputs

X(heterogeneous)T: Tensor of shape [a_1, a_2, …, a_n, r]

K(heterogeneous)tensor(int64): A 1-D tensor containing a single positive value corresponding to the number of top elements to retrieve

Outputs

Values(heterogeneous)T: Tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] containing top K values from the input tensor

Indices(heterogeneous)I: Tensor of shape [a_1, a_2, …, a_{axis-1}, k, a_{axis+1}, … a_n] containing the corresponding input tensor indices for the top K values.

Type Constraints

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double): Constrain input and output types to numeric tensors.

I tensor(int64): Constrain index tensor to int64

Version

Onnx name:TopKThis version of the operator has been available since version 11.

Runtime implementation:`TopK`

### Transpose¶

`mlprodict.onnxrt.ops_cpu.op_transpose.Transpose`

(*self*, *onnx_node*, *desc* = None, *options*)

Transpose the input tensor similar to numpy.transpose. For example, when perm=(1, 0, 2), given an input tensor of shape (1, 2, 3), the output shape will be (2, 1, 3).

Attributes

perm: A list of integers. By default, reverse the dimensions, otherwise permute the axes according to the values given.default value cannot be automatically retrieved(INTS)

Inputs

data(heterogeneous)T: An input tensor.

Outputs

transposed(heterogeneous)T: Transposed output.

Type Constraints

Version

Onnx name:TransposeThis version of the operator has been available since version 13.

Runtime implementation:`Transpose`

### TreeEnsembleClassifier¶

`mlprodict.onnxrt.ops_cpu.op_tree_ensemble_classifier.TreeEnsembleClassifier`

(*self*, *onnx_node*, *desc* = None, *options*)

Tree Ensemble classifier. Returns the top class for each of N inputs.

The attributes named ‘nodes_X’ form a sequence of tuples, associated by index into the sequences, which must all be of equal length. These tuples define the nodes.

Similarly, all fields prefixed with ‘class_’ are tuples of votes at the leaves. A leaf may have multiple votes, where each vote is weighted by the associated class_weights index.

One and only one of classlabels_strings or classlabels_int64s will be defined. The class_ids are indices into this list.

Attributes

base_values: Base values for classification, added to final class score; the size must be the same as the classes or can be left unassigned (assumed 0)default value cannot be automatically retrieved(FLOATS)

class_ids: The index of the class list that each weight is for.default value cannot be automatically retrieved(INTS)

class_nodeids: node id that this weight is for.default value cannot be automatically retrieved(INTS)

class_treeids: The id of the tree that this node is in.default value cannot be automatically retrieved(INTS)

class_weights: The weight for the class in class_id.default value cannot be automatically retrieved(FLOATS)

classlabels_int64s: Class labels if using integer labels. One and only one of the ‘classlabels_*’ attributes must be defined.default value cannot be automatically retrieved(INTS)

classlabels_strings: Class labels if using string labels. One and only one of the ‘classlabels_*’ attributes must be defined.default value cannot be automatically retrieved(STRINGS)

nodes_falsenodeids: Child node if expression is false.default value cannot be automatically retrieved(INTS)

nodes_featureids: Feature id for each node.default value cannot be automatically retrieved(INTS)

nodes_hitrates: Popularity of each node, used for performance and may be omitted.default value cannot be automatically retrieved(FLOATS)

nodes_missing_value_tracks_true: For each node, define what to do in the presence of a missing value: if a value is missing (NaN), use the ‘true’ or ‘false’ branch based on the value in this array. This attribute may be left undefined, and the defalt value is false (0) for all nodes.default value cannot be automatically retrieved(INTS)

nodes_modes: The node kind, that is, the comparison to make at the node. There is no comparison to make at a leaf node. One of ‘BRANCH_LEQ’, ‘BRANCH_LT’, ‘BRANCH_GTE’, ‘BRANCH_GT’, ‘BRANCH_EQ’, ‘BRANCH_NEQ’, ‘LEAF’default value cannot be automatically retrieved(STRINGS)

nodes_nodeids: Node id for each node. Ids may restart at zero for each tree, but it not required to.default value cannot be automatically retrieved(INTS)

nodes_treeids: Tree id for each node.default value cannot be automatically retrieved(INTS)

nodes_truenodeids: Child node if expression is true.default value cannot be automatically retrieved(INTS)

nodes_values: Thresholds to do the splitting on for each node.default value cannot be automatically retrieved(FLOATS)

post_transform: Indicates the transform to apply to the score. One of ‘NONE,’ ‘SOFTMAX,’ ‘LOGISTIC,’ ‘SOFTMAX_ZERO,’ or ‘PROBIT.’ Default value is`nameposttransformsNONEtypeSTRING`

(STRING)

Inputs

X(heterogeneous)T1: Input of shape [N,F]

Outputs

Y(heterogeneous)T2: N, Top class for each point

Z(heterogeneous)tensor(float): The class score for each class, for each point, a tensor of shape [N,E].

Type Constraints

T1 tensor(float), tensor(double), tensor(int64), tensor(int32): The input type must be a tensor of a numeric type.

T2 tensor(string), tensor(int64): The output type will be a tensor of strings or integers, depending on which of the the classlabels_* attributes is used.

Version

Onnx name:TreeEnsembleClassifierThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`TreeEnsembleClassifier`

### TreeEnsembleClassifierDouble¶

`mlprodict.onnxrt.ops_cpu.op_tree_ensemble_classifier.TreeEnsembleClassifierDouble`

(*self*, *onnx_node*, *desc* = None, *options*)

Version

Onnx name:TreeEnsembleClassifierDoubleThis version of the operator has been available since version of domain mlprodict.

Runtime implementation:`TreeEnsembleClassifierDouble`

### TreeEnsembleRegressor¶

`mlprodict.onnxrt.ops_cpu.op_tree_ensemble_regressor.TreeEnsembleRegressor`

(*self*, *onnx_node*, *desc* = None, *runtime_version* = 1, *options*)

Tree Ensemble regressor. Returns the regressed values for each input in N.

All args with nodes_ are fields of a tuple of tree nodes, and it is assumed they are the same length, and an index i will decode the tuple across these inputs. Each node id can appear only once for each tree id.

All fields prefixed with target_ are tuples of votes at the leaves.

A leaf may have multiple votes, where each vote is weighted by the associated target_weights index.

All trees must have their node ids start at 0 and increment by 1.

Mode enum is BRANCH_LEQ, BRANCH_LT, BRANCH_GTE, BRANCH_GT, BRANCH_EQ, BRANCH_NEQ, LEAF

Attributes

aggregate_function: Defines how to aggregate leaf values within a target. One of ‘AVERAGE,’ ‘SUM,’ ‘MIN,’ ‘MAX.’ Default value is`nameaggregatefunctionsSUMtypeSTRING`

(STRING)

base_values: Base values for classification, added to final class score; the size must be the same as the classes or can be left unassigned (assumed 0)default value cannot be automatically retrieved(FLOATS)

n_targets: The total number of targets.default value cannot be automatically retrieved(INT)

nodes_falsenodeids: Child node if expression is falsedefault value cannot be automatically retrieved(INTS)

nodes_featureids: Feature id for each node.default value cannot be automatically retrieved(INTS)

nodes_hitrates: Popularity of each node, used for performance and may be omitted.default value cannot be automatically retrieved(FLOATS)

nodes_missing_value_tracks_true: For each node, define what to do in the presence of a NaN: use the ‘true’ (if the attribute value is 1) or ‘false’ (if the attribute value is 0) branch based on the value in this array. This attribute may be left undefined and the defalt value is false (0) for all nodes.default value cannot be automatically retrieved(INTS)

nodes_modes: The node kind, that is, the comparison to make at the node. There is no comparison to make at a leaf node. One of ‘BRANCH_LEQ’, ‘BRANCH_LT’, ‘BRANCH_GTE’, ‘BRANCH_GT’, ‘BRANCH_EQ’, ‘BRANCH_NEQ’, ‘LEAF’default value cannot be automatically retrieved(STRINGS)

nodes_nodeids: Node id for each node. Node ids must restart at zero for each tree and increase sequentially.default value cannot be automatically retrieved(INTS)

nodes_treeids: Tree id for each node.default value cannot be automatically retrieved(INTS)

nodes_truenodeids: Child node if expression is truedefault value cannot be automatically retrieved(INTS)

nodes_values: Thresholds to do the splitting on for each node.default value cannot be automatically retrieved(FLOATS)

post_transform: Indicates the transform to apply to the score. One of ‘NONE,’ ‘SOFTMAX,’ ‘LOGISTIC,’ ‘SOFTMAX_ZERO,’ or ‘PROBIT’ Default value is`nameposttransformsNONEtypeSTRING`

(STRING)

target_ids: The index of the target that each weight is fordefault value cannot be automatically retrieved(INTS)

target_nodeids: The node id of each weightdefault value cannot be automatically retrieved(INTS)

target_treeids: The id of the tree that each node is in.default value cannot be automatically retrieved(INTS)

target_weights: The weight for each targetdefault value cannot be automatically retrieved(FLOATS)

Inputs

X(heterogeneous)T: Input of shape [N,F]

Outputs

Y(heterogeneous)tensor(float): N classes

Type Constraints

T tensor(float), tensor(double), tensor(int64), tensor(int32): The input type must be a tensor of a numeric type.

Version

Onnx name:TreeEnsembleRegressorThis version of the operator has been available since version 1 of domain ai.onnx.ml.

Runtime implementation:`TreeEnsembleRegressor`

### TreeEnsembleRegressorDouble¶

`mlprodict.onnxrt.ops_cpu.op_tree_ensemble_regressor.TreeEnsembleRegressorDouble`

(*self*, *onnx_node*, *desc* = None, *runtime_version* = 1, *options*)

Version

Onnx name:TreeEnsembleRegressorDoubleThis version of the operator has been available since version of domain mlprodict.

Runtime implementation:`TreeEnsembleRegressorDouble`

### Unsqueeze¶

`mlprodict.onnxrt.ops_cpu.op_unsqueeze.Unsqueeze`

(*self*, *onnx_node*, *desc* = None, *options*)

Insert single-dimensional entries to the shape of an input tensor (data). Takes one required input axes - which contains a list of dimension indices and this operator will insert a dimension of value 1 into the corresponding index of the output tensor (expanded).

- For example:
Given an input tensor (data) of shape [3, 4, 5], then Unsqueeze(data, axes=[0, 4]) outputs a tensor (expanded) containing same data as data but with shape [1, 3, 4, 5, 1].

The input axes should not contain any duplicate entries. It is an error if it contains duplicates. The rank of the output tensor (output_rank) is the rank of the input tensor (data) plus the number of values in axes. Each value in axes should be within the (inclusive) range [-output_rank , output_rank - 1]. The order of values in axes does not matter and can come in any order.

Inputs

data(heterogeneous)T: Original tensor

axes(heterogeneous)tensor(int64): List of integers indicating the dimensions to be inserted. Negative value means counting dimensions from the back. Accepted range is [-r, r-1] where r = rank(expanded).

Outputs

expanded(heterogeneous)T: Reshaped tensor with same data as input.

Type Constraints

Version

Onnx name:UnsqueezeThis version of the operator has been available since version 13.

Runtime implementation:`Unsqueeze`

### Where¶

`mlprodict.onnxrt.ops_cpu.op_where.Where`

(*self*, *onnx_node*, *desc* = None, *options*)

Return elements, either from X or Y, depending on condition (with Numpy-style broadcasting support). Where behaves like numpy.where with three parameters: https://docs.scipy.org/doc/numpy/reference/generated/numpy.where.html

Inputs

condition(heterogeneous)B: When True (nonzero), yield X, otherwise yield Y

X(heterogeneous)T: values selected at indices where condition is True

Y(heterogeneous)T: values selected at indices where condition is False

Outputs

output(heterogeneous)T: Tensor of shape equal to the broadcasted shape of condition, X, and Y.

Type Constraints

B tensor(bool): Constrain to boolean tensors.

T tensor(uint8), tensor(uint16), tensor(uint32), tensor(uint64), tensor(int8), tensor(int16), tensor(int32), tensor(int64), tensor(float16), tensor(float), tensor(double), tensor(string), tensor(bool), tensor(complex64), tensor(complex128): Constrain input and output types to all tensor types.

Version

Onnx name:WhereThis version of the operator has been available since version 9.

Runtime implementation:`Where`