Interface NodeDefOrBuilder

All Superinterfaces:
MessageLiteOrBuilder, MessageOrBuilder
All Known Implementing Classes:
NodeDef, NodeDef.Builder
public interface NodeDefOrBuilder extends MessageOrBuilder

  • Method Details

    • getName

      String getName()
      The name given to this operator. Used for naming inputs,
logging, visualization, etc.  Unique within a single GraphDef.
Must match the regexp "[A-Za-z0-9.][A-Za-z0-9_>./]*".
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      ByteString getNameBytes()
      The name given to this operator. Used for naming inputs,
logging, visualization, etc.  Unique within a single GraphDef.
Must match the regexp "[A-Za-z0-9.][A-Za-z0-9_>./]*".
      string name = 1;
      Returns:
      The bytes for name.

    • getOp

      String getOp()
      The operation name.  There may be custom parameters in attrs.
Op names starting with an underscore are reserved for internal use.
      string op = 2;
      Returns:
      The op.

    • getOpBytes

      ByteString getOpBytes()
      The operation name.  There may be custom parameters in attrs.
Op names starting with an underscore are reserved for internal use.
      string op = 2;
      Returns:
      The bytes for op.

    • getInputList

      List<String> getInputList()
      Each input is "node:src_output" with "node" being a string name and
"src_output" indicating which output tensor to use from "node". If
"src_output" is 0 the ":0" suffix can be omitted.  Regular inputs
may optionally be followed by control inputs that have the format
"^node".
      repeated string input = 3;
      Returns:
      A list containing the input.

    • getInputCount

      int getInputCount()
      Each input is "node:src_output" with "node" being a string name and
"src_output" indicating which output tensor to use from "node". If
"src_output" is 0 the ":0" suffix can be omitted.  Regular inputs
may optionally be followed by control inputs that have the format
"^node".
      repeated string input = 3;
      Returns:
      The count of input.

    • getInput

      String getInput(int index)
      Each input is "node:src_output" with "node" being a string name and
"src_output" indicating which output tensor to use from "node". If
"src_output" is 0 the ":0" suffix can be omitted.  Regular inputs
may optionally be followed by control inputs that have the format
"^node".
      repeated string input = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The input at the given index.

    • getInputBytes

      ByteString getInputBytes(int index)
      Each input is "node:src_output" with "node" being a string name and
"src_output" indicating which output tensor to use from "node". If
"src_output" is 0 the ":0" suffix can be omitted.  Regular inputs
may optionally be followed by control inputs that have the format
"^node".
      repeated string input = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the input at the given index.

    • getDevice

      String getDevice()
      A (possibly partial) specification for the device on which this
node should be placed.
The expected syntax for this string is as follows:
DEVICE_SPEC ::= PARTIAL_SPEC
PARTIAL_SPEC ::= ("/" CONSTRAINT) *
CONSTRAINT ::= ("job:" JOB_NAME)
             | ("replica:" [1-9][0-9]*)
             | ("task:" [1-9][0-9]*)
             | ("device:" [A-Za-z]* ":" ([1-9][0-9]* | "*") )
Valid values for this string include:
* "/job:worker/replica:0/task:1/device:GPU:3"  (full specification)
* "/job:worker/device:GPU:3"                   (partial specification)
* ""                                    (no specification)
If the constraints do not resolve to a single device (or if this
field is empty or not present), the runtime will attempt to
choose a device automatically.
      string device = 4;
      Returns:
      The device.

    • getDeviceBytes

      ByteString getDeviceBytes()
      A (possibly partial) specification for the device on which this
node should be placed.
The expected syntax for this string is as follows:
DEVICE_SPEC ::= PARTIAL_SPEC
PARTIAL_SPEC ::= ("/" CONSTRAINT) *
CONSTRAINT ::= ("job:" JOB_NAME)
             | ("replica:" [1-9][0-9]*)
             | ("task:" [1-9][0-9]*)
             | ("device:" [A-Za-z]* ":" ([1-9][0-9]* | "*") )
Valid values for this string include:
* "/job:worker/replica:0/task:1/device:GPU:3"  (full specification)
* "/job:worker/device:GPU:3"                   (partial specification)
* ""                                    (no specification)
If the constraints do not resolve to a single device (or if this
field is empty or not present), the runtime will attempt to
choose a device automatically.
      string device = 4;
      Returns:
      The bytes for device.

    • getAttrCount

      int getAttrCount()
      Operation-specific graph-construction-time configuration.
Note that this should include all attrs defined in the
corresponding OpDef, including those with a value matching
the default -- this allows the default to change and makes
NodeDefs easier to interpret on their own.  However, if
an attr with a default is not specified in this list, the
default will be used.
The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and
one of the names from the corresponding OpDef's attr field).
The values must have a type matching the corresponding OpDef
attr's type field.
TODO(josh11b): Add some examples here showing best practices.
      map<string, .tensorflow.AttrValue> attr = 5;

    • containsAttr

      boolean containsAttr(String key)
      Operation-specific graph-construction-time configuration.
Note that this should include all attrs defined in the
corresponding OpDef, including those with a value matching
the default -- this allows the default to change and makes
NodeDefs easier to interpret on their own.  However, if
an attr with a default is not specified in this list, the
default will be used.
The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and
one of the names from the corresponding OpDef's attr field).
The values must have a type matching the corresponding OpDef
attr's type field.
TODO(josh11b): Add some examples here showing best practices.
      map<string, .tensorflow.AttrValue> attr = 5;

    • getAttr

      @Deprecated Map<String, AttrValue> getAttr()
      Deprecated.
      Use getAttrMap() instead.

    • getAttrMap

      Map<String, AttrValue> getAttrMap()
      Operation-specific graph-construction-time configuration.
Note that this should include all attrs defined in the
corresponding OpDef, including those with a value matching
the default -- this allows the default to change and makes
NodeDefs easier to interpret on their own.  However, if
an attr with a default is not specified in this list, the
default will be used.
The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and
one of the names from the corresponding OpDef's attr field).
The values must have a type matching the corresponding OpDef
attr's type field.
TODO(josh11b): Add some examples here showing best practices.
      map<string, .tensorflow.AttrValue> attr = 5;

    • getAttrOrDefault

      AttrValue getAttrOrDefault(String key, AttrValue defaultValue)
      Operation-specific graph-construction-time configuration.
Note that this should include all attrs defined in the
corresponding OpDef, including those with a value matching
the default -- this allows the default to change and makes
NodeDefs easier to interpret on their own.  However, if
an attr with a default is not specified in this list, the
default will be used.
The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and
one of the names from the corresponding OpDef's attr field).
The values must have a type matching the corresponding OpDef
attr's type field.
TODO(josh11b): Add some examples here showing best practices.
      map<string, .tensorflow.AttrValue> attr = 5;

    • getAttrOrThrow

      AttrValue getAttrOrThrow(String key)
      Operation-specific graph-construction-time configuration.
Note that this should include all attrs defined in the
corresponding OpDef, including those with a value matching
the default -- this allows the default to change and makes
NodeDefs easier to interpret on their own.  However, if
an attr with a default is not specified in this list, the
default will be used.
The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and
one of the names from the corresponding OpDef's attr field).
The values must have a type matching the corresponding OpDef
attr's type field.
TODO(josh11b): Add some examples here showing best practices.
      map<string, .tensorflow.AttrValue> attr = 5;

    • hasExperimentalDebugInfo

      boolean hasExperimentalDebugInfo()
      This stores debug information associated with the node.
      .tensorflow.NodeDef.ExperimentalDebugInfo experimental_debug_info = 6;
      Returns:
      Whether the experimentalDebugInfo field is set.

    • getExperimentalDebugInfo

      NodeDef.ExperimentalDebugInfo getExperimentalDebugInfo()
      This stores debug information associated with the node.
      .tensorflow.NodeDef.ExperimentalDebugInfo experimental_debug_info = 6;
      Returns:
      The experimentalDebugInfo.

    • getExperimentalDebugInfoOrBuilder

      NodeDef.ExperimentalDebugInfoOrBuilder getExperimentalDebugInfoOrBuilder()
      This stores debug information associated with the node.
      .tensorflow.NodeDef.ExperimentalDebugInfo experimental_debug_info = 6;

    • hasExperimentalType

      boolean hasExperimentalType()
      The complete type of this node. Experimental and subject to change.
Currently, the field only contains the return types of the node. That will
extend in the future to contain the entire signature of the node, as a
function type.
      .tensorflow.FullTypeDef experimental_type = 7;
      Returns:
      Whether the experimentalType field is set.

    • getExperimentalType

      FullTypeDef getExperimentalType()
      The complete type of this node. Experimental and subject to change.
Currently, the field only contains the return types of the node. That will
extend in the future to contain the entire signature of the node, as a
function type.
      .tensorflow.FullTypeDef experimental_type = 7;
      Returns:
      The experimentalType.

    • getExperimentalTypeOrBuilder

      FullTypeDefOrBuilder getExperimentalTypeOrBuilder()
      The complete type of this node. Experimental and subject to change.
Currently, the field only contains the return types of the node. That will
extend in the future to contain the entire signature of the node, as a
function type.
      .tensorflow.FullTypeDef experimental_type = 7;