Struct Graph

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

Main model class

Parameterized by a Fact class.

Fields

nodes: Vec<Node<F, O>>

all nodes in the model

inputs: Vec<OutletId>

model inputs

outputs: Vec<OutletId>

model outputs

outlet_labels: HashMap<OutletId, String>

outlet labels

properties: HashMap<String, Arc<Tensor>>

model properties

symbols: SymbolScope

symbol scope, including table

Implementations

impl<F, O> Graph<F, O>

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

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

Computes an evalutation order for the graph inputs and outputs

pub fn eval_order_opt_ram(&self) -> Result<Vec<usize>, Error>

Computes an evalutation order for the graph inputs and outputs. This order will minimize temporary buffers.

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

pub fn eval_tmp_memory_usage<Flushable>( &self, order: &[usize], flushable: Flushable, ) -> Result<SmallVec<[(usize, TDim); 4]>, Error>

where Flushable: Fn(&Node<F, O>) -> bool,

Evaluate temporary memory usage with its related node at each step of the given order.

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

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

Converts the model into a RunnableModel to actually process user data.

pub fn into_runnable_with_options( self, options: &PlanOptions, ) -> Result<SimplePlan<F, O, Graph<F, O>>, Error>

Converts the model into a RunnableModel to actually process user data. This variant accepts options.

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>

single_succ is only intended for optimisation of simple operators with 1 output, and only 1 output successors (successor with only 1 input)

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

pub fn sym(&self, s: &str) -> Symbol

retrieve of create a symbol

pub fn new_sym_with_prefix(&self, prefix: &str) -> Symbol

create a new symbol with the prefix

pub fn unique_name<'n>(&self, prefix: impl Into<Cow<'n, str>>) -> Cow<'n, str>

generates a name for a new node in the model that will not conflict (by suffixing with a dot and number)

impl<F, O> Graph<F, O>

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

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

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

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

impl Graph<TypedFact, Box<dyn TypedOp>>

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

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

pub fn into_decluttered( self, ) -> Result<Graph<TypedFact, Box<dyn TypedOp>>, Error>

pub fn transform(&mut self, transform: &dyn ModelTransform) -> Result<(), Error>

Perform declutter passes on the network.

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

Perform declutter passes on the network.

pub fn optimize_with_session( &mut self, session: &mut OptimizerSession<'_>, ) -> Result<(), Error>

Perform optimization passes on the model, using a given optimizer session.

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

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

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

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

pub fn node_axes_mapping(&self, id: usize) -> Result<AxesMapping, Error>

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

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

Trait Implementations

impl<F, O> Clone for Graph<F, O>

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

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

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

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

Returns the “default value” for a type.

impl<F, O> Display for Graph<F, O>

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

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

Formats the value using the given formatter.

impl Framework<ProtoModel, Graph<TypedFact, Box<dyn TypedOp>>> for Nnef

fn model_for_path( &self, p: impl AsRef<Path>, ) -> Result<Graph<TypedFact, Box<dyn TypedOp>>, Error>

Build a model from a filename.

fn proto_model_for_path( &self, path: impl AsRef<Path>, ) -> Result<ProtoModel, Error>

Read a proto model from a filename.

fn proto_model_for_read( &self, reader: &mut dyn Read, ) -> Result<ProtoModel, Error>

Parse a proto model from a reader.

fn model_for_proto_model_with_model_template( &self, proto: &ProtoModel, template: Graph<TypedFact, Box<dyn TypedOp>>, ) -> Result<Graph<TypedFact, Box<dyn TypedOp>>, Error>

Translate a proto model into a model, with some symbols already listed.

fn model_for_proto_model(&self, proto: &ProtoModel) -> Result<Model, Error>

Translate a proto model into a model.

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

Read a model from a reader

impl InnerModel for Graph<TypedFact, Box<dyn TypedOp>>

fn output_facts( &self, _inputs: &[&TypedFact], ) -> Result<SmallVec<[TypedFact; 4]>, Error>

fn is_stateless(&self) -> bool

fn state( &self, session: &mut SessionState, node_id: usize, ) -> Result<Option<Box<dyn OpState>>, Error>

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

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

fn as_typed(&self) -> &Graph<TypedFact, Box<dyn TypedOp>>

impl SpecialOps<TypedFact, Box<dyn TypedOp>> for Graph<TypedFact, Box<dyn TypedOp>>

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

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

fn create_source(&self, fact: TypedFact) -> Box<dyn TypedOp>

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

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