Struct orkhon::prelude::ops::scan::Scan

pub struct Scan {
    pub skip: usize,
    pub body: Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    pub seq_length_input_slot: Option<usize>,
    pub input_mapping: Vec<InputMapping, Global>,
    pub output_mapping: Vec<OutputMapping<TDim>, Global>,
    // some fields omitted
}

Fields

skip: usize

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

seq_length_input_slot: Option<usize>

input_mapping: Vec<InputMapping, Global>

output_mapping: Vec<OutputMapping<TDim>, Global>

Implementations

impl Scan

pub fn to_codegen_op(&self, optimize_inner: bool) -> Result<LirScan, Error>

pub fn new(
    body: Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    input_mapping: Vec<InputMapping, Global>,
    output_mapping: Vec<OutputMapping<TDim>, Global>,
    seq_length_input_slot: Option<usize>,
    skip: usize
) -> Result<Scan, Error>

pub fn iteration_count(&self, inputs: &[&TypedFact]) -> Option<TDim>

Trait Implementations

impl Clone for Scan

pub fn clone(&self) -> Scan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scan

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

Formats the value using the given formatter.

impl Default for Scan

pub fn default() -> Scan

Returns the "default value" for a type.

impl DynHash for Scan

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

impl EvalOp for Scan

pub fn is_stateless(&self) -> bool

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

pub fn eval(
    &self,
    inputs: SmallVec<[Arc<Tensor>; 4]>
) -> Result<SmallVec<[Arc<Tensor>; 4]>, Error>

impl Hash for Scan

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Op for Scan

pub fn name(&self) -> Cow<'_, str>

pub fn info(&self) -> Result<Vec<String, Global>, Error>

Short (one-line) strings giving hints on internal implementation or important configuration details to be displayed in dumps.

pub fn validation(&self) -> Validation

The kind of accuracy check that should be performed on operation when testing them.

pub fn op_families(&self) -> &'static [&'static str]

Vector of short strings defining what families the op belongs too. tract-core defines "core", "mir", "lir".

pub fn as_typed(&self) -> Option<&(dyn TypedOp + 'static)>

pub fn same_as(&self, _other: &(dyn Op + 'static)) -> bool

Compare two ops.

impl TypedOp for Scan

pub fn as_op(&self) -> &(dyn Op + 'static)

Reinterpret the TypedOp as an Op.

pub fn as_op_mut(&mut self) -> &mut (dyn Op + 'static)

Reinterpret the TypedOp as an Op, mutably.

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

Deduce output facts from input facts.

pub fn invariants(
    &self,
    _model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    _node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>
) -> Result<Invariants, Error>

pub fn change_axes(
    &self,
    _model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    _node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    io: InOut,
    change: &AxisOp
) -> Result<Option<AxisChangeConsequence>, Error>

pub fn declutter(
    &self,
    model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>
) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp + 'static, Global>>>, Error>

Declutter the op to the tract_core operator set as much as possible.

pub fn concretize_dims(
    &self,
    _source: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    target: &mut Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    mapping: &HashMap<OutletId, OutletId, RandomState>,
    values: &SymbolValues
) -> Result<SmallVec<[OutletId; 4]>, Error>

Transform the op into by providing a value to one or more symbols.

pub fn codegen(
    &self,
    model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>
) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp + 'static, Global>>>, Error>

Translate the op into the most efficient form possible for execution.

pub fn fuse(
    &self,
    _model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    _node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>
) -> Result<Option<ModelPatch<TypedFact, Box<dyn TypedOp + 'static, Global>>>, Error>

Fuse op after codegen to deal with local optimisations.

pub fn cost(
    &self,
    _inputs: &[&TypedFact]
) -> Result<SmallVec<[(Cost, TDim); 4]>, Error>

Computes a cost hint of the operation.

pub fn suggested_axis_changes(
    &self
) -> Result<SmallVec<[(InOut, AxisOp); 4]>, Error>

pub fn slice_output(
    &self,
    model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    patch: &mut ModelPatch<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    output_slot: usize,
    axis: usize,
    start: usize,
    end: usize
) -> Result<Option<OutletId>, Error>

pub fn quantize(
    &self,
    model: &Graph<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    node: &Node<TypedFact, Box<dyn TypedOp + 'static, Global>>,
    dt: DatumType,
    scale: f32,
    zero_point: i32
) -> Result<Option<Box<dyn TypedOp + 'static, Global>>, Error>

Transforms the op in an equivalent one, operating on dt (i8 or u8).

pub fn nested_model_multipliers(
    &self,
    inputs: &[&TypedFact]
) -> Vec<(Cow<'_, str>, f64), Global>

Nested model multipliers, with label (for profiling).