Skip to main content

CausalLm

Enum CausalLm 

Source
pub enum CausalLm {
    LlamaFamily(LlamaModel),
    Phi(PhiModel),
    Gemma(GemmaModel),
    Gemma4(Box<Gemma4Model>),
    Opt(Box<OptModel>),
}
Expand description

Unified causal language model supporting all architectures in SamsungLabs/LittleBit plus Gemma 4.

Variants§

§

LlamaFamily(LlamaModel)

Llama, Llama 2/3, Qwen2/2.5/QwQ, and Qwen3.

§

Phi(PhiModel)

Phi-3 and Phi-4 (including PhiQKVSplitAttention).

§

Gemma(GemmaModel)

Gemma 2 and Gemma 3.

§

Gemma4(Box<Gemma4Model>)

Gemma 4 Dense and Mixture-of-Experts.

§

Opt(Box<OptModel>)

Meta OPT.

Implementations§

Source§

impl CausalLm

Source

pub fn from_tensors( config: ModelConfig, tensors: &HashMap<String, Tensor>, littlebit: Option<&LittleBitConfig>, weight_state: WeightState, inference_mode: InferenceMode, dtype: DType, device: &Device, ) -> Result<Self>

Construct a model from a parsed ModelConfig and loaded checkpoint tensors.

§Errors

Returns an error if the architecture is unsupported or required weights are missing.

Source

pub fn new_random( config: ModelConfig, dtype: DType, device: &Device, seed: u64, ) -> Result<Self>

Initialize a compact or full-sized random model for testing and benchmarking.

§Errors

Returns an error if architecture detection or tensor allocation fails.

Source

pub fn forward( &self, input_ids: &Tensor, cache: Option<&mut KvCache>, hidden_mode: HiddenStatesMode, ) -> Result<CausalLmOutput>

Execute causal forward pass over input_ids (batch, seq_len).

§Errors

Returns an error if layer computation fails.

Source

pub fn apply_littlebit_patch( &mut self, lb_cfg: &LittleBitConfig, train_mode: TrainMode, base_seed: u64, ) -> Result<PatchSummary>

Apply LittleBit / LittleBit-2 quantization patch across all linear projections (excluding lm_head, router, splitting qkv_proj on Phi, and scaling k_proj/v_proj by kv_factor).

§Errors

Returns an error if config validation or SVD/ITQ decomposition fails.

Source

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

Convert all LittleBitLinear layers into memory-compact 1-bit PackedLittleBitLinear modules.

§Errors

Returns an error if packing fails.

Source

pub fn prepare_for_training(&mut self, exclude: &[&str]) -> Result<()>

Prepare model parameters for QAT training, making all non-excluded parameters trainable and freezing parameters whose module path contains any pattern in exclude.

Matches upstream utils/utils.py::prepare_model_for_training.

§Errors

Returns an error if wrapping parameters in [Var] fails.

Source

pub fn freeze_matching(&mut self, exclude: &[&str])

Freeze all parameters matching any substring in exclude.

Source

pub fn trainable_vars(&self) -> Vec<Var>

Collect all active trainable [Var] parameters across the model.

Source

pub fn parameter_stats(&self) -> ParameterStats

Compute trainable and total scalar parameter counts.

Source

pub fn pack_state_dict(&self) -> Result<HashMap<String, Tensor>>

Export full model state dictionary with LittleBit layers binarized & 1-bit packed.

§Errors

Returns an error if packing any layer fails.

Source

pub fn config(&self) -> &ModelConfig

Borrow underlying Hugging Face ModelConfig.

Source

pub fn generate( &self, prompt_ids: &[u32], cfg: &GenerateConfig, device: &Device, ) -> Result<Vec<u32>>

Autoregressive text generation using KvCache given initial prompt_ids.

§Errors

Returns an error if prompt_ids is empty or forward/sampling fails.

Trait Implementations§

Source§

impl Clone for CausalLm

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 CausalLm

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
§

impl<T> ByRef<T> for T

§

fn by_ref(&self) -> &T

§

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
§

impl<T> DropFlavorWrapper<T> for T

§

type Flavor = MayDrop

The DropFlavor that [wrap]s T into Self
§

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, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

§

const WITNESS: W = W::MAKE

A constant of the type witness
§

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

§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

§

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> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

§

impl<E> ResultError for E
where E: Send + Debug + Sync,

§

impl<T> ResultType for T
where T: Send + Clone + Sync + Debug,

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