Struct tract_hir::internal::Graph

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

Main model class

Parameterized by a Fact class.

Fields

nodes: Vec<Node<F, O>, Global>

all nodes in the model

inputs: Vec<OutletId, Global>

model inputs

outputs: Vec<OutletId, Global>

model outputs

outlet_labels: HashMap<OutletId, String, RandomState>

outlet labels

properties: HashMap<String, Arc<Tensor>, RandomState>

model properties

Implementations

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

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

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

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

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

Connect a node outlet to a node inlet.

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

Get model inputs.

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

Change model inputs.

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

Change model inputs and return self.

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

Set model inputs by the node name.

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

Set model inputs by the node name and return self.

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

Get the ix-th input tensor type information.

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

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

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

Set the ix-th input tensor type information.

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

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

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

Get model outputs.

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

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

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

Change model outputs.

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

Change model outputs and return self.

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

Set model outputs by node names.

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

Set model outputs by node names and return self.

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

Get the ix-th input tensor type information.

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

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

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

Set the ix-th output tensor type information.

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

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

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

Find a node by its name.

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

Borrow mutably a node by its name.

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

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

Get input and output tensor information for a node.

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

Get input tensor information for a node.

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

Get output tensor information for a node.

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

Get tensor information for a single outlet.

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

Get tensor information for a single outlet.

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

Get multiple mutable tensor information for outlets.

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

Set tensor information for a single outlet.

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

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

Set label for an outlet.

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

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, Global>, Error>

Computes an evalutation order for the graph inputs and outputs

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

Performs a sanity check on network connections.

pub fn into_runnable(self) -> Result<SimplePlan<F, O, Graph<F, O>>, Error>

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<&Node<F, O>>, Error>

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

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

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

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

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

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

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

pub fn check_compact(&self) -> Result<(), Error>

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

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

pub fn signature(&self) -> u64

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

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

Perform declutter passes on the network.

pub fn concretize_dims(
    &self,
    values: &SymbolValues
) -> Result<Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>, Error>

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

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

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

Trait Implementations

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

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

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

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

Returns the “default value” for a type.

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

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

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

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

pub 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 SpecialOps<TypedFact, Box<dyn TypedOp + 'static, Global>> for Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>

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

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

pub fn create_source(
    &self,
    fact: TypedFact
) -> Box<dyn TypedOp + 'static, Global>

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