Struct LlamaContextParams

pub struct LlamaContextParams { /* private fields */ }

A safe wrapper around llama_context_params.

Generally this should be created with Default::default() and then modified with with_* methods.

Examples

use llama_cpp_2::context::params::LlamaContextParams;

let ctx_params = LlamaContextParams::default()
   .with_n_ctx(NonZeroU32::new(2048));

assert_eq!(ctx_params.n_ctx(), NonZeroU32::new(2048));

Implementations

impl LlamaContextParams

pub fn with_n_ctx(self, n_ctx: Option<NonZeroU32>) -> Self

Set the side of the context

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default();
let params = params.with_n_ctx(NonZeroU32::new(2048));
assert_eq!(params.n_ctx(), NonZeroU32::new(2048));

pub fn n_ctx(&self) -> Option<NonZeroU32>

Get the size of the context.

None if the context size is specified by the model and not the context.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.n_ctx(), std::num::NonZeroU32::new(512));

pub fn with_n_batch(self, n_batch: u32) -> Self

Set the n_batch

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
    .with_n_batch(2048);
assert_eq!(params.n_batch(), 2048);

pub fn n_batch(&self) -> u32

Get the n_batch

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default();
assert_eq!(params.n_batch(), 2048);

pub fn with_n_ubatch(self, n_ubatch: u32) -> Self

Set the n_ubatch

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
    .with_n_ubatch(512);
assert_eq!(params.n_ubatch(), 512);

pub fn n_ubatch(&self) -> u32

Get the n_ubatch

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default();
assert_eq!(params.n_ubatch(), 512);

pub fn with_flash_attention(self, enabled: bool) -> Self

Set the flash_attention parameter

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
    .with_flash_attention(true);
assert_eq!(params.flash_attention(), true);

pub fn flash_attention(&self) -> bool

Get the flash_attention parameter

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default();
assert_eq!(params.flash_attention(), false);

pub fn with_offload_kqv(self, enabled: bool) -> Self

Set the offload_kqv parameter to control offloading KV cache & KQV ops to GPU

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
    .with_offload_kqv(false);
assert_eq!(params.offload_kqv(), false);

pub fn offload_kqv(&self) -> bool

Get the offload_kqv parameter

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default();
assert_eq!(params.offload_kqv(), true);

pub fn with_rope_scaling_type(self, rope_scaling_type: RopeScalingType) -> Self

Set the type of rope scaling.

Examples

use llama_cpp_2::context::params::{LlamaContextParams, RopeScalingType};
let params = LlamaContextParams::default()
    .with_rope_scaling_type(RopeScalingType::Linear);
assert_eq!(params.rope_scaling_type(), RopeScalingType::Linear);

pub fn rope_scaling_type(&self) -> RopeScalingType

Get the type of rope scaling.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.rope_scaling_type(), llama_cpp_2::context::params::RopeScalingType::Unspecified);

pub fn with_rope_freq_base(self, rope_freq_base: f32) -> Self

Set the rope frequency base.

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
   .with_rope_freq_base(0.5);
assert_eq!(params.rope_freq_base(), 0.5);

pub fn rope_freq_base(&self) -> f32

Get the rope frequency base.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.rope_freq_base(), 0.0);

pub fn with_rope_freq_scale(self, rope_freq_scale: f32) -> Self

Set the rope frequency scale.

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
  .with_rope_freq_scale(0.5);
assert_eq!(params.rope_freq_scale(), 0.5);

pub fn rope_freq_scale(&self) -> f32

Get the rope frequency scale.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.rope_freq_scale(), 0.0);

pub fn n_threads(&self) -> i32

Get the number of threads.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.n_threads(), 4);

pub fn n_threads_batch(&self) -> i32

Get the number of threads allocated for batches.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.n_threads_batch(), 4);

pub fn with_n_threads(self, n_threads: i32) -> Self

Set the number of threads.

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
   .with_n_threads(8);
assert_eq!(params.n_threads(), 8);

pub fn with_n_threads_batch(self, n_threads: i32) -> Self

Set the number of threads allocated for batches.

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
   .with_n_threads_batch(8);
assert_eq!(params.n_threads_batch(), 8);

pub fn embeddings(&self) -> bool

Check whether embeddings are enabled

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert!(!params.embeddings());

pub fn with_embeddings(self, embedding: bool) -> Self

Enable the use of embeddings

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default()
   .with_embeddings(true);
assert!(params.embeddings());

pub fn with_cb_eval(self, cb_eval: ggml_backend_sched_eval_callback) -> Self

Set the evaluation callback.

Examples

extern "C" fn cb_eval_fn(
    t: *mut llama_cpp_sys_2::ggml_tensor,
    ask: bool,
    user_data: *mut std::ffi::c_void,
) -> bool {
    false
}

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default().with_cb_eval(Some(cb_eval_fn));

pub fn with_cb_eval_user_data(self, cb_eval_user_data: *mut c_void) -> Self

Set the evaluation callback user data.

Examples

use llama_cpp_2::context::params::LlamaContextParams;
let params = LlamaContextParams::default();
let user_data = std::ptr::null_mut();
let params = params.with_cb_eval_user_data(user_data);

pub fn with_pooling_type(self, pooling_type: LlamaPoolingType) -> Self

Set the type of pooling.

Examples

use llama_cpp_2::context::params::{LlamaContextParams, LlamaPoolingType};
let params = LlamaContextParams::default()
    .with_pooling_type(LlamaPoolingType::Last);
assert_eq!(params.pooling_type(), LlamaPoolingType::Last);

pub fn pooling_type(&self) -> LlamaPoolingType

Get the type of pooling.

Examples

let params = llama_cpp_2::context::params::LlamaContextParams::default();
assert_eq!(params.pooling_type(), llama_cpp_2::context::params::LlamaPoolingType::Unspecified);

Trait Implementations

impl Clone for LlamaContextParams

fn clone(&self) -> LlamaContextParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LlamaContextParams

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

Formats the value using the given formatter.

impl Default for LlamaContextParams

Default parameters for LlamaContext. (as defined in llama.cpp by llama_context_default_params)

use llama_cpp_2::context::params::{LlamaContextParams, RopeScalingType};
let params = LlamaContextParams::default();
assert_eq!(params.n_ctx(), NonZeroU32::new(512), "n_ctx should be 512");
assert_eq!(params.rope_scaling_type(), RopeScalingType::Unspecified);

fn default() -> Self

Returns the “default value” for a type.

impl Send for LlamaContextParams

SAFETY: we do not currently allow setting or reading the pointers that cause this to not be automatically send or sync.

impl Sync for LlamaContextParams