llama.h 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145
  1. #ifndef LLAMA_H
  2. #define LLAMA_H
  3. #include "ggml.h"
  4. #include "ggml-backend.h"
  5. #include <stddef.h>
  6. #include <stdint.h>
  7. #include <stdio.h>
  8. #include <stdbool.h>
  9. #ifdef LLAMA_SHARED
  10. # if defined(_WIN32) && !defined(__MINGW32__)
  11. # ifdef LLAMA_BUILD
  12. # define LLAMA_API __declspec(dllexport)
  13. # else
  14. # define LLAMA_API __declspec(dllimport)
  15. # endif
  16. # else
  17. # define LLAMA_API __attribute__ ((visibility ("default")))
  18. # endif
  19. #else
  20. # define LLAMA_API
  21. #endif
  22. #ifdef __GNUC__
  23. # define DEPRECATED(func, hint) func __attribute__((deprecated(hint)))
  24. #elif defined(_MSC_VER)
  25. # define DEPRECATED(func, hint) __declspec(deprecated(hint)) func
  26. #else
  27. # define DEPRECATED(func, hint) func
  28. #endif
  29. #define LLAMA_DEFAULT_SEED 0xFFFFFFFF
  30. #define LLAMA_MAX_RNG_STATE (64*1024)
  31. #define LLAMA_FILE_MAGIC_GGLA 0x67676c61u // 'ggla'
  32. #define LLAMA_FILE_MAGIC_GGSN 0x6767736eu // 'ggsn'
  33. #define LLAMA_FILE_MAGIC_GGSQ 0x67677371u // 'ggsq'
  34. #define LLAMA_SESSION_MAGIC LLAMA_FILE_MAGIC_GGSN
  35. #define LLAMA_SESSION_VERSION 6
  36. #define LLAMA_STATE_SEQ_MAGIC LLAMA_FILE_MAGIC_GGSQ
  37. #define LLAMA_STATE_SEQ_VERSION 1
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. //
  42. // C interface
  43. //
  44. // TODO: show sample usage
  45. //
  46. struct llama_model;
  47. struct llama_context;
  48. typedef int32_t llama_pos;
  49. typedef int32_t llama_token;
  50. typedef int32_t llama_seq_id;
  51. enum llama_vocab_type {
  52. LLAMA_VOCAB_TYPE_NONE = 0, // For models without vocab
  53. LLAMA_VOCAB_TYPE_SPM = 1, // LLaMA tokenizer based on byte-level BPE with byte fallback
  54. LLAMA_VOCAB_TYPE_BPE = 2, // GPT-2 tokenizer based on byte-level BPE
  55. LLAMA_VOCAB_TYPE_WPM = 3, // BERT tokenizer based on WordPiece
  56. };
  57. // pre-tokenization types
  58. enum llama_vocab_pre_type {
  59. LLAMA_VOCAB_PRE_TYPE_DEFAULT = 0,
  60. LLAMA_VOCAB_PRE_TYPE_LLAMA3 = 1,
  61. LLAMA_VOCAB_PRE_TYPE_DEEPSEEK_LLM = 2,
  62. LLAMA_VOCAB_PRE_TYPE_DEEPSEEK_CODER = 3,
  63. LLAMA_VOCAB_PRE_TYPE_FALCON = 4,
  64. LLAMA_VOCAB_PRE_TYPE_MPT = 5,
  65. LLAMA_VOCAB_PRE_TYPE_STARCODER = 6,
  66. LLAMA_VOCAB_PRE_TYPE_GPT2 = 7,
  67. LLAMA_VOCAB_PRE_TYPE_REFACT = 8,
  68. LLAMA_VOCAB_PRE_TYPE_COMMAND_R = 9,
  69. };
  70. // note: these values should be synchronized with ggml_rope
  71. // TODO: maybe move this enum to ggml.h (ggml_rope_type)
  72. enum llama_rope_type {
  73. LLAMA_ROPE_TYPE_NONE = -1,
  74. LLAMA_ROPE_TYPE_NORM = 0,
  75. LLAMA_ROPE_TYPE_NEOX = 2,
  76. LLAMA_ROPE_TYPE_GLM = 4,
  77. };
  78. enum llama_token_type {
  79. LLAMA_TOKEN_TYPE_UNDEFINED = 0,
  80. LLAMA_TOKEN_TYPE_NORMAL = 1,
  81. LLAMA_TOKEN_TYPE_UNKNOWN = 2,
  82. LLAMA_TOKEN_TYPE_CONTROL = 3,
  83. LLAMA_TOKEN_TYPE_USER_DEFINED = 4,
  84. LLAMA_TOKEN_TYPE_UNUSED = 5,
  85. LLAMA_TOKEN_TYPE_BYTE = 6,
  86. };
  87. // model file types
  88. enum llama_ftype {
  89. LLAMA_FTYPE_ALL_F32 = 0,
  90. LLAMA_FTYPE_MOSTLY_F16 = 1, // except 1d tensors
  91. LLAMA_FTYPE_MOSTLY_Q4_0 = 2, // except 1d tensors
  92. LLAMA_FTYPE_MOSTLY_Q4_1 = 3, // except 1d tensors
  93. LLAMA_FTYPE_MOSTLY_Q4_1_SOME_F16 = 4, // tok_embeddings.weight and output.weight are F16
  94. // LLAMA_FTYPE_MOSTLY_Q4_2 = 5, // support has been removed
  95. // LLAMA_FTYPE_MOSTLY_Q4_3 = 6, // support has been removed
  96. LLAMA_FTYPE_MOSTLY_Q8_0 = 7, // except 1d tensors
  97. LLAMA_FTYPE_MOSTLY_Q5_0 = 8, // except 1d tensors
  98. LLAMA_FTYPE_MOSTLY_Q5_1 = 9, // except 1d tensors
  99. LLAMA_FTYPE_MOSTLY_Q2_K = 10, // except 1d tensors
  100. LLAMA_FTYPE_MOSTLY_Q3_K_S = 11, // except 1d tensors
  101. LLAMA_FTYPE_MOSTLY_Q3_K_M = 12, // except 1d tensors
  102. LLAMA_FTYPE_MOSTLY_Q3_K_L = 13, // except 1d tensors
  103. LLAMA_FTYPE_MOSTLY_Q4_K_S = 14, // except 1d tensors
  104. LLAMA_FTYPE_MOSTLY_Q4_K_M = 15, // except 1d tensors
  105. LLAMA_FTYPE_MOSTLY_Q5_K_S = 16, // except 1d tensors
  106. LLAMA_FTYPE_MOSTLY_Q5_K_M = 17, // except 1d tensors
  107. LLAMA_FTYPE_MOSTLY_Q6_K = 18, // except 1d tensors
  108. LLAMA_FTYPE_MOSTLY_IQ2_XXS = 19, // except 1d tensors
  109. LLAMA_FTYPE_MOSTLY_IQ2_XS = 20, // except 1d tensors
  110. LLAMA_FTYPE_MOSTLY_Q2_K_S = 21, // except 1d tensors
  111. LLAMA_FTYPE_MOSTLY_IQ3_XS = 22, // except 1d tensors
  112. LLAMA_FTYPE_MOSTLY_IQ3_XXS = 23, // except 1d tensors
  113. LLAMA_FTYPE_MOSTLY_IQ1_S = 24, // except 1d tensors
  114. LLAMA_FTYPE_MOSTLY_IQ4_NL = 25, // except 1d tensors
  115. LLAMA_FTYPE_MOSTLY_IQ3_S = 26, // except 1d tensors
  116. LLAMA_FTYPE_MOSTLY_IQ3_M = 27, // except 1d tensors
  117. LLAMA_FTYPE_MOSTLY_IQ2_S = 28, // except 1d tensors
  118. LLAMA_FTYPE_MOSTLY_IQ2_M = 29, // except 1d tensors
  119. LLAMA_FTYPE_MOSTLY_IQ4_XS = 30, // except 1d tensors
  120. LLAMA_FTYPE_MOSTLY_IQ1_M = 31, // except 1d tensors
  121. LLAMA_FTYPE_GUESSED = 1024, // not specified in the model file
  122. };
  123. enum llama_rope_scaling_type {
  124. LLAMA_ROPE_SCALING_TYPE_UNSPECIFIED = -1,
  125. LLAMA_ROPE_SCALING_TYPE_NONE = 0,
  126. LLAMA_ROPE_SCALING_TYPE_LINEAR = 1,
  127. LLAMA_ROPE_SCALING_TYPE_YARN = 2,
  128. LLAMA_ROPE_SCALING_TYPE_MAX_VALUE = LLAMA_ROPE_SCALING_TYPE_YARN,
  129. };
  130. enum llama_pooling_type {
  131. LLAMA_POOLING_TYPE_UNSPECIFIED = -1,
  132. LLAMA_POOLING_TYPE_NONE = 0,
  133. LLAMA_POOLING_TYPE_MEAN = 1,
  134. LLAMA_POOLING_TYPE_CLS = 2,
  135. };
  136. enum llama_split_mode {
  137. LLAMA_SPLIT_MODE_NONE = 0, // single GPU
  138. LLAMA_SPLIT_MODE_LAYER = 1, // split layers and KV across GPUs
  139. LLAMA_SPLIT_MODE_ROW = 2, // split rows across GPUs
  140. };
  141. typedef struct llama_token_data {
  142. llama_token id; // token id
  143. float logit; // log-odds of the token
  144. float p; // probability of the token
  145. } llama_token_data;
  146. typedef struct llama_token_data_array {
  147. llama_token_data * data;
  148. size_t size;
  149. bool sorted;
  150. } llama_token_data_array;
  151. typedef bool (*llama_progress_callback)(float progress, void * user_data);
  152. // Input data for llama_decode
  153. // A llama_batch object can contain input about one or many sequences
  154. // The provided arrays (i.e. token, embd, pos, etc.) must have size of n_tokens
  155. //
  156. // - token : the token ids of the input (used when embd is NULL)
  157. // - embd : token embeddings (i.e. float vector of size n_embd) (used when token is NULL)
  158. // - pos : the positions of the respective token in the sequence
  159. // - seq_id : the sequence to which the respective token belongs
  160. // - logits : if zero, the logits (and/or the embeddings) for the respective token will not be output
  161. //
  162. typedef struct llama_batch {
  163. int32_t n_tokens;
  164. llama_token * token;
  165. float * embd;
  166. llama_pos * pos;
  167. int32_t * n_seq_id;
  168. llama_seq_id ** seq_id;
  169. int8_t * logits; // TODO: rename this to "output"
  170. // NOTE: helpers for smooth API transition - can be deprecated in the future
  171. // for future-proof code, use the above fields instead and ignore everything below
  172. //
  173. // pos[i] = all_pos_0 + i*all_pos_1
  174. //
  175. llama_pos all_pos_0; // used if pos == NULL
  176. llama_pos all_pos_1; // used if pos == NULL
  177. llama_seq_id all_seq_id; // used if seq_id == NULL
  178. } llama_batch;
  179. enum llama_model_kv_override_type {
  180. LLAMA_KV_OVERRIDE_TYPE_INT,
  181. LLAMA_KV_OVERRIDE_TYPE_FLOAT,
  182. LLAMA_KV_OVERRIDE_TYPE_BOOL,
  183. LLAMA_KV_OVERRIDE_TYPE_STR,
  184. };
  185. struct llama_model_kv_override {
  186. enum llama_model_kv_override_type tag;
  187. char key[128];
  188. union {
  189. int64_t val_i64;
  190. double val_f64;
  191. bool val_bool;
  192. char val_str[128];
  193. };
  194. };
  195. struct llama_model_params {
  196. int32_t n_gpu_layers; // number of layers to store in VRAM
  197. enum llama_split_mode split_mode; // how to split the model across multiple GPUs
  198. // main_gpu interpretation depends on split_mode:
  199. // LLAMA_SPLIT_NONE: the GPU that is used for the entire model
  200. // LLAMA_SPLIT_ROW: the GPU that is used for small tensors and intermediate results
  201. // LLAMA_SPLIT_LAYER: ignored
  202. int32_t main_gpu;
  203. // proportion of the model (layers or rows) to offload to each GPU, size: llama_max_devices()
  204. const float * tensor_split;
  205. // Called with a progress value between 0.0 and 1.0. Pass NULL to disable.
  206. // If the provided progress_callback returns true, model loading continues.
  207. // If it returns false, model loading is immediately aborted.
  208. llama_progress_callback progress_callback;
  209. // context pointer passed to the progress callback
  210. void * progress_callback_user_data;
  211. // override key-value pairs of the model meta data
  212. const struct llama_model_kv_override * kv_overrides;
  213. // Keep the booleans together to avoid misalignment during copy-by-value.
  214. bool vocab_only; // only load the vocabulary, no weights
  215. bool use_mmap; // use mmap if possible
  216. bool use_mlock; // force system to keep model in RAM
  217. bool check_tensors; // validate model tensor data
  218. };
  219. struct llama_context_params {
  220. uint32_t seed; // RNG seed, -1 for random
  221. uint32_t n_ctx; // text context, 0 = from model
  222. uint32_t n_batch; // logical maximum batch size that can be submitted to llama_decode
  223. uint32_t n_ubatch; // physical maximum batch size
  224. uint32_t n_seq_max; // max number of sequences (i.e. distinct states for recurrent models)
  225. uint32_t n_threads; // number of threads to use for generation
  226. uint32_t n_threads_batch; // number of threads to use for batch processing
  227. enum llama_rope_scaling_type rope_scaling_type; // RoPE scaling type, from `enum llama_rope_scaling_type`
  228. enum llama_pooling_type pooling_type; // whether to pool (sum) embedding results by sequence id
  229. // (ignored if no pooling layer)
  230. // ref: https://github.com/ggerganov/llama.cpp/pull/2054
  231. float rope_freq_base; // RoPE base frequency, 0 = from model
  232. float rope_freq_scale; // RoPE frequency scaling factor, 0 = from model
  233. float yarn_ext_factor; // YaRN extrapolation mix factor, negative = from model
  234. float yarn_attn_factor; // YaRN magnitude scaling factor
  235. float yarn_beta_fast; // YaRN low correction dim
  236. float yarn_beta_slow; // YaRN high correction dim
  237. uint32_t yarn_orig_ctx; // YaRN original context size
  238. float defrag_thold; // defragment the KV cache if holes/size > thold, < 0 disabled (default)
  239. ggml_backend_sched_eval_callback cb_eval;
  240. void * cb_eval_user_data;
  241. enum ggml_type type_k; // data type for K cache
  242. enum ggml_type type_v; // data type for V cache
  243. // Keep the booleans together to avoid misalignment during copy-by-value.
  244. bool logits_all; // the llama_decode() call computes all logits, not just the last one (DEPRECATED - set llama_batch.logits instead)
  245. bool embeddings; // if true, extract embeddings (together with logits)
  246. bool offload_kqv; // whether to offload the KQV ops (including the KV cache) to GPU
  247. bool flash_attn; // whether to use flash attention
  248. // Abort callback
  249. // if it returns true, execution of llama_decode() will be aborted
  250. // currently works only with CPU execution
  251. ggml_abort_callback abort_callback;
  252. void * abort_callback_data;
  253. };
  254. // model quantization parameters
  255. typedef struct llama_model_quantize_params {
  256. int32_t nthread; // number of threads to use for quantizing, if <=0 will use std::thread::hardware_concurrency()
  257. enum llama_ftype ftype; // quantize to this llama_ftype
  258. enum ggml_type output_tensor_type; // output tensor type
  259. enum ggml_type token_embedding_type; // itoken embeddings tensor type
  260. bool allow_requantize; // allow quantizing non-f32/f16 tensors
  261. bool quantize_output_tensor; // quantize output.weight
  262. bool only_copy; // only copy tensors - ftype, allow_requantize and quantize_output_tensor are ignored
  263. bool pure; // quantize all tensors to the default type
  264. bool keep_split; // quantize to the same number of shards
  265. void * imatrix; // pointer to importance matrix data
  266. void * kv_overrides; // pointer to vector containing overrides
  267. } llama_model_quantize_params;
  268. // grammar types
  269. struct llama_grammar;
  270. // grammar element type
  271. enum llama_gretype {
  272. // end of rule definition
  273. LLAMA_GRETYPE_END = 0,
  274. // start of alternate definition for rule
  275. LLAMA_GRETYPE_ALT = 1,
  276. // non-terminal element: reference to rule
  277. LLAMA_GRETYPE_RULE_REF = 2,
  278. // terminal element: character (code point)
  279. LLAMA_GRETYPE_CHAR = 3,
  280. // inverse char(s) ([^a], [^a-b] [^abc])
  281. LLAMA_GRETYPE_CHAR_NOT = 4,
  282. // modifies a preceding LLAMA_GRETYPE_CHAR or LLAMA_GRETYPE_CHAR_ALT to
  283. // be an inclusive range ([a-z])
  284. LLAMA_GRETYPE_CHAR_RNG_UPPER = 5,
  285. // modifies a preceding LLAMA_GRETYPE_CHAR or
  286. // LLAMA_GRETYPE_CHAR_RNG_UPPER to add an alternate char to match ([ab], [a-zA])
  287. LLAMA_GRETYPE_CHAR_ALT = 6,
  288. };
  289. typedef struct llama_grammar_element {
  290. enum llama_gretype type;
  291. uint32_t value; // Unicode code point or rule ID
  292. } llama_grammar_element;
  293. // performance timing information
  294. struct llama_timings {
  295. double t_start_ms;
  296. double t_end_ms;
  297. double t_load_ms;
  298. double t_sample_ms;
  299. double t_p_eval_ms;
  300. double t_eval_ms;
  301. int32_t n_sample;
  302. int32_t n_p_eval;
  303. int32_t n_eval;
  304. };
  305. // used in chat template
  306. typedef struct llama_chat_message {
  307. const char * role;
  308. const char * content;
  309. } llama_chat_message;
  310. // Helpers for getting default parameters
  311. LLAMA_API struct llama_model_params llama_model_default_params(void);
  312. LLAMA_API struct llama_context_params llama_context_default_params(void);
  313. LLAMA_API struct llama_model_quantize_params llama_model_quantize_default_params(void);
  314. // Initialize the llama + ggml backend
  315. // If numa is true, use NUMA optimizations
  316. // Call once at the start of the program
  317. LLAMA_API void llama_backend_init(void);
  318. //optional:
  319. LLAMA_API void llama_numa_init(enum ggml_numa_strategy numa);
  320. // Call once at the end of the program - currently only used for MPI
  321. LLAMA_API void llama_backend_free(void);
  322. LLAMA_API struct llama_model * llama_load_model_from_file(
  323. const char * path_model,
  324. struct llama_model_params params);
  325. LLAMA_API void llama_free_model(struct llama_model * model);
  326. LLAMA_API struct llama_context * llama_new_context_with_model(
  327. struct llama_model * model,
  328. struct llama_context_params params);
  329. // Frees all allocated memory
  330. LLAMA_API void llama_free(struct llama_context * ctx);
  331. LLAMA_API int64_t llama_time_us(void);
  332. LLAMA_API size_t llama_max_devices(void);
  333. LLAMA_API bool llama_supports_mmap (void);
  334. LLAMA_API bool llama_supports_mlock (void);
  335. LLAMA_API bool llama_supports_gpu_offload(void);
  336. LLAMA_API const struct llama_model * llama_get_model(const struct llama_context * ctx);
  337. LLAMA_API uint32_t llama_n_ctx (const struct llama_context * ctx);
  338. LLAMA_API uint32_t llama_n_batch (const struct llama_context * ctx);
  339. LLAMA_API uint32_t llama_n_ubatch (const struct llama_context * ctx);
  340. LLAMA_API uint32_t llama_n_seq_max (const struct llama_context * ctx);
  341. LLAMA_API enum llama_pooling_type llama_pooling_type(const struct llama_context * ctx);
  342. LLAMA_API enum llama_vocab_type llama_vocab_type (const struct llama_model * model);
  343. LLAMA_API enum llama_rope_type llama_rope_type (const struct llama_model * model);
  344. LLAMA_API int32_t llama_n_vocab (const struct llama_model * model);
  345. LLAMA_API int32_t llama_n_ctx_train(const struct llama_model * model);
  346. LLAMA_API int32_t llama_n_embd (const struct llama_model * model);
  347. LLAMA_API int32_t llama_n_layer (const struct llama_model * model);
  348. // Get the model's RoPE frequency scaling factor
  349. LLAMA_API float llama_rope_freq_scale_train(const struct llama_model * model);
  350. // Functions to access the model's GGUF metadata scalar values
  351. // - The functions return the length of the string on success, or -1 on failure
  352. // - The output string is always null-terminated and cleared on failure
  353. // - GGUF array values are not supported by these functions
  354. // Get metadata value as a string by key name
  355. LLAMA_API int32_t llama_model_meta_val_str(const struct llama_model * model, const char * key, char * buf, size_t buf_size);
  356. // Get the number of metadata key/value pairs
  357. LLAMA_API int32_t llama_model_meta_count(const struct llama_model * model);
  358. // Get metadata key name by index
  359. LLAMA_API int32_t llama_model_meta_key_by_index(const struct llama_model * model, int32_t i, char * buf, size_t buf_size);
  360. // Get metadata value as a string by index
  361. LLAMA_API int32_t llama_model_meta_val_str_by_index(const struct llama_model * model, int32_t i, char * buf, size_t buf_size);
  362. // Get a string describing the model type
  363. LLAMA_API int32_t llama_model_desc(const struct llama_model * model, char * buf, size_t buf_size);
  364. // Returns the total size of all the tensors in the model in bytes
  365. LLAMA_API uint64_t llama_model_size(const struct llama_model * model);
  366. // Returns the total number of parameters in the model
  367. LLAMA_API uint64_t llama_model_n_params(const struct llama_model * model);
  368. // Get a llama model tensor
  369. LLAMA_API struct ggml_tensor * llama_get_model_tensor(struct llama_model * model, const char * name);
  370. // Returns 0 on success
  371. LLAMA_API uint32_t llama_model_quantize(
  372. const char * fname_inp,
  373. const char * fname_out,
  374. const llama_model_quantize_params * params);
  375. // Apply a LoRA adapter to a loaded model
  376. // path_base_model is the path to a higher quality model to use as a base for
  377. // the layers modified by the adapter. Can be NULL to use the current loaded model.
  378. // The model needs to be reloaded before applying a new adapter, otherwise the adapter
  379. // will be applied on top of the previous one
  380. // Returns 0 on success
  381. LLAMA_API int32_t llama_model_apply_lora_from_file(
  382. const struct llama_model * model,
  383. const char * path_lora,
  384. float scale,
  385. const char * path_base_model,
  386. int32_t n_threads);
  387. // Apply a loaded control vector to a llama_context, or if data is NULL, clear
  388. // the currently loaded vector.
  389. // n_embd should be the size of a single layer's control, and data should point
  390. // to an n_embd x n_layers buffer starting from layer 1.
  391. // il_start and il_end are the layer range the vector should apply to (both inclusive)
  392. // See llama_control_vector_load in common to load a control vector.
  393. LLAMA_API int32_t llama_control_vector_apply(
  394. struct llama_context * lctx,
  395. const float * data,
  396. size_t len,
  397. int32_t n_embd,
  398. int32_t il_start,
  399. int32_t il_end);
  400. //
  401. // KV cache
  402. //
  403. // Information associated with an individual cell in the KV cache view.
  404. struct llama_kv_cache_view_cell {
  405. // The position for this cell. Takes KV cache shifts into account.
  406. // May be negative if the cell is not populated.
  407. llama_pos pos;
  408. };
  409. // An updateable view of the KV cache.
  410. struct llama_kv_cache_view {
  411. // Number of KV cache cells. This will be the same as the context size.
  412. int32_t n_cells;
  413. // Maximum number of sequences that can exist in a cell. It's not an error
  414. // if there are more sequences in a cell than this value, however they will
  415. // not be visible in the view cells_sequences.
  416. int32_t n_seq_max;
  417. // Number of tokens in the cache. For example, if there are two populated
  418. // cells, the first with 1 sequence id in it and the second with 2 sequence
  419. // ids then you'll have 3 tokens.
  420. int32_t token_count;
  421. // Number of populated cache cells.
  422. int32_t used_cells;
  423. // Maximum contiguous empty slots in the cache.
  424. int32_t max_contiguous;
  425. // Index to the start of the max_contiguous slot range. Can be negative
  426. // when cache is full.
  427. int32_t max_contiguous_idx;
  428. // Information for an individual cell.
  429. struct llama_kv_cache_view_cell * cells;
  430. // The sequences for each cell. There will be n_seq_max items per cell.
  431. llama_seq_id * cells_sequences;
  432. };
  433. // Create an empty KV cache view. (use only for debugging purposes)
  434. LLAMA_API struct llama_kv_cache_view llama_kv_cache_view_init(const struct llama_context * ctx, int32_t n_seq_max);
  435. // Free a KV cache view. (use only for debugging purposes)
  436. LLAMA_API void llama_kv_cache_view_free(struct llama_kv_cache_view * view);
  437. // Update the KV cache view structure with the current state of the KV cache. (use only for debugging purposes)
  438. LLAMA_API void llama_kv_cache_view_update(const struct llama_context * ctx, struct llama_kv_cache_view * view);
  439. // Returns the number of tokens in the KV cache (slow, use only for debug)
  440. // If a KV cell has multiple sequences assigned to it, it will be counted multiple times
  441. LLAMA_API int32_t llama_get_kv_cache_token_count(const struct llama_context * ctx);
  442. // Returns the number of used KV cells (i.e. have at least one sequence assigned to them)
  443. LLAMA_API int32_t llama_get_kv_cache_used_cells(const struct llama_context * ctx);
  444. // Clear the KV cache - both cell info is erased and KV data is zeroed
  445. LLAMA_API void llama_kv_cache_clear(
  446. struct llama_context * ctx);
  447. // Removes all tokens that belong to the specified sequence and have positions in [p0, p1)
  448. // Returns false if a partial sequence cannot be removed. Removing a whole sequence never fails
  449. // seq_id < 0 : match any sequence
  450. // p0 < 0 : [0, p1]
  451. // p1 < 0 : [p0, inf)
  452. LLAMA_API bool llama_kv_cache_seq_rm(
  453. struct llama_context * ctx,
  454. llama_seq_id seq_id,
  455. llama_pos p0,
  456. llama_pos p1);
  457. // Copy all tokens that belong to the specified sequence to another sequence
  458. // Note that this does not allocate extra KV cache memory - it simply assigns the tokens to the new sequence
  459. // p0 < 0 : [0, p1]
  460. // p1 < 0 : [p0, inf)
  461. LLAMA_API void llama_kv_cache_seq_cp(
  462. struct llama_context * ctx,
  463. llama_seq_id seq_id_src,
  464. llama_seq_id seq_id_dst,
  465. llama_pos p0,
  466. llama_pos p1);
  467. // Removes all tokens that do not belong to the specified sequence
  468. LLAMA_API void llama_kv_cache_seq_keep(
  469. struct llama_context * ctx,
  470. llama_seq_id seq_id);
  471. // Adds relative position "delta" to all tokens that belong to the specified sequence and have positions in [p0, p1)
  472. // If the KV cache is RoPEd, the KV data is updated accordingly:
  473. // - lazily on next llama_decode()
  474. // - explicitly with llama_kv_cache_update()
  475. // p0 < 0 : [0, p1]
  476. // p1 < 0 : [p0, inf)
  477. LLAMA_API void llama_kv_cache_seq_add(
  478. struct llama_context * ctx,
  479. llama_seq_id seq_id,
  480. llama_pos p0,
  481. llama_pos p1,
  482. llama_pos delta);
  483. // Integer division of the positions by factor of `d > 1`
  484. // If the KV cache is RoPEd, the KV data is updated accordingly:
  485. // - lazily on next llama_decode()
  486. // - explicitly with llama_kv_cache_update()
  487. // p0 < 0 : [0, p1]
  488. // p1 < 0 : [p0, inf)
  489. LLAMA_API void llama_kv_cache_seq_div(
  490. struct llama_context * ctx,
  491. llama_seq_id seq_id,
  492. llama_pos p0,
  493. llama_pos p1,
  494. int d);
  495. // Returns the largest position present in the KV cache for the specified sequence
  496. LLAMA_API llama_pos llama_kv_cache_seq_pos_max(
  497. struct llama_context * ctx,
  498. llama_seq_id seq_id);
  499. // Defragment the KV cache
  500. // This will be applied:
  501. // - lazily on next llama_decode()
  502. // - explicitly with llama_kv_cache_update()
  503. LLAMA_API void llama_kv_cache_defrag(struct llama_context * ctx);
  504. // Apply the KV cache updates (such as K-shifts, defragmentation, etc.)
  505. LLAMA_API void llama_kv_cache_update(struct llama_context * ctx);
  506. //
  507. // State / sessions
  508. //
  509. // Returns the maximum size in bytes of the state (rng, logits, embedding
  510. // and kv_cache) - will often be smaller after compacting tokens
  511. LLAMA_API size_t llama_state_get_size(const struct llama_context * ctx);
  512. LLAMA_API DEPRECATED(size_t llama_get_state_size(const struct llama_context * ctx),
  513. "use llama_state_get_size instead");
  514. // Copies the state to the specified destination address.
  515. // Destination needs to have allocated enough memory.
  516. // Returns the number of bytes copied
  517. LLAMA_API size_t llama_state_get_data(
  518. struct llama_context * ctx,
  519. uint8_t * dst);
  520. LLAMA_API DEPRECATED(size_t llama_copy_state_data(
  521. struct llama_context * ctx,
  522. uint8_t * dst),
  523. "use llama_state_get_data instead");
  524. // Set the state reading from the specified address
  525. // Returns the number of bytes read
  526. LLAMA_API size_t llama_state_set_data(
  527. struct llama_context * ctx,
  528. const uint8_t * src);
  529. LLAMA_API DEPRECATED(size_t llama_set_state_data(
  530. struct llama_context * ctx,
  531. const uint8_t * src),
  532. "use llama_state_set_data instead");
  533. // Save/load session file
  534. LLAMA_API bool llama_state_load_file(
  535. struct llama_context * ctx,
  536. const char * path_session,
  537. llama_token * tokens_out,
  538. size_t n_token_capacity,
  539. size_t * n_token_count_out);
  540. LLAMA_API DEPRECATED(bool llama_load_session_file(
  541. struct llama_context * ctx,
  542. const char * path_session,
  543. llama_token * tokens_out,
  544. size_t n_token_capacity,
  545. size_t * n_token_count_out),
  546. "use llama_state_load_file instead");
  547. LLAMA_API bool llama_state_save_file(
  548. struct llama_context * ctx,
  549. const char * path_session,
  550. const llama_token * tokens,
  551. size_t n_token_count);
  552. LLAMA_API DEPRECATED(bool llama_save_session_file(
  553. struct llama_context * ctx,
  554. const char * path_session,
  555. const llama_token * tokens,
  556. size_t n_token_count),
  557. "use llama_state_save_file instead");
  558. // Get the exact size needed to copy the KV cache of a single sequence
  559. LLAMA_API size_t llama_state_seq_get_size(
  560. struct llama_context * ctx,
  561. llama_seq_id seq_id);
  562. // Copy the KV cache of a single sequence into the specified buffer
  563. LLAMA_API size_t llama_state_seq_get_data(
  564. struct llama_context * ctx,
  565. uint8_t * dst,
  566. llama_seq_id seq_id);
  567. // Copy the sequence data (originally copied with `llama_state_seq_get_data`) into the specified sequence
  568. // Returns:
  569. // - Positive: Ok
  570. // - Zero: Failed to load
  571. LLAMA_API size_t llama_state_seq_set_data(
  572. struct llama_context * ctx,
  573. const uint8_t * src,
  574. llama_seq_id dest_seq_id);
  575. LLAMA_API size_t llama_state_seq_save_file(
  576. struct llama_context * ctx,
  577. const char * filepath,
  578. llama_seq_id seq_id,
  579. const llama_token * tokens,
  580. size_t n_token_count);
  581. LLAMA_API size_t llama_state_seq_load_file(
  582. struct llama_context * ctx,
  583. const char * filepath,
  584. llama_seq_id dest_seq_id,
  585. llama_token * tokens_out,
  586. size_t n_token_capacity,
  587. size_t * n_token_count_out);
  588. //
  589. // Decoding
  590. //
  591. // Return batch for single sequence of tokens starting at pos_0
  592. //
  593. // NOTE: this is a helper function to facilitate transition to the new batch API - avoid using it
  594. //
  595. LLAMA_API struct llama_batch llama_batch_get_one(
  596. llama_token * tokens,
  597. int32_t n_tokens,
  598. llama_pos pos_0,
  599. llama_seq_id seq_id);
  600. // Allocates a batch of tokens on the heap that can hold a maximum of n_tokens
  601. // Each token can be assigned up to n_seq_max sequence ids
  602. // The batch has to be freed with llama_batch_free()
  603. // If embd != 0, llama_batch.embd will be allocated with size of n_tokens * embd * sizeof(float)
  604. // Otherwise, llama_batch.token will be allocated to store n_tokens llama_token
  605. // The rest of the llama_batch members are allocated with size n_tokens
  606. // All members are left uninitialized
  607. LLAMA_API struct llama_batch llama_batch_init(
  608. int32_t n_tokens,
  609. int32_t embd,
  610. int32_t n_seq_max);
  611. // Frees a batch of tokens allocated with llama_batch_init()
  612. LLAMA_API void llama_batch_free(struct llama_batch batch);
  613. // Positive return values does not mean a fatal error, but rather a warning.
  614. // 0 - success
  615. // 1 - could not find a KV slot for the batch (try reducing the size of the batch or increase the context)
  616. // < 0 - error
  617. LLAMA_API int32_t llama_decode(
  618. struct llama_context * ctx,
  619. struct llama_batch batch);
  620. // Set the number of threads used for decoding
  621. // n_threads is the number of threads used for generation (single token)
  622. // n_threads_batch is the number of threads used for prompt and batch processing (multiple tokens)
  623. LLAMA_API void llama_set_n_threads(struct llama_context * ctx, uint32_t n_threads, uint32_t n_threads_batch);
  624. // Set whether to use causal attention or not
  625. // If set to true, the model will only attend to the past tokens
  626. LLAMA_API void llama_set_causal_attn(struct llama_context * ctx, bool causal_attn);
  627. // Set abort callback
  628. LLAMA_API void llama_set_abort_callback(struct llama_context * ctx, ggml_abort_callback abort_callback, void * abort_callback_data);
  629. // Wait until all computations are finished
  630. // This is automatically done when using one of the functions below to obtain the computation results
  631. // and is not necessary to call it explicitly in most cases
  632. LLAMA_API void llama_synchronize(struct llama_context * ctx);
  633. // Token logits obtained from the last call to llama_decode()
  634. // The logits for which llama_batch.logits[i] != 0 are stored contiguously
  635. // in the order they have appeared in the batch.
  636. // Rows: number of tokens for which llama_batch.logits[i] != 0
  637. // Cols: n_vocab
  638. LLAMA_API float * llama_get_logits(struct llama_context * ctx);
  639. // Logits for the ith token. For positive indices, Equivalent to:
  640. // llama_get_logits(ctx) + ctx->output_ids[i]*n_vocab
  641. // Negative indicies can be used to access logits in reverse order, -1 is the last logit.
  642. // returns NULL for invalid ids.
  643. LLAMA_API float * llama_get_logits_ith(struct llama_context * ctx, int32_t i);
  644. // Get all output token embeddings.
  645. // when pooling_type == LLAMA_POOLING_TYPE_NONE or when using a generative model,
  646. // the embeddings for which llama_batch.logits[i] != 0 are stored contiguously
  647. // in the order they have appeared in the batch.
  648. // shape: [n_outputs*n_embd]
  649. // Otherwise, returns NULL.
  650. LLAMA_API float * llama_get_embeddings(struct llama_context * ctx);
  651. // Get the embeddings for the ith token. For positive indices, Equivalent to:
  652. // llama_get_embeddings(ctx) + ctx->output_ids[i]*n_embd
  653. // Negative indicies can be used to access embeddings in reverse order, -1 is the last embedding.
  654. // shape: [n_embd] (1-dimensional)
  655. // returns NULL for invalid ids.
  656. LLAMA_API float * llama_get_embeddings_ith(struct llama_context * ctx, int32_t i);
  657. // Get the embeddings for a sequence id
  658. // Returns NULL if pooling_type is LLAMA_POOLING_TYPE_NONE
  659. // shape: [n_embd] (1-dimensional)
  660. LLAMA_API float * llama_get_embeddings_seq(struct llama_context * ctx, llama_seq_id seq_id);
  661. //
  662. // Vocab
  663. //
  664. LLAMA_API const char * llama_token_get_text(const struct llama_model * model, llama_token token);
  665. LLAMA_API float llama_token_get_score(const struct llama_model * model, llama_token token);
  666. LLAMA_API enum llama_token_type llama_token_get_type(const struct llama_model * model, llama_token token);
  667. // Check if the token is supposed to end generation (end-of-generation, eg. EOS, EOT, etc.)
  668. LLAMA_API bool llama_token_is_eog(const struct llama_model * model, llama_token token);
  669. // Special tokens
  670. LLAMA_API llama_token llama_token_bos(const struct llama_model * model); // beginning-of-sentence
  671. LLAMA_API llama_token llama_token_eos(const struct llama_model * model); // end-of-sentence
  672. LLAMA_API llama_token llama_token_cls(const struct llama_model * model); // classification
  673. LLAMA_API llama_token llama_token_sep(const struct llama_model * model); // sentence separator
  674. LLAMA_API llama_token llama_token_nl (const struct llama_model * model); // next-line
  675. // Returns -1 if unknown, 1 for true or 0 for false.
  676. LLAMA_API int32_t llama_add_bos_token(const struct llama_model * model);
  677. // Returns -1 if unknown, 1 for true or 0 for false.
  678. LLAMA_API int32_t llama_add_eos_token(const struct llama_model * model);
  679. // Codellama infill tokens
  680. LLAMA_API llama_token llama_token_prefix(const struct llama_model * model); // Beginning of infill prefix
  681. LLAMA_API llama_token llama_token_middle(const struct llama_model * model); // Beginning of infill middle
  682. LLAMA_API llama_token llama_token_suffix(const struct llama_model * model); // Beginning of infill suffix
  683. LLAMA_API llama_token llama_token_eot (const struct llama_model * model); // End of infill middle
  684. //
  685. // Tokenization
  686. //
  687. /// @details Convert the provided text into tokens.
  688. /// @param tokens The tokens pointer must be large enough to hold the resulting tokens.
  689. /// @return Returns the number of tokens on success, no more than n_tokens_max
  690. /// @return Returns a negative number on failure - the number of tokens that would have been returned
  691. /// @param parse_special Allow tokenizing special and/or control tokens which otherwise are not exposed and treated
  692. /// as plaintext. Does not insert a leading space.
  693. LLAMA_API int32_t llama_tokenize(
  694. const struct llama_model * model,
  695. const char * text,
  696. int32_t text_len,
  697. llama_token * tokens,
  698. int32_t n_tokens_max,
  699. bool add_special,
  700. bool parse_special);
  701. // Token Id -> Piece.
  702. // Uses the vocabulary in the provided context.
  703. // Does not write null terminator to the buffer.
  704. // User code is responsible to remove the leading whitespace of the first non-BOS token when decoding multiple tokens.
  705. // @param special If true, special tokens are rendered in the output.
  706. LLAMA_API int32_t llama_token_to_piece(
  707. const struct llama_model * model,
  708. llama_token token,
  709. char * buf,
  710. int32_t length,
  711. bool special);
  712. /// Apply chat template. Inspired by hf apply_chat_template() on python.
  713. /// Both "model" and "custom_template" are optional, but at least one is required. "custom_template" has higher precedence than "model"
  714. /// NOTE: This function does not use a jinja parser. It only support a pre-defined list of template. See more: https://github.com/ggerganov/llama.cpp/wiki/Templates-supported-by-llama_chat_apply_template
  715. /// @param tmpl A Jinja template to use for this chat. If this is nullptr, the model’s default chat template will be used instead.
  716. /// @param chat Pointer to a list of multiple llama_chat_message
  717. /// @param n_msg Number of llama_chat_message in this chat
  718. /// @param add_ass Whether to end the prompt with the token(s) that indicate the start of an assistant message.
  719. /// @param buf A buffer to hold the output formatted prompt. The recommended alloc size is 2 * (total number of characters of all messages)
  720. /// @param length The size of the allocated buffer
  721. /// @return The total number of bytes of the formatted prompt. If is it larger than the size of buffer, you may need to re-alloc it and then re-apply the template.
  722. LLAMA_API int32_t llama_chat_apply_template(
  723. const struct llama_model * model,
  724. const char * tmpl,
  725. const struct llama_chat_message * chat,
  726. size_t n_msg,
  727. bool add_ass,
  728. char * buf,
  729. int32_t length);
  730. //
  731. // Grammar
  732. //
  733. LLAMA_API struct llama_grammar * llama_grammar_init(
  734. const llama_grammar_element ** rules,
  735. size_t n_rules,
  736. size_t start_rule_index);
  737. LLAMA_API void llama_grammar_free(struct llama_grammar * grammar);
  738. LLAMA_API struct llama_grammar * llama_grammar_copy(const struct llama_grammar * grammar);
  739. //
  740. // Sampling functions
  741. //
  742. // Sets the current rng seed.
  743. LLAMA_API void llama_set_rng_seed(struct llama_context * ctx, uint32_t seed);
  744. /// @details Repetition penalty described in CTRL academic paper https://arxiv.org/abs/1909.05858, with negative logit fix.
  745. /// @details Frequency and presence penalties described in OpenAI API https://platform.openai.com/docs/api-reference/parameter-details.
  746. LLAMA_API void llama_sample_repetition_penalties(
  747. struct llama_context * ctx,
  748. llama_token_data_array * candidates,
  749. const llama_token * last_tokens,
  750. size_t penalty_last_n,
  751. float penalty_repeat,
  752. float penalty_freq,
  753. float penalty_present);
  754. /// @details Apply classifier-free guidance to the logits as described in academic paper "Stay on topic with Classifier-Free Guidance" https://arxiv.org/abs/2306.17806
  755. /// @param logits Logits extracted from the original generation context.
  756. /// @param logits_guidance Logits extracted from a separate context from the same model. Other than a negative prompt at the beginning, it should have all generated and user input tokens copied from the main context.
  757. /// @param scale Guidance strength. 1.0f means no guidance. Higher values mean stronger guidance.
  758. LLAMA_API void llama_sample_apply_guidance(
  759. struct llama_context * ctx,
  760. float * logits,
  761. float * logits_guidance,
  762. float scale);
  763. /// @details Sorts candidate tokens by their logits in descending order and calculate probabilities based on logits.
  764. LLAMA_API void llama_sample_softmax(
  765. struct llama_context * ctx,
  766. llama_token_data_array * candidates);
  767. /// @details Top-K sampling described in academic paper "The Curious Case of Neural Text Degeneration" https://arxiv.org/abs/1904.09751
  768. LLAMA_API void llama_sample_top_k(
  769. struct llama_context * ctx,
  770. llama_token_data_array * candidates,
  771. int32_t k,
  772. size_t min_keep);
  773. /// @details Nucleus sampling described in academic paper "The Curious Case of Neural Text Degeneration" https://arxiv.org/abs/1904.09751
  774. LLAMA_API void llama_sample_top_p(
  775. struct llama_context * ctx,
  776. llama_token_data_array * candidates,
  777. float p,
  778. size_t min_keep);
  779. /// @details Minimum P sampling as described in https://github.com/ggerganov/llama.cpp/pull/3841
  780. LLAMA_API void llama_sample_min_p(
  781. struct llama_context * ctx,
  782. llama_token_data_array * candidates,
  783. float p,
  784. size_t min_keep);
  785. /// @details Tail Free Sampling described in https://www.trentonbricken.com/Tail-Free-Sampling/.
  786. LLAMA_API void llama_sample_tail_free(
  787. struct llama_context * ctx,
  788. llama_token_data_array * candidates,
  789. float z,
  790. size_t min_keep);
  791. /// @details Locally Typical Sampling implementation described in the paper https://arxiv.org/abs/2202.00666.
  792. LLAMA_API void llama_sample_typical(
  793. struct llama_context * ctx,
  794. llama_token_data_array * candidates,
  795. float p,
  796. size_t min_keep);
  797. /// @details Dynamic temperature implementation described in the paper https://arxiv.org/abs/2309.02772.
  798. LLAMA_API void llama_sample_entropy(
  799. struct llama_context * ctx,
  800. llama_token_data_array * candidates_p,
  801. float min_temp,
  802. float max_temp,
  803. float exponent_val);
  804. LLAMA_API void llama_sample_temp(
  805. struct llama_context * ctx,
  806. llama_token_data_array * candidates,
  807. float temp);
  808. /// @details Apply constraints from grammar
  809. LLAMA_API void llama_sample_grammar(
  810. struct llama_context * ctx,
  811. llama_token_data_array * candidates,
  812. const struct llama_grammar * grammar);
  813. /// @details Mirostat 1.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words.
  814. /// @param candidates A vector of `llama_token_data` containing the candidate tokens, their probabilities (p), and log-odds (logit) for the current position in the generated text.
  815. /// @param tau The target cross-entropy (or surprise) value you want to achieve for the generated text. A higher value corresponds to more surprising or less predictable text, while a lower value corresponds to less surprising or more predictable text.
  816. /// @param eta The learning rate used to update `mu` based on the error between the target and observed surprisal of the sampled word. A larger learning rate will cause `mu` to be updated more quickly, while a smaller learning rate will result in slower updates.
  817. /// @param m The number of tokens considered in the estimation of `s_hat`. This is an arbitrary value that is used to calculate `s_hat`, which in turn helps to calculate the value of `k`. In the paper, they use `m = 100`, but you can experiment with different values to see how it affects the performance of the algorithm.
  818. /// @param mu Maximum cross-entropy. This value is initialized to be twice the target cross-entropy (`2 * tau`) and is updated in the algorithm based on the error between the target and observed surprisal.
  819. LLAMA_API llama_token llama_sample_token_mirostat(
  820. struct llama_context * ctx,
  821. llama_token_data_array * candidates,
  822. float tau,
  823. float eta,
  824. int32_t m,
  825. float * mu);
  826. /// @details Mirostat 2.0 algorithm described in the paper https://arxiv.org/abs/2007.14966. Uses tokens instead of words.
  827. /// @param candidates A vector of `llama_token_data` containing the candidate tokens, their probabilities (p), and log-odds (logit) for the current position in the generated text.
  828. /// @param tau The target cross-entropy (or surprise) value you want to achieve for the generated text. A higher value corresponds to more surprising or less predictable text, while a lower value corresponds to less surprising or more predictable text.
  829. /// @param eta The learning rate used to update `mu` based on the error between the target and observed surprisal of the sampled word. A larger learning rate will cause `mu` to be updated more quickly, while a smaller learning rate will result in slower updates.
  830. /// @param mu Maximum cross-entropy. This value is initialized to be twice the target cross-entropy (`2 * tau`) and is updated in the algorithm based on the error between the target and observed surprisal.
  831. LLAMA_API llama_token llama_sample_token_mirostat_v2(
  832. struct llama_context * ctx,
  833. llama_token_data_array * candidates,
  834. float tau,
  835. float eta,
  836. float * mu);
  837. /// @details Selects the token with the highest probability.
  838. /// Does not compute the token probabilities. Use llama_sample_softmax() instead.
  839. LLAMA_API llama_token llama_sample_token_greedy(
  840. struct llama_context * ctx,
  841. llama_token_data_array * candidates);
  842. /// @details Randomly selects a token from the candidates based on their probabilities using the RNG of ctx.
  843. LLAMA_API llama_token llama_sample_token(
  844. struct llama_context * ctx,
  845. llama_token_data_array * candidates);
  846. /// @details Accepts the sampled token into the grammar
  847. LLAMA_API void llama_grammar_accept_token(
  848. struct llama_context * ctx,
  849. struct llama_grammar * grammar,
  850. llama_token token);
  851. //
  852. // Beam search
  853. //
  854. struct llama_beam_view {
  855. const llama_token * tokens;
  856. size_t n_tokens;
  857. float p; // Cumulative beam probability (renormalized relative to all beams)
  858. bool eob; // Callback should set this to true when a beam is at end-of-beam.
  859. };
  860. // Passed to beam_search_callback function.
  861. // Whenever 0 < common_prefix_length, this number of tokens should be copied from any of the beams
  862. // (e.g. beams[0]) as they will be removed (shifted) from all beams in all subsequent callbacks.
  863. // These pointers are valid only during the synchronous callback, so should not be saved.
  864. struct llama_beams_state {
  865. struct llama_beam_view * beam_views;
  866. size_t n_beams; // Number of elements in beam_views[].
  867. size_t common_prefix_length; // Current max length of prefix tokens shared by all beams.
  868. bool last_call; // True iff this is the last callback invocation.
  869. };
  870. // Type of pointer to the beam_search_callback function.
  871. // void* callback_data is any custom data passed to llama_beam_search, that is subsequently
  872. // passed back to beam_search_callback. This avoids having to use global variables in the callback.
  873. typedef void (*llama_beam_search_callback_fn_t)(void * callback_data, struct llama_beams_state);
  874. /// @details Deterministically returns entire sentence constructed by a beam search.
  875. /// @param ctx Pointer to the llama_context.
  876. /// @param callback Invoked for each iteration of the beam_search loop, passing in beams_state.
  877. /// @param callback_data A pointer that is simply passed back to callback.
  878. /// @param n_beams Number of beams to use.
  879. /// @param n_past Number of tokens already evaluated.
  880. /// @param n_predict Maximum number of tokens to predict. EOS may occur earlier.
  881. LLAMA_API void llama_beam_search(
  882. struct llama_context * ctx,
  883. llama_beam_search_callback_fn_t callback,
  884. void * callback_data,
  885. size_t n_beams,
  886. int32_t n_past,
  887. int32_t n_predict);
  888. /// @details Build a split GGUF final path for this chunk.
  889. /// llama_split_path(split_path, sizeof(split_path), "/models/ggml-model-q4_0", 2, 4) => split_path = "/models/ggml-model-q4_0-00002-of-00004.gguf"
  890. // Returns the split_path length.
  891. LLAMA_API int llama_split_path(char * split_path, size_t maxlen, const char * path_prefix, int split_no, int split_count);
  892. /// @details Extract the path prefix from the split_path if and only if the split_no and split_count match.
  893. /// llama_split_prefix(split_prefix, 64, "/models/ggml-model-q4_0-00002-of-00004.gguf", 2, 4) => split_prefix = "/models/ggml-model-q4_0"
  894. // Returns the split_prefix length.
  895. LLAMA_API int llama_split_prefix(char * split_prefix, size_t maxlen, const char * split_path, int split_no, int split_count);
  896. // Performance information
  897. LLAMA_API struct llama_timings llama_get_timings(struct llama_context * ctx);
  898. LLAMA_API void llama_print_timings(struct llama_context * ctx);
  899. LLAMA_API void llama_reset_timings(struct llama_context * ctx);
  900. // Print system information
  901. LLAMA_API const char * llama_print_system_info(void);
  902. // Set callback for all future logging events.
  903. // If this is not called, or NULL is supplied, everything is output on stderr.
  904. LLAMA_API void llama_log_set(ggml_log_callback log_callback, void * user_data);
  905. LLAMA_API void llama_dump_timing_info_yaml(FILE * stream, const struct llama_context * ctx);
  906. #ifdef __cplusplus
  907. }
  908. #endif
  909. // Internal API to be implemented by llama.cpp and used by tests/benchmarks only
  910. #ifdef LLAMA_API_INTERNAL
  911. #include <random>
  912. #include <string>
  913. #include <vector>
  914. struct ggml_tensor;
  915. struct llama_partial_utf8 {
  916. uint32_t value; // bit value so far (unshifted)
  917. int n_remain; // num bytes remaining; -1 indicates invalid sequence
  918. };
  919. struct llama_grammar {
  920. const std::vector<std::vector<llama_grammar_element>> rules;
  921. std::vector<std::vector<const llama_grammar_element *>> stacks;
  922. // buffer for partially generated UTF-8 sequence from accepted tokens
  923. llama_partial_utf8 partial_utf8;
  924. };
  925. struct llama_grammar_candidate {
  926. size_t index;
  927. const uint32_t * code_points;
  928. llama_partial_utf8 partial_utf8;
  929. };
  930. const std::vector<std::pair<std::string, struct ggml_tensor *>> & llama_internal_get_tensor_map(
  931. struct llama_context * ctx
  932. );
  933. void llama_grammar_accept(
  934. const std::vector<std::vector<llama_grammar_element>> & rules,
  935. const std::vector<std::vector<const llama_grammar_element *>> & stacks,
  936. const uint32_t chr,
  937. std::vector<std::vector<const llama_grammar_element *>> & new_stacks);
  938. std::pair<std::vector<uint32_t>, llama_partial_utf8> decode_utf8(
  939. const std::string & src,
  940. llama_partial_utf8 partial_start);
  941. // Randomly selects a token from the candidates based on their probabilities using given std::mt19937.
  942. // This is a temporary workaround in order to fix race conditions when sampling with multiple sequences.
  943. llama_token llama_sample_token_with_rng(struct llama_context * ctx, llama_token_data_array * candidates, std::mt19937 & rng);
  944. #endif // LLAMA_API_INTERNAL
  945. #endif // LLAMA_H