llama_cpp 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35afb5cc65c290036ae7e45459eadc9b509f34f33a3f7708244cf47f1a38829f
-  data.tar.gz: 3301158526c63d9d2004e22bda0d1cc8025b4343d8d737df96260786531b074d
+  metadata.gz: 991df3df6b16ec98a203a6c6565794988eec04697ccb963faab976f436e1bfcc
+  data.tar.gz: dafd3b8274640eb79353e11056f497a02392fef332a46dcc1717878c836f62bd
 SHA512:
-  metadata.gz: b0a50f9f012f44f119a70790d3de07c7fcc64151246791e270e4ff9fc479a85a01c53cf2775945eba3145a3ba89da55a8d14891c6236cfeae16aed5ae455cf0d
-  data.tar.gz: ede388584e115ae93d509b6c15b288303c348f3cfe8ea46879a1b69e6c96be31a321edbb52cfbeb309a8fb456738f3f6b7cc1d3f71ce7addbd05b3a1e73d4755
+  metadata.gz: 0a54fdf18c5be5273f01d4d991b59975a8e8b6a0a8f54087fb90df3f1a8a7ebad557d01fb119f3d61cafa8f6c59fb81641624779fda27b732eea2868cb4642e8
+  data.tar.gz: 6574064078070502e36ad933bd5efb2f479c94f47a1260286fe485e48d35a7b3985274943c6163189326891349b47b1d9815d77c600b015fe111cc3842179392

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [[0.3.5](https://github.com/yoshoku/llama_cpp.rb/compare/v0.3.4...v0.3.5)] - 2023-07-29
+
+- Bump bundled llama.cpp from master-d924522 to master-1a94186.
+  - Add `GrammarElement` and `Grammar` classes.
+  - Add `sample_grammar` method to Context.
+  - Add `grammar_accept_token method` method to Context.
+
 ## [[0.3.4](https://github.com/yoshoku/llama_cpp.rb/compare/v0.3.3...v0.3.4)] - 2023-07-23
 
 - Bump bundled llama.cpp from master-32c5411 to master-d924522.

data/ext/llama_cpp/extconf.rb

@@ -85,6 +85,7 @@ if with_config('mpi')
   $CXXFLAGS << ' -DGGML_USE_MPI -Wno-cast-qual'
 end
 
+# @!visibility private
 UNAME_M = RbConfig::CONFIG['build_cpu'] || RbConfig::CONFIG['host_cpu'] || RbConfig::CONFIG['target_cpu']
 
 # rubocop:disable Layout/LineLength

data/ext/llama_cpp/llama_cpp.cpp

@@ -8,6 +8,8 @@ VALUE rb_cLLaMAContextParams;
 VALUE rb_cLLaMAModelQuantizeParams;
 VALUE rb_cLLaMATokenData;
 VALUE rb_cLLaMATokenDataArray;
+VALUE rb_cLLaMAGrammarElement;
+VALUE rb_cLLaMAGrammar;
 
 class LLaMATokenDataWrapper {
 public:
@@ -1057,6 +1059,222 @@ const rb_data_type_t RbLLaMAModel::llama_model_type = {
   RUBY_TYPED_FREE_IMMEDIATELY
 };
 
+class LLaMAGrammarElementWrapper {
+public:
+  llama_grammar_element element;
+
+  LLaMAGrammarElementWrapper() {
+    element.type = LLAMA_GRETYPE_END;
+    element.value = 0;
+  }
+
+  ~LLaMAGrammarElementWrapper() {}
+};
+
+class RbLLaMAGrammarElement {
+public:
+  static VALUE llama_grammar_element_alloc(VALUE self) {
+    LLaMAGrammarElementWrapper* ptr = (LLaMAGrammarElementWrapper*)ruby_xmalloc(sizeof(LLaMAGrammarElementWrapper));
+    new (ptr) LLaMAGrammarElementWrapper();
+    return TypedData_Wrap_Struct(self, &llama_grammar_element_type, ptr);
+  }
+
+  static void llama_grammar_element_free(void* ptr) {
+    ((LLaMAGrammarElementWrapper*)ptr)->~LLaMAGrammarElementWrapper();
+    ruby_xfree(ptr);
+  }
+
+  static size_t llama_grammar_element_size(const void* ptr) {
+    return sizeof(*((LLaMAGrammarElementWrapper*)ptr));
+  }
+
+  static LLaMAGrammarElementWrapper* get_llama_grammar_element(VALUE self) {
+    LLaMAGrammarElementWrapper* ptr;
+    TypedData_Get_Struct(self, LLaMAGrammarElementWrapper, &llama_grammar_element_type, ptr);
+    return ptr;
+  }
+
+  static void define_class(VALUE outer) {
+    rb_cLLaMAGrammarElement = rb_define_class_under(outer, "GrammarElement", rb_cObject);
+    rb_define_alloc_func(rb_cLLaMAGrammarElement, llama_grammar_element_alloc);
+    rb_define_method(rb_cLLaMAGrammarElement, "initialize", RUBY_METHOD_FUNC(_llama_grammar_element_init), -1);
+    rb_define_method(rb_cLLaMAGrammarElement, "type=", RUBY_METHOD_FUNC(_llama_grammar_element_set_type), 1);
+    rb_define_method(rb_cLLaMAGrammarElement, "type", RUBY_METHOD_FUNC(_llama_grammar_element_get_type), 0);
+    rb_define_method(rb_cLLaMAGrammarElement, "value=", RUBY_METHOD_FUNC(_llama_grammar_element_set_value), 1);
+    rb_define_method(rb_cLLaMAGrammarElement, "value", RUBY_METHOD_FUNC(_llama_grammar_element_get_value), 0);
+  }
+
+private:
+  static const rb_data_type_t llama_grammar_element_type;
+
+  static VALUE _llama_grammar_element_init(int argc, VALUE* argv, VALUE self) {
+    VALUE kw_args = Qnil;
+    ID kw_table[2] = { rb_intern("type"), rb_intern("value") };
+    VALUE kw_values[2] = { Qundef, Qundef };
+    VALUE arr = Qnil;
+    rb_scan_args(argc, argv, ":", &arr, &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 0, 2, kw_values);
+
+    if (kw_values[0] != Qundef && !RB_INTEGER_TYPE_P(kw_values[0])) {
+      rb_raise(rb_eArgError, "type must be an integer");
+      return Qnil;
+    }
+    if (kw_values[1] != Qundef && !RB_INTEGER_TYPE_P(kw_values[1])) {
+      rb_raise(rb_eArgError, "value must be an integer");
+      return Qnil;
+    }
+
+    LLaMAGrammarElementWrapper* ptr = get_llama_grammar_element(self);
+    new (ptr) LLaMAGrammarElementWrapper();
+
+    if (kw_values[0] != Qundef) {
+      ptr->element.type = (enum llama_gretype)NUM2INT(kw_values[0]);
+    }
+    if (kw_values[1] != Qundef) {
+      ptr->element.value = NUM2INT(kw_values[1]);
+    }
+
+    return self;
+  }
+
+  // type
+  static VALUE _llama_grammar_element_set_type(VALUE self, VALUE type) {
+    LLaMAGrammarElementWrapper* ptr = get_llama_grammar_element(self);
+    ptr->element.type = (enum llama_gretype)NUM2INT(type);
+    return INT2NUM(ptr->element.type);
+  }
+
+  static VALUE _llama_grammar_element_get_type(VALUE self) {
+    LLaMAGrammarElementWrapper* ptr = get_llama_grammar_element(self);
+    return INT2NUM(ptr->element.type);
+  }
+
+  // value
+  static VALUE _llama_grammar_element_set_value(VALUE self, VALUE type) {
+    LLaMAGrammarElementWrapper* ptr = get_llama_grammar_element(self);
+    ptr->element.value = NUM2INT(type);
+    return INT2NUM(ptr->element.value);
+  }
+
+  static VALUE _llama_grammar_element_get_value(VALUE self) {
+    LLaMAGrammarElementWrapper* ptr = get_llama_grammar_element(self);
+    return INT2NUM(ptr->element.value);
+  }
+};
+
+const rb_data_type_t RbLLaMAGrammarElement::llama_grammar_element_type = {
+  "RbLLaMAGrammarElement",
+  { NULL,
+    RbLLaMAGrammarElement::llama_grammar_element_free,
+    RbLLaMAGrammarElement::llama_grammar_element_size },
+  NULL,
+  NULL,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+class LLaMAGrammarWrapper {
+public:
+  struct llama_grammar* grammar;
+
+  LLaMAGrammarWrapper() : grammar(nullptr) {}
+
+  ~LLaMAGrammarWrapper() {
+    if (grammar) {
+      llama_grammar_free(grammar);
+    }
+  }
+};
+
+class RbLLaMAGrammar {
+public:
+  static VALUE llama_grammar_alloc(VALUE self) {
+    LLaMAGrammarWrapper* ptr = (LLaMAGrammarWrapper*)ruby_xmalloc(sizeof(LLaMAGrammarWrapper));
+    new (ptr) LLaMAGrammarWrapper();
+    return TypedData_Wrap_Struct(self, &llama_grammar_type, ptr);
+  }
+
+  static void llama_grammar_free(void* ptr) {
+    ((LLaMAGrammarWrapper*)ptr)->~LLaMAGrammarWrapper();
+    ruby_xfree(ptr);
+  }
+
+  static size_t llama_grammar_size(const void* ptr) {
+    return sizeof(*((LLaMAGrammarWrapper*)ptr));
+  }
+
+  static LLaMAGrammarWrapper* get_llama_grammar(VALUE self) {
+    LLaMAGrammarWrapper* ptr;
+    TypedData_Get_Struct(self, LLaMAGrammarWrapper, &llama_grammar_type, ptr);
+    return ptr;
+  }
+
+  static void define_class(VALUE outer) {
+    rb_cLLaMAGrammar = rb_define_class_under(outer, "Grammar", rb_cObject);
+    rb_define_alloc_func(rb_cLLaMAGrammar, llama_grammar_alloc);
+    rb_define_method(rb_cLLaMAGrammar, "initialize", RUBY_METHOD_FUNC(_llama_grammar_init), -1);
+  }
+
+private:
+  static const rb_data_type_t llama_grammar_type;
+
+  static VALUE _llama_grammar_init(int argc, VALUE* argv, VALUE self) {
+    VALUE kw_args = Qnil;
+    ID kw_table[2] = { rb_intern("rules"), rb_intern("start_rule_index") };
+    VALUE kw_values[2] = { Qundef, Qundef };
+    rb_scan_args(argc, argv, ":", &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 2, 0, kw_values);
+
+    if (!RB_TYPE_P(kw_values[0], T_ARRAY)) {
+      rb_raise(rb_eArgError, "rules must be an array");
+      return Qnil;
+    }
+    if (!RB_INTEGER_TYPE_P(kw_values[1])) {
+      rb_raise(rb_eArgError, "start_rule_index must be an integer");
+      return Qnil;
+    }
+
+    const int n_rules = RARRAY_LEN(kw_values[0]);
+    llama_grammar_element** rules = ALLOCA_N(llama_grammar_element*, n_rules);
+    for (int i = 0; i < n_rules; ++i) {
+      VALUE rule = rb_ary_entry(kw_values[0], i);
+      if (!RB_TYPE_P(rule, T_ARRAY)) {
+        rb_raise(rb_eArgError, "element of rules must be an array");
+        return Qnil;
+      }
+      const int n_elements = RARRAY_LEN(rule);
+      llama_grammar_element* elements = ALLOCA_N(llama_grammar_element, n_elements);
+      for (int j = 0; j < n_elements; ++j) {
+        VALUE element = rb_ary_entry(rule, j);
+        if (!rb_obj_is_kind_of(element, rb_cLLaMAGrammarElement)) {
+          rb_raise(rb_eArgError, "element of rule must be an instance of GrammarElement");
+          return Qnil;
+        }
+        LLaMAGrammarElementWrapper* ptr = RbLLaMAGrammarElement::get_llama_grammar_element(element);
+        elements[j] = ptr->element;
+      }
+      rules[i] = elements;
+    }
+
+    const size_t start_rule_index = NUM2SIZET(kw_values[1]);
+
+    LLaMAGrammarWrapper* ptr = get_llama_grammar(self);
+    new (ptr) LLaMAGrammarWrapper();
+    ptr->grammar = llama_grammar_init((const llama_grammar_element**)rules, n_rules, start_rule_index);
+
+    return self;
+  }
+};
+
+const rb_data_type_t RbLLaMAGrammar::llama_grammar_type = {
+  "RbLLaMAGrammar",
+  { NULL,
+    RbLLaMAGrammar::llama_grammar_free,
+    RbLLaMAGrammar::llama_grammar_size },
+  NULL,
+  NULL,
+  RUBY_TYPED_FREE_IMMEDIATELY
+};
+
 class LLaMAContextWrapper {
 public:
   struct llama_context* ctx;
@@ -1128,6 +1346,8 @@ public:
     rb_define_method(rb_cLLaMAContext, "sample_token_mirostat_v2", RUBY_METHOD_FUNC(_llama_context_sample_token_mirostat_v2), -1);
     rb_define_method(rb_cLLaMAContext, "sample_token_greedy", RUBY_METHOD_FUNC(_llama_context_sample_token_greedy), 1);
     rb_define_method(rb_cLLaMAContext, "sample_token", RUBY_METHOD_FUNC(_llama_context_sample_token), 1);
+    rb_define_method(rb_cLLaMAContext, "sample_grammar", RUBY_METHOD_FUNC(_llama_context_sample_grammar), -1);
+    rb_define_method(rb_cLLaMAContext, "grammar_accept_token", RUBY_METHOD_FUNC(_llama_context_grammar_accept_token), -1);
   }
 
 private:
@@ -2104,6 +2324,69 @@ private:
     llama_token id = llama_sample_token(ctx_ptr->ctx, &(cnd_ptr->array));
     return INT2NUM(id);
   }
+
+  static VALUE _llama_context_sample_grammar(int argc, VALUE* argv, VALUE self) {
+    VALUE kw_args = Qnil;
+    ID kw_table[1] = { rb_intern("grammar") };
+    VALUE kw_values[1] = { Qundef };
+    VALUE candidates = Qnil;
+    rb_scan_args(argc, argv, "1:", &candidates, &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 1, 0, kw_values);
+
+    if (!rb_obj_is_kind_of(candidates, rb_cLLaMATokenDataArray)) {
+      rb_raise(rb_eArgError, "1st argument must be a TokenDataArray");
+      return Qnil;
+    }
+    if (!rb_obj_is_kind_of(kw_values[0], rb_cLLaMAGrammar)) {
+      rb_raise(rb_eArgError, "grammar must be a Grammar");
+      return Qnil;
+    }
+
+    LLaMAContextWrapper* ctx_ptr = get_llama_context(self);
+    if (ctx_ptr->ctx == NULL) {
+      rb_raise(rb_eRuntimeError, "LLaMA context is not initialized");
+      return Qnil;
+    }
+    LLaMATokenDataArrayWrapper* cnd_ptr = RbLLaMATokenDataArray::get_llama_token_data_array(candidates);
+    if (cnd_ptr->array.data == nullptr) {
+      rb_raise(rb_eRuntimeError, "TokenDataArray is empty");
+      return Qnil;
+    }
+    LLaMAGrammarWrapper* grm_ptr = RbLLaMAGrammar::get_llama_grammar(kw_values[0]);
+
+    llama_sample_grammar(ctx_ptr->ctx, &(cnd_ptr->array), grm_ptr->grammar);
+
+    return Qnil;
+  }
+
+  static VALUE _llama_context_grammar_accept_token(int argc, VALUE* argv, VALUE self) {
+    VALUE kw_args = Qnil;
+    ID kw_table[2] = { rb_intern("grammar"), rb_intern("token") };
+    VALUE kw_values[2] = { Qundef, Qundef };
+    rb_scan_args(argc, argv, ":", &kw_args);
+    rb_get_kwargs(kw_args, kw_table, 2, 0, kw_values);
+
+    if (!rb_obj_is_kind_of(kw_values[0], rb_cLLaMAGrammar)) {
+      rb_raise(rb_eArgError, "grammar must be a Grammar");
+      return Qnil;
+    }
+    if (!RB_INTEGER_TYPE_P(kw_values[1])) {
+      rb_raise(rb_eArgError, "token must be an Integer");
+      return Qnil;
+    }
+
+    LLaMAContextWrapper* ctx_ptr = get_llama_context(self);
+    if (ctx_ptr->ctx == NULL) {
+      rb_raise(rb_eRuntimeError, "LLaMA context is not initialized");
+      return Qnil;
+    }
+    LLaMAGrammarWrapper* grm_ptr = RbLLaMAGrammar::get_llama_grammar(kw_values[0]);
+    llama_token token = NUM2INT(kw_values[1]);
+
+    llama_grammar_accept_token(ctx_ptr->ctx, grm_ptr->grammar, token);
+
+    return Qnil;
+  }
 };
 
 const rb_data_type_t RbLLaMAContext::llama_context_type = {
@@ -2208,6 +2491,8 @@ extern "C" void Init_llama_cpp(void) {
   RbLLaMAContext::define_class(rb_mLLaMACpp);
   RbLLaMAContextParams::define_class(rb_mLLaMACpp);
   RbLLaMAModelQuantizeParams::define_class(rb_mLLaMACpp);
+  RbLLaMAGrammarElement::define_class(rb_mLLaMACpp);
+  RbLLaMAGrammar::define_class(rb_mLLaMACpp);
 
   rb_define_module_function(rb_mLLaMACpp, "backend_init", rb_llama_llama_backend_init, -1);
   rb_define_module_function(rb_mLLaMACpp, "backend_free", rb_llama_llama_backend_free, 0);
@@ -2240,6 +2525,14 @@ extern "C" void Init_llama_cpp(void) {
   rb_define_const(rb_mLLaMACpp, "LLAMA_FTYPE_MOSTLY_Q5_K_M", INT2NUM(LLAMA_FTYPE_MOSTLY_Q5_K_M));
   rb_define_const(rb_mLLaMACpp, "LLAMA_FTYPE_MOSTLY_Q6_K", INT2NUM(LLAMA_FTYPE_MOSTLY_Q6_K));
 
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_END", INT2NUM(LLAMA_GRETYPE_END));
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_ALT", INT2NUM(LLAMA_GRETYPE_ALT));
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_RULE_REF", INT2NUM(LLAMA_GRETYPE_RULE_REF));
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_CHAR", INT2NUM(LLAMA_GRETYPE_CHAR));
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_CHAR_NOT", INT2NUM(LLAMA_GRETYPE_CHAR_NOT));
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_CHAR_RNG_UPPER", INT2NUM(LLAMA_GRETYPE_CHAR_RNG_UPPER));
+  rb_define_const(rb_mLLaMACpp, "LLAMA_GRETYPE_CHAR_ALT", INT2NUM(LLAMA_GRETYPE_CHAR_ALT));
+
   std::stringstream ss_magic;
   ss_magic << std::showbase << std::hex << LLAMA_FILE_MAGIC_GGJT;
   rb_define_const(rb_mLLaMACpp, "LLAMA_FILE_MAGIC_GGJT", rb_str_new2(ss_magic.str().c_str()));