Class ONNXRef<T extends com.google.protobuf.GeneratedMessageV3>

java.lang.Object

org.tribuo.util.onnx.ONNXRef<T>

Type Parameters:

T - The protobuf type this reference generates.

Direct Known Subclasses:

ONNXInitializer, ONNXNode, ONNXPlaceholder

public abstract class ONNXRef<T extends com.google.protobuf.GeneratedMessageV3>
extends Object

An abstract reference that represents both a node in an ONNX computation graph and a container for a specific ONNX proto object that denotes that node. In its role as the former it provides a fluent interface for applying ONNXOperators to ONNXRef instances. ONNXRef instances are ultimately created by an ONNXContext instance, and ONNXRefs created by different instances of ONNXContext are incompatible. All ONNX proto objects produced by calling apply methods on ONNXRefs are added to a OnnxMl.GraphProto field in their governing ONNXContext. Instances of ONNXRef have a backreference to the ONNXContext that created them and can thus be passed around without needing to pass their governing context as well.

N.B. This class will be sealed once the library is updated past Java 8. Users should not subclass this class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	backRef	Protobuf reference.
protected final ONNXContext	context	The ONNX context.

Method Summary

Modifier and Type	Method	Description
ONNXNode	apply(ONNXOperator op)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String), using this ONNXRef as the argument to inputs.
ONNXNode	apply(ONNXOperator op, String outputName)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String), using this ONNXRef as the argument to inputs.
List<ONNXNode>	apply(ONNXOperator op, List<String> outputs, Map<String,Object> attributes)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, List, Map), using this ONNXRef as the argument to inputs.
ONNXNode	apply(ONNXOperator op, List<ONNXRef<?>> others)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), using this ONNXRef as the first argument to inputs, with otherInputs append as subsequent arguments.
ONNXNode	apply(ONNXOperator op, List<ONNXRef<?>> others, String outputName)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), using this ONNXRef as the argument to inputs, with otherInputs append as subsequent arguments.
List<ONNXNode>	apply(ONNXOperator op, List<ONNXRef<?>> otherInputs, List<String> outputs, Map<String,Object> attributes)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, List, Map), using this ONNXRef as the first argument to inputs, with otherInputs append as subsequent arguments.
ONNXNode	apply(ONNXOperator op, Map<String,Object> attributes)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), using this ONNXRef as the argument to inputs.
ONNXNode	apply(ONNXOperator op, ONNXRef<?> other)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), passing this ONNXRef and other as a length 2 list to inputs.
ONNXNode	apply(ONNXOperator op, ONNXRef<?> other, String outputName)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String), passing this ONNXRef and other as a length 2 list to inputs.
ONNXNode	apply(ONNXOperator op, ONNXRef<?> other, Map<String,Object> attributes)	Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), passing this ONNXRef and other as a length 2 list to inputs.
<Ret extends ONNXRef<?>> Ret	assignTo(Ret output)	Convenience method that calls ONNXContext.assignTo(ONNXRef, ONNXRef), using this ONNXRef as the argument to input.
ONNXNode	cast(Class<?> clazz)	Casts this ONNXRef to a different type using the ONNXOperators.CAST operation, and returning the output node of that op.
String	getBaseName()	The name of this object.
abstract String	getReference()	Gets the output name of this object.
ONNXContext	onnxContext()	The context this reference operates in.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

backRef

protected final T extends com.google.protobuf.GeneratedMessageV3 backRef

Protobuf reference.

context

protected final ONNXContext context

The ONNX context.

Method Details

getReference

public abstract String getReference()

Gets the output name of this object.

Returns:

The output name.

getBaseName

public String getBaseName()

The name of this object.

Returns:

The name.

onnxContext

public ONNXContext onnxContext()

The context this reference operates in.

Returns:

The context.

apply

public List<ONNXNode> apply(ONNXOperator op,
 List<ONNXRef<?>> otherInputs,
 List<String> outputs,
 Map<String,Object> attributes)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, List, Map), using this ONNXRef as the first argument to inputs, with otherInputs append as subsequent arguments. The other arguments behave as in the analogous method on ONNXContext.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

otherInputs - A list of ONNXRefs created by this instance of ONNXContext.

outputs - A list of names that the output nodes of op should take.

attributes - A map of attributes of the operation, passed to ONNXOperator.build(ONNXContext, String, String, Map).

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public List<ONNXNode> apply(ONNXOperator op,
 List<String> outputs,
 Map<String,Object> attributes)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, List, Map), using this ONNXRef as the argument to inputs. The other arguments behave as in the analogous method on ONNXContext.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

outputs - A list of names that the output nodes of op should take.

attributes - A map of attributes of the operation, passed to ONNXOperator.build(ONNXContext, String, String, Map).

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String), using this ONNXRef as the argument to inputs. Output names are generated based on the ONNXOperator.getOpName() and the name of the input nodes.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 String outputName)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String), using this ONNXRef as the argument to inputs.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

outputName - A name that the output node of op will take.

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 Map<String,Object> attributes)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), using this ONNXRef as the argument to inputs. Output names are generated based on the ONNXOperator.getOpName() and the name of the input nodes.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

attributes - A map of attributes of the operation, passed to ONNXOperator.build(ONNXContext, String, String, Map).

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 ONNXRef<?> other,
 Map<String,Object> attributes)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), passing this ONNXRef and other as a length 2 list to inputs. The other arguments behave as in the analogous method on ONNXContext. Output names are generated based on the ONNXOperator.getOpName() and the name of the input nodes.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

other - A second input argument to op

attributes - A map of attributes of the operation, passed to ONNXOperator.build(ONNXContext, String, String, Map).

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 ONNXRef<?> other,
 String outputName)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String), passing this ONNXRef and other as a length 2 list to inputs.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

other - A second input argument to op

outputName - A name that the output node of op will take.

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 ONNXRef<?> other)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), passing this ONNXRef and other as a length 2 list to inputs. Output names are generated based on the ONNXOperator.getOpName() and the name of the input nodes.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

other - A second input argument to op

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 List<ONNXRef<?>> others)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), using this ONNXRef as the first argument to inputs, with otherInputs append as subsequent arguments. Output names are generated based on the ONNXOperator.getOpName() and the name of the input nodes.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

others - List of ONNXRefs supplied as inputs to op after this ONNXRef.

Returns:

a list of ONNXNodes that are the output nodes of op.

apply

public ONNXNode apply(ONNXOperator op,
 List<ONNXRef<?>> others,
 String outputName)

Convenience method that calls ONNXContext.operation(ONNXOperator, List, String, Map), using this ONNXRef as the argument to inputs, with otherInputs append as subsequent arguments.

Parameters:

op - An ONNXOperator to add to the graph, taking inputs as input.

others - List of ONNXRefs supplied as inputs to op after this ONNXRef.

outputName - The name for the constructed node.

Returns:

a list of ONNXNodes that are the output nodes of op.

assignTo

public <Ret extends ONNXRef<?>> Ret assignTo(Ret output)

Convenience method that calls ONNXContext.assignTo(ONNXRef, ONNXRef), using this ONNXRef as the argument to input.

Type Parameters:

Ret - the ONNXRef type of the output.

Parameters:

output - The output node / left-hand side of the assignment

Returns:

the output node that was assigned to.

cast

public ONNXNode cast(Class<?> clazz)

Casts this ONNXRef to a different type using the ONNXOperators.CAST operation, and returning the output node of that op. Currently supports only float, double, int, and long, which are specified by their respective Class objects (e.g., float.class). Throws IllegalArgumentException when an unsupported cast is requested.

Parameters:

clazz - The class object specifying the type to cast to.

Returns:

An ONNXRef representing this object cast into the requested type.