StructuredValue

public final class StructuredValue 

 `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

Nested Classes

class StructuredValue.Builder 
 `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. 
enum StructuredValue.KindCase  

Constants

int BOOL_VALUE_FIELD_NUMBER
int BOUNDED_TENSOR_SPEC_VALUE_FIELD_NUMBER
int DICT_VALUE_FIELD_NUMBER
int FLOAT64_VALUE_FIELD_NUMBER
int INT64_VALUE_FIELD_NUMBER
int LIST_VALUE_FIELD_NUMBER
int NAMED_TUPLE_VALUE_FIELD_NUMBER
int NONE_VALUE_FIELD_NUMBER
int STRING_VALUE_FIELD_NUMBER
int TENSOR_DTYPE_VALUE_FIELD_NUMBER
int TENSOR_SHAPE_VALUE_FIELD_NUMBER
int TENSOR_SPEC_VALUE_FIELD_NUMBER
int TUPLE_VALUE_FIELD_NUMBER
int TYPE_SPEC_VALUE_FIELD_NUMBER

Public Methods

boolean
equals(Object obj)
boolean
getBoolValue() 
 Represents a boolean value.
BoundedTensorSpecProto
getBoundedTensorSpecValue() 
 Represents a value for tf.BoundedTensorSpec.
BoundedTensorSpecProtoOrBuilder
getBoundedTensorSpecValueOrBuilder() 
 Represents a value for tf.BoundedTensorSpec.
static StructuredValue
getDefaultInstance()
StructuredValue
getDefaultInstanceForType()
final static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
DictValue
getDictValue() 
 Represents a dict `Value`.
DictValueOrBuilder
getDictValueOrBuilder() 
 Represents a dict `Value`.
double
getFloat64Value() 
 Represents a double-precision floating-point value (a Python `float`).
long
getInt64Value() 
 Represents a signed integer value, limited to 64 bits.
StructuredValue.KindCase
getKindCase()
ListValue
getListValue() 
 Represents a list of `Value`.
ListValueOrBuilder
getListValueOrBuilder() 
 Represents a list of `Value`.
NamedTupleValue
getNamedTupleValue() 
 Represents Python's namedtuple.
NamedTupleValueOrBuilder
getNamedTupleValueOrBuilder() 
 Represents Python's namedtuple.
NoneValue
getNoneValue() 
 Represents None.
NoneValueOrBuilder
getNoneValueOrBuilder() 
 Represents None.
getParserForType()
int
getSerializedSize()
String
getStringValue() 
 Represents a string of Unicode characters stored in a Python `str`.
com.google.protobuf.ByteString
getStringValueBytes() 
 Represents a string of Unicode characters stored in a Python `str`.
DataType
getTensorDtypeValue() 
 Represents an enum value for dtype.
int
getTensorDtypeValueValue() 
 Represents an enum value for dtype.
TensorShapeProto
getTensorShapeValue() 
 Represents a TensorShape.
TensorShapeProtoOrBuilder
getTensorShapeValueOrBuilder() 
 Represents a TensorShape.
TensorSpecProto
getTensorSpecValue() 
 Represents a value for tf.TensorSpec.
TensorSpecProtoOrBuilder
getTensorSpecValueOrBuilder() 
 Represents a value for tf.TensorSpec.
TupleValue
getTupleValue() 
 Represents a tuple of `Value`.
TupleValueOrBuilder
getTupleValueOrBuilder() 
 Represents a tuple of `Value`.
TypeSpecProto
getTypeSpecValue() 
 Represents a value for tf.TypeSpec.
TypeSpecProtoOrBuilder
getTypeSpecValueOrBuilder() 
 Represents a value for tf.TypeSpec.
final com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasBoundedTensorSpecValue() 
 Represents a value for tf.BoundedTensorSpec.
boolean
hasDictValue() 
 Represents a dict `Value`.
boolean
hasListValue() 
 Represents a list of `Value`.
boolean
hasNamedTupleValue() 
 Represents Python's namedtuple.
boolean
hasNoneValue() 
 Represents None.
boolean
hasTensorShapeValue() 
 Represents a TensorShape.
boolean
hasTensorSpecValue() 
 Represents a value for tf.TensorSpec.
boolean
hasTupleValue() 
 Represents a tuple of `Value`.
boolean
hasTypeSpecValue() 
 Represents a value for tf.TypeSpec.
int
hashCode()
final boolean
isInitialized()
static StructuredValue.Builder
newBuilder(StructuredValue prototype)
static StructuredValue.Builder
newBuilder()
StructuredValue.Builder
newBuilderForType()
static StructuredValue
parseDelimitedFrom(InputStream input)
static StructuredValue
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredValue
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredValue
parseFrom(com.google.protobuf.CodedInputStream input)
static StructuredValue
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredValue
parseFrom(ByteBuffer data)
static StructuredValue
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredValue
parseFrom(com.google.protobuf.ByteString data)
static StructuredValue
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredValue
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static
parser()
StructuredValue.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)

Inherited Methods

Constants

public static final int BOOL_VALUE_FIELD_NUMBER

Constant Value: 14

public static final int BOUNDED_TENSOR_SPEC_VALUE_FIELD_NUMBER

Constant Value: 35

public static final int DICT_VALUE_FIELD_NUMBER

Constant Value: 53

public static final int FLOAT64_VALUE_FIELD_NUMBER

Constant Value: 11

public static final int INT64_VALUE_FIELD_NUMBER

Constant Value: 12

public static final int LIST_VALUE_FIELD_NUMBER

Constant Value: 51

public static final int NAMED_TUPLE_VALUE_FIELD_NUMBER

Constant Value: 54

public static final int NONE_VALUE_FIELD_NUMBER

Constant Value: 1

public static final int STRING_VALUE_FIELD_NUMBER

Constant Value: 13

public static final int TENSOR_DTYPE_VALUE_FIELD_NUMBER

Constant Value: 32

public static final int TENSOR_SHAPE_VALUE_FIELD_NUMBER

Constant Value: 31

public static final int TENSOR_SPEC_VALUE_FIELD_NUMBER

Constant Value: 33

public static final int TUPLE_VALUE_FIELD_NUMBER

Constant Value: 52

public static final int TYPE_SPEC_VALUE_FIELD_NUMBER

Constant Value: 34

Public Methods

public boolean equals (Object obj)

public boolean getBoolValue () 

 Represents a boolean value.
bool bool_value = 14;

public BoundedTensorSpecProto getBoundedTensorSpecValue () 

 Represents a value for tf.BoundedTensorSpec.
.tensorflow.BoundedTensorSpecProto bounded_tensor_spec_value = 35;

public BoundedTensorSpecProtoOrBuilder getBoundedTensorSpecValueOrBuilder () 

 Represents a value for tf.BoundedTensorSpec.
.tensorflow.BoundedTensorSpecProto bounded_tensor_spec_value = 35;

public static StructuredValue getDefaultInstance ()

public StructuredValue getDefaultInstanceForType ()

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

public DictValue getDictValue () 

 Represents a dict `Value`.
.tensorflow.DictValue dict_value = 53;

public DictValueOrBuilder getDictValueOrBuilder () 

 Represents a dict `Value`.
.tensorflow.DictValue dict_value = 53;

public double getFloat64Value () 

 Represents a double-precision floating-point value (a Python `float`).
double float64_value = 11;

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;

public StructuredValue.KindCase getKindCase ()

public ListValue getListValue () 

 Represents a list of `Value`.
.tensorflow.ListValue list_value = 51;

public ListValueOrBuilder getListValueOrBuilder () 

 Represents a list of `Value`.
.tensorflow.ListValue list_value = 51;

public NamedTupleValue getNamedTupleValue () 

 Represents Python's namedtuple.
.tensorflow.NamedTupleValue named_tuple_value = 54;

public NamedTupleValueOrBuilder getNamedTupleValueOrBuilder () 

 Represents Python's namedtuple.
.tensorflow.NamedTupleValue named_tuple_value = 54;

public NoneValue getNoneValue () 

 Represents None.
.tensorflow.NoneValue none_value = 1;

public NoneValueOrBuilder getNoneValueOrBuilder () 

 Represents None.
.tensorflow.NoneValue none_value = 1;

public getParserForType ()

public int getSerializedSize ()

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;

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;

public DataType getTensorDtypeValue () 

 Represents an enum value for dtype.
.tensorflow.DataType tensor_dtype_value = 32;

public int getTensorDtypeValueValue () 

 Represents an enum value for dtype.
.tensorflow.DataType tensor_dtype_value = 32;

public TensorShapeProto getTensorShapeValue () 

 Represents a TensorShape.
.tensorflow.TensorShapeProto tensor_shape_value = 31;

public TensorShapeProtoOrBuilder getTensorShapeValueOrBuilder () 

 Represents a TensorShape.
.tensorflow.TensorShapeProto tensor_shape_value = 31;

public TensorSpecProto getTensorSpecValue () 

 Represents a value for tf.TensorSpec.
.tensorflow.TensorSpecProto tensor_spec_value = 33;

public TensorSpecProtoOrBuilder getTensorSpecValueOrBuilder () 

 Represents a value for tf.TensorSpec.
.tensorflow.TensorSpecProto tensor_spec_value = 33;

public TupleValue getTupleValue () 

 Represents a tuple of `Value`.
.tensorflow.TupleValue tuple_value = 52;

public TupleValueOrBuilder getTupleValueOrBuilder () 

 Represents a tuple of `Value`.
.tensorflow.TupleValue tuple_value = 52;

public TypeSpecProto getTypeSpecValue () 

 Represents a value for tf.TypeSpec.
.tensorflow.TypeSpecProto type_spec_value = 34;

public TypeSpecProtoOrBuilder getTypeSpecValueOrBuilder () 

 Represents a value for tf.TypeSpec.
.tensorflow.TypeSpecProto type_spec_value = 34;

public final com.google.protobuf.UnknownFieldSet getUnknownFields ()

public boolean hasBoundedTensorSpecValue () 

 Represents a value for tf.BoundedTensorSpec.
.tensorflow.BoundedTensorSpecProto bounded_tensor_spec_value = 35;

public boolean hasDictValue () 

 Represents a dict `Value`.
.tensorflow.DictValue dict_value = 53;

public boolean hasListValue () 

 Represents a list of `Value`.
.tensorflow.ListValue list_value = 51;

public boolean hasNamedTupleValue () 

 Represents Python's namedtuple.
.tensorflow.NamedTupleValue named_tuple_value = 54;

public boolean hasNoneValue () 

 Represents None.
.tensorflow.NoneValue none_value = 1;

public boolean hasTensorShapeValue () 

 Represents a TensorShape.
.tensorflow.TensorShapeProto tensor_shape_value = 31;

public boolean hasTensorSpecValue () 

 Represents a value for tf.TensorSpec.
.tensorflow.TensorSpecProto tensor_spec_value = 33;

public boolean hasTupleValue () 

 Represents a tuple of `Value`.
.tensorflow.TupleValue tuple_value = 52;

public boolean hasTypeSpecValue () 

 Represents a value for tf.TypeSpec.
.tensorflow.TypeSpecProto type_spec_value = 34;

public int hashCode ()

public final boolean isInitialized ()

public static StructuredValue.Builder newBuilder (StructuredValue prototype)

public static StructuredValue.Builder newBuilder ()

public StructuredValue.Builder newBuilderForType ()

public static StructuredValue parseDelimitedFrom (InputStream input)

Throws
IOException

public static StructuredValue parseDelimitedFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static StructuredValue parseFrom (ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static StructuredValue parseFrom (com.google.protobuf.CodedInputStream input)

Throws
IOException

public static StructuredValue parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static StructuredValue parseFrom (ByteBuffer data)

Throws
InvalidProtocolBufferException

public static StructuredValue parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static StructuredValue parseFrom (com.google.protobuf.ByteString data)

Throws
InvalidProtocolBufferException

public static StructuredValue parseFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static StructuredValue parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static parser ()

public StructuredValue.Builder toBuilder ()

public void writeTo (com.google.protobuf.CodedOutputStream output)

Throws
IOException