Package org.tensorflow.framework

Class FunctionDef

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, FunctionDefOrBuilder
    public final class FunctionDef
extends com.google.protobuf.GeneratedMessageV3
implements FunctionDefOrBuilder
     A function can be instantiated when the runtime can bind every attr
 with a value. When a GraphDef has a call to a function, it must
 have binding for every attr defined in the signature.
 TODO(zhifengc):
   * device spec, etc.
    Protobuf type tensorflow.FunctionDef
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  FunctionDef.ArgAttrs
      Attributes for function arguments.
      static interface  FunctionDef.ArgAttrsOrBuilder  
      static class  FunctionDef.Builder
      A function can be instantiated when the runtime can bind every attr with a value.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsArgAttr​(int key)
      map<uint32, .tensorflow.FunctionDef.ArgAttrs> arg_attr = 7;
      boolean containsAttr​(java.lang.String key)
      Attributes specific to this function definition.
      boolean containsControlRet​(java.lang.String key)
      A mapping from control output names from `signature` to node names in `node_def` which should be control outputs of this function.
      boolean containsRet​(java.lang.String key)
      A mapping from the output arg names from `signature` to the outputs from `node_def` that should be returned by the function.
      boolean equals​(java.lang.Object obj)  
      java.util.Map<java.lang.Integer,​FunctionDef.ArgAttrs> getArgAttr()
      Deprecated.
      int getArgAttrCount()
      map<uint32, .tensorflow.FunctionDef.ArgAttrs> arg_attr = 7;
      java.util.Map<java.lang.Integer,​FunctionDef.ArgAttrs> getArgAttrMap()
      map<uint32, .tensorflow.FunctionDef.ArgAttrs> arg_attr = 7;
      FunctionDef.ArgAttrs getArgAttrOrDefault​(int key, FunctionDef.ArgAttrs defaultValue)
      map<uint32, .tensorflow.FunctionDef.ArgAttrs> arg_attr = 7;
      FunctionDef.ArgAttrs getArgAttrOrThrow​(int key)
      map<uint32, .tensorflow.FunctionDef.ArgAttrs> arg_attr = 7;
      java.util.Map<java.lang.String,​AttrValue> getAttr()
      Deprecated.
      int getAttrCount()
      Attributes specific to this function definition.
      java.util.Map<java.lang.String,​AttrValue> getAttrMap()
      Attributes specific to this function definition.
      AttrValue getAttrOrDefault​(java.lang.String key, AttrValue defaultValue)
      Attributes specific to this function definition.
      AttrValue getAttrOrThrow​(java.lang.String key)
      Attributes specific to this function definition.
      java.util.Map<java.lang.String,​java.lang.String> getControlRet()
      Deprecated.
      int getControlRetCount()
      A mapping from control output names from `signature` to node names in `node_def` which should be control outputs of this function.
      java.util.Map<java.lang.String,​java.lang.String> getControlRetMap()
      A mapping from control output names from `signature` to node names in `node_def` which should be control outputs of this function.
      java.lang.String getControlRetOrDefault​(java.lang.String key, java.lang.String defaultValue)
      A mapping from control output names from `signature` to node names in `node_def` which should be control outputs of this function.
      java.lang.String getControlRetOrThrow​(java.lang.String key)
      A mapping from control output names from `signature` to node names in `node_def` which should be control outputs of this function.
      static FunctionDef getDefaultInstance()  
      FunctionDef getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      NodeDef getNodeDef​(int index)
      By convention, "op" in node_def is resolved by consulting with a user-defined library first.
      int getNodeDefCount()
      By convention, "op" in node_def is resolved by consulting with a user-defined library first.
      java.util.List<NodeDef> getNodeDefList()
      By convention, "op" in node_def is resolved by consulting with a user-defined library first.
      NodeDefOrBuilder getNodeDefOrBuilder​(int index)
      By convention, "op" in node_def is resolved by consulting with a user-defined library first.
      java.util.List<? extends NodeDefOrBuilder> getNodeDefOrBuilderList()
      By convention, "op" in node_def is resolved by consulting with a user-defined library first.
      com.google.protobuf.Parser<FunctionDef> getParserForType()  
      java.util.Map<java.lang.String,​java.lang.String> getRet()
      Deprecated.
      int getRetCount()
      A mapping from the output arg names from `signature` to the outputs from `node_def` that should be returned by the function.
      java.util.Map<java.lang.String,​java.lang.String> getRetMap()
      A mapping from the output arg names from `signature` to the outputs from `node_def` that should be returned by the function.
      java.lang.String getRetOrDefault​(java.lang.String key, java.lang.String defaultValue)
      A mapping from the output arg names from `signature` to the outputs from `node_def` that should be returned by the function.
      java.lang.String getRetOrThrow​(java.lang.String key)
      A mapping from the output arg names from `signature` to the outputs from `node_def` that should be returned by the function.
      int getSerializedSize()  
      OpDef getSignature()
      The definition of the function's name, arguments, return values, attrs etc.
      OpDefOrBuilder getSignatureOrBuilder()
      The definition of the function's name, arguments, return values, attrs etc.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasSignature()
      The definition of the function's name, arguments, return values, attrs etc.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      boolean isInitialized()  
      static FunctionDef.Builder newBuilder()  
      static FunctionDef.Builder newBuilder​(FunctionDef prototype)  
      FunctionDef.Builder newBuilderForType()  
      protected FunctionDef.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static FunctionDef parseDelimitedFrom​(java.io.InputStream input)  
      static FunctionDef parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FunctionDef parseFrom​(byte[] data)  
      static FunctionDef parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FunctionDef parseFrom​(com.google.protobuf.ByteString data)  
      static FunctionDef parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FunctionDef parseFrom​(com.google.protobuf.CodedInputStream input)  
      static FunctionDef parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FunctionDef parseFrom​(java.io.InputStream input)  
      static FunctionDef parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static FunctionDef parseFrom​(java.nio.ByteBuffer data)  
      static FunctionDef parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<FunctionDef> parser()  
      FunctionDef.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasSignature

        public boolean hasSignature()
         The definition of the function's name, arguments, return values,
 attrs etc.
        .tensorflow.OpDef signature = 1;
        Specified by:
        hasSignature in interface FunctionDefOrBuilder
        Returns:
        Whether the signature field is set.

      • getSignature

        public OpDef getSignature()
         The definition of the function's name, arguments, return values,
 attrs etc.
        .tensorflow.OpDef signature = 1;
        Specified by:
        getSignature in interface FunctionDefOrBuilder
        Returns:
        The signature.

      • containsAttr

        public boolean containsAttr​(java.lang.String key)
         Attributes specific to this function definition.
        map<string, .tensorflow.AttrValue> attr = 5;
        Specified by:
        containsAttr in interface FunctionDefOrBuilder

      • getAttrMap

        public java.util.Map<java.lang.String,​AttrValue> getAttrMap()
         Attributes specific to this function definition.
        map<string, .tensorflow.AttrValue> attr = 5;
        Specified by:
        getAttrMap in interface FunctionDefOrBuilder

      • getAttrOrThrow

        public AttrValue getAttrOrThrow​(java.lang.String key)
         Attributes specific to this function definition.
        map<string, .tensorflow.AttrValue> attr = 5;
        Specified by:
        getAttrOrThrow in interface FunctionDefOrBuilder

      • containsArgAttr

        public boolean containsArgAttr​(int key)
        map<uint32, .tensorflow.FunctionDef.ArgAttrs> arg_attr = 7;
        Specified by:
        containsArgAttr in interface FunctionDefOrBuilder

      • getNodeDefList

        public java.util.List<NodeDef> getNodeDefList()
         By convention, "op" in node_def is resolved by consulting with a
 user-defined library first. If not resolved, "func" is assumed to
 be a builtin op.
        repeated .tensorflow.NodeDef node_def = 3;
        Specified by:
        getNodeDefList in interface FunctionDefOrBuilder

      • getNodeDefOrBuilderList

        public java.util.List<? extends NodeDefOrBuilder> getNodeDefOrBuilderList()
         By convention, "op" in node_def is resolved by consulting with a
 user-defined library first. If not resolved, "func" is assumed to
 be a builtin op.
        repeated .tensorflow.NodeDef node_def = 3;
        Specified by:
        getNodeDefOrBuilderList in interface FunctionDefOrBuilder

      • getNodeDefCount

        public int getNodeDefCount()
         By convention, "op" in node_def is resolved by consulting with a
 user-defined library first. If not resolved, "func" is assumed to
 be a builtin op.
        repeated .tensorflow.NodeDef node_def = 3;
        Specified by:
        getNodeDefCount in interface FunctionDefOrBuilder

      • getNodeDef

        public NodeDef getNodeDef​(int index)
         By convention, "op" in node_def is resolved by consulting with a
 user-defined library first. If not resolved, "func" is assumed to
 be a builtin op.
        repeated .tensorflow.NodeDef node_def = 3;
        Specified by:
        getNodeDef in interface FunctionDefOrBuilder

      • getNodeDefOrBuilder

        public NodeDefOrBuilder getNodeDefOrBuilder​(int index)
         By convention, "op" in node_def is resolved by consulting with a
 user-defined library first. If not resolved, "func" is assumed to
 be a builtin op.
        repeated .tensorflow.NodeDef node_def = 3;
        Specified by:
        getNodeDefOrBuilder in interface FunctionDefOrBuilder

      • getRetCount

        public int getRetCount()
        Description copied from interface: FunctionDefOrBuilder
         A mapping from the output arg names from `signature` to the
 outputs from `node_def` that should be returned by the function.
        map<string, string> ret = 4;
        Specified by:
        getRetCount in interface FunctionDefOrBuilder

      • containsRet

        public boolean containsRet​(java.lang.String key)
         A mapping from the output arg names from `signature` to the
 outputs from `node_def` that should be returned by the function.
        map<string, string> ret = 4;
        Specified by:
        containsRet in interface FunctionDefOrBuilder

      • getRetMap

        public java.util.Map<java.lang.String,​java.lang.String> getRetMap()
         A mapping from the output arg names from `signature` to the
 outputs from `node_def` that should be returned by the function.
        map<string, string> ret = 4;
        Specified by:
        getRetMap in interface FunctionDefOrBuilder

      • getRetOrDefault

        public java.lang.String getRetOrDefault​(java.lang.String key,
                                        java.lang.String defaultValue)
         A mapping from the output arg names from `signature` to the
 outputs from `node_def` that should be returned by the function.
        map<string, string> ret = 4;
        Specified by:
        getRetOrDefault in interface FunctionDefOrBuilder

      • getRetOrThrow

        public java.lang.String getRetOrThrow​(java.lang.String key)
         A mapping from the output arg names from `signature` to the
 outputs from `node_def` that should be returned by the function.
        map<string, string> ret = 4;
        Specified by:
        getRetOrThrow in interface FunctionDefOrBuilder

      • getControlRetCount

        public int getControlRetCount()
        Description copied from interface: FunctionDefOrBuilder
         A mapping from control output names from `signature` to node names in
 `node_def` which should be control outputs of this function.
        map<string, string> control_ret = 6;
        Specified by:
        getControlRetCount in interface FunctionDefOrBuilder

      • containsControlRet

        public boolean containsControlRet​(java.lang.String key)
         A mapping from control output names from `signature` to node names in
 `node_def` which should be control outputs of this function.
        map<string, string> control_ret = 6;
        Specified by:
        containsControlRet in interface FunctionDefOrBuilder

      • getControlRetMap

        public java.util.Map<java.lang.String,​java.lang.String> getControlRetMap()
         A mapping from control output names from `signature` to node names in
 `node_def` which should be control outputs of this function.
        map<string, string> control_ret = 6;
        Specified by:
        getControlRetMap in interface FunctionDefOrBuilder

      • getControlRetOrDefault

        public java.lang.String getControlRetOrDefault​(java.lang.String key,
                                               java.lang.String defaultValue)
         A mapping from control output names from `signature` to node names in
 `node_def` which should be control outputs of this function.
        map<string, string> control_ret = 6;
        Specified by:
        getControlRetOrDefault in interface FunctionDefOrBuilder

      • getControlRetOrThrow

        public java.lang.String getControlRetOrThrow​(java.lang.String key)
         A mapping from control output names from `signature` to node names in
 `node_def` which should be control outputs of this function.
        map<string, string> control_ret = 6;
        Specified by:
        getControlRetOrThrow in interface FunctionDefOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static FunctionDef parseFrom​(java.nio.ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FunctionDef parseFrom​(java.nio.ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FunctionDef parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FunctionDef parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FunctionDef parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FunctionDef parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static FunctionDef parseFrom​(java.io.InputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FunctionDef parseFrom​(java.io.InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static FunctionDef parseDelimitedFrom​(java.io.InputStream input)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static FunctionDef parseDelimitedFrom​(java.io.InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FunctionDef parseFrom​(com.google.protobuf.CodedInputStream input)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static FunctionDef parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public FunctionDef.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public FunctionDef.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected FunctionDef.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static FunctionDef getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<FunctionDef> parser()

      • getParserForType

        public com.google.protobuf.Parser<FunctionDef> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public FunctionDef getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder