Struct tract_tensorflow::prelude::Graph

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

Main model class

Parameterized by a Fact class.

Fields

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

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

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

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<Graph<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<Graph<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<Graph<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<Graph<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<Graph<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<Graph<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_id_by_name(&self, name: &str) -> Result<usize, TractError>

pub fn node_by_name(
    &self,
    name: impl AsRef<str>
) -> Result<&BaseNode<F, O>, TractError>

Find a node by its name.

pub fn node_by_name_mut(
    &mut self,
    name: impl AsRef<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<Graph<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<Graph<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, Graph<F, O>>, TractError>

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

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

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

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

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

impl<F, O> Graph<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, 

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

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

pub fn compact(&self) -> Result<Graph<F, O>, TractError>

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

pub fn signature(&self) -> u64

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

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

Perform declutter passes on the network.

pub fn concretize_stream_dim(
    &self,
    dim: usize
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static>>, TractError>

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

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

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

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

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

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

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

Trait Implementations

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

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

Returns the "default value" for a type.

impl<F, O> Display for Graph<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 Graph<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 Framework<GraphDef, Graph<InferenceFact, Box<dyn InferenceOp + 'static>>> for Tensorflow

fn proto_model_for_path(&self, r: impl AsRef<Path>) -> TractResult<GraphDef>

This method will try to read as frozen model, then as a saved model.

fn proto_model_for_read(&self, r: &mut dyn Read) -> TractResult<GraphDef>

This method expects a frozen model, use open_saved_model for TF2 saved model format.

fn model_for_proto_model(&self, graph: &GraphDef) -> TractResult<InferenceModel>

Translate a proto model into a model.

fn model_for_read(&self, r: &mut dyn Read) -> Result<Model, TractError>

Read a model from a reader

fn model_for_path(&self, p: impl AsRef<Path>) -> Result<Model, TractError>

Build a model from a filename.

impl<F, O> Hash for Graph<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 InferenceModelExt for Graph<InferenceFact, Box<dyn InferenceOp + 'static>>

fn analyse(&mut self, obstinate: bool) -> Result<bool, TractError>

Analyse all nodes of the graph.

Will stop on first error unless obstinate is true.

fn incorporate(
    self
) -> Result<Graph<InferenceFact, Box<dyn InferenceOp + 'static>>, TractError>

Perform early transformation before going typed.

fn missing_type_shape(&self) -> Result<Vec<OutletId>, TractError>

List OutletId with incomplete type information.

Will stop on first error unless obstinate is true.

fn eliminate_dead_branches(
    self
) -> Result<Graph<InferenceFact, Box<dyn InferenceOp + 'static>>, TractError>

Eliminate seemingly dead branches of the graph.

This may break stateful networks.

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

Attempt full analyse and conversion to TypedModel.

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

Attempt full analyse, decluttering and mapping to optimized operations.

This is meant for "simple" networks, where no special model transformation needs to happen. Aternaltively, use to_typed() and manipulate the TypedModel for more control.

impl SpecialOps<InferenceFact, Box<dyn InferenceOp + 'static>> for Graph<InferenceFact, Box<dyn InferenceOp + 'static>>

fn is_source(op: &Box<dyn InferenceOp + 'static>) -> bool

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

fn create_source(&self, _fact: InferenceFact) -> Box<dyn InferenceOp + 'static>

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

impl SpecialOps<PulsedFact, Box<dyn PulsedOp + 'static>> for Graph<PulsedFact, Box<dyn PulsedOp + 'static>>

fn is_source(op: &Box<dyn PulsedOp + 'static>) -> bool

fn create_source(&self, fact: PulsedFact) -> Box<dyn PulsedOp + 'static>

fn create_dummy(&self) -> 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 SpecialOps<TypedFact, Box<dyn TypedOp + 'static>> for Graph<TypedFact, Box<dyn TypedOp + 'static>>

fn is_source(op: &Box<dyn TypedOp + 'static>) -> bool

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

fn create_source(&self, fact: 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>