Struct tract_tensorflow::prelude::Graph[−]

pub struct Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,  {
    pub nodes: Vec<Node<F, O>, Global>,
    pub inputs: Vec<OutletId, Global>,
    pub outputs: Vec<OutletId, Global>,
    pub outlet_labels: HashMap<OutletId, String, RandomState>,
    pub properties: HashMap<String, Arc<Tensor>, RandomState>,
}
Expand description

Main model class

Parameterized by a Fact class.

Fields

nodes: Vec<Node<F, O>, Global>

all nodes in the model

inputs: Vec<OutletId, Global>

model inputs

outputs: Vec<OutletId, Global>

model outputs

outlet_labels: HashMap<OutletId, String, RandomState>

outlet labels

properties: HashMap<String, Arc<Tensor>, RandomState>

model properties

Implementations

impl<F, O> Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,
    Graph<F, O>: SpecialOps<F, O>, 

pub fn add_source(
    &mut self,
    name: impl Into<String>,
    fact: F
) -> Result<OutletId, Error>

impl<F, O> Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, 

pub fn add_node(
    &mut self,
    name: impl Into<String>,
    op: impl Into<O>,
    output_facts: SmallVec<[F; 4]>
) -> Result<usize, Error>

pub fn add_edge(
    &mut self,
    outlet: OutletId,
    inlet: InletId
) -> Result<(), Error>

Connect a node outlet to a node inlet.

pub fn input_outlets(&self) -> Result<&[OutletId], Error>

Get model inputs.

pub fn set_input_outlets(&mut self, inputs: &[OutletId]) -> Result<(), Error>

Change model inputs.

pub fn with_input_outlets(
    self,
    inputs: &[OutletId]
) -> Result<Graph<F, O>, Error>

Change model inputs and return self.

pub fn set_input_names(
    &mut self,
    inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<(), Error>

Set model inputs by the node name.

pub fn with_input_names(
    self,
    inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<Graph<F, O>, Error>

Set model inputs by the node name and return self.

pub fn input_fact(&self, ix: usize) -> Result<&F, Error>

Get the ix-th input tensor type information.

pub fn input_fact_mut(&mut self, ix: usize) -> Result<&mut F, Error>

Get the ix-th input tensor type information, mutably.

pub fn set_input_fact(&mut self, input: usize, fact: F) -> Result<(), Error>

Set the ix-th input tensor type information.

pub fn with_input_fact(
    self,
    input: usize,
    fact: F
) -> Result<Graph<F, O>, Error>

Set the ix-th input tensor type information and return self.

pub fn output_outlets(&self) -> Result<&[OutletId], Error>

Get model outputs.

pub fn auto_outputs(&mut self) -> Result<(), Error>

Guess outputs from the topology: node or nodes with no successors.

pub fn set_output_outlets(&mut self, outputs: &[OutletId]) -> Result<(), Error>

Change model outputs.

pub fn with_output_outlets(
    self,
    outputs: &[OutletId]
) -> Result<Graph<F, O>, Error>

Change model outputs and return self.

pub fn set_output_names(
    &mut self,
    outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<(), Error>

Set model outputs by node names.

pub fn with_output_names(
    self,
    outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> Result<Graph<F, O>, Error>

Set model outputs by node names and return self.

pub fn output_fact(&self, ix: usize) -> Result<&F, Error>

Get the ix-th input tensor type information.

pub fn output_fact_mut(&mut self, ix: usize) -> Result<&mut F, Error>

Get the ix-th input tensor type information, mutably.

pub fn set_output_fact(&mut self, output: usize, fact: F) -> Result<(), Error>

Set the ix-th output tensor type information.

pub fn with_output_fact(
    self,
    output: usize,
    fact: F
) -> Result<Graph<F, O>, Error>

Set the ix-th output tensor type information and return self.

pub fn node_names(&self) -> impl Iterator<Item = &str>

Iterate over all node names.

pub fn node_id_by_name(&self, name: &str) -> Result<usize, Error>

pub fn node_by_name(&self, name: impl AsRef<str>) -> Result<&Node<F, O>, Error>

Find a node by its name.

pub fn node_by_name_mut(
    &mut self,
    name: impl AsRef<str>
) -> Result<&mut Node<F, O>, Error>

Borrow mutably a node by its name.

pub fn rename_node(&mut self, id: usize, name: &str) -> Result<(), Error>

pub fn node(&self, id: usize) -> &Node<F, O>

Find a node by its id.

pub fn node_mut(&mut self, id: usize) -> &mut Node<F, O>

Find a node by its id.

pub fn nodes(&self) -> &[Node<F, O>]ⓘ

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Access the nodes table.

pub fn nodes_mut(&mut self) -> &mut [Node<F, O>]ⓘ

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Access the nodes table.

pub fn node_facts(
    &self,
    id: usize
) -> Result<(SmallVec<[&F; 4]>, SmallVec<[&F; 4]>), Error>

Get input and output tensor information for a node.

pub fn node_input_facts(
    &self,
    node_id: usize
) -> Result<SmallVec<[&F; 4]>, Error>

Get input tensor information for a node.

pub fn node_output_facts(
    &self,
    node_id: usize
) -> Result<SmallVec<[&F; 4]>, Error>

Get output tensor information for a node.

pub fn outlet_fact(&self, outlet: OutletId) -> Result<&F, Error>

Get tensor information for a single outlet.

pub fn outlet_fact_mut(&mut self, outlet: OutletId) -> Result<&mut F, Error>

Get tensor information for a single outlet.

pub fn outlets_fact_mut(
    &mut self,
    outlets: &[OutletId]
) -> Result<SmallVec<[&mut F; 4]>, Error>

Get multiple mutable tensor information for outlets.

pub fn set_outlet_fact(
    &mut self,
    outlet: OutletId,
    fact: F
) -> Result<(), Error>

Set tensor information for a single outlet.

pub fn with_outlet_fact(
    self,
    outlet: OutletId,
    fact: F
) -> Result<Graph<F, O>, Error>

Set tensor information for a single outlet and return self.

pub fn outlet_label(&self, outlet: OutletId) -> Option<&str>

Get label for an outlet.

pub fn set_outlet_label(
    &mut self,
    outlet: OutletId,
    label: String
) -> Result<(), Error>

Set label for an outlet.

pub fn with_outlet_label(
    self,
    outlet: OutletId,
    label: String
) -> Result<Graph<F, O>, Error>

Set label for an outlet and return self.

pub fn find_outlet_label(&self, label: &str) -> Option<OutletId>

Find outlet by label.

pub fn eval_order(&self) -> Result<Vec<usize, Global>, Error>

Computes an evalutation order for the graph inputs and outputs

pub fn check_edges(&self) -> Result<(), Error>

Performs a sanity check on network connections.

pub fn into_runnable(self) -> Result<SimplePlan<F, O, Graph<F, O>>, Error>

Converts the model into a RunnableModel which fixes the inputs and outputs and allows passing data through the model.

pub fn single_prec(&self, id: usize) -> Result<Option<&Node<F, O>>, Error>

pub fn single_prec_at(
    &self,
    id: usize,
    count: usize
) -> Result<Option<&Node<F, O>>, Error>

pub fn single_succ_at(
    &self,
    id: usize,
    count: usize
) -> Result<Option<&Node<F, O>>, Error>

pub fn single_succ(&self, id: usize) -> Result<Option<&Node<F, O>>, Error>

pub fn outlet_successors(&self, outlet: OutletId) -> &[InletId]ⓘ

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl<F, O> Graph<F, O> where
    F: 'static + Fact + Clone + From<Arc<Tensor>> + Hash,
    O: Debug + Display + From<Const> + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + Hash + 'static, 

pub fn add_const(
    &mut self,
    name: impl Into<String>,
    v: impl IntoArcTensor
) -> Result<OutletId, Error>

impl<F, O> Graph<F, O> where
    F: Fact + Clone + 'static + Hash + for<'a> From<&'a F>,
    O: Display + Debug + Clone + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + 'static + Hash + for<'a> From<&'a O>,
    Graph<F, O>: SpecialOps<F, O>, 

pub fn check_compact(&self) -> Result<(), Error>

pub fn compact(&self) -> Result<Graph<F, O>, Error>

impl Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>

pub fn signature(&self) -> u64

pub fn into_optimized(
    self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>

pub fn declutter(
    &self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>

Perform declutter passes on the network.

pub fn concretize_dims(
    &self,
    values: &SymbolValues
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>

pub fn optimize(
    self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>

Translate the graph to locally optimized operators (LIR or MIR ops).

pub fn invariants(&self) -> Result<Invariants, Error>

Trait Implementations

impl<F, O> Clone for Graph<F, O> where
    F: Clone + Fact + Hash + 'static,
    O: Clone + Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + 'static + Hash, 

pub fn clone(&self) -> Graph<F, O>

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<F, O> Debug for Graph<F, O> where
    F: Debug + Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, 

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

Formats the value using the given formatter. Read more

impl<F, O> Default for Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, 

pub fn default() -> Graph<F, O>

Returns the “default value” for a type. Read more

impl<F, O> Display for Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, 

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

Formats the value using the given formatter. Read more

impl<F, O> DynHash for Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, 

pub fn dyn_hash(&self, hasher: &mut dyn Hasher)

impl Framework<GraphDef, Graph<InferenceFact, Box<dyn InferenceOp + 'static, Global>>> for Tensorflow[src]

fn proto_model_for_path(&self, r: impl AsRef<Path>) -> TractResult<GraphDef>[src]

This method will try to read as frozen model, then as a saved model.

fn proto_model_for_read(&self, r: &mut dyn Read) -> TractResult<GraphDef>[src]

This method expects a frozen model, use open_saved_model for TF2 saved model format.

fn model_for_proto_model(&self, graph: &GraphDef) -> TractResult<InferenceModel>[src]

Translate a proto model into a model.

fn model_for_read(&self, r: &mut dyn Read) -> Result<Model, Error>

Read a model from a reader

fn model_for_path(&self, p: impl AsRef<Path>) -> Result<Model, Error>

Build a model from a filename.

impl<F, O> Hash for Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash, 

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher, 

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 1.3.0[src]

Feeds a slice of this type into the given Hasher. Read more

impl InferenceModelExt for Graph<InferenceFact, Box<dyn InferenceOp + 'static, Global>>[src]

pub fn analyse(&mut self, obstinate: bool) -> Result<bool, Error>[src]

Analyse all nodes of the graph.

Will stop on first error unless obstinate is true.

pub fn incorporate(
    self
) -> Result<Graph<InferenceFact, Box<dyn InferenceOp + 'static, Global>>, Error>[src]

Perform early transformation before going typed.

pub fn missing_type_shape(&self) -> Result<Vec<OutletId, Global>, Error>[src]

List OutletId with incomplete type information.

Will stop on first error unless obstinate is true.

pub fn eliminate_dead_branches(
    self
) -> Result<Graph<InferenceFact, Box<dyn InferenceOp + 'static, Global>>, Error>[src]

Eliminate seemingly dead branches of the graph.

This may break stateful networks.

pub fn into_typed(
    self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>[src]

Attempt full analyse and conversion to TypedModel.

pub fn into_optimized(
    self
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>[src]

Attempt full analyse, decluttering and mapping to optimized operations.

This is meant for “simple” networks, where no special model transformation needs to happen. Aternaltively, use to_typed() and manipulate the TypedModel for more control.

impl SpecialOps<InferenceFact, Box<dyn InferenceOp + 'static, Global>> for Graph<InferenceFact, Box<dyn InferenceOp + 'static, Global>>[src]

pub fn is_source(op: &Box<dyn InferenceOp + 'static, Global>) -> bool[src]

pub fn create_dummy(&self) -> Box<dyn InferenceOp + 'static, Global>ⓘ

Notable traits for Box<R, Global>

impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static,  type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator,  type Item = <I as Iterator>::Item;
[src]

pub fn create_source(
    &self,
    _fact: InferenceFact
) -> Box<dyn InferenceOp + 'static, Global>ⓘ

Notable traits for Box<R, Global>

impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static,  type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator,  type Item = <I as Iterator>::Item;
[src]

pub fn wire_node(
    &mut self,
    name: impl Into<String>,
    op: impl Into<Box<dyn InferenceOp + 'static, Global>>,
    inputs: &[OutletId]
) -> Result<SmallVec<[OutletId; 4]>, Error>[src]

impl SpecialOps<TypedFact, Box<dyn TypedOp + 'static, Global>> for Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>

pub fn is_source(op: &Box<dyn TypedOp + 'static, Global>) -> bool

pub fn create_dummy(&self) -> Box<dyn TypedOp + 'static, Global>ⓘ

Notable traits for Box<R, Global>

impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static,  type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator,  type Item = <I as Iterator>::Item;

pub fn create_source(
    &self,
    fact: TypedFact
) -> Box<dyn TypedOp + 'static, Global>ⓘ

Notable traits for Box<R, Global>

impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static,  type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator,  type Item = <I as Iterator>::Item;

pub fn wire_node(
    &mut self,
    name: impl Into<String>,
    op: impl Into<Box<dyn TypedOp + 'static, Global>>,
    inputs: &[OutletId]
) -> Result<SmallVec<[OutletId; 4]>, Error>

Auto Trait Implementations

impl<F, O> RefUnwindSafe for Graph<F, O> where
    F: RefUnwindSafe,
    O: RefUnwindSafe, 

impl<F, O> Send for Graph<F, O> where
    O: Send, 

impl<F, O> Sync for Graph<F, O> where
    O: Sync, 

impl<F, O> Unpin for Graph<F, O> where
    F: Unpin,
    O: Unpin, 

impl<F, O> UnwindSafe for Graph<F, O> where
    F: RefUnwindSafe + UnwindSafe,
    O: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any, 

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘ

Notable traits for Box<R, Global>

impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static,  type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator,  type Item = <I as Iterator>::Item;

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync, 

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> DynClone for T where
    T: Clone, [src]

pub fn __clone_box(&self, Private) -> *mut ()[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
    T: Display + ?Sized, [src]

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.