Package org.tensorflow.framework

Class CollectionDef

  • All Implemented Interfaces:
    Serializable, org.nd4j.shade.protobuf.Message, org.nd4j.shade.protobuf.MessageLite, org.nd4j.shade.protobuf.MessageLiteOrBuilder, org.nd4j.shade.protobuf.MessageOrBuilder, CollectionDefOrBuilder
    public final class CollectionDef
extends org.nd4j.shade.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

    • Method Detail

      • newInstance

        protected Object newInstance​(org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final org.nd4j.shade.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface org.nd4j.shade.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final org.nd4j.shade.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • hasNodeList

        public boolean hasNodeList()
        .tensorflow.CollectionDef.NodeList node_list = 1;
        Specified by:
        hasNodeList in interface CollectionDefOrBuilder
        Returns:
        Whether the nodeList field is set.

      • hasBytesList

        public boolean hasBytesList()
        .tensorflow.CollectionDef.BytesList bytes_list = 2;
        Specified by:
        hasBytesList in interface CollectionDefOrBuilder
        Returns:
        Whether the bytesList field is set.

      • hasInt64List

        public boolean hasInt64List()
        .tensorflow.CollectionDef.Int64List int64_list = 3;
        Specified by:
        hasInt64List in interface CollectionDefOrBuilder
        Returns:
        Whether the int64List field is set.

      • hasFloatList

        public boolean hasFloatList()
        .tensorflow.CollectionDef.FloatList float_list = 4;
        Specified by:
        hasFloatList in interface CollectionDefOrBuilder
        Returns:
        Whether the floatList field is set.

      • hasAnyList

        public boolean hasAnyList()
        .tensorflow.CollectionDef.AnyList any_list = 5;
        Specified by:
        hasAnyList in interface CollectionDefOrBuilder
        Returns:
        Whether the anyList field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(org.nd4j.shade.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        writeTo in class org.nd4j.shade.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        getSerializedSize in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface org.nd4j.shade.protobuf.Message
        Overrides:
        equals in class org.nd4j.shade.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface org.nd4j.shade.protobuf.Message
        Overrides:
        hashCode in class org.nd4j.shade.protobuf.AbstractMessage

      • parseFrom

        public static CollectionDef parseFrom​(ByteBuffer data)
                               throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CollectionDef parseFrom​(ByteBuffer data,
                                      org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CollectionDef parseFrom​(org.nd4j.shade.protobuf.ByteString data)
                               throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CollectionDef parseFrom​(org.nd4j.shade.protobuf.ByteString data,
                                      org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CollectionDef parseFrom​(byte[] data)
                               throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CollectionDef parseFrom​(byte[] data,
                                      org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CollectionDef parseFrom​(org.nd4j.shade.protobuf.CodedInputStream input,
                                      org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public CollectionDef.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface org.nd4j.shade.protobuf.Message
        Specified by:
        newBuilderForType in interface org.nd4j.shade.protobuf.MessageLite

      • toBuilder

        public CollectionDef.Builder toBuilder()
        Specified by:
        toBuilder in interface org.nd4j.shade.protobuf.Message
        Specified by:
        toBuilder in interface org.nd4j.shade.protobuf.MessageLite

      • newBuilderForType

        protected CollectionDef.Builder newBuilderForType​(org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static CollectionDef getDefaultInstance()

      • parser

        public static org.nd4j.shade.protobuf.Parser<CollectionDef> parser()

      • getParserForType

        public org.nd4j.shade.protobuf.Parser<CollectionDef> getParserForType()
        Specified by:
        getParserForType in interface org.nd4j.shade.protobuf.Message
        Specified by:
        getParserForType in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        getParserForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CollectionDef getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageOrBuilder