Package tensorflow

Class Struct.StructuredValue

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
tensorflow.Struct.StructuredValue
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Struct.StructuredValueOrBuilder
Enclosing class:
Struct
public static final class Struct.StructuredValue extends com.google.protobuf.GeneratedMessageV3 implements Struct.StructuredValueOrBuilder
 `StructuredValue` represents a dynamically typed value representing various
 data structures that are inspired by Python data structures typically used in
 TensorFlow functions as inputs and outputs.

 For example when saving a Layer there may be a `training` argument. If the
 user passes a boolean True/False, that switches between two concrete
 TensorFlow functions. In order to switch between them in the same way after
 loading the SavedModel, we need to represent "True" and "False".

 A more advanced example might be a function which takes a list of
 dictionaries mapping from strings to Tensors. In order to map from
 user-specified arguments `[{"a": tf.constant(1.)}, {"q": tf.constant(3.)}]`
 after load to the right saved TensorFlow function, we need to represent the
 nested structure and the strings, recording that we have a trace for anything
 matching `[{"a": tf.TensorSpec(None, tf.float32)}, {"q": tf.TensorSpec([],
 tf.float64)}]` as an example.

 Likewise functions may return nested structures of Tensors, for example
 returning a dictionary mapping from strings to Tensors. In order for the
 loaded function to return the same structure we need to serialize it.

 This is an ergonomic aid for working with loaded SavedModels, not a promise
 to serialize all possible function signatures. For example we do not expect
 to pickle generic Python objects, and ideally we'd stay language-agnostic.
Protobuf type tensorflow.StructuredValue
See Also:

  • Field Details

    • NONE_VALUE_FIELD_NUMBER

      public static final int NONE_VALUE_FIELD_NUMBER
      See Also:

    • FLOAT64_VALUE_FIELD_NUMBER

      public static final int FLOAT64_VALUE_FIELD_NUMBER
      See Also:

    • INT64_VALUE_FIELD_NUMBER

      public static final int INT64_VALUE_FIELD_NUMBER
      See Also:

    • STRING_VALUE_FIELD_NUMBER

      public static final int STRING_VALUE_FIELD_NUMBER
      See Also:

    • BOOL_VALUE_FIELD_NUMBER

      public static final int BOOL_VALUE_FIELD_NUMBER
      See Also:

    • TENSOR_SHAPE_VALUE_FIELD_NUMBER

      public static final int TENSOR_SHAPE_VALUE_FIELD_NUMBER
      See Also:

    • TENSOR_DTYPE_VALUE_FIELD_NUMBER

      public static final int TENSOR_DTYPE_VALUE_FIELD_NUMBER
      See Also:

    • TENSOR_SPEC_VALUE_FIELD_NUMBER

      public static final int TENSOR_SPEC_VALUE_FIELD_NUMBER
      See Also:

    • TYPE_SPEC_VALUE_FIELD_NUMBER

      public static final int TYPE_SPEC_VALUE_FIELD_NUMBER
      See Also:

    • BOUNDED_TENSOR_SPEC_VALUE_FIELD_NUMBER

      public static final int BOUNDED_TENSOR_SPEC_VALUE_FIELD_NUMBER
      See Also:

    • LIST_VALUE_FIELD_NUMBER

      public static final int LIST_VALUE_FIELD_NUMBER
      See Also:

    • TUPLE_VALUE_FIELD_NUMBER

      public static final int TUPLE_VALUE_FIELD_NUMBER
      See Also:

    • DICT_VALUE_FIELD_NUMBER

      public static final int DICT_VALUE_FIELD_NUMBER
      See Also:

    • NAMED_TUPLE_VALUE_FIELD_NUMBER

      public static final int NAMED_TUPLE_VALUE_FIELD_NUMBER
      See Also:

    • TENSOR_VALUE_FIELD_NUMBER

      public static final int TENSOR_VALUE_FIELD_NUMBER
      See Also:

    • NUMPY_VALUE_FIELD_NUMBER

      public static final int NUMPY_VALUE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

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

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getKindCase

      public Struct.StructuredValue.KindCase getKindCase()
      Specified by:
      getKindCase in interface Struct.StructuredValueOrBuilder

    • hasNoneValue

      public boolean hasNoneValue()
       Represents None.
      .tensorflow.NoneValue none_value = 1;
      Specified by:
      hasNoneValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the noneValue field is set.

    • getNoneValue

      public Struct.NoneValue getNoneValue()
       Represents None.
      .tensorflow.NoneValue none_value = 1;
      Specified by:
      getNoneValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The noneValue.

    • getNoneValueOrBuilder

      public Struct.NoneValueOrBuilder getNoneValueOrBuilder()
       Represents None.
      .tensorflow.NoneValue none_value = 1;
      Specified by:
      getNoneValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasFloat64Value

      public boolean hasFloat64Value()
       Represents a double-precision floating-point value (a Python `float`).
      double float64_value = 11;
      Specified by:
      hasFloat64Value in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the float64Value field is set.

    • getFloat64Value

      public double getFloat64Value()
       Represents a double-precision floating-point value (a Python `float`).
      double float64_value = 11;
      Specified by:
      getFloat64Value in interface Struct.StructuredValueOrBuilder
      Returns:
      The float64Value.

    • hasInt64Value

      public boolean hasInt64Value()
       Represents a signed integer value, limited to 64 bits.
 Larger values from Python's arbitrary-precision integers are unsupported.
      sint64 int64_value = 12;
      Specified by:
      hasInt64Value in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the int64Value field is set.

    • getInt64Value

      public long getInt64Value()
       Represents a signed integer value, limited to 64 bits.
 Larger values from Python's arbitrary-precision integers are unsupported.
      sint64 int64_value = 12;
      Specified by:
      getInt64Value in interface Struct.StructuredValueOrBuilder
      Returns:
      The int64Value.

    • hasStringValue

      public boolean hasStringValue()
       Represents a string of Unicode characters stored in a Python `str`.
 In Python 3, this is exactly what type `str` is.
 In Python 2, this is the UTF-8 encoding of the characters.
 For strings with ASCII characters only (as often used in TensorFlow code)
 there is effectively no difference between the language versions.
 The obsolescent `unicode` type of Python 2 is not supported here.
      string string_value = 13;
      Specified by:
      hasStringValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the stringValue field is set.

    • getStringValue

      public String getStringValue()
       Represents a string of Unicode characters stored in a Python `str`.
 In Python 3, this is exactly what type `str` is.
 In Python 2, this is the UTF-8 encoding of the characters.
 For strings with ASCII characters only (as often used in TensorFlow code)
 there is effectively no difference between the language versions.
 The obsolescent `unicode` type of Python 2 is not supported here.
      string string_value = 13;
      Specified by:
      getStringValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The stringValue.

    • getStringValueBytes

      public com.google.protobuf.ByteString getStringValueBytes()
       Represents a string of Unicode characters stored in a Python `str`.
 In Python 3, this is exactly what type `str` is.
 In Python 2, this is the UTF-8 encoding of the characters.
 For strings with ASCII characters only (as often used in TensorFlow code)
 there is effectively no difference between the language versions.
 The obsolescent `unicode` type of Python 2 is not supported here.
      string string_value = 13;
      Specified by:
      getStringValueBytes in interface Struct.StructuredValueOrBuilder
      Returns:
      The bytes for stringValue.

    • hasBoolValue

      public boolean hasBoolValue()
       Represents a boolean value.
      bool bool_value = 14;
      Specified by:
      hasBoolValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the boolValue field is set.

    • getBoolValue

      public boolean getBoolValue()
       Represents a boolean value.
      bool bool_value = 14;
      Specified by:
      getBoolValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The boolValue.

    • hasTensorShapeValue

      public boolean hasTensorShapeValue()
       Represents a TensorShape.
      .tensorflow.TensorShapeProto tensor_shape_value = 31;
      Specified by:
      hasTensorShapeValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the tensorShapeValue field is set.

    • getTensorShapeValue

      public TensorShapeProto getTensorShapeValue()
       Represents a TensorShape.
      .tensorflow.TensorShapeProto tensor_shape_value = 31;
      Specified by:
      getTensorShapeValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The tensorShapeValue.

    • getTensorShapeValueOrBuilder

      public TensorShapeProtoOrBuilder getTensorShapeValueOrBuilder()
       Represents a TensorShape.
      .tensorflow.TensorShapeProto tensor_shape_value = 31;
      Specified by:
      getTensorShapeValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasTensorDtypeValue

      public boolean hasTensorDtypeValue()
       Represents an enum value for dtype.
      .tensorflow.DataType tensor_dtype_value = 32;
      Specified by:
      hasTensorDtypeValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the tensorDtypeValue field is set.

    • getTensorDtypeValueValue

      public int getTensorDtypeValueValue()
       Represents an enum value for dtype.
      .tensorflow.DataType tensor_dtype_value = 32;
      Specified by:
      getTensorDtypeValueValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The enum numeric value on the wire for tensorDtypeValue.

    • getTensorDtypeValue

      public DataType getTensorDtypeValue()
       Represents an enum value for dtype.
      .tensorflow.DataType tensor_dtype_value = 32;
      Specified by:
      getTensorDtypeValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The tensorDtypeValue.

    • hasTensorSpecValue

      public boolean hasTensorSpecValue()
       Represents a value for tf.TensorSpec.
      .tensorflow.TensorSpecProto tensor_spec_value = 33;
      Specified by:
      hasTensorSpecValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the tensorSpecValue field is set.

    • getTensorSpecValue

      public Struct.TensorSpecProto getTensorSpecValue()
       Represents a value for tf.TensorSpec.
      .tensorflow.TensorSpecProto tensor_spec_value = 33;
      Specified by:
      getTensorSpecValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The tensorSpecValue.

    • getTensorSpecValueOrBuilder

      public Struct.TensorSpecProtoOrBuilder getTensorSpecValueOrBuilder()
       Represents a value for tf.TensorSpec.
      .tensorflow.TensorSpecProto tensor_spec_value = 33;
      Specified by:
      getTensorSpecValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasTypeSpecValue

      public boolean hasTypeSpecValue()
       Represents a value for tf.TypeSpec.
      .tensorflow.TypeSpecProto type_spec_value = 34;
      Specified by:
      hasTypeSpecValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the typeSpecValue field is set.

    • getTypeSpecValue

      public Struct.TypeSpecProto getTypeSpecValue()
       Represents a value for tf.TypeSpec.
      .tensorflow.TypeSpecProto type_spec_value = 34;
      Specified by:
      getTypeSpecValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The typeSpecValue.

    • getTypeSpecValueOrBuilder

      public Struct.TypeSpecProtoOrBuilder getTypeSpecValueOrBuilder()
       Represents a value for tf.TypeSpec.
      .tensorflow.TypeSpecProto type_spec_value = 34;
      Specified by:
      getTypeSpecValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasBoundedTensorSpecValue

      public boolean hasBoundedTensorSpecValue()
       Represents a value for tf.BoundedTensorSpec.
      .tensorflow.BoundedTensorSpecProto bounded_tensor_spec_value = 35;
      Specified by:
      hasBoundedTensorSpecValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the boundedTensorSpecValue field is set.

    • getBoundedTensorSpecValue

      public Struct.BoundedTensorSpecProto getBoundedTensorSpecValue()
       Represents a value for tf.BoundedTensorSpec.
      .tensorflow.BoundedTensorSpecProto bounded_tensor_spec_value = 35;
      Specified by:
      getBoundedTensorSpecValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The boundedTensorSpecValue.

    • getBoundedTensorSpecValueOrBuilder

      public Struct.BoundedTensorSpecProtoOrBuilder getBoundedTensorSpecValueOrBuilder()
       Represents a value for tf.BoundedTensorSpec.
      .tensorflow.BoundedTensorSpecProto bounded_tensor_spec_value = 35;
      Specified by:
      getBoundedTensorSpecValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasListValue

      public boolean hasListValue()
       Represents a list of `Value`.
      .tensorflow.ListValue list_value = 51;
      Specified by:
      hasListValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the listValue field is set.

    • getListValue

      public Struct.ListValue getListValue()
       Represents a list of `Value`.
      .tensorflow.ListValue list_value = 51;
      Specified by:
      getListValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The listValue.

    • getListValueOrBuilder

      public Struct.ListValueOrBuilder getListValueOrBuilder()
       Represents a list of `Value`.
      .tensorflow.ListValue list_value = 51;
      Specified by:
      getListValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasTupleValue

      public boolean hasTupleValue()
       Represents a tuple of `Value`.
      .tensorflow.TupleValue tuple_value = 52;
      Specified by:
      hasTupleValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the tupleValue field is set.

    • getTupleValue

      public Struct.TupleValue getTupleValue()
       Represents a tuple of `Value`.
      .tensorflow.TupleValue tuple_value = 52;
      Specified by:
      getTupleValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The tupleValue.

    • getTupleValueOrBuilder

      public Struct.TupleValueOrBuilder getTupleValueOrBuilder()
       Represents a tuple of `Value`.
      .tensorflow.TupleValue tuple_value = 52;
      Specified by:
      getTupleValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasDictValue

      public boolean hasDictValue()
       Represents a dict `Value`.
      .tensorflow.DictValue dict_value = 53;
      Specified by:
      hasDictValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the dictValue field is set.

    • getDictValue

      public Struct.DictValue getDictValue()
       Represents a dict `Value`.
      .tensorflow.DictValue dict_value = 53;
      Specified by:
      getDictValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The dictValue.

    • getDictValueOrBuilder

      public Struct.DictValueOrBuilder getDictValueOrBuilder()
       Represents a dict `Value`.
      .tensorflow.DictValue dict_value = 53;
      Specified by:
      getDictValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasNamedTupleValue

      public boolean hasNamedTupleValue()
       Represents Python's namedtuple.
      .tensorflow.NamedTupleValue named_tuple_value = 54;
      Specified by:
      hasNamedTupleValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the namedTupleValue field is set.

    • getNamedTupleValue

      public Struct.NamedTupleValue getNamedTupleValue()
       Represents Python's namedtuple.
      .tensorflow.NamedTupleValue named_tuple_value = 54;
      Specified by:
      getNamedTupleValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The namedTupleValue.

    • getNamedTupleValueOrBuilder

      public Struct.NamedTupleValueOrBuilder getNamedTupleValueOrBuilder()
       Represents Python's namedtuple.
      .tensorflow.NamedTupleValue named_tuple_value = 54;
      Specified by:
      getNamedTupleValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasTensorValue

      public boolean hasTensorValue()
       Represents a value for tf.Tensor.
      .tensorflow.TensorProto tensor_value = 55;
      Specified by:
      hasTensorValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the tensorValue field is set.

    • getTensorValue

      public TensorProto getTensorValue()
       Represents a value for tf.Tensor.
      .tensorflow.TensorProto tensor_value = 55;
      Specified by:
      getTensorValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The tensorValue.

    • getTensorValueOrBuilder

      public TensorProtoOrBuilder getTensorValueOrBuilder()
       Represents a value for tf.Tensor.
      .tensorflow.TensorProto tensor_value = 55;
      Specified by:
      getTensorValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • hasNumpyValue

      public boolean hasNumpyValue()
       Represents a value for np.ndarray.
      .tensorflow.TensorProto numpy_value = 56;
      Specified by:
      hasNumpyValue in interface Struct.StructuredValueOrBuilder
      Returns:
      Whether the numpyValue field is set.

    • getNumpyValue

      public TensorProto getNumpyValue()
       Represents a value for np.ndarray.
      .tensorflow.TensorProto numpy_value = 56;
      Specified by:
      getNumpyValue in interface Struct.StructuredValueOrBuilder
      Returns:
      The numpyValue.

    • getNumpyValueOrBuilder

      public TensorProtoOrBuilder getNumpyValueOrBuilder()
       Represents a value for np.ndarray.
      .tensorflow.TensorProto numpy_value = 56;
      Specified by:
      getNumpyValueOrBuilder in interface Struct.StructuredValueOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 Struct.StructuredValue parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Struct.StructuredValue parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Struct.StructuredValue parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Struct.StructuredValue parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Struct.StructuredValue parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Struct.StructuredValue parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Struct.StructuredValue parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Struct.StructuredValue parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Struct.StructuredValue parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Struct.StructuredValue.Builder newBuilder()

    • newBuilder

      public static Struct.StructuredValue.Builder newBuilder(Struct.StructuredValue prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Struct.StructuredValue getDefaultInstance()

    • parser

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

    • getParserForType

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