Package org.tensorflow.framework
Interface OpDefOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OpDef,OpDef.Builder
public interface OpDefOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanBy default, all inputs to an Op must be initialized Tensors.getAttr(int index) repeated .tensorflow.OpDef.AttrDef attr = 4;intrepeated .tensorflow.OpDef.AttrDef attr = 4;repeated .tensorflow.OpDef.AttrDef attr = 4;getAttrOrBuilder(int index) repeated .tensorflow.OpDef.AttrDef attr = 4;List<? extends OpDef.AttrDefOrBuilder> repeated .tensorflow.OpDef.AttrDef attr = 4;getControlOutput(int index) Named control outputs for this operation.com.google.protobuf.ByteStringgetControlOutputBytes(int index) Named control outputs for this operation.intNamed control outputs for this operation.Named control outputs for this operation.Optional deprecation based on GraphDef versions.Optional deprecation based on GraphDef versions.Additional, longer human-readable description of what the Op does.com.google.protobuf.ByteStringAdditional, longer human-readable description of what the Op does.getInputArg(int index) Description of the input(s).intDescription of the input(s).Description of the input(s).getInputArgOrBuilder(int index) Description of the input(s).List<? extends OpDef.ArgDefOrBuilder> Description of the input(s).booleanIf is_aggregate is true, then this operation accepts N >= 2 inputs and produces 1 output all of the same type.booleanTrue if the operation is commutative ("op(a,b) == op(b,a)" for all inputs)booleanIndicates whether the op implementation uses distributed communication.booleanOps are marked as stateful if their behavior depends on some state beyond their input tensors (e.g. variable reading op) or if they have a side-effect (e.g. printing or asserting ops).getName()Op names starting with an underscore are reserved for internal use.com.google.protobuf.ByteStringOp names starting with an underscore are reserved for internal use.getOutputArg(int index) Description of the output(s).intDescription of the output(s).Description of the output(s).getOutputArgOrBuilder(int index) Description of the output(s).List<? extends OpDef.ArgDefOrBuilder> Description of the output(s).One-line human-readable description of what the Op does.com.google.protobuf.ByteStringOne-line human-readable description of what the Op does.booleanOptional deprecation based on GraphDef versions.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Op names starting with an underscore are reserved for internal use. Names should be CamelCase and match the regexp "[A-Z][a-zA-Z0-9>_]*".
string name = 1;- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Op names starting with an underscore are reserved for internal use. Names should be CamelCase and match the regexp "[A-Z][a-zA-Z0-9>_]*".
string name = 1;- Returns:
- The bytes for name.
-
getInputArgList
List<OpDef.ArgDef> getInputArgList()Description of the input(s).
repeated .tensorflow.OpDef.ArgDef input_arg = 2; -
getInputArg
Description of the input(s).
repeated .tensorflow.OpDef.ArgDef input_arg = 2; -
getInputArgCount
int getInputArgCount()Description of the input(s).
repeated .tensorflow.OpDef.ArgDef input_arg = 2; -
getInputArgOrBuilderList
List<? extends OpDef.ArgDefOrBuilder> getInputArgOrBuilderList()Description of the input(s).
repeated .tensorflow.OpDef.ArgDef input_arg = 2; -
getInputArgOrBuilder
Description of the input(s).
repeated .tensorflow.OpDef.ArgDef input_arg = 2; -
getOutputArgList
List<OpDef.ArgDef> getOutputArgList()Description of the output(s).
repeated .tensorflow.OpDef.ArgDef output_arg = 3; -
getOutputArg
Description of the output(s).
repeated .tensorflow.OpDef.ArgDef output_arg = 3; -
getOutputArgCount
int getOutputArgCount()Description of the output(s).
repeated .tensorflow.OpDef.ArgDef output_arg = 3; -
getOutputArgOrBuilderList
List<? extends OpDef.ArgDefOrBuilder> getOutputArgOrBuilderList()Description of the output(s).
repeated .tensorflow.OpDef.ArgDef output_arg = 3; -
getOutputArgOrBuilder
Description of the output(s).
repeated .tensorflow.OpDef.ArgDef output_arg = 3; -
getControlOutputList
Named control outputs for this operation. Useful only for composite operations (i.e. functions) which want to name different control outputs.
repeated string control_output = 20;- Returns:
- A list containing the controlOutput.
-
getControlOutputCount
int getControlOutputCount()Named control outputs for this operation. Useful only for composite operations (i.e. functions) which want to name different control outputs.
repeated string control_output = 20;- Returns:
- The count of controlOutput.
-
getControlOutput
Named control outputs for this operation. Useful only for composite operations (i.e. functions) which want to name different control outputs.
repeated string control_output = 20;- Parameters:
index- The index of the element to return.- Returns:
- The controlOutput at the given index.
-
getControlOutputBytes
com.google.protobuf.ByteString getControlOutputBytes(int index) Named control outputs for this operation. Useful only for composite operations (i.e. functions) which want to name different control outputs.
repeated string control_output = 20;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the controlOutput at the given index.
-
getAttrList
List<OpDef.AttrDef> getAttrList()repeated .tensorflow.OpDef.AttrDef attr = 4; -
getAttr
repeated .tensorflow.OpDef.AttrDef attr = 4; -
getAttrCount
int getAttrCount()repeated .tensorflow.OpDef.AttrDef attr = 4; -
getAttrOrBuilderList
List<? extends OpDef.AttrDefOrBuilder> getAttrOrBuilderList()repeated .tensorflow.OpDef.AttrDef attr = 4; -
getAttrOrBuilder
repeated .tensorflow.OpDef.AttrDef attr = 4; -
hasDeprecation
boolean hasDeprecation()Optional deprecation based on GraphDef versions.
.tensorflow.OpDeprecation deprecation = 8;- Returns:
- Whether the deprecation field is set.
-
getDeprecation
OpDeprecation getDeprecation()Optional deprecation based on GraphDef versions.
.tensorflow.OpDeprecation deprecation = 8;- Returns:
- The deprecation.
-
getDeprecationOrBuilder
OpDeprecationOrBuilder getDeprecationOrBuilder()Optional deprecation based on GraphDef versions.
.tensorflow.OpDeprecation deprecation = 8; -
getSummary
String getSummary()One-line human-readable description of what the Op does.
string summary = 5;- Returns:
- The summary.
-
getSummaryBytes
com.google.protobuf.ByteString getSummaryBytes()One-line human-readable description of what the Op does.
string summary = 5;- Returns:
- The bytes for summary.
-
getDescription
String getDescription()Additional, longer human-readable description of what the Op does.
string description = 6;- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Additional, longer human-readable description of what the Op does.
string description = 6;- Returns:
- The bytes for description.
-
getIsCommutative
boolean getIsCommutative()True if the operation is commutative ("op(a,b) == op(b,a)" for all inputs)bool is_commutative = 18;- Returns:
- The isCommutative.
-
getIsAggregate
boolean getIsAggregate()If is_aggregate is true, then this operation accepts N >= 2 inputs and produces 1 output all of the same type. Should be associative and commutative, and produce output with the same shape as the input. The optimizer may replace an aggregate op taking input from multiple devices with a tree of aggregate ops that aggregate locally within each device (and possibly within groups of nearby devices) before communicating. TODO(josh11b): Implement that optimization.
bool is_aggregate = 16;- Returns:
- The isAggregate.
-
getIsStateful
boolean getIsStateful()Ops are marked as stateful if their behavior depends on some state beyond their input tensors (e.g. variable reading op) or if they have a side-effect (e.g. printing or asserting ops). Equivalently, stateless ops must always produce the same output for the same input and have no side-effects. By default Ops may be moved between devices. Stateful ops should either not be moved, or should only be moved if that state can also be moved (e.g. via some sort of save / restore). Stateful ops are guaranteed to never be optimized away by Common Subexpression Elimination (CSE).
bool is_stateful = 17;- Returns:
- The isStateful.
-
getAllowsUninitializedInput
boolean getAllowsUninitializedInput()By default, all inputs to an Op must be initialized Tensors. Ops that may initialize tensors for the first time should set this field to true, to allow the Op to take an uninitialized Tensor as input.
bool allows_uninitialized_input = 19;- Returns:
- The allowsUninitializedInput.
-
getIsDistributedCommunication
boolean getIsDistributedCommunication()Indicates whether the op implementation uses distributed communication. If True, the op is allowed to return errors for network disconnection and trigger TF network failure handling logics.
bool is_distributed_communication = 21;- Returns:
- The isDistributedCommunication.
-