Package org.tensorflow.framework

Class SignatureDef

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, SignatureDefOrBuilder
    public final class SignatureDef
extends com.google.protobuf.GeneratedMessageV3
implements SignatureDefOrBuilder
     SignatureDef defines the signature of a computation supported by a TensorFlow
 graph.
 For example, a model with two loss computations, sharing a single input,
 might have the following signature_def map.
 Note that across the two SignatureDefs "loss_A" and "loss_B", the input key,
 output key, and method_name are identical, and will be used by system(s) that
 implement or rely upon this particular loss method. The output tensor names
 differ, demonstrating how different outputs can exist for the same method.
 signature_def {
   key: "loss_A"
   value {
     inputs {
       key: "input"
       value {
         name: "input:0"
         dtype: DT_STRING
         tensor_shape: ...
       }
     }
     outputs {
       key: "loss_output"
       value {
         name: "loss_output_A:0"
         dtype: DT_FLOAT
         tensor_shape: ...
       }
     }
   }
   ...
   method_name: "some/package/compute_loss"
 }
 signature_def {
   key: "loss_B"
   value {
     inputs {
       key: "input"
       value {
         name: "input:0"
         dtype: DT_STRING
         tensor_shape: ...
       }
     }
     outputs {
       key: "loss_output"
       value {
         name: "loss_output_B:0"
         dtype: DT_FLOAT
         tensor_shape: ...
       }
     }
   }
   ...
   method_name: "some/package/compute_loss"
 }
    Protobuf type tensorflow.SignatureDef
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SignatureDef.Builder
      SignatureDef defines the signature of a computation supported by a TensorFlow graph.

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int INPUTS_FIELD_NUMBER  
      static int METHOD_NAME_FIELD_NUMBER  
      static int OUTPUTS_FIELD_NUMBER  

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

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsInputs​(java.lang.String key)
      Named input parameters.
      boolean containsOutputs​(java.lang.String key)
      Named output parameters.
      boolean equals​(java.lang.Object obj)  
      static SignatureDef getDefaultInstance()  
      SignatureDef getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.util.Map<java.lang.String,​TensorInfo> getInputs()
      Deprecated.
      int getInputsCount()
      Named input parameters.
      java.util.Map<java.lang.String,​TensorInfo> getInputsMap()
      Named input parameters.
      TensorInfo getInputsOrDefault​(java.lang.String key, TensorInfo defaultValue)
      Named input parameters.
      TensorInfo getInputsOrThrow​(java.lang.String key)
      Named input parameters.
      java.lang.String getMethodName()
      Extensible method_name information enabling third-party users to mark a SignatureDef as supporting a particular method.
      com.google.protobuf.ByteString getMethodNameBytes()
      Extensible method_name information enabling third-party users to mark a SignatureDef as supporting a particular method.
      java.util.Map<java.lang.String,​TensorInfo> getOutputs()
      Deprecated.
      int getOutputsCount()
      Named output parameters.
      java.util.Map<java.lang.String,​TensorInfo> getOutputsMap()
      Named output parameters.
      TensorInfo getOutputsOrDefault​(java.lang.String key, TensorInfo defaultValue)
      Named output parameters.
      TensorInfo getOutputsOrThrow​(java.lang.String key)
      Named output parameters.
      com.google.protobuf.Parser<SignatureDef> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      boolean isInitialized()  
      static SignatureDef.Builder newBuilder()  
      static SignatureDef.Builder newBuilder​(SignatureDef prototype)  
      SignatureDef.Builder newBuilderForType()  
      protected SignatureDef.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static SignatureDef parseDelimitedFrom​(java.io.InputStream input)  
      static SignatureDef parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SignatureDef parseFrom​(byte[] data)  
      static SignatureDef parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SignatureDef parseFrom​(com.google.protobuf.ByteString data)  
      static SignatureDef parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SignatureDef parseFrom​(com.google.protobuf.CodedInputStream input)  
      static SignatureDef parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SignatureDef parseFrom​(java.io.InputStream input)  
      static SignatureDef parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static SignatureDef parseFrom​(java.nio.ByteBuffer data)  
      static SignatureDef parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<SignatureDef> parser()  
      SignatureDef.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

      • containsInputs

        public boolean containsInputs​(java.lang.String key)
         Named input parameters.
        map<string, .tensorflow.TensorInfo> inputs = 1;
        Specified by:
        containsInputs in interface SignatureDefOrBuilder

      • getInputsMap

        public java.util.Map<java.lang.String,​TensorInfo> getInputsMap()
         Named input parameters.
        map<string, .tensorflow.TensorInfo> inputs = 1;
        Specified by:
        getInputsMap in interface SignatureDefOrBuilder

      • containsOutputs

        public boolean containsOutputs​(java.lang.String key)
         Named output parameters.
        map<string, .tensorflow.TensorInfo> outputs = 2;
        Specified by:
        containsOutputs in interface SignatureDefOrBuilder

      • getOutputsMap

        public java.util.Map<java.lang.String,​TensorInfo> getOutputsMap()
         Named output parameters.
        map<string, .tensorflow.TensorInfo> outputs = 2;
        Specified by:
        getOutputsMap in interface SignatureDefOrBuilder

      • getMethodName

        public java.lang.String getMethodName()
         Extensible method_name information enabling third-party users to mark a
 SignatureDef as supporting a particular method. This enables producers and
 consumers of SignatureDefs, e.g. a model definition library and a serving
 library to have a clear hand-off regarding the semantics of a computation.
 Note that multiple SignatureDefs in a single MetaGraphDef may have the same
 method_name. This is commonly used to support multi-headed computation,
 where a single graph computation may return multiple results.
        string method_name = 3;
        Specified by:
        getMethodName in interface SignatureDefOrBuilder
        Returns:
        The methodName.

      • getMethodNameBytes

        public com.google.protobuf.ByteString getMethodNameBytes()
         Extensible method_name information enabling third-party users to mark a
 SignatureDef as supporting a particular method. This enables producers and
 consumers of SignatureDefs, e.g. a model definition library and a serving
 library to have a clear hand-off regarding the semantics of a computation.
 Note that multiple SignatureDefs in a single MetaGraphDef may have the same
 method_name. This is commonly used to support multi-headed computation,
 where a single graph computation may return multiple results.
        string method_name = 3;
        Specified by:
        getMethodNameBytes in interface SignatureDefOrBuilder
        Returns:
        The bytes for methodName.

      • 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 SignatureDef parseFrom​(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static SignatureDef getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<SignatureDef> 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 SignatureDef getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder