Struct CollectionDef

pub struct CollectionDef {
    pub kind: Option<Kind>,
}

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)

Fields

kind: Option<Kind>

Trait Implementations

impl Clone for CollectionDef

fn clone(&self) -> CollectionDef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CollectionDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CollectionDef

fn default() -> Self

Returns the “default value” for a type.

impl Message for CollectionDef

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CollectionDef

fn eq(&self, other: &CollectionDef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CollectionDef