Struct tract_core::model::dsl::ModelImpl

pub struct ModelImpl<F, O> where
    F: Fact + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static,  {
    pub label: Option<String>,
    pub nodes: Vec<BaseNode<F, O>>,
    pub inputs: Vec<OutletId>,
    pub outputs: Vec<OutletId>,
    pub outlet_labels: HashMap<OutletId, String>,
    // some fields omitted
}

Main model class

Parameterized by a Fact class.

Fields

label: Option<String>

nodes: Vec<BaseNode<F, O>>

all nodes in the model

inputs: Vec<OutletId>

model inputs

outputs: Vec<OutletId>

model outputs

outlet_labels: HashMap<OutletId, String>

outlet labels

Methods

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

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 set_input_names(
    &mut self,
    inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>

Set model inputs by the node name.

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 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 set_output_names(
    &mut self,
    outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>

Set model outputs by node names.

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 node_names(&self) -> impl Iterator<Item = &str>

Iterate over all node names.

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

Find a node by its name.

pub fn node_by_name_mut(
    &mut self,
    name: &str
) -> TractResult<&mut BaseNode<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) -> &BaseNode<F, O>

Find a node by its id.

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

Find a node by its id.

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

Access the nodes table.

pub fn nodes_mut(&mut self) -> &mut [BaseNode<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 outlet_label(&self, outlet: OutletId) -> Option<&str>

Get label for an outlet.

pub fn set_outlet_label(&mut self, outlet: OutletId, label: String)

Set label for an outlet.

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

Performs a sanity check on network connections.

impl ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>

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

Perform declutter pass on the network.

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

Translate the graph to optimized operators.

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

pub fn into_normalized(self) -> TractResult<NormalizedModel>

Attempt to convert the network to a NormalizedModel.

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

Declutter as much as possible, then translate to optimized operators.

impl ModelImpl<NormalizedFact, Box<dyn TypedOp + 'static>>

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

Convert back to TypedModel.

Can not fail.

impl ModelImpl<PulsedFact, Box<dyn PulsedOp + 'static>>

pub fn new(source: &NormalizedModel, pulse: usize) -> TractResult<PulsedModel>

pub fn new_with_mapping(
    source: &NormalizedModel,
    pulse: usize
) -> TractResult<(PulsedModel, HashMap<OutletId, OutletId>)>

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Returns the "default value" for a type.

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

fn model_label(&self) -> Option<&str>

Model label

fn node_id_by_name(&self, name: &str) -> TractResult<usize>

Lookup node id by name

fn node_name(&self, id: usize) -> &str

Node name by id

fn node_inputs(&self, id: usize) -> &[OutletId]

Node inputs by id

fn node_output_count(&self, id: usize) -> usize

Number of outputs for a node, by id.

fn nodes_len(&self) -> usize

Number nodes

fn node_format(&self, id: usize) -> String

Formatted node label

fn eval_order(&self) -> TractResult<Vec<usize>>

Eval order for the model

fn eval_order_for_io(
    &self,
    inputs: &[usize],
    outputs: &[usize]
) -> TractResult<Vec<usize>>

Eval order for the model overriding input and outputs node

fn input_outlets(&self) -> &[OutletId]

Inputs of the model

fn output_outlets(&self) -> &[OutletId]

Outputs of the model

fn node_op(&self, id: usize) -> &dyn Op

Node op by id

fn outlet_typedfact(&self, outlet: OutletId) -> TractResult<TypedFact>

Tensorfact for an outlet

fn outlet_fact_format(&self, outlet: OutletId) -> String

Short outlet formatter (id plus fact)

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

Labels for an outlet

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

List consumers of an outlet

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

fn single_prec(&self, id: usize) -> TractResult<Option<&BaseNode<F, O>>>

Find the lone precursor of a node, if applicable.

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

Find the count-th precursor of a node id in a chain of single tensor operation, if applicable.

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

Find the count-th successor of a node id in a chain of single tensor operation, if applicable.

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

Find the lone succesor of a node, if applicable.

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

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

Add a constant node to the graph.