Struct TextForwardResult 

pub struct TextForwardResult { /* private fields */ }

Result of a text-based forward pass, bundling MI outputs with token position mapping.

Returned by MIModel::forward_text. Provides access to the HookCache (logits + captured activations) alongside the EncodingWithOffsets (token strings, IDs, and byte offset ranges for mapping between source text positions and token indices).

Implementations

impl TextForwardResult

pub const fn cache(&self) -> &HookCache

Access the hook cache (logits + captured activations).

pub fn into_cache(self) -> HookCache

Consume the result and return the hook cache.

pub const fn encoding(&self) -> &EncodingWithOffsets

Access the token encoding with character offset mapping.

pub const fn output(&self) -> &Tensor

The output tensor from the forward pass (typically logits).

Shortcut for self.cache().output().

Shapes

• returns: [1, seq, vocab_size]

pub fn require(&self, hook: &HookPoint) -> Result<&Tensor>

Retrieve a captured tensor by hook point, returning an error if not found.

Shortcut for self.cache().require(hook).

Errors

Returns MIError::Hook if the hook point was not captured.

pub fn get(&self, hook: &HookPoint) -> Option<&Tensor>

Retrieve a captured tensor by hook point.

Shortcut for self.cache().get(hook).

pub fn tokens(&self) -> &[String]

The raw BPE token strings (with space-prefix markers like Ġ).

Shortcut for self.encoding().tokens.

pub const fn seq_len(&self) -> usize

Number of tokens in the encoded sequence.

Trait Implementations

impl Debug for TextForwardResult

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

Formats the value using the given formatter.