org.bytedeco.onnx

Class OpSchema

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.onnx.OpSchema

All Implemented Interfaces:

AutoCloseable

@Namespace(value="onnx")
 @NoOffset
 @Properties(inherit=onnx.class)
public class OpSchema
extends Pointer

\brief A class to record the schema of an op. OpSchema records the common interface of an op specified by its name. To register an OpSchema, one can use the macro ONNX_OPERATOR_SCHEMA(name) and then append the various functions in the class. For example, for an op that takes in two inputs, one output, and the first input and output could be in-place, can be written as ONNX_OPERATOR_SCHEMA(name) .NumInputs(2).NumOutputs(1).AllowConsumed({{0, 0}}); To manufacture methods that may be used to register an OpSchema non-statically, the following may be used: ONNX_OPERATOR_SET_SCHEMA(name, version, OpSchema() .NumInputs(2).NumOutputs(1).AllowConsumed({{0, 0}}));

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpSchema.Attribute
static class	OpSchema.FormalParameter
static class	OpSchema.TypeConstraintParam

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COMMON enum class onnx::OpSchema::SupportType
static byte	EXPERIMENTAL enum class onnx::OpSchema::SupportType
static byte	Optional enum onnx::OpSchema::FormalParameterOption
static byte	Single enum onnx::OpSchema::FormalParameterOption
static byte	Variadic enum onnx::OpSchema::FormalParameterOption

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
OpSchema()
OpSchema(BytePointer name, BytePointer file, int line)
OpSchema(long size) Native array allocator.
OpSchema(Pointer p) Pointer cast constructor.
OpSchema(String name, String file, int line)

Method Summary

Modifier and Type	Method and Description
static StringVector	all_numeric_sequence_types()
static StringVector	all_numeric_types()
static StringVector	all_tensor_sequence_types()
static StringVector	all_tensor_types()
OpSchema	AllowUncheckedAttributes()
OpSchema	Attr(BytePointer name, BytePointer description, int type)
OpSchema	Attr(BytePointer name, BytePointer description, int type, boolean required)
OpSchema	Attr(BytePointer name, BytePointer description, int type, BytePointer defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, float defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, FloatVector defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, GraphProto defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, long defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, LongVector defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, StringVector defaultValue)
OpSchema	Attr(BytePointer name, BytePointer description, int type, TensorProto defaultValue)
OpSchema	Attr(OpSchema.Attribute attr)
OpSchema	Attr(String name, String description, int type)
OpSchema	Attr(String name, String description, int type, boolean required)
OpSchema	Attr(String name, String description, int type, float defaultValue)
OpSchema	Attr(String name, String description, int type, FloatVector defaultValue)
OpSchema	Attr(String name, String description, int type, GraphProto defaultValue)
OpSchema	Attr(String name, String description, int type, long defaultValue)
OpSchema	Attr(String name, String description, int type, LongVector defaultValue)
OpSchema	Attr(String name, String description, int type, String defaultValue)
OpSchema	Attr(String name, String description, int type, StringVector defaultValue)
OpSchema	Attr(String name, String description, int type, TensorProto defaultValue)
StringAttributeMap	attributes()
OpSchema	Deprecate() Marks this op as deprecated as of it's since_version.
boolean	deprecated()
boolean	Deprecated()
BytePointer	doc() \brief Returns the docstring of the op schema.
BytePointer	domain()
BytePointer	file() \brief Returns the file that the op schema is registered from.
OpSchema	FillUsing(onnx.VoidOpSchemaFn populator)
void	Finalize()
OpSchema	FunctionBody(NodeProto func_nodes)
FunctionProto	GetFunction()
boolean	has_type_and_shape_inference_function()
boolean	HasFunction()
OpSchema	Input(int n, BytePointer name, BytePointer description, BytePointer type_str)
OpSchema	Input(int n, BytePointer name, BytePointer description, BytePointer type_str, byte param_option, boolean is_homogeneous, int min_arity)
OpSchema	Input(int n, String name, String description, String type_str)
OpSchema	Input(int n, String name, String description, String type_str, byte param_option, boolean is_homogeneous, int min_arity)
FormalParameterVector	inputs()
int	line() \brief Returns the line in file that the op schema is registered from.
int	max_input()
int	max_output()
int	min_input()
int	min_output()
BytePointer	Name()
static StringVector	numeric_types_for_math_reduction()
OpSchema	NumInputs(IntSet allowed_input_nums) \brief Input could be one of the values specified in allowed_input_nums.
OpSchema	NumOutputs(IntSet allowed_output_nums) \brief Output could be one of the values specified in allowed_output_nums.
OpSchema	Output(int n, BytePointer name, BytePointer description, BytePointer type_str)
OpSchema	Output(int n, BytePointer name, BytePointer description, BytePointer type_str, byte param_option, boolean is_homogeneous, int min_arity)
OpSchema	Output(int n, String name, String description, String type_str)
OpSchema	Output(int n, String name, String description, String type_str, byte param_option, boolean is_homogeneous, int min_arity)
FormalParameterVector	outputs()
OpSchema	position(long position)
OpSchema	SetDoc(BytePointer doc)
OpSchema	SetDoc(String doc)
OpSchema	SetDomain(BytePointer domain)
OpSchema	SetDomain(String domain)
OpSchema	SetLocation(BytePointer file, int line)
OpSchema	SetLocation(String file, int line)
OpSchema	SetName(BytePointer name)
OpSchema	SetName(String name)
OpSchema	SetSupportLevel(byte supportType)
int	since_version()
int	SinceVersion()
OpSchema	SinceVersion(int n) The earliest operator set version which this operator was present in.
byte	support_level() \brief Returns the support level of the op schema.
OpSchema	TypeAndShapeInferenceFunction(onnx.InferenceFunction inferenceFunction)
OpSchema	TypeConstraint(BytePointer type_str, StringVector constraints, BytePointer description)
OpSchema	TypeConstraint(String type_str, StringVector constraints, String description)
TypeConstraintParamVector	typeConstraintParams()
void	Verify(NodeProto node) \brief Verifies if a NodeProto matches the pattern specified in the schema.

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

Single

public static final byte Single

enum onnx::OpSchema::FormalParameterOption

See Also:

Constant Field Values

Optional

public static final byte Optional

enum onnx::OpSchema::FormalParameterOption

See Also:

Constant Field Values

Variadic

public static final byte Variadic

enum onnx::OpSchema::FormalParameterOption

See Also:

Constant Field Values

COMMON

public static final byte COMMON

enum class onnx::OpSchema::SupportType

See Also:

Constant Field Values

EXPERIMENTAL

public static final byte EXPERIMENTAL

enum class onnx::OpSchema::SupportType

See Also:

Constant Field Values

Constructor Detail

OpSchema

public OpSchema(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

OpSchema

public OpSchema(long size)

Native array allocator. Access with Pointer.position(long).

OpSchema

public OpSchema()

OpSchema

public OpSchema(@StdString
                BytePointer name,
                @StdString
                BytePointer file,
                int line)

OpSchema

public OpSchema(@StdString
                String name,
                @StdString
                String file,
                int line)

Method Detail

position

public OpSchema position(long position)

Overrides:

position in class Pointer

file

@StdString
public BytePointer file()

\brief Returns the file that the op schema is registered from.

line

public int line()

\brief Returns the line in file that the op schema is registered from.

support_level

@Cast(value="onnx::OpSchema::SupportType")
public byte support_level()

\brief Returns the support level of the op schema.

doc

@Cast(value="const char*")
public BytePointer doc()

\brief Returns the docstring of the op schema.

Verify

public void Verify(@Const @ByRef
                   NodeProto node)

\brief Verifies if a NodeProto matches the pattern specified in the schema.

SinceVersion

@ByRef
 @Function
public OpSchema SinceVersion(@Cast(value="onnx::OperatorSetVersion")
                                               int n)

The earliest operator set version which this operator was present in. If an operator has had no BC-breaking changes, this is simply the first operator set the operator was a member of; if it has had BC-breaking changes, then for the semantics /as described/ in the OpSchema entry, this version describes the operator set which introduced the BC-breaking change. For example, suppose op Foo was added in v3, and had a BC-breaking change in v6. Then there will be an op schema entry for Foo with SinceVersion(3), and another, updated op schema entry for Foo with SinceVersion(6).

Deprecate

@ByRef
public OpSchema Deprecate()

Marks this op as deprecated as of it's since_version. This will cause the Schema() lookup functions to return nullptr when the version is in the deprecated range.

Deprecated

@Cast(value="bool")
public boolean Deprecated()

NumInputs

@ByRef
public OpSchema NumInputs(@ByVal
                                 IntSet allowed_input_nums)

\brief Input could be one of the values specified in allowed_input_nums.

NumOutputs

@ByRef
public OpSchema NumOutputs(@ByVal
                                  IntSet allowed_output_nums)

\brief Output could be one of the values specified in allowed_output_nums.

TypeAndShapeInferenceFunction

@ByRef
public OpSchema TypeAndShapeInferenceFunction(@ByVal
                                                     onnx.InferenceFunction inferenceFunction)

SetSupportLevel

@ByRef
public OpSchema SetSupportLevel(@Cast(value="onnx::OpSchema::SupportType")
                                       byte supportType)

SetDoc

@ByRef
public OpSchema SetDoc(@Cast(value="const char*")
                              BytePointer doc)

SetDoc

@ByRef
public OpSchema SetDoc(String doc)

SetName

@ByRef
public OpSchema SetName(@Cast(value="const char*")
                               BytePointer name)

SetName

@ByRef
public OpSchema SetName(String name)

SetLocation

@ByRef
public OpSchema SetLocation(@Cast(value="const char*")
                                   BytePointer file,
                                   int line)

SetLocation

@ByRef
public OpSchema SetLocation(String file,
                                   int line)

SetDomain

@ByRef
public OpSchema SetDomain(@Cast(value="const char*")
                                 BytePointer domain)

SetDomain

@ByRef
public OpSchema SetDomain(String domain)

Attr

@ByRef
public OpSchema Attr(@ByVal
                            OpSchema.Attribute attr)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Cast(value="const int64_t")
                            long defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Cast(value="const int64_t")
                            long defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            LongVector defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            LongVector defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            float defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            float defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            FloatVector defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            FloatVector defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @StdString
                            BytePointer defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @StdString
                            String defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            StringVector defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            StringVector defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            TensorProto defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            TensorProto defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            GraphProto defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Const @ByRef
                            GraphProto defaultValue)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Cast(value="bool")
                            boolean required)

Attr

@ByRef
public OpSchema Attr(@StdString
                            BytePointer name,
                            @StdString
                            BytePointer description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type,
                            @Cast(value="bool")
                            boolean required)

Attr

@ByRef
public OpSchema Attr(@StdString
                            String name,
                            @StdString
                            String description,
                            @Cast(value="onnx::AttributeProto::AttributeType")
                            int type)

AllowUncheckedAttributes

@ByRef
public OpSchema AllowUncheckedAttributes()

Input

@ByRef
public OpSchema Input(int n,
                             @StdString
                             BytePointer name,
                             @StdString
                             BytePointer description,
                             @StdString
                             BytePointer type_str,
                             @Cast(value="onnx::OpSchema::FormalParameterOption")
                             byte param_option,
                             @Cast(value="bool")
                             boolean is_homogeneous,
                             int min_arity)

Input

@ByRef
public OpSchema Input(int n,
                             @StdString
                             BytePointer name,
                             @StdString
                             BytePointer description,
                             @StdString
                             BytePointer type_str)

Input

@ByRef
public OpSchema Input(int n,
                             @StdString
                             String name,
                             @StdString
                             String description,
                             @StdString
                             String type_str,
                             @Cast(value="onnx::OpSchema::FormalParameterOption")
                             byte param_option,
                             @Cast(value="bool")
                             boolean is_homogeneous,
                             int min_arity)

Input

@ByRef
public OpSchema Input(int n,
                             @StdString
                             String name,
                             @StdString
                             String description,
                             @StdString
                             String type_str)

Output

@ByRef
public OpSchema Output(int n,
                              @StdString
                              BytePointer name,
                              @StdString
                              BytePointer description,
                              @StdString
                              BytePointer type_str,
                              @Cast(value="onnx::OpSchema::FormalParameterOption")
                              byte param_option,
                              @Cast(value="bool")
                              boolean is_homogeneous,
                              int min_arity)

Output

@ByRef
public OpSchema Output(int n,
                              @StdString
                              BytePointer name,
                              @StdString
                              BytePointer description,
                              @StdString
                              BytePointer type_str)

Output

@ByRef
public OpSchema Output(int n,
                              @StdString
                              String name,
                              @StdString
                              String description,
                              @StdString
                              String type_str,
                              @Cast(value="onnx::OpSchema::FormalParameterOption")
                              byte param_option,
                              @Cast(value="bool")
                              boolean is_homogeneous,
                              int min_arity)

Output

@ByRef
public OpSchema Output(int n,
                              @StdString
                              String name,
                              @StdString
                              String description,
                              @StdString
                              String type_str)

TypeConstraint

@ByRef
public OpSchema TypeConstraint(@StdString
                                      BytePointer type_str,
                                      @ByVal
                                      StringVector constraints,
                                      @StdString
                                      BytePointer description)

TypeConstraint

@ByRef
public OpSchema TypeConstraint(@StdString
                                      String type_str,
                                      @ByVal
                                      StringVector constraints,
                                      @StdString
                                      String description)

numeric_types_for_math_reduction

@Const
 @ByRef
public static StringVector numeric_types_for_math_reduction()

all_numeric_types

@Const
 @ByRef
public static StringVector all_numeric_types()

all_numeric_sequence_types

@Const
 @ByRef
public static StringVector all_numeric_sequence_types()

all_tensor_types

@Const
 @ByRef
public static StringVector all_tensor_types()

all_tensor_sequence_types

@Const
 @ByRef
public static StringVector all_tensor_sequence_types()

FillUsing

@ByRef
public OpSchema FillUsing(@Const @ByRef
                                 onnx.VoidOpSchemaFn populator)

domain

@StdString
public BytePointer domain()

attributes

@Const
 @ByRef
public StringAttributeMap attributes()

inputs

@Const
 @ByRef
public FormalParameterVector inputs()

outputs

@Const
 @ByRef
public FormalParameterVector outputs()

typeConstraintParams

@Const
 @ByRef
public TypeConstraintParamVector typeConstraintParams()

Name

@StdString
public BytePointer Name()

SinceVersion

@Cast(value="onnx::OperatorSetVersion")
 @Function
public int SinceVersion()

since_version

public int since_version()

deprecated

@Cast(value="bool")
public boolean deprecated()

min_input

public int min_input()

max_input

public int max_input()

min_output

public int min_output()

max_output

public int max_output()

has_type_and_shape_inference_function

@Cast(value="bool")
public boolean has_type_and_shape_inference_function()

HasFunction

@Cast(value="bool")
public boolean HasFunction()

FunctionBody

@ByRef
public OpSchema FunctionBody(@StdVector
                                    NodeProto func_nodes)

GetFunction

@Const
public FunctionProto GetFunction()

Finalize

public void Finalize()