Struct tract_core::model::Graph
source · [−]pub struct Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash, {
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>>,
}
Expand description
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
Implementations
sourceimpl<F, O> Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
Graph<F, O>: SpecialOps<F, O>,
impl<F, O> Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
Graph<F, O>: SpecialOps<F, O>,
pub fn add_source(
&mut self,
name: impl Into<String>,
fact: F
) -> TractResult<OutletId>
sourceimpl<F, O> Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
impl<F, O> Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
pub fn add_node(
&mut self,
name: impl Into<String>,
op: impl Into<O>,
output_facts: TVec<F>
) -> TractResult<usize>
sourcepub fn add_edge(&mut self, outlet: OutletId, inlet: InletId) -> TractResult<()>
pub fn add_edge(&mut self, outlet: OutletId, inlet: InletId) -> TractResult<()>
Connect a node outlet to a node inlet.
sourcepub fn input_outlets(&self) -> TractResult<&[OutletId]>
pub fn input_outlets(&self) -> TractResult<&[OutletId]>
Get model inputs.
sourcepub fn set_input_outlets(&mut self, inputs: &[OutletId]) -> TractResult<()>
pub fn set_input_outlets(&mut self, inputs: &[OutletId]) -> TractResult<()>
Change model inputs.
sourcepub fn with_input_outlets(self, inputs: &[OutletId]) -> TractResult<Self>
pub fn with_input_outlets(self, inputs: &[OutletId]) -> TractResult<Self>
Change model inputs and return self
.
sourcepub fn set_input_names(
&mut self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>
pub fn set_input_names(
&mut self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>
Set model inputs by the node name.
sourcepub fn with_input_names(
self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<Self>
pub fn with_input_names(
self,
inputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<Self>
Set model inputs by the node name and return self
.
sourcepub fn input_fact(&self, ix: usize) -> TractResult<&F>
pub fn input_fact(&self, ix: usize) -> TractResult<&F>
Get the ix
-th input tensor type information.
sourcepub fn input_fact_mut(&mut self, ix: usize) -> TractResult<&mut F>
pub fn input_fact_mut(&mut self, ix: usize) -> TractResult<&mut F>
Get the ix
-th input tensor type information, mutably.
sourcepub fn set_input_fact(&mut self, input: usize, fact: F) -> TractResult<()>
pub fn set_input_fact(&mut self, input: usize, fact: F) -> TractResult<()>
Set the ix
-th input tensor type information.
sourcepub fn with_input_fact(self, input: usize, fact: F) -> TractResult<Self>
pub fn with_input_fact(self, input: usize, fact: F) -> TractResult<Self>
Set the ix
-th input tensor type information and return self
.
sourcepub fn output_outlets(&self) -> TractResult<&[OutletId]>
pub fn output_outlets(&self) -> TractResult<&[OutletId]>
Get model outputs.
sourcepub fn auto_outputs(&mut self) -> TractResult<()>
pub fn auto_outputs(&mut self) -> TractResult<()>
Guess outputs from the topology: node or nodes with no successors.
sourcepub fn set_output_outlets(&mut self, outputs: &[OutletId]) -> TractResult<()>
pub fn set_output_outlets(&mut self, outputs: &[OutletId]) -> TractResult<()>
Change model outputs.
sourcepub fn with_output_outlets(self, outputs: &[OutletId]) -> TractResult<Self>
pub fn with_output_outlets(self, outputs: &[OutletId]) -> TractResult<Self>
Change model outputs and return self
.
sourcepub fn set_output_names(
&mut self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>
pub fn set_output_names(
&mut self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<()>
Set model outputs by node names.
sourcepub fn with_output_names(
self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<Self>
pub fn with_output_names(
self,
outputs: impl IntoIterator<Item = impl AsRef<str>>
) -> TractResult<Self>
Set model outputs by node names and return self
.
sourcepub fn output_fact(&self, ix: usize) -> TractResult<&F>
pub fn output_fact(&self, ix: usize) -> TractResult<&F>
Get the ix
-th input tensor type information.
sourcepub fn output_fact_mut(&mut self, ix: usize) -> TractResult<&mut F>
pub fn output_fact_mut(&mut self, ix: usize) -> TractResult<&mut F>
Get the ix
-th input tensor type information, mutably.
sourcepub fn set_output_fact(&mut self, output: usize, fact: F) -> TractResult<()>
pub fn set_output_fact(&mut self, output: usize, fact: F) -> TractResult<()>
Set the ix
-th output tensor type information.
sourcepub fn with_output_fact(self, output: usize, fact: F) -> TractResult<Self>
pub fn with_output_fact(self, output: usize, fact: F) -> TractResult<Self>
Set the ix
-th output tensor type information and return self
.
sourcepub fn node_names(&self) -> impl Iterator<Item = &str>
pub fn node_names(&self) -> impl Iterator<Item = &str>
Iterate over all node names.
pub fn node_id_by_name(&self, name: &str) -> TractResult<usize>
sourcepub fn node_by_name(&self, name: impl AsRef<str>) -> TractResult<&Node<F, O>>
pub fn node_by_name(&self, name: impl AsRef<str>) -> TractResult<&Node<F, O>>
Find a node by its name.
sourcepub fn node_by_name_mut(
&mut self,
name: impl AsRef<str>
) -> TractResult<&mut Node<F, O>>
pub fn node_by_name_mut(
&mut self,
name: impl AsRef<str>
) -> TractResult<&mut Node<F, O>>
Borrow mutably a node by its name.
pub fn rename_node(&mut self, id: usize, name: &str) -> TractResult<()>
sourcepub fn node_facts(&self, id: usize) -> TractResult<(TVec<&F>, TVec<&F>)>
pub fn node_facts(&self, id: usize) -> TractResult<(TVec<&F>, TVec<&F>)>
Get input and output tensor information for a node.
sourcepub fn node_input_facts(&self, node_id: usize) -> TractResult<TVec<&F>>
pub fn node_input_facts(&self, node_id: usize) -> TractResult<TVec<&F>>
Get input tensor information for a node.
sourcepub fn node_output_facts(&self, node_id: usize) -> TractResult<TVec<&F>>
pub fn node_output_facts(&self, node_id: usize) -> TractResult<TVec<&F>>
Get output tensor information for a node.
sourcepub fn outlet_fact(&self, outlet: OutletId) -> TractResult<&F>
pub fn outlet_fact(&self, outlet: OutletId) -> TractResult<&F>
Get tensor information for a single outlet.
sourcepub fn outlet_fact_mut(&mut self, outlet: OutletId) -> TractResult<&mut F>
pub fn outlet_fact_mut(&mut self, outlet: OutletId) -> TractResult<&mut F>
Get tensor information for a single outlet.
sourcepub fn outlets_fact_mut(
&mut self,
outlets: &[OutletId]
) -> TractResult<TVec<&mut F>>
pub fn outlets_fact_mut(
&mut self,
outlets: &[OutletId]
) -> TractResult<TVec<&mut F>>
Get multiple mutable tensor information for outlets.
sourcepub fn set_outlet_fact(&mut self, outlet: OutletId, fact: F) -> TractResult<()>
pub fn set_outlet_fact(&mut self, outlet: OutletId, fact: F) -> TractResult<()>
Set tensor information for a single outlet.
sourcepub fn with_outlet_fact(self, outlet: OutletId, fact: F) -> TractResult<Self>
pub fn with_outlet_fact(self, outlet: OutletId, fact: F) -> TractResult<Self>
Set tensor information for a single outlet and return self
.
sourcepub fn outlet_label(&self, outlet: OutletId) -> Option<&str>
pub fn outlet_label(&self, outlet: OutletId) -> Option<&str>
Get label for an outlet.
sourcepub fn set_outlet_label(
&mut self,
outlet: OutletId,
label: String
) -> TractResult<()>
pub fn set_outlet_label(
&mut self,
outlet: OutletId,
label: String
) -> TractResult<()>
Set label for an outlet.
sourcepub fn with_outlet_label(
self,
outlet: OutletId,
label: String
) -> TractResult<Self>
pub fn with_outlet_label(
self,
outlet: OutletId,
label: String
) -> TractResult<Self>
Set label for an outlet and return self
.
sourcepub fn find_outlet_label(&self, label: &str) -> Option<OutletId>
pub fn find_outlet_label(&self, label: &str) -> Option<OutletId>
Find outlet by label.
sourcepub fn eval_order(&self) -> TractResult<Vec<usize>>
pub fn eval_order(&self) -> TractResult<Vec<usize>>
Computes an evalutation order for the graph inputs and outputs
sourcepub fn check_edges(&self) -> TractResult<()>
pub fn check_edges(&self) -> TractResult<()>
Performs a sanity check on network connections.
sourcepub fn into_runnable(self) -> TractResult<RunnableModel<F, O, Self>>
pub fn into_runnable(self) -> TractResult<RunnableModel<F, O, Self>>
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) -> TractResult<Option<&Node<F, O>>>
pub fn single_prec_at(
&self,
id: usize,
count: usize
) -> TractResult<Option<&Node<F, O>>>
pub fn single_succ_at(
&self,
id: usize,
count: usize
) -> TractResult<Option<&Node<F, O>>>
pub fn single_succ(&self, id: usize) -> TractResult<Option<&Node<F, O>>>
pub fn outlet_successors(&self, outlet: OutletId) -> &[InletId]
sourceimpl<F: Fact + Clone + 'static, O> Graph<F, O> where
F: Fact + Clone + 'static + From<Arc<Tensor>> + Hash,
O: Debug + Display + From<Const> + AsRef<dyn Op> + AsMut<dyn Op> + Clone + Hash + 'static,
impl<F: Fact + Clone + 'static, O> Graph<F, O> where
F: Fact + Clone + 'static + From<Arc<Tensor>> + Hash,
O: Debug + Display + From<Const> + AsRef<dyn Op> + AsMut<dyn Op> + Clone + Hash + 'static,
pub fn add_const(
&mut self,
name: impl Into<String>,
v: impl IntoArcTensor
) -> TractResult<OutletId>
sourceimpl<F, O> Graph<F, O> where
F: Fact + Clone + 'static + Hash + for<'a> From<&'a F>,
O: Display + Debug + Clone + AsRef<dyn Op> + AsMut<dyn Op> + 'static + Hash + for<'a> From<&'a O>,
Graph<F, O>: SpecialOps<F, O>,
impl<F, O> Graph<F, O> where
F: Fact + Clone + 'static + Hash + for<'a> From<&'a F>,
O: Display + Debug + Clone + AsRef<dyn Op> + AsMut<dyn Op> + 'static + Hash + for<'a> From<&'a O>,
Graph<F, O>: SpecialOps<F, O>,
pub fn check_compact(&self) -> TractResult<()>
pub fn compact(&mut self) -> TractResult<()>
pub fn into_compact(self) -> TractResult<Self>
sourceimpl Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>
impl Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>
pub fn signature(&self) -> u64
pub fn into_optimized(self) -> TractResult<TypedModel>
pub fn into_decluttered(self) -> TractResult<TypedModel>
sourcepub fn declutter(&mut self) -> TractResult<()>
pub fn declutter(&mut self) -> TractResult<()>
Perform declutter passes on the network.
pub fn concretize_dims(&self, values: &SymbolValues) -> TractResult<TypedModel>
sourcepub fn optimize(&mut self) -> TractResult<()>
pub fn optimize(&mut self) -> TractResult<()>
Translate the graph to locally optimized operators (LIR or MIR ops).
pub fn invariants(&self) -> TractResult<Invariants>
Trait Implementations
sourceimpl<F: Clone, O: Clone> Clone for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
impl<F: Clone, O: Clone> Clone for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
sourceimpl<F: Debug, O: Debug> Debug for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
impl<F: Debug, O: Debug> Debug for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
sourceimpl<F, O> Default for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
impl<F, O> Default for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
sourceimpl<F, O> Display for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
impl<F, O> Display for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
sourceimpl<F, O> DynHash for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
impl<F, O> DynHash for Graph<F, O> where
F: Fact + Hash + Clone + 'static,
O: Debug + Display + AsRef<dyn Op> + AsMut<dyn Op> + Clone + 'static + Hash,
Auto Trait Implementations
impl<F, O> RefUnwindSafe for Graph<F, O> where
F: RefUnwindSafe,
O: RefUnwindSafe,
impl<F, O> Send for Graph<F, O> where
O: Send,
impl<F, O> Sync for Graph<F, O> where
O: Sync,
impl<F, O> Unpin for Graph<F, O> where
F: Unpin,
O: Unpin,
impl<F, O> UnwindSafe for Graph<F, O> where
F: UnwindSafe + RefUnwindSafe,
O: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more