Package org.tribuo.util.onnx

Enum Class ONNXOperators

java.lang.Object
java.lang.Enum<ONNXOperators>
org.tribuo.util.onnx.ONNXOperators
All Implemented Interfaces:
Serializable, Comparable<ONNXOperators>, Constable, ONNXOperator
public enum ONNXOperators extends Enum<ONNXOperators> implements ONNXOperator
ONNX Opset 13, and ONNX-ML version 1.

In a future version of Tribuo this class will be split into two enums, one for ONNX opset 13 and one for ONNX-ML v1.

  • Enum Constant Details

    • IDENTITY

      public static final ONNXOperators IDENTITY
      Identity.

    • CONCAT

      public static final ONNXOperators CONCAT
      Concatenates tensors.

    • CONSTANT_OF_SHAPE

      public static final ONNXOperators CONSTANT_OF_SHAPE
      Makes a constant of the size of the supplied shape containing the value.

    • SIGMOID

      public static final ONNXOperators SIGMOID
      Sigmoid element-wise.

    • SOFTMAX

      public static final ONNXOperators SOFTMAX
      Softmax.
      • axis defaults to -1.

    • CAST

      public static final ONNXOperators CAST
      Cast input to specified type.
      • to must be a data type int from OnnxMl.TensorProto.DataType

    • NEG

      public static final ONNXOperators NEG
      Element-wise negation.

    • ADD

      public static final ONNXOperators ADD
      Element-wise addition with broadcasting.

    • SUB

      public static final ONNXOperators SUB
      Element-wise subtraction with broadcasting.

    • MUL

      public static final ONNXOperators MUL
      Element-wise multiplication with broadcasting.

    • DIV

      public static final ONNXOperators DIV
      Element-wise division with broadcasting.

    • POW

      public static final ONNXOperators POW
      Element-wise exponentiation with broadcasting.

    • SUM

      public static final ONNXOperators SUM
      Element-wise summation across the supplied inputs with broadcasting.

    • GATHER

      public static final ONNXOperators GATHER
      Gathers elements from the first argument (of rank r) indexed by the second argument (of rank q) producing a tensor of rank q + r - 1.
      • axis the axis of the first argument to gather from.

    • HARDMAX

      public static final ONNXOperators HARDMAX
      Hardmax(element in input, axis) = 1 if the element is the first maximum value along the specified axis, 0 otherwise.
      • axis default is -1, i.e., take the hardmax over the last dimension.

    • REDUCE_MEAN

      public static final ONNXOperators REDUCE_MEAN
      Computes the mean of the input tensor's element along the provided axes.
      • axes default is to reduce over all dimensions.
      • keepdims defaults to 1 which means keep.

    • REDUCE_MIN

      public static final ONNXOperators REDUCE_MIN
      Compute the minimum along the specified axes of the tensor.
      • axes defaults to all dimensions.
      • keepdims defaults to 1 which means keep.

    • REDUCE_SUM

      public static final ONNXOperators REDUCE_SUM
      Compute the sum along the specified axes of the tensor, the axes are the second input.
      • keepdims defaults to 1 which means keep.
      • noop_with_empty_axes defaults to 0 which means empty axes reduces the tensor to a scalar.

    • UNSQUEEZE

      public static final ONNXOperators UNSQUEEZE
      Adds extra dimensions to a tensor in the specified places, the axes are the second input.

    • GEMM

      public static final ONNXOperators GEMM
      General Matrix Multiply: alpha*AB + beta*C.

      The C input is optional, and if not supplied is treated as zero.

      • alpha defaults to 1.0
      • beta defaults to 1.0
      • transA defaults to 0 (i.e., not transposed)
      • transB defaults to 0 (i.e., not transposed)

    • GREATER

      public static final ONNXOperators GREATER
      Greater than, returns the element-wise greater than operation on the two tensors.

      Tensors must be broadcastable to the same shape.

    • GREATER_OR_EQUAL

      public static final ONNXOperators GREATER_OR_EQUAL
      Greater than or equal to, returns the element-wise greater than or equal to operation on the two tensors.

      Tensors must be broadcastable to the same shape.

    • LESS

      public static final ONNXOperators LESS
      Less than, returns the element-wise less than operation on the two tensors.

      Tensors must be broadcastable to the same shape.

    • LESS_OR_EQUAL

      public static final ONNXOperators LESS_OR_EQUAL
      Less than or equal to, returns the element-wise less than or equal to operation on the two tensors.

      Tensors must be broadcastable to the same shape.

    • WHERE

      public static final ONNXOperators WHERE
      Choice operator, based on the true value of the condition input, returns the element at that index from either the second or third input. When the test is true, return the second input, otherwise return the third input.

    • ARRAY_FEATURE_EXTRACTOR

      public static final ONNXOperators ARRAY_FEATURE_EXTRACTOR
      Array feature extractor, selects the indices specified by the second tensor from the last dimension of the first tensor.

    • SVM_CLASSIFIER

      public static final ONNXOperators SVM_CLASSIFIER
      SVM Classifier.
      • classlabels_ints - Class labels if using integer labels. One and only one of the 'classlabels_*' attributes must be defined.
      • classlabels_strings - Class labels if using string labels. One and only one of the 'classlabels_*' attributes must be defined.
      • coefficients - SVM coefficients
      • kernel_params - Tuple of gamma, coef0 and degree. Set to zero if unused by the kernel.
      • kernel_type - One of 'LINEAR,' 'POLY,' 'RBF,' 'SIGMOID'.
      • post_transforms - Transform to apply to the score (usually unused by SVMs), one of 'NONE,' 'SOFTMAX,' 'LOGISTIC,' 'SOFTMAX_ZERO,' or 'PROBIT'.
      • prob_a - Probability coefficients, if set must be the same size as prob_b.
      • prob_b - Probability coefficients, if set must be the same size as prob_a.
      • rho - Rho vector.
      • support_vectors - linearised support vectors.
      • vectors_per_class - the number of support vectors in each class.

    • SVM_REGRESSOR

      public static final ONNXOperators SVM_REGRESSOR
      SVM Regressor.
      • coefficients - SVM coefficients
      • kernel_params - Tuple of gamma, coef0 and degree. Set to zero if unused by the kernel.
      • kernel_type - One of 'LINEAR,' 'POLY,' 'RBF,' 'SIGMOID'.
      • n_supports - The number of support vectors.
      • one_class - Flag noting if this regression is a one-class SVM for anomaly detection or not.
      • post_transforms - Transform to apply to the score (usually unused by SVMs), one of 'NONE,' 'SOFTMAX,' 'LOGISTIC,' 'SOFTMAX_ZERO,' or 'PROBIT'.
      • rho - Rho vector.
      • support_vectors - linearised support vectors.

  • Field Details

    • opName

      public final String opName
      The operator name.

    • numInputs

      public final int numInputs
      The number of inputs.

    • numOptionalInputs

      public final int numOptionalInputs
      The number of optional inputs.

    • numOutputs

      public final int numOutputs
      The number of outputs.

    • attributes

      public final Map<String,ONNXAttribute> attributes
      The operator attributes.

    • mandatoryAttributeNames

      public final Set<String> mandatoryAttributeNames
      The mandatory attribute names.

    • domain

      public final String domain
      The operator domain (used for the ML operators).

      Null if the domain is the default one.

  • Method Details

    • values

      public static ONNXOperators[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ONNXOperators valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getOpName

      public String getOpName()
      Description copied from interface: ONNXOperator
      The operator name.
      Specified by:
      getOpName in interface ONNXOperator
      Returns:
      The name.

    • getNumInputs

      public int getNumInputs()
      Description copied from interface: ONNXOperator
      The number of inputs.
      Specified by:
      getNumInputs in interface ONNXOperator
      Returns:
      The number of inputs.

    • getNumOptionalInputs

      public int getNumOptionalInputs()
      Description copied from interface: ONNXOperator
      The number of optional inputs.
      Specified by:
      getNumOptionalInputs in interface ONNXOperator
      Returns:
      The number of optional inputs.

    • getNumOutputs

      public int getNumOutputs()
      Description copied from interface: ONNXOperator
      The number of outputs.
      Specified by:
      getNumOutputs in interface ONNXOperator
      Returns:
      The number of outputs.

    • getAttributes

      public Map<String,ONNXAttribute> getAttributes()
      Description copied from interface: ONNXOperator
      The operator attributes.
      Specified by:
      getAttributes in interface ONNXOperator
      Returns:
      The operator attribute map.

    • getMandatoryAttributeNames

      public Set<String> getMandatoryAttributeNames()
      Description copied from interface: ONNXOperator
      The mandatory attribute names.
      Specified by:
      getMandatoryAttributeNames in interface ONNXOperator
      Returns:
      The required attribute names.

    • getOpVersion

      public int getOpVersion()
      Description copied from interface: ONNXOperator
      Returns the opset version.
      Specified by:
      getOpVersion in interface ONNXOperator
      Returns:
      The opset version.

    • getOpDomain

      public String getOpDomain()
      Description copied from interface: ONNXOperator
      Returns the opset domain.

      May be null if it is the default ONNX domain;

      Specified by:
      getOpDomain in interface ONNXOperator
      Returns:
      The opset domain.

    • getOpsetVersion

      public static int getOpsetVersion()
      Returns the opset version supported by these operators.
      Returns:
      The opset version.

    • getOpsetProto

      public static ai.onnx.proto.OnnxMl.OperatorSetIdProto getOpsetProto()
      Returns the opset proto for these operators.
      Returns:
      The opset proto.