Struct tract_core::model::Graph[−][src]

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

Main model class

Parameterized by a Fact class.

Fields

nodes: Vec<Node<F, O>>
Expand description

all nodes in the model

inputs: Vec<OutletId>
Expand description

model inputs

outputs: Vec<OutletId>
Expand description

model outputs

outlet_labels: HashMap<OutletId, String>
Expand description

outlet labels

properties: HashMap<String, Arc<Tensor>>
Expand description

model properties

Implementations

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

pub fn add_source(
    &mut self,
    name: impl Into<String>,
    fact: F
) -> TractResult<OutletId>[src]

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

pub fn add_node(
    &mut self,
    name: impl Into<String>,
    op: impl Into<O>,
    output_facts: TVec<F>
) -> TractResult<usize>[src]

pub fn add_edge(&mut self, outlet: OutletId, inlet: InletId) -> TractResult<()>[src]

Connect a node outlet to a node inlet.

pub fn input_outlets(&self) -> TractResult<&[OutletId]>[src]

Get model inputs.

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

Change model inputs.

pub fn with_input_outlets(self, inputs: &[OutletId]) -> TractResult<Self>[src]

Change model inputs and return self.

pub fn set_input_names(
    &mut self,
    inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>[src]

Set model inputs by the node name.

pub fn with_input_names(
    self,
    inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<Self>[src]

Set model inputs by the node name and return self.

pub fn input_fact(&self, ix: usize) -> TractResult<&F>[src]

Get the ix-th input tensor type information.

pub fn input_fact_mut(&mut self, ix: usize) -> TractResult<&mut F>[src]

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

pub fn set_input_fact(&mut self, input: usize, fact: F) -> TractResult<()>[src]

Set the ix-th input tensor type information.

pub fn with_input_fact(self, input: usize, fact: F) -> TractResult<Self>[src]

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

pub fn output_outlets(&self) -> TractResult<&[OutletId]>[src]

Get model outputs.

pub fn auto_outputs(&mut self) -> TractResult<()>[src]

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

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

Change model outputs.

pub fn with_output_outlets(self, outputs: &[OutletId]) -> TractResult<Self>[src]

Change model outputs and return self.

pub fn set_output_names(
    &mut self,
    outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>[src]

Set model outputs by node names.

pub fn with_output_names(
    self,
    outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<Self>[src]

Set model outputs by node names and return self.

pub fn output_fact(&self, ix: usize) -> TractResult<&F>[src]

Get the ix-th input tensor type information.

pub fn output_fact_mut(&mut self, ix: usize) -> TractResult<&mut F>[src]

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

pub fn set_output_fact(&mut self, output: usize, fact: F) -> TractResult<()>[src]

Set the ix-th output tensor type information.

pub fn with_output_fact(self, output: usize, fact: F) -> TractResult<Self>[src]

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

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

Iterate over all node names.

pub fn node_id_by_name(&self, name: &str) -> TractResult<usize>[src]

pub fn node_by_name(&self, name: impl AsRef<str>) -> TractResult<&Node<F, O>>[src]

Find a node by its name.

pub fn node_by_name_mut(
    &mut self,
    name: impl AsRef<str>
) -> TractResult<&mut Node<F, O>>[src]

Borrow mutably a node by its name.

pub fn rename_node(&mut self, id: usize, name: &str) -> TractResult<()>[src]

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

Find a node by its id.

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

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]
[src]

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]
[src]

Access the nodes table.

pub fn node_facts(&self, id: usize) -> TractResult<(TVec<&F>, TVec<&F>)>[src]

Get input and output tensor information for a node.

pub fn node_input_facts(&self, node_id: usize) -> TractResult<TVec<&F>>[src]

Get input tensor information for a node.

pub fn node_output_facts(&self, node_id: usize) -> TractResult<TVec<&F>>[src]

Get output tensor information for a node.

pub fn outlet_fact(&self, outlet: OutletId) -> TractResult<&F>[src]

Get tensor information for a single outlet.

pub fn outlet_fact_mut(&mut self, outlet: OutletId) -> TractResult<&mut F>[src]

Get tensor information for a single outlet.

pub fn outlets_fact_mut(
    &mut self,
    outlets: &[OutletId]
) -> TractResult<TVec<&mut F>>[src]

Get multiple mutable tensor information for outlets.

pub fn set_outlet_fact(&mut self, outlet: OutletId, fact: F) -> TractResult<()>[src]

Set tensor information for a single outlet.

pub fn with_outlet_fact(self, outlet: OutletId, fact: F) -> TractResult<Self>[src]

Set tensor information for a single outlet and return self.

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

Get label for an outlet.

pub fn set_outlet_label(
    &mut self,
    outlet: OutletId,
    label: String
) -> TractResult<()>[src]

Set label for an outlet.

pub fn with_outlet_label(
    self,
    outlet: OutletId,
    label: String
) -> TractResult<Self>[src]

Set label for an outlet and return self.

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

Find outlet by label.

pub fn eval_order(&self) -> TractResult<Vec<usize>>[src]

Computes an evalutation order for the graph inputs and outputs

pub fn check_edges(&self) -> TractResult<()>[src]

Performs a sanity check on network connections.

pub fn into_runnable(self) -> TractResult<RunnableModel<F, O, Self>>[src]

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) -> TractResult<Option<&Node<F, O>>>[src]

pub fn single_prec_at(
    &self,
    id: usize,
    count: usize
) -> TractResult<Option<&Node<F, O>>>[src]

pub fn single_succ_at(
    &self,
    id: usize,
    count: usize
) -> TractResult<Option<&Node<F, O>>>[src]

pub fn single_succ(&self, id: usize) -> TractResult<Option<&Node<F, O>>>[src]

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

Notable traits for &'_ [u8]

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

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

pub fn add_const(
    &mut self,
    name: impl Into<String>,
    v: impl IntoArcTensor
) -> TractResult<OutletId>[src]

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

pub fn check_compact(&self) -> TractResult<()>[src]

pub fn compact(&self) -> TractResult<Self>[src]

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

pub fn signature(&self) -> u64[src]

pub fn into_optimized(self) -> TractResult<TypedModel>[src]

pub fn declutter(&self) -> TractResult<TypedModel>[src]

Perform declutter passes on the network.

pub fn concretize_dims(&self, values: &SymbolValues) -> TractResult<TypedModel>[src]

pub fn optimize(self) -> TractResult<TypedModel>[src]

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

pub fn invariants(&self) -> TractResult<Invariants>[src]

Trait Implementations

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

fn clone(&self) -> Graph<F, O>[src]

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: Debug, O: Debug> Debug for Graph<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash, [src]

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

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> + AsMut<dyn Op> + Clone + 'static + Hash, [src]

fn default() -> Graph<F, O>[src]

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> + AsMut<dyn Op> + Clone + 'static + Hash, [src]

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

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> + AsMut<dyn Op> + Clone + 'static + Hash, [src]

fn dyn_hash(&self, hasher: &mut dyn Hasher)[src]

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

fn hash<H: Hasher>(&self, state: &mut H)[src]

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

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, [src]

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
    A: Allocator,
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;
[src]

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>[src]

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)[src]

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)[src]

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, [src]

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

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.