Struct tract_core::model::Graph

pub struct Graph<F, O>where
    F: Fact + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static,{
    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>>,
    pub symbol_table: SymbolTable,
}

Main model class

Parameterized by a Fact class.

Fields

nodes: Vec<Node<F, O>>

all nodes in the model

inputs: Vec<OutletId>

model inputs

outputs: Vec<OutletId>

model outputs

outlet_labels: HashMap<OutletId, String>

outlet labels

properties: HashMap<String, Arc<Tensor>>

model properties

symbol_table: SymbolTable

symbol table

Implementations

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

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

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

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

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

Connect a node outlet to a node inlet.

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

Get model inputs.

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

Change model inputs.

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

Change model inputs and return self.

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

Set model inputs by the node name.

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

Set model inputs by the node name and return self.

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

Get the ix-th input tensor type information.

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

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

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

Set the ix-th input tensor type information.

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

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

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

Get model outputs.

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

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

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

Change model outputs.

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

Change model outputs and return self.

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

Set model outputs by node names.

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

Set model outputs by node names and return self.

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

Get the ix-th input tensor type information.

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

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

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

Set the ix-th output tensor type information.

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

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) -> TractResult<usize>

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

Find a node by its name.

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

Borrow mutably a node by its name.

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

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

Access the nodes table.

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

Access the nodes table.

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

Get input and output tensor information for a node.

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

Get input tensor information for a node.

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

Get output tensor information for a node.

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

Get tensor information for a single outlet.

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

Get tensor information for a single outlet.

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

Get multiple mutable tensor information for outlets.

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

Set tensor information for a single outlet.

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

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 ) -> TractResult<()>

Set label for an outlet.

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

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) -> TractResult<Vec<usize>>

Computes an evalutation order for the graph inputs and outputs

pub fn check_edges(&self) -> TractResult<()>

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

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>>>

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

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

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

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

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

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

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

pub fn check_compact(&self) -> TractResult<()>

pub fn compact(&mut self) -> TractResult<()>

pub fn into_compact(self) -> TractResult<Self>

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

pub fn into_optimized(self) -> TractResult<TypedModel>

pub fn check_consistency(&self) -> TractResult<()>

pub fn into_decluttered(self) -> TractResult<TypedModel>

pub fn declutter(&mut self) -> TractResult<()>

Perform declutter passes on the network.

pub fn optimize_with_session( &mut self, session: &mut OptimizerSession<'_> ) -> TractResult<()>

Perform optimization passes on the model, using a given optimizer session.

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

pub fn optimize(&mut self) -> TractResult<()>

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

pub fn node_axes_mapping(&self, id: usize) -> TractResult<AxesMapping>

pub fn axes_mapping(&self) -> TractResult<AxesMapping>

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.