Struct tract_hir::prelude::InferenceFact

pub struct InferenceFact {
    pub datum_type: TypeFactoid,
    pub shape: ShapeFactoid,
    pub value: ValueFact,
}

Partial information about a tensor.

The task of the analyser is to tag every edge in the graph with information about the tensors that flow through it - specifically their datum_type, their shape and possibly their value. During the analysis, however, we might only know some of that information (say, for instance, that an edge only carries tensors of rank 4, but without knowing their precise dimension).

This is where tensor facts come in: they hold partial information about the datum_type, shape and value of tensors that might flow through an edge of the graph. The analyser will first tag each edge with a fact, starting with the most general one and specializing it at each iteration. Eventually, it will reach a fixed point that - hopefully - holds enough information.

Fields

datum_type: TypeFactoid

shape: ShapeFactoid

value: ValueFact

Implementations

impl InferenceFact

pub fn new() -> InferenceFact

Constructs the most general tensor fact possible.

pub fn any() -> InferenceFact

pub fn dt(dt: DatumType) -> InferenceFact

pub fn dt_shape<S: Into<ShapeFactoid>>(dt: DatumType, shape: S) -> InferenceFact

pub fn shape<S: Into<ShapeFactoid>>(shape: S) -> InferenceFact

pub fn with_datum_type(self, dt: DatumType) -> InferenceFact

pub fn with_shape<S: Into<ShapeFactoid>>(self, shape: S) -> InferenceFact

pub fn with_streaming_shape<S: IntoIterator<Item = Option<usize>>>(
    self,
    shape: S
) -> InferenceFact

pub fn stream_info(&self) -> TractResult<Option<StreamFact>>

pub fn format_dt_shape(&self) -> String

pub fn dt_shape_from_tensor(t: &Tensor) -> InferenceFact

pub fn without_value(self) -> InferenceFact

Trait Implementations

impl Clone for InferenceFact

fn clone(&self) -> InferenceFact

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InferenceFact

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

Formats the value using the given formatter.

impl Default for InferenceFact

fn default() -> InferenceFact

Returns the "default value" for a type.

impl Fact for InferenceFact

fn to_typed_fact(&self) -> TractResult<TypedFact>

fn matches(&self, t: &Tensor) -> TractResult<bool>

fn same_as(&self, other: &dyn Fact) -> bool

impl Factoid for InferenceFact

type Concrete = Arc<Tensor>

fn concretize(&self) -> Option<Self::Concrete>

Tries to transform the fact into a concrete value.

fn unify(&self, other: &Self) -> TractResult<Self>

Tries to unify the fact with another fact of the same type.

fn is_concrete(&self) -> bool

Returns whether the value is fully determined.

fn unify_with(&mut self, other: &Self) -> TractResult<bool>

Tries to unify the fact with another fact of the same type and update self.

fn unify_with_mut(&mut self, other: &mut Self) -> TractResult<bool>

Tries to unify the fact with another fact of the same type and update both of them.

fn unify_all(facts: &mut [&mut Self]) -> TractResult<bool>

Tries to unify all facts in the list.

impl<'a> From<&'a Arc<Tensor>> for InferenceFact

fn from(t: &'a Arc<Tensor>) -> InferenceFact

Performs the conversion.

impl<'a> From<&'a InferenceFact> for InferenceFact

fn from(t: &'a InferenceFact) -> InferenceFact

Performs the conversion.

impl<'a> From<&'a Tensor> for InferenceFact

fn from(t: &'a Tensor) -> InferenceFact

Performs the conversion.

impl<'a> From<&'a TypedFact> for InferenceFact

fn from(t: &'a TypedFact) -> InferenceFact

Performs the conversion.

impl From<Arc<Tensor>> for InferenceFact

fn from(t: Arc<Tensor>) -> InferenceFact

Performs the conversion.

impl From<Tensor> for InferenceFact

fn from(t: Tensor) -> InferenceFact

Performs the conversion.

impl Hash for InferenceFact

fn hash<__H: Hasher>(&self, state: &mut __H)

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 ModelSpecialOps<InferenceFact, Box<dyn InferenceOp + 'static>> for InferenceModel

fn add_source(
    &mut self,
    name: impl Into<String>,
    fact: InferenceFact
) -> TractResult<OutletId>

Adds a source op to the network.

fn is_source(op: &dyn Op) -> bool

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

impl ModelWireNode<InferenceFact, Box<dyn InferenceOp + 'static>> for InferenceModel

fn wire_node(
    &mut self,
    name: impl Into<String>,
    op: impl Into<Box<dyn InferenceOp>>,
    inputs: &[OutletId]
) -> TractResult<TVec<OutletId>>

impl PartialEq<InferenceFact> for InferenceFact

fn eq(&self, other: &InferenceFact) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &InferenceFact) -> bool

This method tests for !=.

impl StructuralPartialEq for InferenceFact

impl<'a> TryFrom<&'a InferenceFact> for TypedFact

type Error = TractError

The type returned in the event of a conversion error.

fn try_from(fact: &InferenceFact) -> TractResult<TypedFact>

Performs the conversion.