Skip to main content

RaggedBatch

Struct RaggedBatch 

Source
pub struct RaggedBatch {
    pub token_ids: Vec<u32>,
    pub cumulative_offsets: Vec<u32>,
    pub max_seq_len: usize,
}
Expand description

A ragged (unpadded) batch for efficient ModernBERT inference.

ModernBERT achieves its speed advantage by avoiding padding tokens entirely. Instead of [batch, max_seq_len], it uses a single contiguous 1D sequence with offset indices to track document boundaries.

§Memory Layout

Traditional (padded):
[doc1_tok1, doc1_tok2, PAD, PAD, PAD]  <- wasted compute
[doc2_tok1, doc2_tok2, doc2_tok3, PAD, PAD]

Ragged (unpadded):
[doc1_tok1, doc1_tok2, doc2_tok1, doc2_tok2, doc2_tok3]
cumulative_offsets: [0, 2, 5]  <- doc1 is [0..2], doc2 is [2..5]

Fields§

§token_ids: Vec<u32>

Token IDs flattened into a single contiguous array. Shape: [total_tokens] (1D, no padding)

§cumulative_offsets: Vec<u32>

Cumulative sequence lengths. Length: batch_size + 1 Document i spans tokens [offsets[i]..offsets[i+1])

§max_seq_len: usize

Maximum sequence length in this batch (for kernel bounds).

Implementations§

Source§

impl RaggedBatch

Source

pub fn from_sequences(sequences: &[Vec<u32>]) -> Self

Create a new ragged batch from sequences.

Source

pub fn batch_size(&self) -> usize

Get the number of documents in this batch.

Source

pub fn total_tokens(&self) -> usize

Get the total number of tokens (no padding).

Source

pub fn doc_range(&self, doc_idx: usize) -> Option<Range<usize>>

Get token range for a specific document.

Source

pub fn doc_tokens(&self, doc_idx: usize) -> Option<&[u32]>

Get tokens for a specific document.

Source

pub fn padding_savings(&self) -> f64

Calculate memory saved vs padded batch.

Trait Implementations§

Source§

impl Clone for RaggedBatch

Source§

fn clone(&self) -> RaggedBatch

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RaggedBatch

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V