Skip to main content

CodecConfig

Struct CodecConfig 

Source
pub struct CodecConfig {
Show 21 fields pub model: ModelConfig, pub optim: OptimConfig, pub retrain: RetrainConfig, pub batch_size: usize, pub block_len: usize, pub online_loss: OnlineLoss, pub project_only_targets: bool, pub seed: u64, pub dtype: ComputeDType, pub autocast_policy: AutocastPolicy, pub device: DeviceChoice, pub max_tokens: Option<usize>, pub raw_bytes: Option<u64>, pub vocab_bytes: u64, pub vocab_file: Option<PathBuf>, pub initial_prior: Option<PathBuf>, pub log_interval: usize, pub checkpoint_dir: Option<PathBuf>, pub checkpoint_every_blocks: usize, pub stop_after_blocks: Option<usize>, pub run_dir: Option<PathBuf>,
}
Expand description

Complete configuration for running the neural compressor or decompressor.

Fields§

§model: ModelConfig

Transformer architecture configuration.

§optim: OptimConfig

Online Adam configuration.

§retrain: RetrainConfig

Prefix replay configuration.

§batch_size: usize

Number of parallel streams per block.

§block_len: usize

Target token count per block (rounded down to multiple of batch_size).

§online_loss: OnlineLoss

Supervision loss mode (Code vs Window).

§project_only_targets: bool

Project only supervised positions through head.

§seed: u64

Deterministic PRNG seed.

§dtype: ComputeDType

Activation precision (Fp32 or Bf16).

§autocast_policy: AutocastPolicy

Controls when Bf16 autocast is active.

§device: DeviceChoice

Execution device choice.

§max_tokens: Option<usize>

Optional cap on input tokens during compression.

§raw_bytes: Option<u64>

Original byte length before preprocessing (for bits/byte metrics).

§vocab_bytes: u64

Vocabulary file byte size (for benchmark accounting).

§vocab_file: Option<PathBuf>

Path to vocabulary file required when initial_prior is set.

§initial_prior: Option<PathBuf>

Path to QPI1 quantized prior archive (weights.bin).

§log_interval: usize

Progress logging interval in symbols.

§checkpoint_dir: Option<PathBuf>

Optional directory for durable resumable checkpoints.

§checkpoint_every_blocks: usize

Periodic checkpoint interval in completed blocks.

§stop_after_blocks: Option<usize>

Optional block limit to trigger clean checkpoint & requeue exit (for testing).

§run_dir: Option<PathBuf>

Optional directory where log.txt is appended.

Implementations§

Source§

impl CodecConfig

Source

pub fn v2() -> Self

Returns the exact configuration used to produce and decode tufazip v2.

Source

pub fn tiny(vocab_size: usize) -> Self

Returns a fast, tiny preset suitable for unit/integration tests and quick local runs.

Source

pub fn validate(&self, mode: CodecMode) -> Result<(), CodecError>

Validates all invariants before starting compression or decompression.

§Errors

Returns CodecError::InvalidConfig on invalid settings.

Source

pub fn checkpoint_signature(&self) -> String

Computes a deterministic JSON configuration signature used to reject incompatible resumes.

Source

pub fn effective_compute_dtype(&self, device: &Device) -> DType

Resolves the effective activation DType for device.

Trait Implementations§

Source§

impl Clone for CodecConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CodecConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CodecConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CodecConfig

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for CodecConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CodecConfig

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more