Struct tfrecord::protobuf::FunctionDef

pub struct FunctionDef {
    pub signature: Option<OpDef>,
    pub attr: HashMap<String, AttrValue>,
    pub arg_attr: HashMap<u32, ArgAttrs>,
    pub resource_arg_unique_id: HashMap<u32, u32>,
    pub node_def: Vec<NodeDef>,
    pub ret: HashMap<String, String>,
    pub control_ret: HashMap<String, String>,
}

A function can be instantiated when the runtime can bind every attr with a value. When a GraphDef has a call to a function, it must have binding for every attr defined in the signature.

TODO(zhifengc):

• device spec, etc.

Fields

signature: Option<OpDef>

The definition of the function’s name, arguments, return values, attrs etc.

attr: HashMap<String, AttrValue>

Attributes specific to this function definition.

arg_attr: HashMap<u32, ArgAttrs>

resource_arg_unique_id: HashMap<u32, u32>

Unique IDs for each resource argument, used to track aliasing resources. If Argument A and Argument B alias each other, then resource_arg_unique_ids[A.index] == resource_arg_unique_ids[B.index].

If this field is empty, none of the arguments could alias; otherwise, every resource argument should have an entry in this field.

When instantiated, the unique IDs will be attached to the _Arg nodes’ “_resource_arg_unique_id” attribute.

node_def: Vec<NodeDef>

By convention, “op” in node_def is resolved by consulting with a user-defined library first. If not resolved, “func” is assumed to be a builtin op.

ret: HashMap<String, String>

A mapping from the output arg names from signature to the outputs from node_def that should be returned by the function.

control_ret: HashMap<String, String>

A mapping from control output names from signature to node names in node_def which should be control outputs of this function.

Trait Implementations

impl Clone for FunctionDef

fn clone(&self) -> FunctionDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDef

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

Formats the value using the given formatter.

impl Default for FunctionDef

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FunctionDef

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_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated 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 encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated 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<FunctionDef> for FunctionDef

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FunctionDef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionDef