Module: LlamaCpp

Defined in:
lib/llama_cpp.rb,
lib/llama_cpp/version.rb,
ext/llama_cpp/llama_cpp.c

Overview

llama_cpp.rb provides Ruby bindings for the llama.cpp.

Defined Under Namespace

Classes: LlamaAdapterLora, LlamaBatch, LlamaChatMessage, LlamaContext, LlamaContextParams, LlamaLogitBias, LlamaMemoryT, LlamaModel, LlamaModelImatrixData, LlamaModelKvOverride, LlamaModelParams, LlamaModelQuantizeParams, LlamaModelTensorBuftOverride, LlamaModelTensorOverride, LlamaPerfContextData, LlamaPerfSamplerData, LlamaSampler, LlamaSamplerChainParams, LlamaTokenData, LlamaTokenDataArray, LlamaVocab

Constant Summary collapse

VERSION =

The version of llama_cpp.rb you install.

'0.25.7'
LLAMA_CPP_VERSION =

The supported version of llama.cpp.

'b9950'
LLAMA_DEFAULT_SEED = 
rb_str_new2(tmp)
LLAMA_TOKEN_NULL = 
INT2NUM(LLAMA_TOKEN_NULL)
LLAMA_STATE_SEQ_FLAGS_NONE = 
INT2NUM(LLAMA_STATE_SEQ_FLAGS_NONE)
LLAMA_STATE_SEQ_FLAGS_SWA_ONLY = 
INT2NUM(LLAMA_STATE_SEQ_FLAGS_SWA_ONLY)
LLAMA_STATE_SEQ_FLAGS_PARTIAL_ONLY = 
INT2NUM(LLAMA_STATE_SEQ_FLAGS_PARTIAL_ONLY)
LLAMA_STATE_SEQ_FLAGS_ON_DEVICE = 
INT2NUM(LLAMA_STATE_SEQ_FLAGS_ON_DEVICE)
LLAMA_FILE_MAGIC_GGLA = 
rb_str_new2(tmp)
LLAMA_FILE_MAGIC_GGSN = 
rb_str_new2(tmp)
LLAMA_FILE_MAGIC_GGSQ = 
rb_str_new2(tmp)
LLAMA_SESSION_MAGIC = 
rb_str_new2(tmp)
LLAMA_SESSION_VERSION = 
INT2NUM(LLAMA_SESSION_VERSION)
LLAMA_STATE_SEQ_MAGIC = 
rb_str_new2(tmp)
LLAMA_STATE_SEQ_VERSION = 
INT2NUM(LLAMA_STATE_SEQ_VERSION)
LLAMA_VOCAB_TYPE_NONE = 
INT2NUM(LLAMA_VOCAB_TYPE_NONE)
LLAMA_VOCAB_TYPE_SPM = 
INT2NUM(LLAMA_VOCAB_TYPE_SPM)
LLAMA_VOCAB_TYPE_BPE = 
INT2NUM(LLAMA_VOCAB_TYPE_BPE)
LLAMA_VOCAB_TYPE_WPM = 
INT2NUM(LLAMA_VOCAB_TYPE_WPM)
LLAMA_VOCAB_TYPE_UGM = 
INT2NUM(LLAMA_VOCAB_TYPE_UGM)
LLAMA_VOCAB_TYPE_RWKV = 
INT2NUM(LLAMA_VOCAB_TYPE_RWKV)
LLAMA_VOCAB_TYPE_PLAMO2 = 
INT2NUM(LLAMA_VOCAB_TYPE_PLAMO2)
LLAMA_ROPE_TYPE_NONE = 
INT2NUM(LLAMA_ROPE_TYPE_NONE)
LLAMA_ROPE_TYPE_NORM = 
INT2NUM(LLAMA_ROPE_TYPE_NORM)
LLAMA_ROPE_TYPE_NEOX = 
INT2NUM(LLAMA_ROPE_TYPE_NEOX)
LLAMA_ROPE_TYPE_MROPE = 
INT2NUM(LLAMA_ROPE_TYPE_MROPE)
LLAMA_ROPE_TYPE_IMROPE = 
INT2NUM(LLAMA_ROPE_TYPE_IMROPE)
LLAMA_ROPE_TYPE_VISION = 
INT2NUM(LLAMA_ROPE_TYPE_VISION)
LLAMA_TOKEN_TYPE_UNDEFINED = 
INT2NUM(LLAMA_TOKEN_TYPE_UNDEFINED)
LLAMA_TOKEN_TYPE_NORMAL = 
INT2NUM(LLAMA_TOKEN_TYPE_NORMAL)
LLAMA_TOKEN_TYPE_UNKNOWN = 
INT2NUM(LLAMA_TOKEN_TYPE_UNKNOWN)
LLAMA_TOKEN_TYPE_CONTROL = 
INT2NUM(LLAMA_TOKEN_TYPE_CONTROL)
LLAMA_TOKEN_TYPE_USER_DEFINED = 
INT2NUM(LLAMA_TOKEN_TYPE_USER_DEFINED)
LLAMA_TOKEN_TYPE_UNUSED = 
INT2NUM(LLAMA_TOKEN_TYPE_UNUSED)
LLAMA_TOKEN_TYPE_BYTE = 
INT2NUM(LLAMA_TOKEN_TYPE_BYTE)
LLAMA_TOKEN_ATTR_UNDEFINED = 
INT2NUM(LLAMA_TOKEN_ATTR_UNDEFINED)
LLAMA_TOKEN_ATTR_UNKNOWN = 
INT2NUM(LLAMA_TOKEN_ATTR_UNKNOWN)
LLAMA_TOKEN_ATTR_UNUSED = 
INT2NUM(LLAMA_TOKEN_ATTR_UNUSED)
LLAMA_TOKEN_ATTR_NORMAL = 
INT2NUM(LLAMA_TOKEN_ATTR_NORMAL)
LLAMA_TOKEN_ATTR_CONTROL = 
INT2NUM(LLAMA_TOKEN_ATTR_CONTROL)
LLAMA_TOKEN_ATTR_USER_DEFINED = 
INT2NUM(LLAMA_TOKEN_ATTR_USER_DEFINED)
LLAMA_TOKEN_ATTR_BYTE = 
INT2NUM(LLAMA_TOKEN_ATTR_BYTE)
LLAMA_TOKEN_ATTR_NORMALIZED = 
INT2NUM(LLAMA_TOKEN_ATTR_NORMALIZED)
LLAMA_TOKEN_ATTR_LSTRIP = 
INT2NUM(LLAMA_TOKEN_ATTR_LSTRIP)
LLAMA_TOKEN_ATTR_RSTRIP = 
INT2NUM(LLAMA_TOKEN_ATTR_RSTRIP)
LLAMA_TOKEN_ATTR_SINGLE_WORD = 
INT2NUM(LLAMA_TOKEN_ATTR_SINGLE_WORD)
LLAMA_FTYPE_ALL_F32 = 
INT2NUM(LLAMA_FTYPE_ALL_F32)
LLAMA_FTYPE_MOSTLY_F16 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_F16)
LLAMA_FTYPE_MOSTLY_Q4_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q4_0)
LLAMA_FTYPE_MOSTLY_Q4_1 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q4_1)
LLAMA_FTYPE_MOSTLY_Q8_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q8_0)
LLAMA_FTYPE_MOSTLY_Q5_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q5_0)
LLAMA_FTYPE_MOSTLY_Q5_1 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q5_1)
LLAMA_FTYPE_MOSTLY_Q2_K = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q2_K)
LLAMA_FTYPE_MOSTLY_Q3_K_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q3_K_S)
LLAMA_FTYPE_MOSTLY_Q3_K_M = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q3_K_M)
LLAMA_FTYPE_MOSTLY_Q3_K_L = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q3_K_L)
LLAMA_FTYPE_MOSTLY_Q4_K_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q4_K_S)
LLAMA_FTYPE_MOSTLY_Q4_K_M = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q4_K_M)
LLAMA_FTYPE_MOSTLY_Q5_K_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q5_K_S)
LLAMA_FTYPE_MOSTLY_Q5_K_M = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q5_K_M)
LLAMA_FTYPE_MOSTLY_Q6_K = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q6_K)
LLAMA_FTYPE_MOSTLY_IQ2_XXS = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ2_XXS)
LLAMA_FTYPE_MOSTLY_IQ2_XS = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ2_XS)
LLAMA_FTYPE_MOSTLY_Q2_K_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q2_K_S)
LLAMA_FTYPE_MOSTLY_IQ3_XS = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ3_XS)
LLAMA_FTYPE_MOSTLY_IQ3_XXS = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ3_XXS)
LLAMA_FTYPE_MOSTLY_IQ1_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ1_S)
LLAMA_FTYPE_MOSTLY_IQ4_NL = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ4_NL)
LLAMA_FTYPE_MOSTLY_IQ3_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ3_S)
LLAMA_FTYPE_MOSTLY_IQ3_M = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ3_M)
LLAMA_FTYPE_MOSTLY_IQ2_S = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ2_S)
LLAMA_FTYPE_MOSTLY_IQ2_M = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ2_M)
LLAMA_FTYPE_MOSTLY_IQ4_XS = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ4_XS)
LLAMA_FTYPE_MOSTLY_IQ1_M = 
INT2NUM(LLAMA_FTYPE_MOSTLY_IQ1_M)
LLAMA_FTYPE_MOSTLY_BF16 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_BF16)
LLAMA_FTYPE_MOSTLY_TQ1_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_TQ1_0)
LLAMA_FTYPE_MOSTLY_TQ2_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_TQ2_0)
LLAMA_FTYPE_MOSTLY_MXFP4_MOE = 
INT2NUM(LLAMA_FTYPE_MOSTLY_MXFP4_MOE)
LLAMA_FTYPE_MOSTLY_NVFP4 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_NVFP4)
LLAMA_FTYPE_MOSTLY_Q1_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q1_0)
LLAMA_FTYPE_MOSTLY_Q2_0 = 
INT2NUM(LLAMA_FTYPE_MOSTLY_Q2_0)
LLAMA_FTYPE_GUESSED = 
INT2NUM(LLAMA_FTYPE_GUESSED)
LLAMA_ROPE_SCALING_TYPE_UNSPECIFIED = 
INT2NUM(LLAMA_ROPE_SCALING_TYPE_UNSPECIFIED)
LLAMA_ROPE_SCALING_TYPE_NONE = 
INT2NUM(LLAMA_ROPE_SCALING_TYPE_NONE)
LLAMA_ROPE_SCALING_TYPE_LINEAR = 
INT2NUM(LLAMA_ROPE_SCALING_TYPE_LINEAR)
LLAMA_ROPE_SCALING_TYPE_YARN = 
INT2NUM(LLAMA_ROPE_SCALING_TYPE_YARN)
LLAMA_ROPE_SCALING_TYPE_LONGROPE = 
INT2NUM(LLAMA_ROPE_SCALING_TYPE_LONGROPE)
LLAMA_ROPE_SCALING_TYPE_MAX_VALUE = 
INT2NUM(LLAMA_ROPE_SCALING_TYPE_MAX_VALUE)
LLAMA_POOLING_TYPE_UNSPECIFIED = 
INT2NUM(LLAMA_POOLING_TYPE_UNSPECIFIED)
LLAMA_POOLING_TYPE_NONE = 
INT2NUM(LLAMA_POOLING_TYPE_NONE)
LLAMA_POOLING_TYPE_MEAN = 
INT2NUM(LLAMA_POOLING_TYPE_MEAN)
LLAMA_POOLING_TYPE_CLS = 
INT2NUM(LLAMA_POOLING_TYPE_CLS)
LLAMA_POOLING_TYPE_LAST = 
INT2NUM(LLAMA_POOLING_TYPE_LAST)
LLAMA_POOLING_TYPE_RANK = 
INT2NUM(LLAMA_POOLING_TYPE_RANK)
LLAMA_ATTENTION_TYPE_UNSPECIFIED = 
INT2NUM(LLAMA_ATTENTION_TYPE_UNSPECIFIED)
LLAMA_ATTENTION_TYPE_CAUSAL = 
INT2NUM(LLAMA_ATTENTION_TYPE_CAUSAL)
LLAMA_ATTENTION_TYPE_NON_CAUSAL = 
INT2NUM(LLAMA_ATTENTION_TYPE_NON_CAUSAL)
LLAMA_FLASH_ATTN_TYPE_AUTO = 
INT2NUM(LLAMA_FLASH_ATTN_TYPE_AUTO)
LLAMA_FLASH_ATTN_TYPE_DISABLED = 
INT2NUM(LLAMA_FLASH_ATTN_TYPE_DISABLED)
LLAMA_FLASH_ATTN_TYPE_ENABLED = 
INT2NUM(LLAMA_FLASH_ATTN_TYPE_ENABLED)
LLAMA_SPLIT_MODE_NONE = 
INT2NUM(LLAMA_SPLIT_MODE_NONE)
LLAMA_SPLIT_MODE_LAYER = 
INT2NUM(LLAMA_SPLIT_MODE_LAYER)
LLAMA_SPLIT_MODE_ROW = 
INT2NUM(LLAMA_SPLIT_MODE_ROW)
LLAMA_SPLIT_MODE_TENSOR = 
INT2NUM(LLAMA_SPLIT_MODE_TENSOR)
LLAMA_CONTEXT_TYPE_DEFAULT = 
INT2NUM(LLAMA_CONTEXT_TYPE_DEFAULT)
LLAMA_CONTEXT_TYPE_MTP = 
INT2NUM(LLAMA_CONTEXT_TYPE_MTP)
LLAMA_KV_OVERRIDE_TYPE_INT = 
INT2NUM(LLAMA_KV_OVERRIDE_TYPE_INT)
LLAMA_KV_OVERRIDE_TYPE_FLOAT = 
INT2NUM(LLAMA_KV_OVERRIDE_TYPE_FLOAT)
LLAMA_KV_OVERRIDE_TYPE_BOOL = 
INT2NUM(LLAMA_KV_OVERRIDE_TYPE_BOOL)
LLAMA_KV_OVERRIDE_TYPE_STR = 
INT2NUM(LLAMA_KV_OVERRIDE_TYPE_STR)
LLAMA_MODEL_META_KEY_SAMPLING_SEQUENCE = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_SEQUENCE)
LLAMA_MODEL_META_KEY_SAMPLING_TOP_K = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_TOP_K)
LLAMA_MODEL_META_KEY_SAMPLING_TOP_P = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_TOP_P)
LLAMA_MODEL_META_KEY_SAMPLING_MIN_P = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_MIN_P)
LLAMA_MODEL_META_KEY_SAMPLING_XTC_PROBABILITY = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_XTC_PROBABILITY)
LLAMA_MODEL_META_KEY_SAMPLING_XTC_THRESHOLD = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_XTC_THRESHOLD)
LLAMA_MODEL_META_KEY_SAMPLING_TEMP = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_TEMP)
LLAMA_MODEL_META_KEY_SAMPLING_PENALTY_LAST_N = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_PENALTY_LAST_N)
LLAMA_MODEL_META_KEY_SAMPLING_PENALTY_REPEAT = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_PENALTY_REPEAT)
LLAMA_MODEL_META_KEY_SAMPLING_MIROSTAT = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_MIROSTAT)
LLAMA_MODEL_META_KEY_SAMPLING_MIROSTAT_TAU = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_MIROSTAT_TAU)
LLAMA_MODEL_META_KEY_SAMPLING_MIROSTAT_ETA = 
INT2NUM(LLAMA_MODEL_META_KEY_SAMPLING_MIROSTAT_ETA)

Class Method Summary collapse

Class Method Details

.generate(context, prompt, n_predict: 128) ⇒ String

Generates sentences following the given prompt for operation check.

Parameters:

  • context (LlamaCpp::LlamaContext) —

    The context to use.

  • prompt (String) —

    The prompt to start generation with.

  • n_predict (Integer) (defaults to: 128) —

    The number of tokens to predict.

Returns:

  • (String)

Raises:

  • (ArgumentError) 


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/llama_cpp.rb', line 18

def generate(context, prompt, n_predict: 128) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  raise ArgumentError, 'context must be a LlamaContext' unless context.is_a?(LlamaCpp::LlamaContext)
  raise ArgumentError, 'prompt must be a String' unless prompt.is_a?(String)

  model = LlamaCpp.llama_get_model(context)
  vocab = LlamaCpp.llama_model_get_vocab(model)

  n_prompt = -LlamaCpp.llama_tokenize(vocab, prompt, [], 0, true, true)

  prompt_tokens = []
  raise 'Failed to tokenize the prompt' if LlamaCpp.llama_tokenize(vocab, prompt, prompt_tokens, n_prompt, true,
                                                                   true).negative?

  ctx_params = LlamaCpp::LlamaContextParams.new
  ctx_params.n_ctx = n_prompt + n_predict - 1
  ctx_params.n_batch = n_prompt
  ctx_params.no_perf = false

  ctx = LlamaCpp.llama_init_from_model(model, ctx_params)

  sparams = LlamaCpp::LlamaSamplerChainParams.new
  sparams.no_perf = false
  smpl = LlamaCpp.llama_sampler_chain_init(sparams)
  LlamaCpp.llama_sampler_chain_add(smpl, LlamaCpp.llama_sampler_init_greedy)

  batch = LlamaCpp.llama_batch_get_one(prompt_tokens)

  n_pos = 0
  output = []
  while n_pos + batch.n_tokens < n_prompt + n_predict
    break if LlamaCpp.llama_decode(ctx, batch) != 0

    n_pos += batch.n_tokens

    new_token_id = LlamaCpp.llama_sampler_sample(smpl, ctx, -1)
    break if llama_vocab_is_eog?(vocab, new_token_id)

    buf = llama_token_to_piece(vocab, new_token_id, 0, true)
    output << buf

    batch = LlamaCpp.llama_batch_get_one([new_token_id])
  end

  output.join
end

.ggml_backend_load_all ⇒ NilClass

Returns:

  • (NilClass) 


27
28
29
30
 
# File 'ext/llama_cpp/llama_cpp.c', line 27

static VALUE rb_ggml_backend_load_all(VALUE self) {
  ggml_backend_load_all();
  return Qnil;
}

.llama_adapter_get_alora_n_invocation_tokens(adapter) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2378
2379
2380
2381
2382
2383
2384
2385
 
# File 'ext/llama_cpp/llama_cpp.c', line 2378

static VALUE rb_llama_adapter_get_alora_n_invocation_tokens(VALUE self, VALUE adapter) {
  if (!rb_obj_is_kind_of(adapter, rb_cLlamaAdapterLora)) {
    rb_raise(rb_eArgError, "adapter must be a LlamaAdapterLora");
    return Qnil;
  }
  llama_adapter_lora_wrapper* adapter_wrapper = get_llama_adapter_lora_wrapper(adapter);
  return ULONG2NUM(llama_adapter_get_alora_n_invocation_tokens(adapter_wrapper->adapter));
}

.llama_adapter_lora_free(adapter) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
 
# File 'ext/llama_cpp/llama_cpp.c', line 2359

static VALUE rb_llama_adapter_lora_free(VALUE self, VALUE adapter) {
  if (!rb_obj_is_kind_of(adapter, rb_cLlamaAdapterLora)) {
    rb_raise(rb_eArgError, "adapter must be a LlamaAdapterLora");
    return Qnil;
  }
  llama_adapter_lora_wrapper* adapter_wrapper = get_llama_adapter_lora_wrapper(adapter);
  if (adapter_wrapper->adapter != NULL) {
    llama_adapter_lora_free(adapter_wrapper->adapter);
    adapter_wrapper->adapter = NULL;
  }
  RB_GC_GUARD(adapter);
  return Qnil;
}

.llama_adapter_lora_init(model, path_lora) ⇒ LlamaAdapterLora

Parameters:

Returns:



2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
 
# File 'ext/llama_cpp/llama_cpp.c', line 2263

static VALUE rb_llama_adapter_lora_init(VALUE self, VALUE model, VALUE path_lora) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!RB_TYPE_P(path_lora, T_STRING)) {
    rb_raise(rb_eArgError, "path_lora must be a String");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  const char* path_lora_ = StringValueCStr(path_lora);
  llama_adapter_lora_wrapper* adapter_wrapper = (llama_adapter_lora_wrapper*)ruby_xmalloc(sizeof(llama_adapter_lora_wrapper));
  adapter_wrapper->adapter = llama_adapter_lora_init(model_wrapper->model, path_lora_);
  RB_GC_GUARD(model);
  RB_GC_GUARD(path_lora);
  return TypedData_Wrap_Struct(rb_cLlamaAdapterLora, &llama_adapter_lora_wrapper_data_type, adapter_wrapper);
}

.llama_adapter_meta_count(adapter) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'ext/llama_cpp/llama_cpp.c', line 2286

static VALUE rb_llama_adapter_meta_count(VALUE self, VALUE adapter) {
  if (!rb_obj_is_kind_of(adapter, rb_cLlamaAdapterLora)) {
    rb_raise(rb_eArgError, "adapter must be a LlamaAdapterLora");
    return Qnil;
  }
  llama_adapter_lora_wrapper* adapter_wrapper = get_llama_adapter_lora_wrapper(adapter);
  return INT2NUM(llama_adapter_meta_count(adapter_wrapper->adapter));
}

.llama_backend_free ⇒ NilClass

Returns:

  • (NilClass) 


1345
1346
1347
1348
 
# File 'ext/llama_cpp/llama_cpp.c', line 1345

static VALUE rb_llama_backend_free(VALUE self) {
  llama_backend_free();
  return Qnil;
}

.llama_backend_init ⇒ NilClass

Returns:

  • (NilClass) 


1336
1337
1338
1339
 
# File 'ext/llama_cpp/llama_cpp.c', line 1336

static VALUE rb_llama_backend_init(VALUE self) {
  llama_backend_init();
  return Qnil;
}

.llama_batch_free(batch) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
 
# File 'ext/llama_cpp/llama_cpp.c', line 2743

static VALUE rb_llama_batch_free(VALUE self, VALUE batch) {
  if (!rb_obj_is_kind_of(batch, rb_cLlamaBatch)) {
    rb_raise(rb_eArgError, "batch must be a LlamaBatch");
    return Qnil;
  }
  llama_batch* batch_ = get_llama_batch(batch);
  llama_batch_free(*batch_);
  batch_ = NULL;
  RB_GC_GUARD(batch);
  return Qnil;
}

.llama_batch_get_one(tokens) ⇒ LlamaBatch

Parameters:

  • tokens (Array<Integer>)

Returns:



2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
 
# File 'ext/llama_cpp/llama_cpp.c', line 2688

static VALUE rb_llama_batch_get_one(VALUE self, VALUE tokens) {
  if (!RB_TYPE_P(tokens, T_ARRAY)) {
    rb_raise(rb_eArgError, "tokens must be an Array");
    return Qnil;
  }
  const size_t n_tokens = RARRAY_LEN(tokens);
  if (n_tokens == 0) {
    return Qnil;
  }
  llama_token* tokens_ = (llama_token*)ruby_xmalloc(sizeof(llama_token) * n_tokens);
  for (size_t i = 0; i < n_tokens; i++) {
    VALUE token = rb_ary_entry(tokens, i);
    if (!RB_INTEGER_TYPE_P(token)) {
      ruby_xfree(tokens_);
      rb_raise(rb_eArgError, "tokens must be an Array of Integers");
      return Qnil;
    }
    tokens_[i] = NUM2INT(token);
  }
  llama_batch* batch = (llama_batch*)ruby_xmalloc(sizeof(llama_batch));
  *batch = llama_batch_get_one(NULL, (int32_t)n_tokens);
  batch->token = tokens_;
  return TypedData_Wrap_Struct(rb_cLlamaBatch, &llama_batch_type, batch);
}

.llama_batch_init(n_tokens, embd, n_seq_max) ⇒ LlamaBatch

Parameters:

  • n_tokens (Integer)
  • embd (Integer)
  • n_seq_max (Integer)

Returns:



2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
 
# File 'ext/llama_cpp/llama_cpp.c', line 2720

static VALUE rb_llama_batch_init(VALUE self, VALUE n_tokens, VALUE embd, VALUE n_seq_max) {
  if (!RB_INTEGER_TYPE_P(n_tokens)) {
    rb_raise(rb_eArgError, "n_tokens must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(embd)) {
    rb_raise(rb_eArgError, "embd must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(n_seq_max)) {
    rb_raise(rb_eArgError, "n_seq_max must be an Integer");
    return Qnil;
  }
  llama_batch* batch = (llama_batch*)ruby_xmalloc(sizeof(llama_batch));
  *batch = llama_batch_init(NUM2INT(n_tokens), NUM2INT(embd), NUM2INT(n_seq_max));
  return TypedData_Wrap_Struct(rb_cLlamaBatch, &llama_batch_type, batch);
}

.llama_decode(context, batch) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
 
# File 'ext/llama_cpp/llama_cpp.c', line 2784

static VALUE rb_llama_decode(VALUE self, VALUE ctx, VALUE batch) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(batch, rb_cLlamaBatch)) {
    rb_raise(rb_eArgError, "batch must be a LlamaBatch");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  llama_batch* batch_ = get_llama_batch(batch);
  const int32_t res = llama_decode(context_wrapper->context, *batch_);
  RB_GC_GUARD(ctx);
  RB_GC_GUARD(batch);
  return INT2NUM(res);
}

.llama_detokenize(vocab, tokens, remove_special, unparse_special) ⇒ String

Parameters:

  • vocab (LlamaVocab)
  • tokens (Array<Integer>)
  • remove_special (Boolean)
  • unparse_special (Boolean)

Returns:

  • (String) 


3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
 
# File 'ext/llama_cpp/llama_cpp.c', line 3415

static VALUE rb_llama_detokenize(VALUE self, VALUE vocab, VALUE tokens, VALUE remove_special, VALUE unparse_special) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_TYPE_P(tokens, T_ARRAY)) {
    rb_raise(rb_eArgError, "tokens must be an Array");
    return Qnil;
  }

  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t n_tokens = (int32_t)RARRAY_LEN(tokens);
  if (n_tokens == 0) {
    return Qnil;
  }
  llama_token* tokens_ = (llama_token*)ruby_xmalloc(sizeof(llama_token) * n_tokens);
  for (int32_t i = 0; i < n_tokens; i++) {
    tokens_[i] = NUM2INT(rb_ary_entry(tokens, i));
  }
  const int32_t text_len_max = n_tokens > 1024 ? n_tokens : 1024;
  char* text = (char*)ruby_xmalloc(sizeof(char) * text_len_max);
  const bool remove_special_ = RTEST(remove_special) ? true : false;
  const bool unparse_special_ = RTEST(unparse_special) ? true : false;

  int32_t n_chars = llama_detokenize(vocab_wrapper->vocab, tokens_, n_tokens, text, text_len_max, remove_special_, unparse_special_);

  if (n_chars < 0) {
    ruby_xfree(text);
    text = (char*)ruby_xmalloc(sizeof(char) * -n_chars);
    n_chars = llama_detokenize(vocab_wrapper->vocab, tokens_, n_tokens, text, -n_chars, remove_special_, unparse_special_);
    if (n_chars <= (int32_t)strlen(text)) {
      ruby_xfree(tokens_);
      ruby_xfree(text);
      rb_raise(rb_eRuntimeError, "Failed to detokenize");
      return Qnil;
    }
  }

  VALUE ret = rb_utf8_str_new_cstr(text);
  ruby_xfree(tokens_);
  ruby_xfree(text);
  RB_GC_GUARD(vocab);

  return ret;
}

.llama_encode(context, batch) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
 
# File 'ext/llama_cpp/llama_cpp.c', line 2761

static VALUE rb_llama_encode(VALUE self, VALUE ctx, VALUE batch) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(batch, rb_cLlamaBatch)) {
    rb_raise(rb_eArgError, "batch must be a LlamaBatch");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  llama_batch* batch_ = get_llama_batch(batch);
  const int32_t res = llama_encode(context_wrapper->context, *batch_);
  RB_GC_GUARD(ctx);
  RB_GC_GUARD(batch);
  return INT2NUM(res);
}

.llama_flash_attn_type_name(flash_attn_type) ⇒ String

Parameters:

  • flash_attn_type (Integer)

Returns:

  • (String) 


4350
4351
4352
4353
4354
4355
4356
4357
 
# File 'ext/llama_cpp/llama_cpp.c', line 4350

static VALUE rb_llama_flash_attn_type_name(VALUE self, VALUE flash_attn_type) {
  if (!RB_INTEGER_TYPE_P(flash_attn_type)) {
    rb_raise(rb_eArgError, "flash_attn_type must be an Integer");
    return Qnil;
  }
  const char* name = llama_flash_attn_type_name((enum llama_flash_attn_type)NUM2INT(flash_attn_type));
  return rb_utf8_str_new_cstr(name);
}

.llama_free(context) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
 
# File 'ext/llama_cpp/llama_cpp.c', line 1491

static VALUE rb_llama_free(VALUE self, VALUE context) {
  if (!rb_obj_is_kind_of(context, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "context must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(context);
  if (context_wrapper->context != NULL) {
    llama_free(context_wrapper->context);
    context_wrapper->context = NULL;
  }
  return Qnil;
}

.llama_ftype_name(ftype) ⇒ String

Parameters:

  • ftype (Integer)

Returns:

  • (String) 


4336
4337
4338
4339
4340
4341
4342
4343
 
# File 'ext/llama_cpp/llama_cpp.c', line 4336

static VALUE rb_llama_ftype_name(VALUE self, VALUE ftype) {
  if (!RB_INTEGER_TYPE_P(ftype)) {
    rb_raise(rb_eArgError, "ftype must be an Integer");
    return Qnil;
  }
  const char* name = llama_ftype_name((enum llama_ftype)NUM2INT(ftype));
  return rb_utf8_str_new_cstr(name);
}

.llama_get_memory(context) ⇒ LlamaMemoryT

Parameters:

Returns:



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
 
# File 'ext/llama_cpp/llama_cpp.c', line 2607

static VALUE rb_llama_get_memory(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  llama_memory_t memory = llama_get_memory(context_wrapper->context);
  llama_memory_t_wrapper* memory_wrapper = (llama_memory_t_wrapper*)ruby_xmalloc(sizeof(llama_memory_t_wrapper));
  memory_wrapper->memory = memory;
  RB_GC_GUARD(ctx);
  return TypedData_Wrap_Struct(rb_cLlamaMemoryT, &llama_memory_t_wrapper_data_type, memory_wrapper);
}

.llama_get_model(context) ⇒ LlamaModel

Parameters:

Returns:



1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
 
# File 'ext/llama_cpp/llama_cpp.c', line 1657

static VALUE rb_llama_get_model(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a Context");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  llama_model_wrapper* model_wrapper = (llama_model_wrapper*)ruby_xmalloc(sizeof(llama_model_wrapper));
  model_wrapper->model = (struct llama_model*)llama_get_model(context_wrapper->context);
  model_wrapper->copied = true;
  RB_GC_GUARD(ctx);
  return TypedData_Wrap_Struct(rb_cLlamaModel, &llama_model_wrapper_data_type, model_wrapper);
}

.llama_init_from_model(model, params) ⇒ LlamaContext

Parameters:

Returns:



1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'ext/llama_cpp/llama_cpp.c', line 1468

static VALUE rb_llama_init_from_model(VALUE self, VALUE model, VALUE params) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(params, rb_cLlamaContextParams)) {
    rb_raise(rb_eArgError, "params must be a LlamaContextParams");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  struct llama_context_params* params_ = get_llama_context_params(params);
  llama_context_wrapper* context_wrapper = (llama_context_wrapper*)ruby_xmalloc(sizeof(llama_context_wrapper));
  context_wrapper->context = llama_init_from_model(model_wrapper->model, *params_);
  RB_GC_GUARD(model);
  RB_GC_GUARD(params);
  return TypedData_Wrap_Struct(rb_cLlamaContext, &llama_context_wrapper_data_type, context_wrapper);
}

.llama_max_devices ⇒ Integer

Returns:

  • (Integer) 


1516
1517
1518
 
# File 'ext/llama_cpp/llama_cpp.c', line 1516

static VALUE rb_llama_max_devices(VALUE self) {
  return SIZET2NUM(llama_max_devices());
}

.llama_max_parallel_sequences ⇒ Integer

Returns:

  • (Integer) 


1524
1525
1526
 
# File 'ext/llama_cpp/llama_cpp.c', line 1524

static VALUE rb_llama_max_parallel_sequences(VALUE self) {
  return SIZET2NUM(llama_max_parallel_sequences());
}

.llama_max_tensor_buft_overrides ⇒ Integer

Returns:

  • (Integer) 


1532
1533
1534
 
# File 'ext/llama_cpp/llama_cpp.c', line 1532

static VALUE rb_llama_max_tensor_buft_overrides(VALUE self) {
  return SIZET2NUM(llama_max_tensor_buft_overrides());
}

.llama_memory_can_shift?(memory) ⇒ Boolean

llama_memory_can_shift

Returns:

  • (Boolean) 


2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
 
# File 'ext/llama_cpp/llama_cpp.c', line 2591

static VALUE rb_llama_memory_can_shift(VALUE self, VALUE memory) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  const bool can_shift = llama_memory_can_shift(memory_wrapper->memory);
  RB_GC_GUARD(memory);
  return can_shift ? Qtrue : Qfalse;
}

.llama_memory_clear(memory, data) ⇒ Object

llama_memory_clear



2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
 
# File 'ext/llama_cpp/llama_cpp.c', line 2431

static VALUE rb_llama_memory_clear(VALUE self, VALUE memory, VALUE data) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_memory_clear(memory_wrapper->memory, RTEST(data) ? true : false);
  RB_GC_GUARD(memory);
  return Qnil;
}

.llama_memory_seq_add(memory, seq_id, p0, p1, delta) ⇒ Object

llama_memory_seq_add



2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
 
# File 'ext/llama_cpp/llama_cpp.c', line 2507

static VALUE rb_llama_memory_seq_add(VALUE self, VALUE memory, VALUE seq_id, VALUE p0, VALUE p1, VALUE delta) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p0)) {
    rb_raise(rb_eArgError, "p0 must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p1)) {
    rb_raise(rb_eArgError, "p1 must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(delta)) {
    rb_raise(rb_eArgError, "delta must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_memory_seq_add(memory_wrapper->memory, NUM2INT(seq_id), NUM2INT(p0), NUM2INT(p1), NUM2INT(delta));
  RB_GC_GUARD(memory);
  return Qnil;
}

.llama_memory_seq_cp(memory, seq_id_src, seq_id_dst, p0, p1) ⇒ Object

llama_memory_seq_cp



2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'ext/llama_cpp/llama_cpp.c', line 2465

static VALUE rb_llama_memory_seq_cp(VALUE self, VALUE memory, VALUE seq_id_src, VALUE seq_id_dst, VALUE p0, VALUE p1) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id_src)) {
    rb_raise(rb_eArgError, "seq_id_src must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id_dst)) {
    rb_raise(rb_eArgError, "seq_id_dst must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p0)) {
    rb_raise(rb_eArgError, "p0 must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p1)) {
    rb_raise(rb_eArgError, "p1 must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_memory_seq_cp(memory_wrapper->memory, NUM2INT(seq_id_src), NUM2INT(seq_id_dst), NUM2INT(p0), NUM2INT(p1));
  RB_GC_GUARD(memory);
  return Qnil;
}

.llama_memory_seq_div(memory, seq_id, p0, p1, d) ⇒ Object

llama_memory_seq_div



2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
 
# File 'ext/llama_cpp/llama_cpp.c', line 2534

static VALUE rb_llama_memory_seq_div(VALUE self, VALUE memory, VALUE seq_id, VALUE p0, VALUE p1, VALUE d) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p0)) {
    rb_raise(rb_eArgError, "p0 must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p1)) {
    rb_raise(rb_eArgError, "p1 must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(d)) {
    rb_raise(rb_eArgError, "d must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_memory_seq_div(memory_wrapper->memory, NUM2INT(seq_id), NUM2INT(p0), NUM2INT(p1), NUM2INT(d));
  RB_GC_GUARD(memory);
  return Qnil;
}

.llama_memory_seq_keep(memory, seq_id) ⇒ Object

llama_memory_seq_keep



2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'ext/llama_cpp/llama_cpp.c', line 2492

static VALUE rb_llama_memory_seq_keep(VALUE self, VALUE memory, VALUE seq_id) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_memory_seq_keep(memory_wrapper->memory, NUM2INT(seq_id));
  RB_GC_GUARD(memory);
  return Qnil;
}

.llama_memory_seq_pos_max(memory, seq_id) ⇒ Object

llama_memory_seq_pos_max



2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
 
# File 'ext/llama_cpp/llama_cpp.c', line 2576

static VALUE rb_llama_memory_seq_pos_max(VALUE self, VALUE memory, VALUE seq_id) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_pos pos_max = llama_memory_seq_pos_max(memory_wrapper->memory, NUM2INT(seq_id));
  RB_GC_GUARD(memory);
  return INT2NUM(pos_max);
}

.llama_memory_seq_pos_min(memory, seq_id) ⇒ Object

llama_memory_seq_pos_min



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
 
# File 'ext/llama_cpp/llama_cpp.c', line 2561

static VALUE rb_llama_memory_seq_pos_min(VALUE self, VALUE memory, VALUE seq_id) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  llama_pos pos_min = llama_memory_seq_pos_min(memory_wrapper->memory, NUM2INT(seq_id));
  RB_GC_GUARD(memory);
  return INT2NUM(pos_min);
}

.llama_memory_seq_rm(memory, seq_id, p0, p1) ⇒ Object

llama_memory_seq_rm



2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'ext/llama_cpp/llama_cpp.c', line 2442

static VALUE rb_llama_memory_seq_rm(VALUE self, VALUE memory, VALUE seq_id, VALUE p0, VALUE p1) {
  if (!rb_obj_is_kind_of(memory, rb_cLlamaMemoryT)) {
    rb_raise(rb_eArgError, "memory must be a LlamaMemoryT");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p0)) {
    rb_raise(rb_eArgError, "p0 must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(p1)) {
    rb_raise(rb_eArgError, "p1 must be an Integer");
    return Qnil;
  }
  llama_memory_t_wrapper* memory_wrapper = get_llama_memory_t_wrapper(memory);
  const bool res = llama_memory_seq_rm(memory_wrapper->memory, NUM2INT(seq_id), NUM2INT(p0), NUM2INT(p1));
  RB_GC_GUARD(memory);
  return res ? Qtrue : Qfalse;
}

.llama_model_chat_template(model, name) ⇒ String?

Returns nil if no chat template is available.

Parameters:

  • model (LlamaModel)
  • name (String, nil) —

    pass nil to get the default chat template

Returns:

  • (String, nil) —

    nil if no chat template is available



2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'ext/llama_cpp/llama_cpp.c', line 2112

static VALUE rb_llama_model_chat_template(VALUE self, VALUE model, VALUE name) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!NIL_P(name) && !RB_TYPE_P(name, T_STRING)) {
    rb_raise(rb_eArgError, "name must be a String or nil");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  const char* name_ = NIL_P(name) ? NULL : StringValueCStr(name);
  const char* templ = llama_model_chat_template(model_wrapper->model, name_);
  RB_GC_GUARD(model);
  RB_GC_GUARD(name);
  return templ == NULL ? Qnil : rb_utf8_str_new_cstr(templ);
}

.llama_model_cls_label(model, id) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'ext/llama_cpp/llama_cpp.c', line 1876

static VALUE rb_llama_model_cls_label(VALUE self, VALUE model, VALUE id) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(id)) {
    rb_raise(rb_eArgError, "id must be an Integer");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  const char* str = llama_model_cls_label(model_wrapper->model, NUM2UINT(id));
  RB_GC_GUARD(model);
  return rb_utf8_str_new_cstr(str);
}

.llama_model_decoder_start_token(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2176
2177
2178
2179
2180
2181
2182
2183
 
# File 'ext/llama_cpp/llama_cpp.c', line 2176

static VALUE rb_llama_model_decoder_start_token(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_decoder_start_token(model_wrapper->model));
}

.llama_model_desc(model) ⇒ String

Parameters:

Returns:

  • (String) 


2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
 
# File 'ext/llama_cpp/llama_cpp.c', line 2066

static VALUE rb_llama_model_desc(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  char buf[128];
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  llama_model_desc(model_wrapper->model, buf, sizeof(buf));
  RB_GC_GUARD(model);
  return rb_utf8_str_new_cstr(buf);
}

.llama_model_free(model) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
 
# File 'ext/llama_cpp/llama_cpp.c', line 1369

static VALUE rb_llama_model_free(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  if (model_wrapper->model != NULL) {
    llama_model_free(model_wrapper->model);
    model_wrapper->model = NULL;
  }
  return Qnil;
}

.llama_model_ftype(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2083
2084
2085
2086
2087
2088
2089
2090
 
# File 'ext/llama_cpp/llama_cpp.c', line 2083

static VALUE rb_llama_model_ftype(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_ftype(model_wrapper->model));
}

.llama_model_get_vocab(model) ⇒ LlamaVocab

Parameters:

Returns:



1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
 
# File 'ext/llama_cpp/llama_cpp.c', line 1689

static VALUE rb_llama_model_get_vocab(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  llama_vocab_wrapper* vocab_wrapper = (llama_vocab_wrapper*)ruby_xmalloc(sizeof(llama_vocab_wrapper));
  vocab_wrapper->vocab = (struct llama_vocab*)llama_model_get_vocab(model_wrapper->model);
  vocab_wrapper->copied = true;
  RB_GC_GUARD(model);
  return TypedData_Wrap_Struct(rb_cLlamaVocab, &llama_vocab_wrapper_data_type, vocab_wrapper);
}

.llama_model_has_decoder(model) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2162
2163
2164
2165
2166
2167
2168
2169
 
# File 'ext/llama_cpp/llama_cpp.c', line 2162

static VALUE rb_llama_model_has_decoder(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return llama_model_has_decoder(model_wrapper->model) ? Qtrue : Qfalse;
}

.llama_model_has_encoder?(model) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2148
2149
2150
2151
2152
2153
2154
2155
 
# File 'ext/llama_cpp/llama_cpp.c', line 2148

static VALUE rb_llama_model_has_encoder(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return llama_model_has_encoder(model_wrapper->model) ? Qtrue : Qfalse;
}

.llama_model_is_diffusion?(model) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2218
2219
2220
2221
2222
2223
2224
2225
 
# File 'ext/llama_cpp/llama_cpp.c', line 2218

static VALUE rb_llama_model_is_diffusion(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return llama_model_is_diffusion(model_wrapper->model) ? Qtrue : Qfalse;
}

.llama_model_is_hybrid?(model) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'ext/llama_cpp/llama_cpp.c', line 2204

static VALUE rb_llama_model_is_hybrid(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return llama_model_is_hybrid(model_wrapper->model) ? Qtrue : Qfalse;
}

.llama_model_is_recurrent?(model) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2190
2191
2192
2193
2194
2195
2196
2197
 
# File 'ext/llama_cpp/llama_cpp.c', line 2190

static VALUE rb_llama_model_is_recurrent(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return llama_model_is_recurrent(model_wrapper->model) ? Qtrue : Qfalse;
}

.llama_model_load_from_file(path_model) ⇒ LlamaModel

Parameters:

Returns:



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
 
# File 'ext/llama_cpp/llama_cpp.c', line 1388

static VALUE rb_llama_model_load_from_file(VALUE self, VALUE path_model, VALUE params) {
  if (!RB_TYPE_P(path_model, T_STRING)) {
    rb_raise(rb_eArgError, "path_model must be a String");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(params, rb_cLlamaModelParams)) {
    rb_raise(rb_eArgError, "params must be a LlamaModelParams");
    return Qnil;
  }
  const char* path_model_ = StringValueCStr(path_model);
  struct llama_model_params* params_ = get_llama_model_params(params);
  llama_model_wrapper* model_wrapper = (llama_model_wrapper*)ruby_xmalloc(sizeof(llama_model_wrapper));
  model_wrapper->model = llama_model_load_from_file(path_model_, *params_);
  RB_GC_GUARD(path_model);
  RB_GC_GUARD(params);
  return TypedData_Wrap_Struct(rb_cLlamaModel, &llama_model_wrapper_data_type, model_wrapper);
}

.llama_model_load_from_splits(paths, params) ⇒ LlamaModel

Parameters:

Returns:



1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
 
# File 'ext/llama_cpp/llama_cpp.c', line 1412

static VALUE rb_llama_model_load_from_splits(VALUE self, VALUE paths, VALUE params) {
  if (!RB_TYPE_P(paths, T_ARRAY)) {
    rb_raise(rb_eArgError, "paths must be an Array");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(params, rb_cLlamaModelParams)) {
    rb_raise(rb_eArgError, "params must be a LlamaModelParams");
    return Qnil;
  }
  size_t n_paths = RARRAY_LEN(paths);
  const char** paths_ = ALLOCA_N(const char*, n_paths);
  for (size_t i = 0; i < n_paths; i++) {
    VALUE path = rb_ary_entry(paths, i);
    if (!RB_TYPE_P(path, T_STRING)) {
      rb_raise(rb_eArgError, "paths must be an Array of Strings");
      return Qnil;
    }
    paths_[i] = StringValueCStr(path);
  }
  struct llama_model_params* params_ = get_llama_model_params(params);
  llama_model_wrapper* model_wrapper = (llama_model_wrapper*)ruby_xmalloc(sizeof(llama_model_wrapper));
  model_wrapper->model = llama_model_load_from_splits(paths_, n_paths, *params_);
  RB_GC_GUARD(paths);
  RB_GC_GUARD(params);
  return TypedData_Wrap_Struct(rb_cLlamaModel, &llama_model_wrapper_data_type, model_wrapper);
}

.llama_model_meta_count(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1928
1929
1930
1931
1932
1933
1934
1935
 
# File 'ext/llama_cpp/llama_cpp.c', line 1928

static VALUE rb_llama_model_meta_count(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_meta_count(model_wrapper->model));
}

.llama_model_meta_key_by_index(model, idx) ⇒ String?

Returns nil if the index is out of range.

Parameters:

Returns:

  • (String, nil) —

    nil if the index is out of range



1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 
# File 'ext/llama_cpp/llama_cpp.c', line 1995

static VALUE rb_llama_model_meta_key_by_index(VALUE self, VALUE model, VALUE idx) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(idx)) {
    rb_raise(rb_eArgError, "i must be an Integer");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  int32_t idx_ = NUM2INT(idx);
  char stack_buf[1024];
  int32_t n = llama_model_meta_key_by_index(model_wrapper->model, idx_, stack_buf, sizeof(stack_buf));
  if (n < 0) {
    RB_GC_GUARD(model);
    return Qnil;
  }
  VALUE result;
  if ((size_t)n < sizeof(stack_buf)) {
    result = rb_utf8_str_new(stack_buf, n);
  } else {
    char* heap_buf = (char*)ruby_xmalloc((size_t)n + 1);
    llama_model_meta_key_by_index(model_wrapper->model, idx_, heap_buf, (size_t)n + 1);
    result = rb_utf8_str_new(heap_buf, n);
    ruby_xfree(heap_buf);
  }
  RB_GC_GUARD(model);
  return result;
}

.llama_model_meta_key_str(key) ⇒ String

Parameters:

  • key (Integer) —

    (must be one of Llama::LLAMA_MODEL_META_KEY_* constants)

Returns:

  • (String) 


1942
1943
1944
1945
1946
1947
1948
1949
 
# File 'ext/llama_cpp/llama_cpp.c', line 1942

static VALUE rb_llama_model_meta_key_str(VALUE self, VALUE key) {
  if (!RB_INTEGER_TYPE_P(key)) {
    rb_raise(rb_eArgError, "key must be an Integer");
    return Qnil;
  }
  const char* key_str = llama_model_meta_key_str(NUM2INT(key));
  return rb_utf8_str_new_cstr(key_str);
}

.llama_model_meta_val_str(model, key) ⇒ String?

Returns nil if the key is not found.

Parameters:

Returns:

  • (String, nil) —

    nil if the key is not found



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'ext/llama_cpp/llama_cpp.c', line 1957

static VALUE rb_llama_model_meta_val_str(VALUE self, VALUE model, VALUE key) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!RB_TYPE_P(key, T_STRING)) {
    rb_raise(rb_eArgError, "key must be a String");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  const char* key_ = StringValueCStr(key);
  char stack_buf[1024];
  int32_t n = llama_model_meta_val_str(model_wrapper->model, key_, stack_buf, sizeof(stack_buf));
  if (n < 0) {
    RB_GC_GUARD(model);
    RB_GC_GUARD(key);
    return Qnil;
  }
  VALUE result;
  if ((size_t)n < sizeof(stack_buf)) {
    result = rb_utf8_str_new(stack_buf, n);
  } else {
    char* heap_buf = (char*)ruby_xmalloc((size_t)n + 1);
    llama_model_meta_val_str(model_wrapper->model, key_, heap_buf, (size_t)n + 1);
    result = rb_utf8_str_new(heap_buf, n);
    ruby_xfree(heap_buf);
  }
  RB_GC_GUARD(model);
  RB_GC_GUARD(key);
  return result;
}

.llama_model_meta_val_str_by_index(model, idx) ⇒ String?

Returns nil if the index is out of range.

Parameters:

Returns:

  • (String, nil) —

    nil if the index is out of range



2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'ext/llama_cpp/llama_cpp.c', line 2031

static VALUE rb_llama_model_meta_val_str_by_index(VALUE self, VALUE model, VALUE idx) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(idx)) {
    rb_raise(rb_eArgError, "i must be an Integer");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  int32_t idx_ = NUM2INT(idx);
  char stack_buf[1024];
  int32_t n = llama_model_meta_val_str_by_index(model_wrapper->model, idx_, stack_buf, sizeof(stack_buf));
  if (n < 0) {
    RB_GC_GUARD(model);
    return Qnil;
  }
  VALUE result;
  if ((size_t)n < sizeof(stack_buf)) {
    result = rb_utf8_str_new(stack_buf, n);
  } else {
    char* heap_buf = (char*)ruby_xmalloc((size_t)n + 1);
    llama_model_meta_val_str_by_index(model_wrapper->model, idx_, heap_buf, (size_t)n + 1);
    result = rb_utf8_str_new(heap_buf, n);
    ruby_xfree(heap_buf);
  }
  RB_GC_GUARD(model);
  return result;
}

.llama_model_n_cls_out(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1861
1862
1863
1864
1865
1866
1867
1868
 
# File 'ext/llama_cpp/llama_cpp.c', line 1861

static VALUE rb_llama_model_n_cls_out(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return UINT2NUM(llama_model_n_cls_out(model_wrapper->model));
}

.llama_model_n_ctx_train(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'ext/llama_cpp/llama_cpp.c', line 1721

static VALUE rb_llama_model_n_ctx_train(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_ctx_train(model_wrapper->model));
}

.llama_model_n_embd(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1735
1736
1737
1738
1739
1740
1741
1742
 
# File 'ext/llama_cpp/llama_cpp.c', line 1735

static VALUE rb_llama_model_n_embd(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_embd(model_wrapper->model));
}

.llama_model_n_embd_inp(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1749
1750
1751
1752
1753
1754
1755
1756
 
# File 'ext/llama_cpp/llama_cpp.c', line 1749

static VALUE rb_llama_model_n_embd_inp(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_embd_inp(model_wrapper->model));
}

.llama_model_n_embd_out(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1763
1764
1765
1766
1767
1768
1769
1770
 
# File 'ext/llama_cpp/llama_cpp.c', line 1763

static VALUE rb_llama_model_n_embd_out(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_embd_out(model_wrapper->model));
}

.llama_model_n_head(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1805
1806
1807
1808
1809
1810
1811
1812
 
# File 'ext/llama_cpp/llama_cpp.c', line 1805

static VALUE rb_llama_model_n_head(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_head(model_wrapper->model));
}

.llama_model_n_head_kv(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'ext/llama_cpp/llama_cpp.c', line 1819

static VALUE rb_llama_model_n_head_kv(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_head_kv(model_wrapper->model));
}

.llama_model_n_layer(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1777
1778
1779
1780
1781
1782
1783
1784
 
# File 'ext/llama_cpp/llama_cpp.c', line 1777

static VALUE rb_llama_model_n_layer(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_layer(model_wrapper->model));
}

.llama_model_n_layer_nextn(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'ext/llama_cpp/llama_cpp.c', line 1791

static VALUE rb_llama_model_n_layer_nextn(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_layer_nextn(model_wrapper->model));
}

.llama_model_n_params(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'ext/llama_cpp/llama_cpp.c', line 2134

static VALUE rb_llama_model_n_params(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return ULONG2NUM(llama_model_n_params(model_wrapper->model));
}

.llama_model_n_swa(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1833
1834
1835
1836
1837
1838
1839
1840
 
# File 'ext/llama_cpp/llama_cpp.c', line 1833

static VALUE rb_llama_model_n_swa(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_n_swa(model_wrapper->model));
}

.llama_model_quantize(fname_inp, fname_out, params) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
 
# File 'ext/llama_cpp/llama_cpp.c', line 2234

static VALUE rb_llama_model_quantize(VALUE self, VALUE fname_inp, VALUE fname_out, VALUE params) {
  if (!RB_TYPE_P(fname_inp, T_STRING)) {
    rb_raise(rb_eArgError, "fname_inp must be a String");
    return Qnil;
  }
  if (!RB_TYPE_P(fname_out, T_STRING)) {
    rb_raise(rb_eArgError, "fname_out must be a String");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(params, rb_cLlamaModelQuantizeParams)) {
    rb_raise(rb_eArgError, "params must be a LlamaModelQuantizeParams");
    return Qnil;
  }
  const char* fname_inp_ = StringValueCStr(fname_inp);
  const char* fname_out_ = StringValueCStr(fname_out);
  const llama_model_quantize_params* params_ = get_llama_model_quantize_params(params);
  const uint32_t res = llama_model_quantize(fname_inp_, fname_out_, params_);
  RB_GC_GUARD(fname_inp);
  RB_GC_GUARD(fname_out);
  RB_GC_GUARD(params);
  return res == 0 ? Qtrue : Qfalse;
}

.llama_model_rope_freq_scale_train(model) ⇒ Float

Parameters:

Returns:

  • (Float) 


1847
1848
1849
1850
1851
1852
1853
1854
 
# File 'ext/llama_cpp/llama_cpp.c', line 1847

static VALUE rb_llama_model_rope_freq_scale_train(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return DBL2NUM(llama_model_rope_freq_scale_train(model_wrapper->model));
}

.llama_model_rope_type(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'ext/llama_cpp/llama_cpp.c', line 1707

static VALUE rb_llama_model_rope_type(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return INT2NUM(llama_model_rope_type(model_wrapper->model));
}

.llama_model_save_to_file(model, path_model) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
 
# File 'ext/llama_cpp/llama_cpp.c', line 1445

static VALUE rb_llama_model_save_to_file(VALUE self, VALUE model, VALUE path_model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  if (!RB_TYPE_P(path_model, T_STRING)) {
    rb_raise(rb_eArgError, "path_model must be a String");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  const char* path_model_ = StringValueCStr(path_model);
  llama_model_save_to_file(model_wrapper->model, path_model_);
  RB_GC_GUARD(model);
  RB_GC_GUARD(path_model);
  return Qnil;
}

.llama_model_size(model) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2097
2098
2099
2100
2101
2102
2103
2104
 
# File 'ext/llama_cpp/llama_cpp.c', line 2097

static VALUE rb_llama_model_size(VALUE self, VALUE model) {
  if (!rb_obj_is_kind_of(model, rb_cLlamaModel)) {
    rb_raise(rb_eArgError, "model must be a LlamaModel");
    return Qnil;
  }
  llama_model_wrapper* model_wrapper = get_llama_model_wrapper(model);
  return ULONG2NUM(llama_model_size(model_wrapper->model));
}

.llama_n_batch(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1601
1602
1603
1604
1605
1606
1607
1608
 
# File 'ext/llama_cpp/llama_cpp.c', line 1601

static VALUE rb_llama_n_batch(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return UINT2NUM(llama_n_batch(context_wrapper->context));
}

.llama_n_ctx(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1573
1574
1575
1576
1577
1578
1579
1580
 
# File 'ext/llama_cpp/llama_cpp.c', line 1573

static VALUE rb_llama_n_ctx(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return UINT2NUM(llama_n_ctx(context_wrapper->context));
}

.llama_n_ctx_seq(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'ext/llama_cpp/llama_cpp.c', line 1587

static VALUE rb_llama_n_ctx_seq(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return UINT2NUM(llama_n_ctx_seq(context_wrapper->context));
}

.llama_n_rs_seq(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'ext/llama_cpp/llama_cpp.c', line 1643

static VALUE rb_llama_n_rs_seq(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return UINT2NUM(llama_n_rs_seq(context_wrapper->context));
}

.llama_n_seq_max(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1629
1630
1631
1632
1633
1634
1635
1636
 
# File 'ext/llama_cpp/llama_cpp.c', line 1629

static VALUE rb_llama_n_seq_max(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return UINT2NUM(llama_n_seq_max(context_wrapper->context));
}

.llama_n_threads(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
 
# File 'ext/llama_cpp/llama_cpp.c', line 2832

static VALUE rb_llama_n_threads(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const int32_t n_threads = llama_n_threads(context_wrapper->context);
  RB_GC_GUARD(ctx);
  return INT2NUM(n_threads);
}

.llama_n_threads_batch(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
 
# File 'ext/llama_cpp/llama_cpp.c', line 2848

static VALUE rb_llama_n_threads_batch(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const int32_t n_threads_batch = llama_n_threads_batch(context_wrapper->context);
  RB_GC_GUARD(ctx);
  return INT2NUM(n_threads_batch);
}

.llama_n_ubatch(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'ext/llama_cpp/llama_cpp.c', line 1615

static VALUE rb_llama_n_ubatch(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return UINT2NUM(llama_n_ubatch(context_wrapper->context));
}

.llama_numa_init(numa) ⇒ NilClass

Parameters:

  • numa (Integer)

Returns:

  • (NilClass) 


1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'ext/llama_cpp/llama_cpp.c', line 1355

static VALUE rb_llama_numa_init(VALUE self, VALUE numa) {
  if (!RB_INTEGER_TYPE_P(numa)) {
    rb_raise(rb_eArgError, "numa must be an Integer");
    return Qnil;
  }
  llama_numa_init((enum ggml_numa_strategy)NUM2INT(numa));
  return Qnil;
}

.llama_perf_context(context) ⇒ LlamaPerfContextData

Parameters:

Returns:



4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
 
# File 'ext/llama_cpp/llama_cpp.c', line 4238

static VALUE rb_llama_perf_context(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* ctx_wrapper = get_llama_context_wrapper(ctx);
  struct llama_perf_context_data* data = (struct llama_perf_context_data*)ruby_xmalloc(sizeof(struct llama_perf_context_data));
  *data = llama_perf_context(ctx_wrapper->context);
  RB_GC_GUARD(ctx);
  return TypedData_Wrap_Struct(rb_cLlamaPerfContextData, &llama_perf_context_data_type, data);
}

.llama_perf_context_print(context) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
 
# File 'ext/llama_cpp/llama_cpp.c', line 4255

static VALUE rb_llama_perf_context_print(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* ctx_wrapper = get_llama_context_wrapper(ctx);
  llama_perf_context_print(ctx_wrapper->context);
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_perf_context_reset(context) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
 
# File 'ext/llama_cpp/llama_cpp.c', line 4287

static VALUE rb_llama_perf_context_reset(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* ctx_wrapper = get_llama_context_wrapper(ctx);
  llama_perf_context_reset(ctx_wrapper->context);
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_perf_sampler(chain) ⇒ LlamaPerfSamplerData

Parameters:

Returns:



4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
 
# File 'ext/llama_cpp/llama_cpp.c', line 4303

static VALUE rb_llama_perf_sampler(VALUE self, VALUE chain) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  struct llama_perf_sampler_data* data = (struct llama_perf_sampler_data*)ruby_xmalloc(sizeof(struct llama_perf_sampler_data));
  *data = llama_perf_sampler(chain_);
  RB_GC_GUARD(chain);
  return TypedData_Wrap_Struct(rb_cLlamaPerfSamplerData, &llama_perf_sampler_data_type, data);
}

.llama_perf_sampler_print(chain) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
 
# File 'ext/llama_cpp/llama_cpp.c', line 4271

static VALUE rb_llama_perf_sampler_print(VALUE self, VALUE chain) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  llama_perf_sampler_print(chain_);
  RB_GC_GUARD(chain);
  return Qnil;
}

.llama_perf_sampler_reset(chain) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
 
# File 'ext/llama_cpp/llama_cpp.c', line 4320

static VALUE rb_llama_perf_sampler_reset(VALUE self, VALUE chain) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  llama_perf_sampler_reset(chain_);
  RB_GC_GUARD(chain);
  return Qnil;
}

.llama_pooling_type(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1675
1676
1677
1678
1679
1680
1681
1682
 
# File 'ext/llama_cpp/llama_cpp.c', line 1675

static VALUE rb_llama_pooling_type(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  return INT2NUM(llama_pooling_type(context_wrapper->context));
}

.llama_print_system_info ⇒ String

Returns:

  • (String) 


4110
4111
4112
4113
 
# File 'ext/llama_cpp/llama_cpp.c', line 4110

static VALUE rb_llama_print_system_info(VALUE self) {
  const char* info = llama_print_system_info();
  return rb_utf8_str_new_cstr(info);
}

.llama_sampler_accept(sampler, token) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
 
# File 'ext/llama_cpp/llama_cpp.c', line 3517

static VALUE rb_llama_sampler_accept(VALUE self, VALUE sampler, VALUE token) {
  if (!rb_obj_is_kind_of(sampler, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaSampler");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler_ = get_llama_sampler(sampler);
  llama_token token_ = NUM2INT(token);
  llama_sampler_accept(sampler_, token_);
  RB_GC_GUARD(sampler);
  return Qnil;
}

.llama_sampler_apply(sampler, cur_p) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
 
# File 'ext/llama_cpp/llama_cpp.c', line 3539

static VALUE rb_llama_sampler_apply(VALUE self, VALUE sampler, VALUE cur_p) {
  if (!rb_obj_is_kind_of(sampler, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaSampler");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(cur_p, rb_cLlamaTokenDataArray)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaTokenDataArray");
    return Qnil;
  }
  struct llama_sampler* sampler_ = get_llama_sampler(sampler);
  llama_token_data_array* cur_p_ = get_llama_token_data_array(cur_p);
  llama_sampler_apply(sampler_, cur_p_);
  RB_GC_GUARD(sampler);
  RB_GC_GUARD(cur_p);
  return Qnil;
}

.llama_sampler_chain_add(chain, smpl) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
 
# File 'ext/llama_cpp/llama_cpp.c', line 3627

static VALUE rb_llama_sampler_chain_add(VALUE self, VALUE chain, VALUE smpl) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(smpl, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "smpl must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  struct llama_sampler* smpl_ = get_llama_sampler(smpl);
  llama_sampler_chain_add(chain_, smpl_);
  RB_GC_GUARD(chain);
  RB_GC_GUARD(smpl);
  return Qnil;
}

.llama_sampler_chain_get(chain, i) ⇒ LlamaSampler

Parameters:

Returns:



3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
 
# File 'ext/llama_cpp/llama_cpp.c', line 3650

static VALUE rb_llama_sampler_chain_get(VALUE self, VALUE chain, VALUE i) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(i)) {
    rb_raise(rb_eArgError, "i must be an Integer");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  struct llama_sampler* smpl = llama_sampler_chain_get(chain_, NUM2INT(i));
  RB_GC_GUARD(chain);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, smpl);
}

.llama_sampler_chain_init(params) ⇒ LlamaSampler

Parameters:

Returns:



3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
 
# File 'ext/llama_cpp/llama_cpp.c', line 3610

static VALUE rb_llama_sampler_chain_init(VALUE self, VALUE params) {
  if (!rb_obj_is_kind_of(params, rb_cLlamaSamplerChainParams)) {
    rb_raise(rb_eArgError, "params must be a LlamaSamplerChainParams");
    return Qnil;
  }
  llama_sampler_chain_params* params_ = get_llama_sampler_chain_params(params);
  struct llama_sampler* sampler = llama_sampler_chain_init(*params_);
  RB_GC_GUARD(params);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_chain_n(chain) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
 
# File 'ext/llama_cpp/llama_cpp.c', line 3670

static VALUE rb_llama_sampler_chain_n(VALUE self, VALUE chain) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  const int n = llama_sampler_chain_n(chain_);
  RB_GC_GUARD(chain);
  return INT2NUM(n);
}

.llama_sampler_chain_remove(chain, i) ⇒ LlamaSampler

Parameters:

Returns:



3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
 
# File 'ext/llama_cpp/llama_cpp.c', line 3687

static VALUE rb_llama_sampler_chain_remove(VALUE self, VALUE chain, VALUE i) {
  if (!rb_obj_is_kind_of(chain, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "chain must be a LlamaSampler");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(i)) {
    rb_raise(rb_eArgError, "i must be an Integer");
    return Qnil;
  }
  struct llama_sampler* chain_ = get_llama_sampler(chain);
  struct llama_sampler* smpl = llama_sampler_chain_remove(chain_, NUM2INT(i));
  RB_GC_GUARD(chain);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, smpl);
}

.llama_sampler_clone(sampler) ⇒ LlamaSampler

Parameters:

Returns:



3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
 
# File 'ext/llama_cpp/llama_cpp.c', line 3577

static VALUE rb_llama_sampler_clone(VALUE self, VALUE sampler) {
  if (!rb_obj_is_kind_of(sampler, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* sampler_ = get_llama_sampler(sampler);
  struct llama_sampler* clone = llama_sampler_clone(sampler_);
  RB_GC_GUARD(sampler);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, clone);
}

.llama_sampler_free(sampler) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
 
# File 'ext/llama_cpp/llama_cpp.c', line 3593

static VALUE rb_llama_sampler_free(VALUE self, VALUE sampler) {
  if (!rb_obj_is_kind_of(sampler, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* sampler_ = get_llama_sampler(sampler);
  llama_sampler_free(sampler_);
  sampler_ = NULL;
  RB_GC_GUARD(sampler);
  return Qnil;
}

.llama_sampler_get_seed(sampler) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
 
# File 'ext/llama_cpp/llama_cpp.c', line 4067

static VALUE rb_llama_sampler_get_seed(VALUE self, VALUE smpl) {
  if (!rb_obj_is_kind_of(smpl, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "smpl must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* smpl_ = get_llama_sampler(smpl);
  const uint32_t seed = llama_sampler_get_seed(smpl_);
  RB_GC_GUARD(smpl);
  return UINT2NUM(seed);
}

.llama_sampler_init_adaptive_p(target, decay, seed) ⇒ LlamaSampler

Parameters:

  • target (Float)
  • decay (Float)
  • seed (Integer)

Returns:



4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
 
# File 'ext/llama_cpp/llama_cpp.c', line 4001

static VALUE rb_llama_sampler_init_adaptive_p(VALUE self, VALUE target, VALUE decay, VALUE seed) {
  if (!RB_FLOAT_TYPE_P(target)) {
    rb_raise(rb_eArgError, "target must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(decay)) {
    rb_raise(rb_eArgError, "decay must be a Float");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seed)) {
    rb_raise(rb_eArgError, "seed must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_adaptive_p(NUM2DBL(target), NUM2DBL(decay), NUM2UINT(seed));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_dist(seed) ⇒ LlamaSampler

Parameters:

  • seed (Integer)

Returns:



3716
3717
3718
3719
3720
3721
3722
3723
 
# File 'ext/llama_cpp/llama_cpp.c', line 3716

static VALUE rb_llama_sampler_init_dist(VALUE self, VALUE seed) {
  if (!RB_INTEGER_TYPE_P(seed)) {
    rb_raise(rb_eArgError, "seed must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_dist(NUM2UINT(seed));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_grammar(vocab, grammar_str, grammar_root) ⇒ LlamaSampler

Parameters:

  • vocab (LlamaVocab)
  • grammar_str (String)
  • grammar_root (String)

Returns:



3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
 
# File 'ext/llama_cpp/llama_cpp.c', line 3942

static VALUE rb_llama_sampler_init_grammar(VALUE self, VALUE vocab, VALUE grammar_str, VALUE grammar_root) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_TYPE_P(grammar_str, T_STRING)) {
    rb_raise(rb_eArgError, "grammar_str must be a String");
    return Qnil;
  }
  if (!RB_TYPE_P(grammar_root, T_STRING)) {
    rb_raise(rb_eArgError, "grammar_root must be a String");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const char* grammar_str_ = StringValueCStr(grammar_str);
  const char* grammar_root_ = StringValueCStr(grammar_root);
  struct llama_sampler* sampler = llama_sampler_init_grammar(vocab_wrapper->vocab, grammar_str_, grammar_root_);
  RB_GC_GUARD(vocab);
  RB_GC_GUARD(grammar_str);
  RB_GC_GUARD(grammar_root);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_greedy ⇒ LlamaSampler

Returns:



3706
3707
3708
3709
 
# File 'ext/llama_cpp/llama_cpp.c', line 3706

static VALUE rb_llama_sampler_init_greedy(VALUE self) {
  struct llama_sampler* sampler = llama_sampler_init_greedy();
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_infill(vocab) ⇒ LlamaSampler

Parameters:

Returns:



4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
 
# File 'ext/llama_cpp/llama_cpp.c', line 4051

static VALUE rb_llama_sampler_init_infill(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  struct llama_sampler* sampler = llama_sampler_init_infill(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_logit_bias(n_vocab, n_logit_bias, logit_bias) ⇒ LlamaSampler

Parameters:

  • n_vocab (Integer)
  • n_logit_bias (Integer)
  • logit_bias (LlamaLogitBias)

Returns:



4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
 
# File 'ext/llama_cpp/llama_cpp.c', line 4025

static VALUE rb_llama_sampler_init_logit_bias(VALUE self, VALUE n_vocab, VALUE n_logit_bias, VALUE logit_bias) {
  if (!RB_INTEGER_TYPE_P(n_vocab)) {
    rb_raise(rb_eArgError, "n_vocab must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(n_logit_bias)) {
    rb_raise(rb_eArgError, "n_logit_bias must be an Integer");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(logit_bias, rb_cLlamaLogitBias)) {
    rb_raise(rb_eArgError, "logit_bias must be a LlamaLogitBias");
    return Qnil;
  }
  const int32_t n_vocab_ = NUM2INT(n_vocab);
  const int32_t n_logit_bias_ = NUM2INT(n_logit_bias);
  const llama_logit_bias* logit_bias_ = get_llama_logit_bias(logit_bias);
  struct llama_sampler* sampler = llama_sampler_init_logit_bias(n_vocab_, n_logit_bias_, logit_bias_);
  RB_GC_GUARD(logit_bias);
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_min_p(p, min_keep) ⇒ LlamaSampler

Parameters:

  • p (Float)
  • min_keep (Integer)

Returns:



3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
 
# File 'ext/llama_cpp/llama_cpp.c', line 3764

static VALUE rb_llama_sampler_init_min_p(VALUE self, VALUE p, VALUE min_keep) {
  if (!RB_FLOAT_TYPE_P(p)) {
    rb_raise(rb_eArgError, "p must be a Float");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(min_keep)) {
    rb_raise(rb_eArgError, "min_keep must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_min_p(NUM2DBL(p), NUM2SIZET(min_keep));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_mirostat(n_vocab, seed, tau, eta, m) ⇒ LlamaSampler

Parameters:

  • n_vocab (Integer)
  • seed (Integer)
  • tau (Float)
  • eta (Float)
  • m (Integer)

Returns:



3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
 
# File 'ext/llama_cpp/llama_cpp.c', line 3886

static VALUE rb_llama_sampler_init_mirostat(VALUE self, VALUE n_vocab, VALUE seed, VALUE tau, VALUE eta, VALUE m) {
  if (!RB_INTEGER_TYPE_P(n_vocab)) {
    rb_raise(rb_eArgError, "n_vocab must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seed)) {
    rb_raise(rb_eArgError, "seed must be an Integer");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(tau)) {
    rb_raise(rb_eArgError, "tau must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(eta)) {
    rb_raise(rb_eArgError, "eta must be a Float");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(m)) {
    rb_raise(rb_eArgError, "m must be an Integer ");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_mirostat(NUM2INT(n_vocab), NUM2UINT(seed), NUM2DBL(tau), NUM2DBL(eta), NUM2INT(m));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_mirostat_v2(seed, tau, eta) ⇒ LlamaSampler

Parameters:

  • seed (Integer)
  • tau (Float)
  • eta (Float)

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
 
# File 'ext/llama_cpp/llama_cpp.c', line 3918

static VALUE rb_llama_sampler_init_mirostat_v2(VALUE self, VALUE seed, VALUE tau, VALUE eta) {
  if (!RB_INTEGER_TYPE_P(seed)) {
    rb_raise(rb_eArgError, "seed must be an Integer");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(tau)) {
    rb_raise(rb_eArgError, "tau must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(eta)) {
    rb_raise(rb_eArgError, "eta must be a Float");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_mirostat_v2(NUM2UINT(seed), NUM2DBL(tau), NUM2DBL(eta));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_penalties(penalty_last_n, penalty_repeat, penalty_freq, penalty_present) ⇒ LlamaSampler

Parameters:

  • penalty_last_n (Integer)
  • penalty_repeat (Float)
  • penalty_freq (Float)
  • penalty_present (Float)

Returns:



3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
 
# File 'ext/llama_cpp/llama_cpp.c', line 3973

static VALUE rb_llama_sampler_init_penalties(VALUE self, VALUE penalty_last_n, VALUE penalty_repeat, VALUE penalty_freq, VALUE penalty_present) {
  if (!RB_INTEGER_TYPE_P(penalty_last_n)) {
    rb_raise(rb_eArgError, "penalty_last_n must be an Integer");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(penalty_repeat)) {
    rb_raise(rb_eArgError, "penalty_repeat must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(penalty_freq)) {
    rb_raise(rb_eArgError, "penalty_freq must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(penalty_present)) {
    rb_raise(rb_eArgError, "penalty_present must be a Float");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_penalties(NUM2INT(penalty_last_n), NUM2DBL(penalty_repeat), NUM2DBL(penalty_freq), NUM2DBL(penalty_present));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_temp(t) ⇒ LlamaSampler

Parameters:

  • t (Float)

Returns:



3801
3802
3803
3804
3805
3806
3807
3808
 
# File 'ext/llama_cpp/llama_cpp.c', line 3801

static VALUE rb_llama_sampler_init_temp(VALUE self, VALUE t) {
  if (!RB_FLOAT_TYPE_P(t)) {
    rb_raise(rb_eArgError, "t must be a Float");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_temp(NUM2DBL(t));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_temp_ext(t, delta, exponent) ⇒ LlamaSampler

Parameters:

  • t (Float)
  • delta (Float)
  • exponent (Float)

Returns:



3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
 
# File 'ext/llama_cpp/llama_cpp.c', line 3817

static VALUE rb_llama_sampler_init_temp_ext(VALUE self, VALUE t, VALUE delta, VALUE exponent) {
  if (!RB_FLOAT_TYPE_P(t)) {
    rb_raise(rb_eArgError, "t must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(delta)) {
    rb_raise(rb_eArgError, "delta must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(exponent)) {
    rb_raise(rb_eArgError, "exponent must be a Float");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_temp_ext(NUM2DBL(t), NUM2DBL(delta), NUM2DBL(exponent));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_top_k(k) ⇒ LlamaSampler

Parameters:

  • k (Integer)

Returns:



3730
3731
3732
3733
3734
3735
3736
3737
 
# File 'ext/llama_cpp/llama_cpp.c', line 3730

static VALUE rb_llama_sampler_init_top_k(VALUE self, VALUE k) {
  if (!RB_INTEGER_TYPE_P(k)) {
    rb_raise(rb_eArgError, "k must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_top_k(NUM2INT(k));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_top_n_sigma(n) ⇒ LlamaSampler

Parameters:

  • n (Float)

Returns:



3868
3869
3870
3871
3872
3873
3874
3875
 
# File 'ext/llama_cpp/llama_cpp.c', line 3868

static VALUE rb_llama_sampler_init_top_n_sigma(VALUE self, VALUE n) {
  if (!RB_FLOAT_TYPE_P(n)) {
    rb_raise(rb_eArgError, "n must be a Float");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_top_n_sigma(NUM2DBL(n));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_top_p(p, min_keep) ⇒ LlamaSampler

Parameters:

  • p (Float)
  • min_keep (Integer)

Returns:



3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
 
# File 'ext/llama_cpp/llama_cpp.c', line 3745

static VALUE rb_llama_sampler_init_top_p(VALUE self, VALUE p, VALUE min_keep) {
  if (!RB_FLOAT_TYPE_P(p)) {
    rb_raise(rb_eArgError, "p must be a Float");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(min_keep)) {
    rb_raise(rb_eArgError, "min_keep must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_top_p(NUM2DBL(p), NUM2SIZET(min_keep));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_typical(p, min_keep) ⇒ LlamaSampler

Parameters:

  • p (Float)
  • min_keep (Integer)

Returns:



3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
 
# File 'ext/llama_cpp/llama_cpp.c', line 3783

static VALUE rb_llama_sampler_init_typical(VALUE self, VALUE p, VALUE min_keep) {
  if (!RB_FLOAT_TYPE_P(p)) {
    rb_raise(rb_eArgError, "p must be a Float");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(min_keep)) {
    rb_raise(rb_eArgError, "min_keep must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_typical(NUM2DBL(p), NUM2SIZET(min_keep));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_init_xtc(p, t, min_keep, seed) ⇒ LlamaSampler

Parameters:

  • p (Float)
  • t (Float)
  • min_keep (Integer)
  • seed (Integer)

Returns:



3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
 
# File 'ext/llama_cpp/llama_cpp.c', line 3842

static VALUE rb_llama_sampler_init_xtc(VALUE self, VALUE p, VALUE t, VALUE min_keep, VALUE seed ) {
  if (!RB_FLOAT_TYPE_P(p)) {
    rb_raise(rb_eArgError, "p must be a Float");
    return Qnil;
  }
  if (!RB_FLOAT_TYPE_P(t)) {
    rb_raise(rb_eArgError, "t must be a Float");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(min_keep)) {
    rb_raise(rb_eArgError, "min_keep must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seed)) {
    rb_raise(rb_eArgError, "seed must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = llama_sampler_init_xtc(NUM2DBL(p), NUM2DBL(t), NUM2SIZET(min_keep), NUM2UINT(seed));
  return TypedData_Wrap_Struct(rb_cLlamaSampler, &llama_sampler_data_type, sampler);
}

.llama_sampler_name(sampler) ⇒ String

Parameters:

Returns:

  • (String) 


3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
 
# File 'ext/llama_cpp/llama_cpp.c', line 3499

static VALUE rb_llama_sampler_name(VALUE self, VALUE sampler) {
  if (!rb_obj_is_kind_of(sampler, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* sampler_ = get_llama_sampler(sampler);
  const char* name = llama_sampler_name(sampler_);
  VALUE ret = rb_utf8_str_new_cstr(name);
  RB_GC_GUARD(sampler);
  return ret;
}

.llama_sampler_reset(sampler) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
 
# File 'ext/llama_cpp/llama_cpp.c', line 3561

static VALUE rb_llama_sampler_reset(VALUE self, VALUE sampler) {
  if (!rb_obj_is_kind_of(sampler, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "sampler must be a LlamaSampler");
    return Qnil;
  }
  struct llama_sampler* sampler_ = get_llama_sampler(sampler);
  llama_sampler_reset(sampler_);
  RB_GC_GUARD(sampler);
  return Qnil;
}

.llama_sampler_sample(sampler, context, idx) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
 
# File 'ext/llama_cpp/llama_cpp.c', line 4085

static VALUE rb_llama_sampler_sample(VALUE self, VALUE smpl, VALUE ctx, VALUE idx) {
  if (!rb_obj_is_kind_of(smpl, rb_cLlamaSampler)) {
    rb_raise(rb_eArgError, "smpl must be a LlamaSampler");
    return Qnil;
  }
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(idx)) {
    rb_raise(rb_eArgError, "idx must be an Integer");
    return Qnil;
  }
  struct llama_sampler* sampler = get_llama_sampler(smpl);
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const int32_t token = llama_sampler_sample(sampler, context_wrapper->context, NUM2INT(idx));
  RB_GC_GUARD(smpl);
  RB_GC_GUARD(ctx);
  return INT2NUM(token);
}

.llama_set_adapters_lora(context, adapters, scales) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
 
# File 'ext/llama_cpp/llama_cpp.c', line 2302

static VALUE rb_llama_set_adapters_lora(VALUE self, VALUE ctx, VALUE adapters, VALUE scales) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!RB_TYPE_P(adapters, T_ARRAY)) {
    rb_raise(rb_eArgError, "adapters must be an Array");
    return Qnil;
  }
  if (!RB_TYPE_P(scales, T_ARRAY)) {
    rb_raise(rb_eArgError, "scales must be an Array");
    return Qnil;
  }
  long n_adapters = RARRAY_LEN(adapters);
  long n_scales = RARRAY_LEN(scales);
  if (n_adapters != n_scales) {
    rb_raise(rb_eArgError, "adapters and scales must have the same length");
    return Qnil;
  }
  for (long i = 0; i < n_adapters; i++) {
    VALUE adapter = rb_ary_entry(adapters, i);
    if (!rb_obj_is_kind_of(adapter, rb_cLlamaAdapterLora)) {
      rb_raise(rb_eArgError, "adapters must be an Array of LlamaAdapterLora");
      return Qnil;
    }
  }
  for (long i = 0; i < n_scales; i++) {
    VALUE scale = rb_ary_entry(scales, i);
    if (!RB_FLOAT_TYPE_P(scale)) {
      rb_raise(rb_eArgError, "scales must be an Array of Float");
      return Qnil;
    }
  }
  struct llama_adapter_lora** adapters_ = ALLOCA_N(struct llama_adapter_lora*, n_adapters);
  for (long i = 0; i < n_adapters; i++) {
    VALUE adapter = rb_ary_entry(adapters, i);
    llama_adapter_lora_wrapper* adapter_wrapper = get_llama_adapter_lora_wrapper(adapter);
    adapters_[i] = adapter_wrapper->adapter;
  }
  float* scales_ = ALLOCA_N(float, n_scales);
  for (long i = 0; i < n_scales; i++) {
    VALUE scale = rb_ary_entry(scales, i);
    scales_[i] = (float)NUM2DBL(scale);
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const int32_t res = llama_set_adapters_lora(context_wrapper->context, adapters_, n_adapters, scales_);
  RB_GC_GUARD(ctx);
  RB_GC_GUARD(adapters);
  RB_GC_GUARD(scales);
  return NUM2INT(res);
}

.llama_set_causal_attn(context, causal_attn) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
 
# File 'ext/llama_cpp/llama_cpp.c', line 2883

static VALUE rb_llama_set_causal_attn(VALUE self, VALUE ctx, VALUE causal_attn) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const bool causal_attn_ = RTEST(causal_attn) ? true : false;
  llama_set_causal_attn(context_wrapper->context, causal_attn_);
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_set_embeddings(context, embeddings) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
 
# File 'ext/llama_cpp/llama_cpp.c', line 2865

static VALUE rb_llama_set_embeddings(VALUE self, VALUE ctx, VALUE embeddings) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const bool embeddings_ = RTEST(embeddings) ? true : false;
  llama_set_embeddings(context_wrapper->context, embeddings_);
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_set_n_threads(context, n_threads, n_threads_batch) ⇒ NilClass

Parameters:

  • context (LlamaContext)
  • n_threads (Integer)
  • n_threads_batch (Integer)

Returns:

  • (NilClass) 


2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
 
# File 'ext/llama_cpp/llama_cpp.c', line 2808

static VALUE rb_llama_set_n_threads(VALUE self, VALUE ctx, VALUE n_threads, VALUE n_threads_batch) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(n_threads)) {
    rb_raise(rb_eArgError, "n_threads must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(n_threads_batch)) {
    rb_raise(rb_eArgError, "n_threads_batch must be an Integer");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  llama_set_n_threads(context_wrapper->context, NUM2INT(n_threads), NUM2INT(n_threads_batch));
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_set_warmup(context, warmup) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
 
# File 'ext/llama_cpp/llama_cpp.c', line 2901

static VALUE rb_llama_set_warmup(VALUE self, VALUE ctx, VALUE warmup) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const bool warmup_ = RTEST(warmup) ? true : false;
  llama_set_warmup(context_wrapper->context, warmup_);
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_state_get_size(context) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
 
# File 'ext/llama_cpp/llama_cpp.c', line 2625

static VALUE rb_llama_state_get_size(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const size_t size = llama_state_get_size(context_wrapper->context);
  RB_GC_GUARD(ctx);
  return SIZET2NUM(size);
}

.llama_state_seq_get_size(context, seq_id) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
 
# File 'ext/llama_cpp/llama_cpp.c', line 2642

static VALUE rb_llama_state_seq_get_size(VALUE self, VALUE ctx, VALUE seq_id) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const size_t size = llama_state_seq_get_size(context_wrapper->context, NUM2INT(seq_id));
  RB_GC_GUARD(ctx);
  return SIZET2NUM(size);
}

.llama_state_seq_get_size_ext(context, seq_id, flags) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
 
# File 'ext/llama_cpp/llama_cpp.c', line 2664

static VALUE rb_llama_state_seq_get_size_ext(VALUE self, VALUE ctx, VALUE seq_id, VALUE flags) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(seq_id)) {
    rb_raise(rb_eArgError, "seq_id must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(flags)) {
    rb_raise(rb_eArgError, "flags must be an Integer");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  const size_t size = llama_state_seq_get_size_ext(context_wrapper->context, NUM2INT(seq_id), (uint32_t)NUM2UINT(flags));
  RB_GC_GUARD(ctx);
  return SIZET2NUM(size);
}

.llama_supports_gpu_offload? ⇒ Boolean

Returns:

  • (Boolean) 


1556
1557
1558
 
# File 'ext/llama_cpp/llama_cpp.c', line 1556

static VALUE rb_llama_supports_gpu_offload(VALUE self) {
  return llama_supports_gpu_offload() ? Qtrue : Qfalse;
}

.llama_supports_mlock? ⇒ Boolean

Returns:

  • (Boolean) 


1548
1549
1550
 
# File 'ext/llama_cpp/llama_cpp.c', line 1548

static VALUE rb_llama_supports_mlock(VALUE self) {
  return llama_supports_mlock() ? Qtrue : Qfalse;
}

.llama_supports_mmap? ⇒ Boolean

Returns:

  • (Boolean) 


1540
1541
1542
 
# File 'ext/llama_cpp/llama_cpp.c', line 1540

static VALUE rb_llama_supports_mmap(VALUE self) {
  return llama_supports_mmap() ? Qtrue : Qfalse;
}

.llama_supports_rpc? ⇒ Boolean

Returns:

  • (Boolean) 


1564
1565
1566
 
# File 'ext/llama_cpp/llama_cpp.c', line 1564

static VALUE rb_llama_supports_rpc(VALUE self) {
  return llama_supports_rpc() ? Qtrue : Qfalse;
}

.llama_synchronize(context) ⇒ NilClass

Parameters:

Returns:

  • (NilClass) 


2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
 
# File 'ext/llama_cpp/llama_cpp.c', line 2918

static VALUE rb_llama_synchronize(VALUE self, VALUE ctx) {
  if (!rb_obj_is_kind_of(ctx, rb_cLlamaContext)) {
    rb_raise(rb_eArgError, "ctx must be a LlamaContext");
    return Qnil;
  }
  llama_context_wrapper* context_wrapper = get_llama_context_wrapper(ctx);
  llama_synchronize(context_wrapper->context);
  RB_GC_GUARD(ctx);
  return Qnil;
}

.llama_time_us ⇒ Integer

Returns:

  • (Integer) 


1508
1509
1510
 
# File 'ext/llama_cpp/llama_cpp.c', line 1508

static VALUE rb_llama_time_us(VALUE self) {
  return LONG2NUM(llama_time_us());
}

.llama_token_to_piece(vocab, token, lstrip, special) ⇒ String

Parameters:

  • vocab (LlamaVocab)
  • token (Integer)
  • lstrip (Integer)
  • special (Boolean)

Returns:

  • (String) 


3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
 
# File 'ext/llama_cpp/llama_cpp.c', line 3368

static VALUE rb_llama_token_to_piece(VALUE self, VALUE vocab, VALUE token, VALUE lstrip, VALUE special) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(lstrip)) {
    rb_raise(rb_eArgError, "lstrip must be an Integer");
    return Qnil;
  }

  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  llama_token token_ = NUM2INT(token);
  const int32_t lstrip_ = NUM2INT(lstrip);
  const bool special_ = RTEST(special) ? true : false;
  char *buf = (char*)ruby_xmalloc(sizeof(char) * 8);
  const int32_t n_tokens = llama_token_to_piece(vocab_wrapper->vocab, token_, buf, 8, lstrip_, special_);

  if (n_tokens < 0) {
    ruby_xfree(buf);
    buf = (char*)ruby_xmalloc(sizeof(char) * -n_tokens);
    const int32_t check = llama_token_to_piece(vocab_wrapper->vocab, token_, buf, -n_tokens, lstrip_, special_);
    if (check != -n_tokens) {
      ruby_xfree(buf);
      rb_raise(rb_eRuntimeError, "Failed to convert");
      return Qnil;
    }
  }

  VALUE ret = rb_utf8_str_new_cstr(buf);
  ruby_xfree(buf);
  RB_GC_GUARD(vocab);

  return ret;
}

.llama_tokenize(vocab, text, tokens, n_tokens_max, add_special, parse_special) ⇒ Integer

Parameters:

  • vocab (LlamaVocab)
  • text (String)
  • tokens (Array<Integer>)
  • n_tokens_max (Integer)
  • add_special (Boolean)
  • parse_special (Boolean)

Returns:

  • (Integer) 


3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
 
# File 'ext/llama_cpp/llama_cpp.c', line 3300

static VALUE rb_llama_tokenize(VALUE self, VALUE vocab, VALUE text, VALUE tokens, VALUE n_tokens_max, VALUE add_special, VALUE parse_special) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_TYPE_P(text, T_STRING)) {
    rb_raise(rb_eArgError, "text must be a String");
    return Qnil;
  }
  if (!RB_TYPE_P(tokens, T_ARRAY)) {
    rb_raise(rb_eArgError, "tokens must be an Array");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(n_tokens_max)) {
    rb_raise(rb_eArgError, "n_tokens_max must be an Integer");
    return Qnil;
  }

  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const char* text_ = StringValueCStr(text);
  const int32_t text_len = (int32_t)strlen(text_);
  int32_t n_tokens_max_ = NUM2INT(n_tokens_max);
  const bool add_special_ = RTEST(add_special) ? true : false;
  const bool parse_special_ = RTEST(parse_special) ? true : false;

  if (text_len <= 0) {
    rb_raise(rb_eArgError, "text must not be empty");
    return Qnil;
  }

  llama_token* tokens_ = n_tokens_max <= 0 ? NULL : ALLOCA_N(llama_token, n_tokens_max);
  const int32_t sz_tokens = (int32_t)RARRAY_LEN(tokens);

  for (int32_t i = 0; i < n_tokens_max_; i++) {
    if (i >= sz_tokens) break;
    VALUE token = rb_ary_entry(tokens, i);
    if (!RB_INTEGER_TYPE_P(token)) {
      rb_raise(rb_eArgError, "tokens must be an Array of Integers");
      return Qnil;
    }
    tokens_[i] = NUM2INT(token);
  }

  const int32_t n_tokens = llama_tokenize(vocab_wrapper->vocab, text_, text_len, tokens_, n_tokens_max_, add_special_, parse_special_);

  if (n_tokens < 0) {
    return INT2NUM(n_tokens);
  }

  rb_ary_resize(tokens, n_tokens);
  for (int i = 0; i < n_tokens; i++) {
    rb_ary_store(tokens, i, INT2NUM(tokens_[i]));
  }

  RB_GC_GUARD(vocab);
  RB_GC_GUARD(text);

  return INT2NUM(n_tokens);
}

.llama_vocab_bos(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
 
# File 'ext/llama_cpp/llama_cpp.c', line 3039

static VALUE rb_llama_vocab_bos(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_bos(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_eos(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
 
# File 'ext/llama_cpp/llama_cpp.c', line 3055

static VALUE rb_llama_vocab_eos(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_eos(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_eot(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
 
# File 'ext/llama_cpp/llama_cpp.c', line 3071

static VALUE rb_llama_vocab_eot(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_eot(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_fim_mid(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
 
# File 'ext/llama_cpp/llama_cpp.c', line 3231

static VALUE rb_llama_vocab_fim_mid(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_fim_mid(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_fim_pad(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
 
# File 'ext/llama_cpp/llama_cpp.c', line 3247

static VALUE rb_llama_vocab_fim_pad(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_fim_pad(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_fim_pre(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
 
# File 'ext/llama_cpp/llama_cpp.c', line 3199

static VALUE rb_llama_vocab_fim_pre(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_fim_pre(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_fim_rep(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
 
# File 'ext/llama_cpp/llama_cpp.c', line 3263

static VALUE rb_llama_vocab_fim_rep(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_fim_rep(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_fim_sep(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
 
# File 'ext/llama_cpp/llama_cpp.c', line 3279

static VALUE rb_llama_vocab_fim_sep(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_fim_sep(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_fim_suf(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
 
# File 'ext/llama_cpp/llama_cpp.c', line 3215

static VALUE rb_llama_vocab_fim_suf(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_fim_suf(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_get_add_bos ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
 
# File 'ext/llama_cpp/llama_cpp.c', line 3151

static VALUE rb_llama_vocab_get_add_bos(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const bool flag = llama_vocab_get_add_bos(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return flag ? Qtrue : Qfalse;
}

.llama_vocab_get_add_eos(vocab) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
 
# File 'ext/llama_cpp/llama_cpp.c', line 3167

static VALUE rb_llama_vocab_get_add_eos(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const bool flag = llama_vocab_get_add_eos(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return flag ? Qtrue : Qfalse;
}

.llama_vocab_get_add_sep(vocab) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
 
# File 'ext/llama_cpp/llama_cpp.c', line 3183

static VALUE rb_llama_vocab_get_add_sep(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const bool flag = llama_vocab_get_add_sep(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return flag ? Qtrue : Qfalse;
}

.llama_vocab_get_attr(vocab, token) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'ext/llama_cpp/llama_cpp.c', line 2977

static VALUE rb_llama_vocab_get_attr(VALUE self, VALUE vocab, VALUE token) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t attr = llama_vocab_get_attr(vocab_wrapper->vocab, NUM2INT(token));
  RB_GC_GUARD(vocab);
  return INT2NUM(attr);
}

.llama_vocab_get_score(vocab, token) ⇒ Float

Parameters:

Returns:

  • (Float) 


2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
 
# File 'ext/llama_cpp/llama_cpp.c', line 2956

static VALUE rb_llama_vocab_get_score(VALUE self, VALUE vocab, VALUE token) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const float score = llama_vocab_get_score(vocab_wrapper->vocab, NUM2INT(token));
  RB_GC_GUARD(vocab);
  return DBL2NUM(score);
}

.llama_vocab_get_text(vocab, token) ⇒ String

Parameters:

Returns:

  • (String) 


2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
 
# File 'ext/llama_cpp/llama_cpp.c', line 2935

static VALUE rb_llama_vocab_get_text(VALUE self, VALUE vocab, VALUE token) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const char* text = llama_vocab_get_text(vocab_wrapper->vocab, NUM2INT(token));
  RB_GC_GUARD(vocab);
  return rb_utf8_str_new_cstr(text);
}

.llama_vocab_is_control?(vocab, token) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
 
# File 'ext/llama_cpp/llama_cpp.c', line 3019

static VALUE rb_llama_vocab_is_control(VALUE self, VALUE vocab, VALUE token) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "model must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const bool is_control = llama_vocab_is_control(vocab_wrapper->vocab, NUM2INT(token));
  RB_GC_GUARD(vocab);
  return is_control ? Qtrue : Qfalse;
}

.llama_vocab_is_eog?(vocab, token) ⇒ Boolean

Parameters:

Returns:

  • (Boolean) 


2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
 
# File 'ext/llama_cpp/llama_cpp.c', line 2998

static VALUE rb_llama_vocab_is_eog(VALUE self, VALUE vocab, VALUE token) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  if (!RB_INTEGER_TYPE_P(token)) {
    rb_raise(rb_eArgError, "token must be an Integer");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const bool is_eog = llama_vocab_is_eog(vocab_wrapper->vocab, NUM2INT(token));
  RB_GC_GUARD(vocab);
  return is_eog ? Qtrue : Qfalse;
}

.llama_vocab_mask(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
 
# File 'ext/llama_cpp/llama_cpp.c', line 3135

static VALUE rb_llama_vocab_mask(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_mask(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_n_tokens(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
 
# File 'ext/llama_cpp/llama_cpp.c', line 1912

static VALUE rb_llama_vocab_n_tokens(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  VALUE n_tokens = INT2NUM(llama_vocab_n_tokens(vocab_wrapper->vocab));
  RB_GC_GUARD(vocab);
  return n_tokens;
}

.llama_vocab_nl(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
 
# File 'ext/llama_cpp/llama_cpp.c', line 3103

static VALUE rb_llama_vocab_nl(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_nl(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_pad(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
 
# File 'ext/llama_cpp/llama_cpp.c', line 3119

static VALUE rb_llama_vocab_pad(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_pad(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_sep(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
 
# File 'ext/llama_cpp/llama_cpp.c', line 3087

static VALUE rb_llama_vocab_sep(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  const int32_t token = llama_vocab_sep(vocab_wrapper->vocab);
  RB_GC_GUARD(vocab);
  return INT2NUM(token);
}

.llama_vocab_type(vocab) ⇒ Integer

Parameters:

Returns:

  • (Integer) 


1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
 
# File 'ext/llama_cpp/llama_cpp.c', line 1896

static VALUE rb_llama_vocab_type(VALUE self, VALUE vocab) {
  if (!rb_obj_is_kind_of(vocab, rb_cLlamaVocab)) {
    rb_raise(rb_eArgError, "vocab must be a LlamaVocab");
    return Qnil;
  }
  llama_vocab_wrapper* vocab_wrapper = get_llama_vocab_wrapper(vocab);
  VALUE vt = INT2NUM(llama_vocab_type(vocab_wrapper->vocab));
  RB_GC_GUARD(vocab);
  return vt;
}