Compressor

Struct Compressor 

Source
pub struct Compressor {
    pub model: Arc<Model>,
    pub state: State,
    pub scratch: ScratchBuffers,
    pub pdf_buffer: Vec<f64>,
    pub cdf_buffer_ac: Vec<u32>,
    pub ac_freq_buffer: Vec<i64>,
    pub cdf_buffer_rans: Vec<u32>,
    pub rans_freq_buffer: Vec<i64>,
    /* private fields */
}
Expand description

Main compressor/decompressor that combines RWKV7 inference with entropy coding.

The compressor maintains internal state and pre-allocated buffers to minimize allocations during the compression/decompression hot path.

Fields§

§model: Arc<Model>

RWKV7 model for generating probability distributions.

§state: State

Model state (recurrent hidden states).

§scratch: ScratchBuffers

Scratch buffers for model forward passes.

§pdf_buffer: Vec<f64>

Pre-allocated PDF buffer (eliminates allocations in compression loop).

§cdf_buffer_ac: Vec<u32>

Reusable AC CDF buffer (vocab_size + 1 entries).

§ac_freq_buffer: Vec<i64>

Scratch frequencies for AC quantization.

§cdf_buffer_rans: Vec<u32>

Reusable rANS CDF buffer (vocab_size + 1 entries).

§rans_freq_buffer: Vec<i64>

Scratch frequencies for rANS quantization.

Implementations§

Source§

impl Compressor

Source

pub fn new<P: AsRef<Path>>(model_path: P) -> Result<Self>

Create a new compressor with the given model.

§Arguments
  • model_path - Path to RWKV7 model weights (.safetensors format)
§Returns

A new Compressor ready for compression/decompression operations.

Source

pub fn load_model<P: AsRef<Path>>(model_path: P) -> Result<Arc<Model>>

Load a model from disk and wrap it in Arc.

Source

pub fn new_from_model(model: Arc<Model>) -> Self

Create a compressor from a preloaded model.

Source

pub fn new_from_method(method: &str) -> Result<Self>

Create a compressor from a user method string.

Source

pub fn reset(&mut self)

Reset the model state to initial values.

Call this between independent compression/decompression operations to ensure a clean state.

Source

pub fn begin_online_policy_stream( &mut self, total_symbols: Option<u64>, ) -> Result<()>

Begin a policy stream with optional total symbol count.

Source

pub fn finish_online_policy_stream(&mut self) -> Result<()>

Flush any pending TBPTT segment while preserving the current predictive state.

Source

pub fn restart_online_policy_stream( &mut self, total_symbols: Option<u64>, ) -> Result<()>

Reset hidden state and TBPTT bookkeeping for a fresh stream.

Source

pub fn reset_and_prime(&mut self)

Reset state and prime the first predictive distribution.

Source

pub fn snapshot_runtime(&self) -> RuntimeSnapshot

Capture runtime state for later restoration.

Source

pub fn restore_runtime(&mut self, snapshot: &RuntimeSnapshot)

Restore previously captured runtime state.

Source

pub fn absorb_chain(&mut self, parts: &[&[u8]]) -> Result<()>

Absorb a sequence of byte slices as conditioning context.

Source

pub fn cross_entropy_from_current(&mut self, data: &[u8]) -> Result<f64>

Score bytes from the current predictive state.

Source

pub fn cross_entropy_frozen_plugin_chain( &mut self, fit_parts: &[&[u8]], data: &[u8], ) -> Result<f64>

Fit on fit_parts, then reset stream state and score data without further adaptation.

Source

pub fn is_online(&self) -> bool

Returns true when the compressor is in online-adaptation mode.

Source

pub fn can_adapt_online(&self) -> bool

Returns true when the current online configuration can actually adapt parameters.

Source

pub fn tokens_processed(&self) -> u64

Number of tokens processed by the online updater.

Source

pub fn online_method_string(&self) -> Option<&str>

Canonical method string for online mode, if enabled.

Source

pub fn vocab_size(&self) -> usize

Get the vocabulary size (should always be 256 for byte-level).

Source

pub fn online_apply_logits_bias(&self, logits: &[f32], pdf_out: &mut [f64])

Apply optional online bias to logits and emit normalized PDF.

Source

pub fn logits_to_pdf(logits: &[f32], bias: Option<&[f32]>, pdf_out: &mut [f64])

Convert logits (and optional bias) to a normalized PDF.

Source

pub fn forward_to_pdf(&mut self, token: u32, pdf_out: &mut [f64])

Forward one token and emit the resulting (optionally biased) PDF.

Source

pub fn forward_to_internal_pdf(&mut self, token: u32)

Refresh the internal cached PDF buffer from token.

Source

pub fn copy_current_pdf_to(&self, pdf_out: &mut [f64])

Copy the internal cached PDF into pdf_out (length must match vocab size).

Source

pub fn online_bias_snapshot(&self) -> Option<Vec<f32>>

Snapshot current online output bias, if online mode is active.

Source

pub fn online_bias_slice(&self) -> Option<&[f32]>

Borrow online output bias vector when online mode is active.

Source

pub fn online_update_from_pdf(&mut self, symbol: u8, pdf: &[f64]) -> Result<()>

Apply one online update using externally supplied predictive PDF.

Source

pub fn observe_symbol_from_pdf(&mut self, symbol: u8, pdf: &[f64]) -> Result<()>

Update online state from pdf, then advance model state with symbol.

Source

pub fn observe_symbol_from_current_pdf(&mut self, symbol: u8) -> Result<()>

Update online state using current internal PDF, then consume symbol.

Source

pub fn export_online<P: AsRef<Path>>(&self, model_path: P) -> Result<()>

Export model weights and JSON sidecar metadata.

Source

pub fn compress(&mut self, data: &[u8], coder: CoderType) -> Result<Vec<u8>>

Compress data using the specified entropy coder.

§Arguments
  • data - Raw bytes to compress
  • coder - Entropy coder to use (AC or rANS)
§Returns

Compressed data including header with checksum.

Source

pub fn compress_into<W: Write>( &mut self, data: &[u8], coder: CoderType, w: &mut W, ) -> Result<()>

Compress into an arbitrary writer.

Source

pub fn compress_chain_into<W: Write>( &mut self, parts: &[&[u8]], coder: CoderType, w: &mut W, ) -> Result<()>

Compress a chain of byte slices into an arbitrary writer.

Source

pub fn compress_size(&mut self, data: &[u8], coder: CoderType) -> Result<u64>

Return compressed byte size without materializing output bytes.

Source

pub fn compress_size_chain( &mut self, parts: &[&[u8]], coder: CoderType, ) -> Result<u64>

Return compressed byte size for chained inputs.

Source

pub fn decompress(&mut self, data: &[u8]) -> Result<Vec<u8>>

Decompress data.

§Arguments
  • data - Compressed data (must include header)
§Returns

Original decompressed data. Returns error if checksum doesn’t match.

Source

pub fn cross_entropy(&mut self, data: &[u8]) -> Result<f64>

Calculate cross-entropy (bits per byte) for data without compression.

This measures how well the model predicts the data, giving a theoretical lower bound on achievable compression. Useful for evaluating model quality.

§Arguments
  • data - Data to analyze
§Returns

Average bits per byte (lower is better, 8.0 means no compression possible).

Source

pub fn cross_entropy_conditional_chain( &mut self, prefix_parts: &[&[u8]], data: &[u8], ) -> Result<f64>

Cross entropy conditioned on chained prefix slices.

Source

pub fn cross_entropy_conditional( &mut self, prefix: &[u8], data: &[u8], ) -> Result<f64>

Cross entropy conditioned on a single prefix slice.

Source

pub fn joint_cross_entropy_aligned_min( &mut self, x: &[u8], y: &[u8], ) -> Result<f64>

Symmetric aligned joint cross entropy using the better ordering.

Trait Implementations§

Source§

impl Clone for Compressor

Source§

fn clone(&self) -> Self

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

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> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Return the immutable any encapsulated object.
Source§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Return the mutable encapsulated any object.
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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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.
§

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

§

fn vzip(self) -> V