Skip to main content

QuantizeParams

Struct QuantizeParams 

Source
pub struct QuantizeParams {
    pub nthread: i32,
    pub ftype: LlamaFtype,
    pub output_tensor_type: Option<GgmlType>,
    pub token_embedding_type: Option<GgmlType>,
    pub allow_requantize: bool,
    pub quantize_output_tensor: bool,
    pub only_copy: bool,
    pub pure: bool,
    pub keep_split: bool,
    pub dry_run: bool,
    /* private fields */
}
Expand description

Parameters for quantizing a model.

Create with QuantizeParams::new and chain with_* builder methods to configure, then pass a reference to crate::model_quantize.

§Example

use llama_cpp_4::quantize::{GgmlType, LlamaFtype, QuantizeParams, TensorTypeOverride};

let ov = TensorTypeOverride::new("output", GgmlType::F16).unwrap();

let params = QuantizeParams::new(LlamaFtype::MostlyQ4KM)
    .with_nthread(8)
    .with_allow_requantize(false)
    .with_quantize_output_tensor(true)
    .with_pure(false)
    .with_tensor_type_override(ov);

llama_cpp_4::model_quantize("in.gguf", "out.gguf", &params).unwrap();

Fields§

§nthread: i32

Number of threads (0 = auto-detect).

§ftype: LlamaFtype

Target quantization type.

§output_tensor_type: Option<GgmlType>

Force this storage type for the output/lm-head tensor (None = use ftype default).

§token_embedding_type: Option<GgmlType>

Force this storage type for the token-embedding tensor (None = use ftype default).

§allow_requantize: bool

Allow re-quantizing tensors that are already quantized.

§quantize_output_tensor: bool

Quantize the output/lm-head weight tensor.

§only_copy: bool

Copy all tensors without quantizing (ignores ftype).

§pure: bool

Quantize every tensor to the same type (no mixed k-quant strategy).

§keep_split: bool

Keep the same number of shards as the input (for split models).

§dry_run: bool

Estimate output size without writing anything to disk.

Implementations§

Source§

impl QuantizeParams

Source

pub fn new(ftype: LlamaFtype) -> Self

Create a new params set targeting ftype.

All other options are set to the same defaults as llama_model_quantize_default_params().

Source

pub fn with_nthread(self, n: i32) -> Self

Set the number of quantization threads (0 = auto).

Source

pub fn with_output_tensor_type(self, ty: GgmlType) -> Self

Override the output-tensor storage type.

Source

pub fn with_token_embedding_type(self, ty: GgmlType) -> Self

Override the token-embedding storage type.

Source

pub fn with_allow_requantize(self, v: bool) -> Self

Allow (or disallow) re-quantizing already-quantized tensors.

Source

pub fn with_quantize_output_tensor(self, v: bool) -> Self

Quantize the output/lm-head weight (true by default).

Source

pub fn with_only_copy(self, v: bool) -> Self

When true, only copy tensors verbatim (no quantization at all).

Source

pub fn with_pure(self, v: bool) -> Self

When true, quantize all tensors to the same type (no mixed k-quant strategy).

Source

pub fn with_keep_split(self, v: bool) -> Self

Preserve the number of shards when quantizing a split model.

Source

pub fn with_dry_run(self, v: bool) -> Self

Only estimate the output size; do not write anything to disk.

Source

pub fn with_imatrix(self, imatrix: Imatrix) -> Self

Supply importance matrix data to improve quantization quality.

The imatrix is generated by the imatrix tool (or the imatrix example in this crate) and contains per-tensor activation statistics collected from a calibration dataset.

Source

pub fn with_imatrix_entry(self, entry: ImatrixEntry) -> Self

Append a single imatrix entry.

Source

pub fn with_kv_override(self, kv: KvOverride) -> Self

Add (or replace) a GGUF metadata key-value pair in the output file.

Source

pub fn with_tensor_type_override(self, ov: TensorTypeOverride) -> Self

Override the quantization type for tensors whose name matches pattern.

Can be called multiple times; overrides are applied in order.

Source

pub fn with_pruned_layer(self, layer: i32) -> Self

Mark a layer index for pruning (removal) from the output model.

Source

pub fn with_pruned_layers(self, layers: impl IntoIterator<Item = i32>) -> Self

Mark multiple layer indices for pruning.

Trait Implementations§

Source§

impl Clone for QuantizeParams

Source§

fn clone(&self) -> QuantizeParams

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 QuantizeParams

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> Instrument for T

Source§

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

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

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> 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<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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