Struct tract_core::model::ModelPatch

pub struct ModelPatch<F, O> where
    F: Fact + Clone + 'static,
    O: Display + Debug + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static,
    ModelImpl<F, O>: ModelSpecialOps<F, O>,  {
    pub model: ModelImpl<F, O>,
    pub incoming: HashMap<OutletId, OutletId>,
    pub shunt_outlet_by: HashMap<OutletId, OutletId>,
    pub obliterate: Vec<usize>,
}

A change to apply to a model.

Actually structured around a model that represent the new nodes to be inserted, plus information about how to connect these new nodes to the pre-existing graph.

Fields

model: ModelImpl<F, O>

the model-like 'pagch' of nodes to add to the model

incoming: HashMap<OutletId, OutletId>

shunt_outlet_by: HashMap<OutletId, OutletId>

obliterate: Vec<usize>

Methods

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

pub fn is_empty(&self) -> bool

pub fn tap_model(
    &mut self,
    model: &ModelImpl<F, O>,
    outlet: OutletId
) -> TractResult<OutletId>

Draw a tap from a preexisting node.

returns an OutletId usable in the little "patch" model

pub fn shunt_outside(
    &mut self,
    outlet: OutletId,
    by: OutletId
) -> TractResult<()>

Replace an Outlet in the target model by one from the patch.

pub fn obliterate(&mut self, node: usize) -> TractResult<()>

pub fn replace_single_op<IO: Into<O>>(
    patched_model: &ModelImpl<F, O>,
    node: &BaseNode<F, O>,
    inputs: &[OutletId],
    new_op: IO
) -> TractResult<ModelPatch<F, O>>

Convenience method creating a patch that replace a single operation.

pub fn fuse_with_next<IO: Into<O>>(
    patched_model: &ModelImpl<F, O>,
    node: &BaseNode<F, O>,
    new_op: IO
) -> TractResult<ModelPatch<F, O>>

Convenience method creating a patch that replace a single operation.

pub fn shunt_one_op(
    patched_model: &ModelImpl<F, O>,
    node: &BaseNode<F, O>
) -> TractResult<ModelPatch<F, O>>

Convenience method creating a patch that shunt the given node.

pub fn single_unary_op<IO: Into<O>>(
    patched_model: &ModelImpl<F, O>,
    node: &BaseNode<F, O>,
    new_op: IO
) -> TractResult<ModelPatch<F, O>>

Convenience method creating a patch that replace a single unary operation.

pub fn intercept<IO: Into<O>>(
    patched_model: &ModelImpl<F, O>,
    outlet: OutletId,
    name: impl Into<String>,
    new_op: IO,
    fact: F
) -> TractResult<ModelPatch<F, O>>

Convenience method creating a patch that insert an unary op on an outlet.

pub fn apply(self, target: &mut ModelImpl<F, O>) -> TractResult<()>

Apply all changes in the patch to the target model.

Methods from Deref<Target = ModelImpl<F, O>>

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.

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

Trait Implementations

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

fn clone(&self) -> ModelPatch<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 ModelPatch<F, O> where
    F: Fact + Clone + 'static,
    O: Display + Debug + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static,
    ModelImpl<F, O>: ModelSpecialOps<F, O>, 

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

Formats the value using the given formatter.

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

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

Returns the "default value" for a type.

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

type Target = ModelImpl<F, O>

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.