Struct tract_tensorflow::tfpb::tensorflow::NodeDef

pub struct NodeDef {
    pub name: String,
    pub op: String,
    pub input: Vec<String>,
    pub device: String,
    pub attr: HashMap<String, AttrValue>,
}

Fields

name: String

The name given to this operator. Used for naming inputs, logging, visualization, etc. Unique within a single GraphDef. Must match the regexp "[A-Za-z0-9.][A-Za-z0-9_./]*".

op: String

The operation name. There may be custom parameters in attrs. Op names starting with an underscore are reserved for internal use.

input: Vec<String>

Each input is "node:src_output" with "node" being a string name and "src_output" indicating which output tensor to use from "node". If "src_output" is 0 the ":0" suffix can be omitted. Regular inputs may optionally be followed by control inputs that have the format "^node".

device: String

A (possibly partial) specification for the device on which this node should be placed. The expected syntax for this string is as follows:

DEVICE_SPEC ::= PARTIAL_SPEC

PARTIAL_SPEC ::= ("/" CONSTRAINT) * CONSTRAINT ::= ("job:" JOB_NAME) | ("replica:" [1-9][0-9]) | ("task:" [1-9][0-9]) | ("device:" [A-Za-z]* ":" ([1-9][0-9]* | "*") )

Valid values for this string include:

• "/job:worker/replica:0/task:1/device:GPU:3" (full specification)
• "/job:worker/device:GPU:3" (partial specification)
• "" (no specification)

If the constraints do not resolve to a single device (or if this field is empty or not present), the runtime will attempt to choose a device automatically.

attr: HashMap<String, AttrValue>

Operation-specific graph-construction-time configuration. Note that this should include all attrs defined in the corresponding OpDef, including those with a value matching the default -- this allows the default to change and makes NodeDefs easier to interpret on their own. However, if an attr with a default is not specified in this list, the default will be used. The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and one of the names from the corresponding OpDef's attr field). The values must have a type matching the corresponding OpDef attr's type field. TODO(josh11b): Add some examples here showing best practices.

Implementations

impl NodeDef

pub fn name<S: ToString>(mut self: Self, n: S) -> NodeDef

pub fn op<S: ToString>(mut self: Self, n: S) -> NodeDef

pub fn input<S: ToString>(mut self: Self, n: S) -> NodeDef

pub fn attr<S: ToString, V: Into<AttrValue>>(
    mut self: Self,
    n: S,
    v: V
) -> NodeDef

impl NodeDef

pub fn get_attr_raw_str(&self, name: &str) -> TractResult<&[u8]>

pub fn get_attr_opt_raw_str(&self, name: &str) -> TractResult<Option<&[u8]>>

pub fn get_attr_str(&self, name: &str) -> TractResult<String>

pub fn get_attr_opt_str(&self, name: &str) -> TractResult<Option<String>>

pub fn get_attr_bool(&self, name: &str) -> TractResult<bool>

pub fn get_attr_opt_bool(&self, name: &str) -> TractResult<Option<bool>>

pub fn get_attr_datum_type(&self, name: &str) -> TractResult<DatumType>

pub fn get_attr_opt_datum_type(
    &self,
    name: &str
) -> TractResult<Option<DatumType>>

pub fn get_attr_shape(&self, name: &str) -> TractResult<TVec<isize>>

pub fn get_attr_opt_shape(&self, name: &str) -> TractResult<Option<TVec<isize>>>

pub fn get_attr_tensor(&self, name: &str) -> TractResult<Tensor>

pub fn get_attr_opt_tensor(&self, name: &str) -> TractResult<Option<Tensor>>

pub fn get_attr_int<T: FromPrimitive>(&self, name: &str) -> TractResult<T>

pub fn get_attr_opt_int<T: FromPrimitive>(
    &self,
    name: &str
) -> TractResult<Option<T>>

pub fn get_attr_float<T: FromPrimitive>(&self, name: &str) -> TractResult<T>

pub fn get_attr_opt_float<T: FromPrimitive>(
    &self,
    name: &str
) -> TractResult<Option<T>>

pub fn get_attr_list_int<T: FromPrimitive>(
    &self,
    name: &str
) -> TractResult<Vec<T>>

pub fn get_attr_opt_list_int<T: FromPrimitive>(
    &self,
    name: &str
) -> TractResult<Option<Vec<T>>>

Trait Implementations

impl Clone for NodeDef

pub fn clone(&self) -> NodeDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeDef

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

Formats the value using the given formatter.

impl Default for NodeDef

pub fn default() -> Self

Returns the "default value" for a type.

impl Message for NodeDef

pub fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

pub fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

pub fn encoded_len(&self) -> usize

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

pub fn clear(&mut self)

Clears the message, resetting all fields to their default.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<NodeDef> for NodeDef

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

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

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

This method tests for !=.

impl StructuralPartialEq for NodeDef