Package org.tensorflow.framework
Class CollectionDef
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.tensorflow.framework.CollectionDef
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,java.io.Serializable,CollectionDefOrBuilder
public final class CollectionDef extends com.google.protobuf.GeneratedMessageV3 implements CollectionDefOrBuilder
CollectionDef should cover most collections.
To add a user-defined collection, do one of the following:
1. For simple data types, such as string, int, float:
tf.add_to_collection("your_collection_name", your_simple_value)
strings will be stored as bytes_list.
2. For Protobuf types, there are three ways to add them:
1) tf.add_to_collection("your_collection_name",
your_proto.SerializeToString())
collection_def {
key: "user_defined_bytes_collection"
value {
bytes_list {
value: "queue_name: \"test_queue\"\n"
}
}
}
or
2) tf.add_to_collection("your_collection_name", str(your_proto))
collection_def {
key: "user_defined_string_collection"
value {
bytes_list {
value: "\n\ntest_queue"
}
}
}
or
3) any_buf = any_pb2.Any()
tf.add_to_collection("your_collection_name",
any_buf.Pack(your_proto))
collection_def {
key: "user_defined_any_collection"
value {
any_list {
value {
type_url: "type.googleapis.com/tensorflow.QueueRunnerDef"
value: "\n\ntest_queue"
}
}
}
}
3. For Python objects, implement to_proto() and from_proto(), and register
them in the following manner:
ops.register_proto_function("your_collection_name",
proto_type,
to_proto=YourPythonObject.to_proto,
from_proto=YourPythonObject.from_proto)
These functions will be invoked to serialize and de-serialize the
collection. For example,
ops.register_proto_function(ops.GraphKeys.GLOBAL_VARIABLES,
proto_type=variable_pb2.VariableDef,
to_proto=Variable.to_proto,
from_proto=Variable.from_proto)
Protobuf type tensorflow.CollectionDef- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCollectionDef.AnyListAnyList is used for collecting Any protos.static interfaceCollectionDef.AnyListOrBuilderstatic classCollectionDef.BuilderCollectionDef should cover most collections.static classCollectionDef.BytesListBytesList is used for collecting strings and serialized protobufs.static interfaceCollectionDef.BytesListOrBuilderstatic classCollectionDef.FloatListFloatList is used for collecting float values.static interfaceCollectionDef.FloatListOrBuilderstatic classCollectionDef.Int64ListInt64List is used for collecting int, int64 and long values.static interfaceCollectionDef.Int64ListOrBuilderstatic classCollectionDef.KindCasestatic classCollectionDef.NodeListNodeList is used for collecting nodes in graph.static interfaceCollectionDef.NodeListOrBuilderNested 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 -
Field Summary
Fields Modifier and Type Field Description static intANY_LIST_FIELD_NUMBERstatic intBYTES_LIST_FIELD_NUMBERstatic intFLOAT_LIST_FIELD_NUMBERstatic intINT64_LIST_FIELD_NUMBERstatic intNODE_LIST_FIELD_NUMBER -
Method Summary
Modifier and Type Method Description booleanequals(java.lang.Object obj)CollectionDef.AnyListgetAnyList().tensorflow.CollectionDef.AnyList any_list = 5;CollectionDef.AnyListOrBuildergetAnyListOrBuilder().tensorflow.CollectionDef.AnyList any_list = 5;CollectionDef.BytesListgetBytesList().tensorflow.CollectionDef.BytesList bytes_list = 2;CollectionDef.BytesListOrBuildergetBytesListOrBuilder().tensorflow.CollectionDef.BytesList bytes_list = 2;static CollectionDefgetDefaultInstance()CollectionDefgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()CollectionDef.FloatListgetFloatList().tensorflow.CollectionDef.FloatList float_list = 4;CollectionDef.FloatListOrBuildergetFloatListOrBuilder().tensorflow.CollectionDef.FloatList float_list = 4;CollectionDef.Int64ListgetInt64List().tensorflow.CollectionDef.Int64List int64_list = 3;CollectionDef.Int64ListOrBuildergetInt64ListOrBuilder().tensorflow.CollectionDef.Int64List int64_list = 3;CollectionDef.KindCasegetKindCase()CollectionDef.NodeListgetNodeList().tensorflow.CollectionDef.NodeList node_list = 1;CollectionDef.NodeListOrBuildergetNodeListOrBuilder().tensorflow.CollectionDef.NodeList node_list = 1;com.google.protobuf.Parser<CollectionDef>getParserForType()intgetSerializedSize()com.google.protobuf.UnknownFieldSetgetUnknownFields()booleanhasAnyList().tensorflow.CollectionDef.AnyList any_list = 5;booleanhasBytesList().tensorflow.CollectionDef.BytesList bytes_list = 2;booleanhasFloatList().tensorflow.CollectionDef.FloatList float_list = 4;inthashCode()booleanhasInt64List().tensorflow.CollectionDef.Int64List int64_list = 3;booleanhasNodeList().tensorflow.CollectionDef.NodeList node_list = 1;protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static CollectionDef.BuildernewBuilder()static CollectionDef.BuildernewBuilder(CollectionDef prototype)CollectionDef.BuildernewBuilderForType()protected CollectionDef.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected java.lang.ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static CollectionDefparseDelimitedFrom(java.io.InputStream input)static CollectionDefparseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CollectionDefparseFrom(byte[] data)static CollectionDefparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CollectionDefparseFrom(com.google.protobuf.ByteString data)static CollectionDefparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CollectionDefparseFrom(com.google.protobuf.CodedInputStream input)static CollectionDefparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CollectionDefparseFrom(java.io.InputStream input)static CollectionDefparseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static CollectionDefparseFrom(java.nio.ByteBuffer data)static CollectionDefparseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<CollectionDef>parser()CollectionDef.BuildertoBuilder()voidwriteTo(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, internalGetMapField, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Field Details
-
NODE_LIST_FIELD_NUMBER
public static final int NODE_LIST_FIELD_NUMBER- See Also:
- Constant Field Values
-
BYTES_LIST_FIELD_NUMBER
public static final int BYTES_LIST_FIELD_NUMBER- See Also:
- Constant Field Values
-
INT64_LIST_FIELD_NUMBER
public static final int INT64_LIST_FIELD_NUMBER- See Also:
- Constant Field Values
-
FLOAT_LIST_FIELD_NUMBER
public static final int FLOAT_LIST_FIELD_NUMBER- See Also:
- Constant Field Values
-
ANY_LIST_FIELD_NUMBER
public static final int ANY_LIST_FIELD_NUMBER- See Also:
- Constant Field Values
-
-
Method Details
-
newInstance
protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getKindCase
- Specified by:
getKindCasein interfaceCollectionDefOrBuilder
-
hasNodeList
public boolean hasNodeList().tensorflow.CollectionDef.NodeList node_list = 1;- Specified by:
hasNodeListin interfaceCollectionDefOrBuilder- Returns:
- Whether the nodeList field is set.
-
getNodeList
.tensorflow.CollectionDef.NodeList node_list = 1;- Specified by:
getNodeListin interfaceCollectionDefOrBuilder- Returns:
- The nodeList.
-
getNodeListOrBuilder
.tensorflow.CollectionDef.NodeList node_list = 1;- Specified by:
getNodeListOrBuilderin interfaceCollectionDefOrBuilder
-
hasBytesList
public boolean hasBytesList().tensorflow.CollectionDef.BytesList bytes_list = 2;- Specified by:
hasBytesListin interfaceCollectionDefOrBuilder- Returns:
- Whether the bytesList field is set.
-
getBytesList
.tensorflow.CollectionDef.BytesList bytes_list = 2;- Specified by:
getBytesListin interfaceCollectionDefOrBuilder- Returns:
- The bytesList.
-
getBytesListOrBuilder
.tensorflow.CollectionDef.BytesList bytes_list = 2;- Specified by:
getBytesListOrBuilderin interfaceCollectionDefOrBuilder
-
hasInt64List
public boolean hasInt64List().tensorflow.CollectionDef.Int64List int64_list = 3;- Specified by:
hasInt64Listin interfaceCollectionDefOrBuilder- Returns:
- Whether the int64List field is set.
-
getInt64List
.tensorflow.CollectionDef.Int64List int64_list = 3;- Specified by:
getInt64Listin interfaceCollectionDefOrBuilder- Returns:
- The int64List.
-
getInt64ListOrBuilder
.tensorflow.CollectionDef.Int64List int64_list = 3;- Specified by:
getInt64ListOrBuilderin interfaceCollectionDefOrBuilder
-
hasFloatList
public boolean hasFloatList().tensorflow.CollectionDef.FloatList float_list = 4;- Specified by:
hasFloatListin interfaceCollectionDefOrBuilder- Returns:
- Whether the floatList field is set.
-
getFloatList
.tensorflow.CollectionDef.FloatList float_list = 4;- Specified by:
getFloatListin interfaceCollectionDefOrBuilder- Returns:
- The floatList.
-
getFloatListOrBuilder
.tensorflow.CollectionDef.FloatList float_list = 4;- Specified by:
getFloatListOrBuilderin interfaceCollectionDefOrBuilder
-
hasAnyList
public boolean hasAnyList().tensorflow.CollectionDef.AnyList any_list = 5;- Specified by:
hasAnyListin interfaceCollectionDefOrBuilder- Returns:
- Whether the anyList field is set.
-
getAnyList
.tensorflow.CollectionDef.AnyList any_list = 5;- Specified by:
getAnyListin interfaceCollectionDefOrBuilder- Returns:
- The anyList.
-
getAnyListOrBuilder
.tensorflow.CollectionDef.AnyList any_list = 5;- Specified by:
getAnyListOrBuilderin interfaceCollectionDefOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(java.lang.Object obj)- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static CollectionDef parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CollectionDef parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CollectionDef parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CollectionDef parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CollectionDef parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static CollectionDef parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
java.io.IOException
-
parseFrom
public static CollectionDef parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException- Throws:
java.io.IOException
-
parseDelimitedFrom
public static CollectionDef parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException- Throws:
java.io.IOException
-
parseDelimitedFrom
public static CollectionDef parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException- Throws:
java.io.IOException
-
parseFrom
public static CollectionDef parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException- Throws:
java.io.IOException
-
parseFrom
public static CollectionDef parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException- Throws:
java.io.IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CollectionDef.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-