Struct Scan 

pub struct Scan {
    pub skip: usize,
    pub reset_every_turn: bool,
    pub external_state: bool,
    pub body: TypedModel,
    pub decluttered: bool,
    pub input_mapping: Vec<InputMapping>,
    pub output_mapping: Vec<OutputMapping<TDim>>,
}

Fields

skip: usize

reset_every_turn: bool

external_state: bool

True iff the caller manages State inputs externally — they supply a fresh value every run (typically reading the Scan’s last_value_slot output and feeding it back into the next call’s State input). This is set explicitly at construction time, e.g. by the ONNX LSTM/GRU/ RNN importer when both initial_h and Y_h are exposed (parakeet decoder). When true, declutter_single_loop can safely inline a stateful single-iter Scan because the caller’s per-call value reaches the body directly. When false (default), tract carries State across calls internally and inlining would break recurrence (issue #2157).

body: TypedModel

decluttered: bool

input_mapping: Vec<InputMapping>

output_mapping: Vec<OutputMapping<TDim>>

Implementations

impl Scan

pub fn to_codegen_op(&self, optimize_inner: bool) -> TractResult<OptScan>

pub fn new( body: TypedModel, input_mapping: Vec<InputMapping>, output_mapping: Vec<OutputMapping<TDim>>, skip: usize, ) -> TractResult<Scan>

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

Trait Implementations

impl Clone for Scan

fn clone(&self) -> Scan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scan

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

Formats the value using the given formatter.

impl Default for Scan

fn default() -> Scan

Returns the “default value” for a type.

impl EvalOp for Scan

fn is_stateless(&self) -> bool

fn state( &self, session: &TurnState, node_id: usize, ) -> TractResult<Option<Box<dyn OpState>>>

fn eval(&self, inputs: TVec<TValue>) -> TractResult<TVec<TValue>>

fn eval_with_session( &self, node_id: usize, session: &TurnState, inputs: TVec<TValue>, ) -> TractResult<TVec<TValue>>

impl Op for Scan

fn name(&self) -> StaticName

fn info(&self) -> TractResult<Vec<String>>

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

fn validation(&self) -> Validation

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

fn as_typed(&self) -> Option<&dyn TypedOp>

impl PartialEq for Scan

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypedOp for Scan

fn as_op(&self) -> &dyn Op

Reinterpret the TypedOp as an Op.

fn as_op_mut(&mut self) -> &mut dyn Op

Reinterpret the TypedOp as an Op, mutably.

fn output_facts(&self, inputs: &[&TypedFact]) -> TractResult<TVec<TypedFact>>

Deduce output facts from input facts.

fn axes_mapping( &self, inputs: &[&TypedFact], outputs: &[&TypedFact], ) -> TractResult<AxesMapping>

fn suggested_axis_changes(&self) -> TractResult<TVec<(InOut, AxisOp)>>

fn change_axes( &self, model: &TypedModel, node: &TypedNode, io: InOut, change: &AxisOp, ) -> TractResult<Option<AxisChangeConsequence>>

fn declutter_with_session( &self, session: &mut OptimizerSession<'_>, model: &TypedModel, node: &TypedNode, ) -> TractResult<Option<TypedModelPatch>>

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

fn set_symbols( &self, _source: &TypedModel, node: &TypedNode, target: &mut TypedModel, mapping: &HashMap<OutletId, OutletId>, subs: &HashMap<Symbol, TDim>, ) -> TractResult<TVec<OutletId>>

Transform the op by substituting one or more symbols with TDim expressions (a concrete integer is TDim::Val(v); an expression can be any other TDim, including symbolic ones).

fn codegen( &self, model: &TypedModel, node: &TypedNode, ) -> TractResult<Option<TypedModelPatch>>

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

fn fuse( &self, _model: &TypedModel, _node: &TypedNode, ) -> TractResult<Option<TypedModelPatch>>

Fuse op after codegen to deal with local optimisations.

fn declutter( &self, model: &TypedModel, node: &TypedNode, ) -> TractResult<Option<TypedModelPatch>>

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

fn cost(&self, _inputs: &[&TypedFact]) -> TractResult<TVec<(Cost, TDim)>>

Computes a cost hint of the operation.

fn input_roi( &self, model: &TypedModel, node: &TypedNode, ) -> TractResult<Option<TVec<Option<TDim>>>>

Derive ROI (region of interest) expressions for this node’s inputs. Called by the PropagateRoi pass. Default returns None (no propagation). Override to introduce ROIs or bubble them through.

fn slice( &self, patch: &mut TypedModelPatch, model: &TypedModel, node: &TypedNode, prefix: &str, inputs: &[OutletId], output_axis: usize, start: &TDim, end: &TDim, ) -> TractResult<Option<TVec<OutletId>>>

fn quantize( &self, model: &TypedModel, node: &TypedNode, dt: DatumType, scale: f32, zero_point: i32, ) -> TractResult<Option<Box<dyn TypedOp>>>

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

fn nested_model_multipliers( &self, inputs: &[&TypedFact], ) -> Vec<(StaticName, TDim)>

Nested model multipliers, with label (for profiling).

impl Eq for Scan