Struct tract_hir::internal::dsl::ModelImpl

pub struct ModelImpl<F, O> where
    F: Fact + Hash + Clone + 'static,
    O: Debug + Display + AsRef<dyn Op + 'static> + AsMut<dyn Op + 'static> + Clone + 'static + Hash,  {
    pub label: Option<String>,
    pub nodes: Vec<BaseNode<F, O>>,
    pub inputs: Vec<OutletId>,
    pub outputs: Vec<OutletId>,
    pub outlet_labels: HashMap<OutletId, String, RandomState>,
    // 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, RandomState>

outlet labels

Implementations

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

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

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

Connect a node outlet to a node inlet.

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

Get model inputs.

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

Change model inputs.

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

Change model inputs and return self.

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

Set model inputs by the node name.

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

Set model inputs by the node name and return self.

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

Get the ix-th input tensor type information.

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

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

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

Set the ix-th input tensor type information.

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

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

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

Get model outputs.

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

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

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

Change model outputs.

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

Change model outputs and return self.

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

Set model outputs by node names.

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

Set model outputs by node names and return self.

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

Get the ix-th input tensor type information.

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

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

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

Set the ix-th output tensor type information.

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

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_by_name<S>(&self, name: S) -> Result<&BaseNode<F, O>, TractError> where
    S: AsRef<str>, 

Find a node by its name.

pub fn node_by_name_mut(
    &mut self,
    name: &str
) -> Result<&mut BaseNode<F, O>, TractError>

Borrow mutably a node by its name.

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

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
) -> Result<(SmallVec<[&F; 4]>, SmallVec<[&F; 4]>), TractError>

Get input and output tensor information for a node.

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

Get input tensor information for a node.

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

Get output tensor information for a node.

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

Get tensor information for a single outlet.

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

Get tensor information for a single outlet.

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

Get multiple mutable tensor information for outlets.

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

Set tensor information for a single outlet.

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

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

Set label for an outlet.

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

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

Computes an evalutation order for the graph inputs and outputs

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

Performs a sanity check on network connections.

pub fn into_runnable(
    self
) -> Result<SimplePlan<F, O, ModelImpl<F, O>>, TractError>

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

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

pub fn signature(&self) -> u64

pub fn declutter(
    self
) -> Result<ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>, TractError>

Perform declutter pass on the network.

pub fn codegen(
    self
) -> Result<ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>, TractError>

Translate the graph to optimized operators.

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

pub fn into_normalized(
    self
) -> Result<ModelImpl<NormalizedFact, Box<dyn TypedOp + 'static>>, TractError>

Attempt to convert the network to a NormalizedModel.

pub fn into_optimized(
    self
) -> Result<ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>, TractError>

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

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

pub fn into_typed(
    self
) -> Result<ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>, TractError>

Convert back to TypedModel.

Can not fail.

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

pub fn new(
    source: &ModelImpl<NormalizedFact, Box<dyn TypedOp + 'static>>,
    pulse: usize
) -> Result<ModelImpl<PulsedFact, Box<dyn PulsedOp + 'static>>, TractError>

pub fn new_with_mapping(
    source: &ModelImpl<NormalizedFact, Box<dyn TypedOp + 'static>>,
    pulse: usize
) -> Result<(ModelImpl<PulsedFact, Box<dyn PulsedOp + 'static>>, HashMap<OutletId, OutletId, RandomState>), TractError>

pub fn into_typed(
    self
) -> Result<ModelImpl<TypedFact, Box<dyn TypedOp + 'static>>, TractError>

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

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

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

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

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

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

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

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

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

Model label

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

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_display(&self, id: usize) -> String

Formatted node label

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

Formatted node label

fn eval_order(&self) -> Result<Vec<usize>, TractError>

Eval order for the model

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

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 + 'static)

Node op by id

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

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

fn nested_models(
    &self,
    node: usize
) -> Vec<(Cow<str>, &(dyn Model + 'static), Vec<String>, Vec<String>)>

Nested models, with label (for audit).

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

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

Find the lone precursor of a node, if applicable.

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

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
) -> Result<Option<&BaseNode<F, O>>, TractError>

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

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

Find the lone succesor of a node, if applicable.

impl<F, O> ModelDslConst for ModelImpl<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, 

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

Add a constant node to the graph.

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

fn add_source(
    &mut self,
    name: impl Into<String>,
    fact: PulsedFact
) -> Result<OutletId, TractError>

Adds a source op to the network.

fn is_source(op: &(dyn Op + 'static)) -> bool

fn create_dummy(&self) -> Box<dyn TypedOp + 'static>

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

fn add_source(
    &mut self,
    name: impl Into<String>,
    fact: TypedFact
) -> Result<OutletId, TractError>

Adds a source op to the network.

fn is_source(op: &(dyn Op + 'static)) -> bool

fn create_dummy(&self) -> Box<dyn TypedOp + 'static>

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

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

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

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