| Quellcodebibliothek Statistik Leitseite products/Sources/formale Sprachen/C/Firefox/third_party/llama.cpp/include/ (Firefox Browser Version 153.0.1©) Datei vom 27.6.2026 mit Größe 74 kB |
|
Quelle llama.hSprache: C |
|||||||||||||||
|
#ifndef LLAMA_H #define LLAMA_H #include "ggml.h" #include "ggml-cpu.h" #include "ggml-backend.h" #include "ggml-opt.h" #include <stddef.h> #include <stdint.h> #include <stdio.h> #include <stdbool.h> #ifdef LLAMA_SHARED # if defined(_WIN32) && !defined(__MINGW32__) # ifdef LLAMA_BUILD # define LLAMA_API __declspec(dllexport) # else # define LLAMA_API __declspec(dllimport) # endif # else # define LLAMA_API __attribute__ ((visibility ("default"))) # endif #else # define LLAMA_API #endif #ifdef __GNUC__ # define DEPRECATED(func, hint) func __attribute__((deprecated(hint))) #elif defined(_MSC_VER) # define DEPRECATED(func, hint) __declspec(deprecated(hint)) func #else # define DEPRECATED(func, hint) func #endif #define LLAMA_DEFAULT_SEED 0xFFFFFFFF #define LLAMA_TOKEN_NULL -1 #define LLAMA_FILE_MAGIC_GGLA 0x67676c61u // 'ggla' #define LLAMA_FILE_MAGIC_GGSN 0x6767736eu // 'ggsn' #define LLAMA_FILE_MAGIC_GGSQ 0x67677371u // 'ggsq' #define LLAMA_SESSION_MAGIC LLAMA_FILE_MAGIC_GGSN #define LLAMA_SESSION_VERSION 9 #define LLAMA_STATE_SEQ_MAGIC LLAMA_FILE_MAGIC_GGSQ #define LLAMA_STATE_SEQ_VERSION 2 #ifdef __cplusplus extern "C" { #endif // // C interface // // TODO: show sample usage // struct llama_vocab; struct llama_model; struct llama_context; struct llama_sampler; typedef struct llama_memory_i * llama_memory_t; struct llama_kv_cache; // DEPRECATED (use llama_memory instead) typedef int32_t llama_pos; typedef int32_t llama_token; typedef int32_t llama_seq_id; enum llama_vocab_type { LLAMA_VOCAB_TYPE_NONE = 0, // For models without vocab LLAMA_VOCAB_TYPE_SPM = 1, // LLaMA tokenizer based on byte-level BPE with byte fallback LLAMA_VOCAB_TYPE_BPE = 2, // GPT-2 tokenizer based on byte-level BPE LLAMA_VOCAB_TYPE_WPM = 3, // BERT tokenizer based on WordPiece LLAMA_VOCAB_TYPE_UGM = 4, // T5 tokenizer based on Unigram LLAMA_VOCAB_TYPE_RWKV = 5, // RWKV tokenizer based on greedy tokenization LLAMA_VOCAB_TYPE_PLAMO2 = 6, // PLaMo-2 tokenizer based on Aho-Corasick with dynamic progra }; enum llama_rope_type { LLAMA_ROPE_TYPE_NONE = -1, LLAMA_ROPE_TYPE_NORM = 0, LLAMA_ROPE_TYPE_NEOX = GGML_ROPE_TYPE_NEOX, LLAMA_ROPE_TYPE_MROPE = GGML_ROPE_TYPE_MROPE, LLAMA_ROPE_TYPE_VISION = GGML_ROPE_TYPE_VISION, }; enum llama_token_type { //TODO: remove, required until per token attributes are available fr LLAMA_TOKEN_TYPE_UNDEFINED = 0, LLAMA_TOKEN_TYPE_NORMAL = 1, LLAMA_TOKEN_TYPE_UNKNOWN = 2, LLAMA_TOKEN_TYPE_CONTROL = 3, LLAMA_TOKEN_TYPE_USER_DEFINED = 4, LLAMA_TOKEN_TYPE_UNUSED = 5, LLAMA_TOKEN_TYPE_BYTE = 6, }; enum llama_token_attr { LLAMA_TOKEN_ATTR_UNDEFINED = 0, LLAMA_TOKEN_ATTR_UNKNOWN = 1 << 0, LLAMA_TOKEN_ATTR_UNUSED = 1 << 1, LLAMA_TOKEN_ATTR_NORMAL = 1 << 2, LLAMA_TOKEN_ATTR_CONTROL = 1 << 3, // SPECIAL? LLAMA_TOKEN_ATTR_USER_DEFINED = 1 << 4, LLAMA_TOKEN_ATTR_BYTE = 1 << 5, LLAMA_TOKEN_ATTR_NORMALIZED = 1 << 6, LLAMA_TOKEN_ATTR_LSTRIP = 1 << 7, LLAMA_TOKEN_ATTR_RSTRIP = 1 << 8, LLAMA_TOKEN_ATTR_SINGLE_WORD = 1 << 9, }; // model file types enum llama_ftype { LLAMA_FTYPE_ALL_F32 = 0, LLAMA_FTYPE_MOSTLY_F16 = 1, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q4_0 = 2, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q4_1 = 3, // except 1d tensors // LLAMA_FTYPE_MOSTLY_Q4_1_SOME_F16 = 4, // tok_embeddings.weight and output.weight are F // LLAMA_FTYPE_MOSTLY_Q4_2 = 5, // support has been removed // LLAMA_FTYPE_MOSTLY_Q4_3 = 6, // support has been removed LLAMA_FTYPE_MOSTLY_Q8_0 = 7, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q5_0 = 8, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q5_1 = 9, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q2_K = 10, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q3_K_S = 11, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q3_K_M = 12, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q3_K_L = 13, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q4_K_S = 14, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q4_K_M = 15, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q5_K_S = 16, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q5_K_M = 17, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q6_K = 18, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ2_XXS = 19, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ2_XS = 20, // except 1d tensors LLAMA_FTYPE_MOSTLY_Q2_K_S = 21, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ3_XS = 22, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ3_XXS = 23, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ1_S = 24, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ4_NL = 25, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ3_S = 26, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ3_M = 27, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ2_S = 28, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ2_M = 29, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ4_XS = 30, // except 1d tensors LLAMA_FTYPE_MOSTLY_IQ1_M = 31, // except 1d tensors LLAMA_FTYPE_MOSTLY_BF16 = 32, // except 1d tensors //LLAMA_FTYPE_MOSTLY_Q4_0_4_4 = 33, // removed from gguf files, use Q4_0 and runtime repack //LLAMA_FTYPE_MOSTLY_Q4_0_4_8 = 34, // removed from gguf files, use Q4_0 and runtime repack //LLAMA_FTYPE_MOSTLY_Q4_0_8_8 = 35, // removed from gguf files, use Q4_0 and runtime repack LLAMA_FTYPE_MOSTLY_TQ1_0 = 36, // except 1d tensors LLAMA_FTYPE_MOSTLY_TQ2_0 = 37, // except 1d tensors LLAMA_FTYPE_MOSTLY_MXFP4_MOE = 38, // except 1d tensors LLAMA_FTYPE_GUESSED = 1024, // not specified in the model file }; enum llama_rope_scaling_type { LLAMA_ROPE_SCALING_TYPE_UNSPECIFIED = -1, LLAMA_ROPE_SCALING_TYPE_NONE = 0, LLAMA_ROPE_SCALING_TYPE_LINEAR = 1, LLAMA_ROPE_SCALING_TYPE_YARN = 2, LLAMA_ROPE_SCALING_TYPE_LONGROPE = 3, LLAMA_ROPE_SCALING_TYPE_MAX_VALUE = LLAMA_ROPE_SCALING_TYPE_LONGROPE, }; enum llama_pooling_type { LLAMA_POOLING_TYPE_UNSPECIFIED = -1, LLAMA_POOLING_TYPE_NONE = 0, LLAMA_POOLING_TYPE_MEAN = 1, LLAMA_POOLING_TYPE_CLS = 2, LLAMA_POOLING_TYPE_LAST = 3, LLAMA_POOLING_TYPE_RANK = 4, // used by reranking models to attach the classification head to }; enum llama_attention_type { LLAMA_ATTENTION_TYPE_UNSPECIFIED = -1, LLAMA_ATTENTION_TYPE_CAUSAL = 0, LLAMA_ATTENTION_TYPE_NON_CAUSAL = 1, }; enum llama_split_mode { LLAMA_SPLIT_MODE_NONE = 0, // single GPU LLAMA_SPLIT_MODE_LAYER = 1, // split layers and KV across GPUs LLAMA_SPLIT_MODE_ROW = 2, // split layers and KV across GPUs, use tensor parallelism if suppor }; // TODO: simplify (https://github.com/ggml-org/llama.cpp/pull/9294#pullrequestrevie typedef struct llama_token_data { llama_token id; // token id float logit; // log-odds of the token float p; // probability of the token } llama_token_data; typedef struct llama_token_data_array { // TODO: consider SoA // NOTE: this pointer can be modified by the samplers llama_token_data * data; size_t size; int64_t selected; // this is the index in the data array (i.e. not the token id) bool sorted; } llama_token_data_array; typedef bool (*llama_progress_callback)(float progress, void * user_data); // Input data for llama_encode/llama_decode // A llama_batch object can contain input about one or many sequences // The provided arrays (i.e. token, embd, pos, etc.) must have size of n_tokens // // - token : the token ids of the input (used when embd is NULL) // - embd : token embeddings (i.e. float vector of size n_embd) (used when token is NULL) // - pos : the positions of the respective token in the sequence // (if set to NULL, the token position will be tracked automatically by llama_encode/llama_de // - seq_id : the sequence to which the respective token belongs // (if set to NULL, the sequence ID will be assumed to be 0) // - logits : if zero, the logits (and/or the embeddings) for the respective token will not be out // (if set to NULL: // - if embeddings: all tokens are output // - if not: only the last token is output // ) // typedef struct llama_batch { int32_t n_tokens; llama_token * token; float * embd; llama_pos * pos; int32_t * n_seq_id; llama_seq_id ** seq_id; int8_t * logits; // TODO: rename this to "output" } llama_batch; enum llama_model_kv_override_type { LLAMA_KV_OVERRIDE_TYPE_INT, LLAMA_KV_OVERRIDE_TYPE_FLOAT, LLAMA_KV_OVERRIDE_TYPE_BOOL, LLAMA_KV_OVERRIDE_TYPE_STR, }; struct llama_model_kv_override { enum llama_model_kv_override_type tag; char key[128]; union { int64_t val_i64; double val_f64; bool val_bool; char val_str[128]; }; }; struct llama_model_tensor_buft_override { const char * pattern; ggml_backend_buffer_type_t buft; }; struct llama_model_params { // NULL-terminated list of devices to use for offloading (if NULL, all available devices are us ggml_backend_dev_t * devices; // NULL-terminated list of buffer types to use for tensors that match a pattern const struct llama_model_tensor_buft_override * tensor_buft_overrides; int32_t n_gpu_layers; // number of layers to store in VRAM enum llama_split_mode split_mode; // how to split the model across multiple GPUs // the GPU that is used for the entire model when split_mode is LLAMA_SPLIT_MODE_NONE int32_t main_gpu; // proportion of the model (layers or rows) to offload to each GPU, size: llama_max_devices() const float * tensor_split; // Called with a progress value between 0.0 and 1.0. Pass NULL to disable. // If the provided progress_callback returns true, model loading continues. // If it returns false, model loading is immediately aborted. llama_progress_callback progress_callback; // context pointer passed to the progress callback void * progress_callback_user_data; // override key-value pairs of the model meta data const struct llama_model_kv_override * kv_overrides; // Keep the booleans together to avoid misalignment during copy-by-value. bool vocab_only; // only load the vocabulary, no weights bool use_mmap; // use mmap if possible bool use_mlock; // force system to keep model in RAM bool check_tensors; // validate model tensor data bool use_extra_bufts; // use extra buffer types (used for weight repacking) }; // NOTE: changing the default values of parameters marked as [EXPERIMENTAL] may cause crashes // https://github.com/ggml-org/llama.cpp/pull/7544 struct llama_context_params { uint32_t n_ctx; // text context, 0 = from model uint32_t n_batch; // logical maximum batch size that can be submitted to llama_decode uint32_t n_ubatch; // physical maximum batch size uint32_t n_seq_max; // max number of sequences (i.e. distinct states for recurrent models) int32_t n_threads; // number of threads to use for generation int32_t n_threads_batch; // number of threads to use for batch processing enum llama_rope_scaling_type rope_scaling_type; // RoPE scaling type, from `enum llama_ro enum llama_pooling_type pooling_type; // whether to pool (sum) embedding results by sequenc enum llama_attention_type attention_type; // attention type to use for embeddings // ref: https://github.com/ggml-org/llama.cpp/pull/2054 float rope_freq_base; // RoPE base frequency, 0 = from model float rope_freq_scale; // RoPE frequency scaling factor, 0 = from model float yarn_ext_factor; // YaRN extrapolation mix factor, negative = from model float yarn_attn_factor; // YaRN magnitude scaling factor float yarn_beta_fast; // YaRN low correction dim float yarn_beta_slow; // YaRN high correction dim uint32_t yarn_orig_ctx; // YaRN original context size float defrag_thold; // defragment the KV cache if holes/size > thold, <= 0 disabled (default) ggml_backend_sched_eval_callback cb_eval; void * cb_eval_user_data; enum ggml_type type_k; // data type for K cache [EXPERIMENTAL] enum ggml_type type_v; // data type for V cache [EXPERIMENTAL] // Abort callback // if it returns true, execution of llama_decode() will be aborted // currently works only with CPU execution ggml_abort_callback abort_callback; void * abort_callback_data; // Keep the booleans together and at the end of the struct to avoid misalignment during copy-by- bool embeddings; // if true, extract embeddings (together with logits) bool offload_kqv; // offload the KQV ops (including the KV cache) to GPU bool flash_attn; // use flash attention [EXPERIMENTAL] bool no_perf; // measure performance timings bool op_offload; // offload host tensor operations to device bool swa_full; // use full-size SWA cache (https://github.com/ggml-org/llama.cpp/pull/1 // NOTE: setting to false when n_seq_max > 1 can cause bad performance in some cases // ref: https://github.com/ggml-org/llama.cpp/pull/13845#issuecomment-2924800573 bool kv_unified; // use a unified buffer across the input sequences when computing the attenti // try to disable when n_seq_max > 1 for improved performance when the sequences do not share a lar // ref: https://github.com/ggml-org/llama.cpp/pull/14363 }; // model quantization parameters typedef struct llama_model_quantize_params { int32_t nthread; // number of threads to use for quantizing, if <=0 will use std::thread::hardw enum llama_ftype ftype; // quantize to this llama_ftype enum ggml_type output_tensor_type; // output tensor type enum ggml_type token_embedding_type; // token embeddings tensor type bool allow_requantize; // allow quantizing non-f32/f16 tensors bool quantize_output_tensor; // quantize output.weight bool only_copy; // only copy tensors - ftype, allow_requantize and quantize_output_tensor a bool pure; // quantize all tensors to the default type bool keep_split; // quantize to the same number of shards void * imatrix; // pointer to importance matrix data void * kv_overrides; // pointer to vector containing overrides void * tensor_types; // pointer to vector containing tensor types void * prune_layers; // pointer to vector containing layer indices to prune } llama_model_quantize_params; typedef struct llama_logit_bias { llama_token token; float bias; } llama_logit_bias; typedef struct llama_sampler_chain_params { bool no_perf; // whether to measure performance timings } llama_sampler_chain_params; // used in chat template typedef struct llama_chat_message { const char * role; const char * content; } llama_chat_message; // lora adapter struct llama_adapter_lora; // Helpers for getting default parameters // TODO: update API to start accepting pointers to params structs (https://github.com/ggml- LLAMA_API struct llama_model_params llama_model_default_params(void); LLAMA_API struct llama_context_params llama_context_default_params(void); LLAMA_API struct llama_sampler_chain_params llama_sampler_chain_default_params(void LLAMA_API struct llama_model_quantize_params llama_model_quantize_default_params(vo // Initialize the llama + ggml backend // If numa is true, use NUMA optimizations // Call once at the start of the program LLAMA_API void llama_backend_init(void); // Call once at the end of the program - currently only used for MPI LLAMA_API void llama_backend_free(void); //optional: LLAMA_API void llama_numa_init(enum ggml_numa_strategy numa); // Optional: an auto threadpool gets created in ggml if not passed explicitly LLAMA_API void llama_attach_threadpool( struct llama_context * ctx, ggml_threadpool_t threadpool, ggml_threadpool_t threadpool_batch); LLAMA_API void llama_detach_threadpool(struct llama_context * ctx); DEPRECATED(LLAMA_API struct llama_model * llama_load_model_from_file( const char * path_model, struct llama_model_params params), "use llama_model_load_from_file instead"); // Load the model from a file // If the file is split into multiple parts, the file name must follow this pattern: <name>-%05d-o // If the split file name does not follow this pattern, use llama_model_load_from_splits LLAMA_API struct llama_model * llama_model_load_from_file( const char * path_model, struct llama_model_params params); // Load the model from multiple splits (support custom naming scheme) // The paths must be in the correct order LLAMA_API struct llama_model * llama_model_load_from_splits( const char ** paths, size_t n_paths, struct llama_model_params params); // Load the model from a buffer // The buffer must contain a complete GGUF file LLAMA_API struct llama_model * llama_model_load_from_buffer( const void * buffer, size_t buffer_size, struct llama_model_params params); // Load the model from a file handle // The file handle must be positioned at the beginning of a complete GGUF file // The caller is responsible for closing the file handle LLAMA_API struct llama_model * llama_model_load_from_file_handle( FILE * file, struct llama_model_params params); LLAMA_API void llama_model_save_to_file( const struct llama_model * model, const char * path_model); DEPRECATED(LLAMA_API void llama_free_model(struct llama_model * model), "use llama_model_free instead"); LLAMA_API void llama_model_free(struct llama_model * model); LLAMA_API struct llama_context * llama_init_from_model( struct llama_model * model, struct llama_context_params params); DEPRECATED(LLAMA_API struct llama_context * llama_new_context_with_model( struct llama_model * model, struct llama_context_params params), "use llama_init_from_model instead"); // Frees all allocated memory LLAMA_API void llama_free(struct llama_context * ctx); LLAMA_API int64_t llama_time_us(void); LLAMA_API size_t llama_max_devices(void); LLAMA_API size_t llama_max_parallel_sequences(void); LLAMA_API bool llama_supports_mmap (void); LLAMA_API bool llama_supports_mlock (void); LLAMA_API bool llama_supports_gpu_offload(void); LLAMA_API bool llama_supports_rpc (void); LLAMA_API uint32_t llama_n_ctx (const struct llama_context * ctx); LLAMA_API uint32_t llama_n_batch (const struct llama_context * ctx); LLAMA_API uint32_t llama_n_ubatch (const struct llama_context * ctx); LLAMA_API uint32_t llama_n_seq_max (const struct llama_context * ctx); DEPRECATED(LLAMA_API int32_t llama_n_ctx_train(const struct llama_model * model), "use l DEPRECATED(LLAMA_API int32_t llama_n_embd (const struct llama_model * model), "use llama_ DEPRECATED(LLAMA_API int32_t llama_n_layer (const struct llama_model * model), "use llama DEPRECATED(LLAMA_API int32_t llama_n_head (const struct llama_model * model), "use llama_ DEPRECATED(LLAMA_API int32_t llama_n_vocab (const struct llama_vocab * vocab), "use llama LLAMA_API const struct llama_model * llama_get_model (const struct llama_context * ctx); LLAMA_API llama_memory_t llama_get_memory (const struct llama_context * ctx); LLAMA_API enum llama_pooling_type llama_pooling_type(const struct llama_context * ctx); DEPRECATED(LLAMA_API struct llama_kv_cache * llama_get_kv_self(struct llama_context * c LLAMA_API const struct llama_vocab * llama_model_get_vocab(const struct llama_model * mod LLAMA_API enum llama_rope_type llama_model_rope_type(const struct llama_model * model); LLAMA_API int32_t llama_model_n_ctx_train(const struct llama_model * model); LLAMA_API int32_t llama_model_n_embd (const struct llama_model * model); LLAMA_API int32_t llama_model_n_layer (const struct llama_model * model); LLAMA_API int32_t llama_model_n_head (const struct llama_model * model); LLAMA_API int32_t llama_model_n_head_kv (const struct llama_model * model); LLAMA_API int32_t llama_model_n_swa (const struct llama_model * model); // Get the model's RoPE frequency scaling factor LLAMA_API float llama_model_rope_freq_scale_train(const struct llama_model * model); // Returns the number of classifier outputs (only valid for classifier models) // Undefined behavior for non-classifier models LLAMA_API uint32_t llama_model_n_cls_out(const struct llama_model * model); // Returns label of classifier output by index (<n_cls_out). Returns nullptr if no label provid LLAMA_API const char * llama_model_cls_label(const struct llama_model * model, uint32_t i) LLAMA_API enum llama_vocab_type llama_vocab_type(const struct llama_vocab * vocab); LLAMA_API int32_t llama_vocab_n_tokens(const struct llama_vocab * vocab); // Functions to access the model's GGUF metadata scalar values // - The functions return the length of the string on success, or -1 on failure // - The output string is always null-terminated and cleared on failure // - When retrieving a string, an extra byte must be allocated to account for the null terminator // - GGUF array values are not supported by these functions // Get metadata value as a string by key name LLAMA_API int32_t llama_model_meta_val_str(const struct llama_model * model, const char * // Get the number of metadata key/value pairs LLAMA_API int32_t llama_model_meta_count(const struct llama_model * model); // Get metadata key name by index LLAMA_API int32_t llama_model_meta_key_by_index(const struct llama_model * model, int32 // Get metadata value as a string by index LLAMA_API int32_t llama_model_meta_val_str_by_index(const struct llama_model * model, i // Get a string describing the model type LLAMA_API int32_t llama_model_desc(const struct llama_model * model, char * buf, size_t buf // Returns the total size of all the tensors in the model in bytes LLAMA_API uint64_t llama_model_size(const struct llama_model * model); // Get the default chat template. Returns nullptr if not available // If name is NULL, returns the default chat template LLAMA_API const char * llama_model_chat_template(const struct llama_model * model, const c // Returns the total number of parameters in the model LLAMA_API uint64_t llama_model_n_params(const struct llama_model * model); // Returns true if the model contains an encoder that requires llama_encode() call LLAMA_API bool llama_model_has_encoder(const struct llama_model * model); // Returns true if the model contains a decoder that requires llama_decode() call LLAMA_API bool llama_model_has_decoder(const struct llama_model * model); // For encoder-decoder models, this function returns id of the token that must be provided // to the decoder to start generating output sequence. For other models, it returns -1. LLAMA_API llama_token llama_model_decoder_start_token(const struct llama_model * model // Returns true if the model is recurrent (like Mamba, RWKV, etc.) LLAMA_API bool llama_model_is_recurrent(const struct llama_model * model); // Returns true if the model is diffusion-based (like LLaDA, Dream, etc.) LLAMA_API bool llama_model_is_diffusion(const struct llama_model * model); // Returns 0 on success LLAMA_API uint32_t llama_model_quantize( const char * fname_inp, const char * fname_out, const llama_model_quantize_params * params); // // Adapters // // Load a LoRA adapter from file LLAMA_API struct llama_adapter_lora * llama_adapter_lora_init( struct llama_model * model, const char * path_lora); // Manually free a LoRA adapter // Note: loaded adapters will be free when the associated model is deleted LLAMA_API void llama_adapter_lora_free(struct llama_adapter_lora * adapter); // The following functions operate on a llama_context, hence the naming: llama_verb_... // Add a loaded LoRA adapter to given context // This will not modify model's weight LLAMA_API int32_t llama_set_adapter_lora( struct llama_context * ctx, struct llama_adapter_lora * adapter, float scale); // Remove a specific LoRA adapter from given context // Return -1 if the adapter is not present in the context LLAMA_API int32_t llama_rm_adapter_lora( struct llama_context * ctx, struct llama_adapter_lora * adapter); // Remove all LoRA adapters from given context LLAMA_API void llama_clear_adapter_lora(struct llama_context * ctx); // Apply a loaded control vector to a llama_context, or if data is NULL, clear // the currently loaded vector. // n_embd should be the size of a single layer's control, and data should point // to an n_embd x n_layers buffer starting from layer 1. // il_start and il_end are the layer range the vector should apply to (both inclusive) // See llama_control_vector_load in common to load a control vector. LLAMA_API int32_t llama_apply_adapter_cvec( struct llama_context * ctx, const float * data, size_t len, int32_t n_embd, int32_t il_start, int32_t il_end); // // Memory // // Clear the memory contents // If data == true, the data buffers will also be cleared together with the metadata LLAMA_API void llama_memory_clear( llama_memory_t mem, bool data); // Removes all tokens that belong to the specified sequence and have positions in [p0, p1) // Returns false if a partial sequence cannot be removed. Removing a whole sequence never fails // seq_id < 0 : match any sequence // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) LLAMA_API bool llama_memory_seq_rm( llama_memory_t mem, llama_seq_id seq_id, llama_pos p0, llama_pos p1); // Copy all tokens that belong to the specified sequence to another sequence // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) LLAMA_API void llama_memory_seq_cp( llama_memory_t mem, llama_seq_id seq_id_src, llama_seq_id seq_id_dst, llama_pos p0, llama_pos p1); // Removes all tokens that do not belong to the specified sequence LLAMA_API void llama_memory_seq_keep( llama_memory_t mem, llama_seq_id seq_id); // Adds relative position "delta" to all tokens that belong to the specified sequence and have p // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) LLAMA_API void llama_memory_seq_add( llama_memory_t mem, llama_seq_id seq_id, llama_pos p0, llama_pos p1, llama_pos delta); // Integer division of the positions by factor of `d > 1` // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) LLAMA_API void llama_memory_seq_div( llama_memory_t mem, llama_seq_id seq_id, llama_pos p0, llama_pos p1, int d); // Returns the smallest position present in the memory for the specified sequence // This is typically non-zero only for SWA caches // Note that all positions in the range [pos_min, pos_max] are guaranteed to be present in the me // Return -1 if the sequence is empty LLAMA_API llama_pos llama_memory_seq_pos_min( llama_memory_t mem, llama_seq_id seq_id); // Returns the largest position present in the memory for the specified sequence // Note that all positions in the range [pos_min, pos_max] are guaranteed to be present in the me // Return -1 if the sequence is empty LLAMA_API llama_pos llama_memory_seq_pos_max( llama_memory_t mem, llama_seq_id seq_id); // Check if the memory supports shifting LLAMA_API bool llama_memory_can_shift(llama_memory_t mem); // // KV cache for self-attention (TODO: deprecate in favor of llama_memory) // // Returns the number of tokens in the KV cache (slow, use only for debug) // If a KV cell has multiple sequences assigned to it, it will be counted multiple times DEPRECATED(LLAMA_API int32_t llama_kv_self_n_tokens(const struct llama_context * ctx), "Use llama_kv_self_seq_pos_max() and llama_kv_self_seq_pos_min() instead (https://git // Returns the number of used KV cells (i.e. have at least one sequence assigned to them) DEPRECATED(LLAMA_API int32_t llama_kv_self_used_cells(const struct llama_context * ctx "Use llama_kv_self_seq_pos_max() and llama_kv_self_seq_pos_min() instead (https://git // Clear the KV cache - both cell info is erased and KV data is zeroed DEPRECATED(LLAMA_API void llama_kv_self_clear( struct llama_context * ctx), "Use llama_memory_clear() instead"); // Removes all tokens that belong to the specified sequence and have positions in [p0, p1) // Returns false if a partial sequence cannot be removed. Removing a whole sequence never fails // seq_id < 0 : match any sequence // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) DEPRECATED(LLAMA_API bool llama_kv_self_seq_rm( struct llama_context * ctx, llama_seq_id seq_id, llama_pos p0, llama_pos p1), "Use llama_memory_seq_rm() instead"); // Copy all tokens that belong to the specified sequence to another sequence // Note that this does not allocate extra KV cache memory - it simply assigns the tokens to the new // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) DEPRECATED(LLAMA_API void llama_kv_self_seq_cp( struct llama_context * ctx, llama_seq_id seq_id_src, llama_seq_id seq_id_dst, llama_pos p0, llama_pos p1), "Use llama_memory_seq_cp() instead"); // Removes all tokens that do not belong to the specified sequence DEPRECATED(LLAMA_API void llama_kv_self_seq_keep( struct llama_context * ctx, llama_seq_id seq_id), "Use llama_memory_seq_keep() instead"); // Adds relative position "delta" to all tokens that belong to the specified sequence and have p // If the KV cache is RoPEd, the KV data is updated accordingly: // - lazily on next llama_decode() // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) DEPRECATED(LLAMA_API void llama_kv_self_seq_add( struct llama_context * ctx, llama_seq_id seq_id, llama_pos p0, llama_pos p1, llama_pos delta), "Use llama_memory_seq_add() instead"); // Integer division of the positions by factor of `d > 1` // If the KV cache is RoPEd, the KV data is updated accordingly: // - lazily on next llama_decode() // p0 < 0 : [0, p1] // p1 < 0 : [p0, inf) DEPRECATED(LLAMA_API void llama_kv_self_seq_div( struct llama_context * ctx, llama_seq_id seq_id, llama_pos p0, llama_pos p1, int d), "Use llama_memory_seq_div() instead"); // Returns the smallest position present in the KV cache for the specified sequence // This is typically non-zero only for SWA caches // Note that all positions in the range [pos_min, pos_max] are guaranteed to be present in the KV // Return -1 if the sequence is empty DEPRECATED(LLAMA_API llama_pos llama_kv_self_seq_pos_min( struct llama_context * ctx, llama_seq_id seq_id), "Use llama_memory_seq_pos_min() instead"); // Returns the largest position present in the KV cache for the specified sequence // Note that all positions in the range [pos_min, pos_max] are guaranteed to be present in the KV // Return -1 if the sequence is empty DEPRECATED(LLAMA_API llama_pos llama_kv_self_seq_pos_max( struct llama_context * ctx, llama_seq_id seq_id), "Use llama_memory_seq_pos_max() instead"); // Defragment the KV cache // This will be applied: // - lazily on next llama_decode() DEPRECATED(LLAMA_API void llama_kv_self_defrag(struct llama_context * ctx), "simply remove this call, the context will automatically decide when to do a defragmentation b // Check if the context supports KV cache shifting DEPRECATED(LLAMA_API bool llama_kv_self_can_shift(const struct llama_context * ctx), "use llama_memory_can_shift() instead"); // Apply the KV cache updates (such as K-shifts, defragmentation, etc.) DEPRECATED(LLAMA_API void llama_kv_self_update(struct llama_context * ctx), "simply remove this call, updates are applied lazily on the next llama_decode()"); // // State / sessions // // Returns the *actual* size in bytes of the state // (logits, embedding and memory) // Only use when saving the state, not when restoring it, otherwise the size may be too small. LLAMA_API size_t llama_state_get_size(struct llama_context * ctx); LLAMA_API DEPRECATED(size_t llama_get_state_size(struct llama_context * ctx), "use llama_state_get_size instead"); // Copies the state to the specified destination address. // Destination needs to have allocated enough memory. // Returns the number of bytes copied LLAMA_API size_t llama_state_get_data( struct llama_context * ctx, uint8_t * dst, size_t size); LLAMA_API DEPRECATED(size_t llama_copy_state_data( struct llama_context * ctx, uint8_t * dst), "use llama_state_get_data instead"); // Set the state reading from the specified address // Returns the number of bytes read LLAMA_API size_t llama_state_set_data( struct llama_context * ctx, const uint8_t * src, size_t size); LLAMA_API DEPRECATED(size_t llama_set_state_data( struct llama_context * ctx, const uint8_t * src), "use llama_state_set_data instead"); // Save/load session file LLAMA_API bool llama_state_load_file( struct llama_context * ctx, const char * path_session, llama_token * tokens_out, size_t n_token_capacity, size_t * n_token_count_out); LLAMA_API DEPRECATED(bool llama_load_session_file( struct llama_context * ctx, const char * path_session, llama_token * tokens_out, size_t n_token_capacity, size_t * n_token_count_out), "use llama_state_load_file instead"); LLAMA_API bool llama_state_save_file( struct llama_context * ctx, const char * path_session, const llama_token * tokens, size_t n_token_count); LLAMA_API DEPRECATED(bool llama_save_session_file( struct llama_context * ctx, const char * path_session, const llama_token * tokens, size_t n_token_count), "use llama_state_save_file instead"); // Get the exact size needed to copy the state of a single sequence LLAMA_API size_t llama_state_seq_get_size( struct llama_context * ctx, llama_seq_id seq_id); // Copy the state of a single sequence into the specified buffer LLAMA_API size_t llama_state_seq_get_data( struct llama_context * ctx, uint8_t * dst, size_t size, llama_seq_id seq_id); // Copy the sequence data (originally copied with `llama_state_seq_get_data`) into the spec // Returns: // - Positive: Ok // - Zero: Failed to load LLAMA_API size_t llama_state_seq_set_data( struct llama_context * ctx, const uint8_t * src, size_t size, llama_seq_id dest_seq_id); LLAMA_API size_t llama_state_seq_save_file( struct llama_context * ctx, const char * filepath, llama_seq_id seq_id, const llama_token * tokens, size_t n_token_count); LLAMA_API size_t llama_state_seq_load_file( struct llama_context * ctx, const char * filepath, llama_seq_id dest_seq_id, llama_token * tokens_out, size_t n_token_capacity, size_t * n_token_count_out); #define LLAMA_STATE_SEQ_FLAGS_SWA_ONLY 1 typedef uint32_t llama_state_seq_flags; LLAMA_API size_t llama_state_seq_get_size_ext( struct llama_context * ctx, llama_seq_id seq_id, llama_state_seq_flags flags); LLAMA_API size_t llama_state_seq_get_data_ext( struct llama_context * ctx, uint8_t * dst, size_t size, llama_seq_id seq_id, llama_state_seq_flags flags); LLAMA_API size_t llama_state_seq_set_data_ext( struct llama_context * ctx, const uint8_t * src, size_t size, llama_seq_id dest_seq_id, llama_state_seq_flags flags); // // Decoding // // Return batch for single sequence of tokens // The sequence ID will be fixed to 0 // The position of the tokens will be tracked automatically by llama_decode // // NOTE: this is a helper function to facilitate transition to the new batch API - avoid using it // LLAMA_API struct llama_batch llama_batch_get_one( llama_token * tokens, int32_t n_tokens); // Allocates a batch of tokens on the heap that can hold a maximum of n_tokens // Each token can be assigned up to n_seq_max sequence ids // The batch has to be freed with llama_batch_free() // If embd != 0, llama_batch.embd will be allocated with size of n_tokens * embd * sizeof(float) // Otherwise, llama_batch.token will be allocated to store n_tokens llama_token // The rest of the llama_batch members are allocated with size n_tokens // All members are left uninitialized LLAMA_API struct llama_batch llama_batch_init( int32_t n_tokens, int32_t embd, int32_t n_seq_max); // Frees a batch of tokens allocated with llama_batch_init() LLAMA_API void llama_batch_free(struct llama_batch batch); // Process a batch of tokens. // In contrast to llama_decode() - this call does not use KV cache. // For encode-decoder contexts, processes the batch using the encoder. // Can store the encoder output internally for later use by the decoder's cross-attention laye // 0 - success // < 0 - error. the memory state is restored to the state before this call LLAMA_API int32_t llama_encode( struct llama_context * ctx, struct llama_batch batch); // Process a batch of tokens. // Requires the context to have a memory. // For encode-decoder contexts, processes the batch using the decoder. // Positive return values does not mean a fatal error, but rather a warning. // Upon fatal-error or abort, the ubatches that managed to be been processed will remain in the m // To handle this correctly, query the memory state using llama_memory_seq_pos_min() and lla // Upon other return values, the memory state is restored to the state before this call // 0 - success // 1 - could not find a KV slot for the batch (try reducing the size of the batch or increase the cont // 2 - aborted (processed ubatches will remain in the context's memory) // -1 - invalid input batch // < -1 - fatal error (processed ubatches will remain in the context's memory) LLAMA_API int32_t llama_decode( struct llama_context * ctx, struct llama_batch batch); // Set the number of threads used for decoding // n_threads is the number of threads used for generation (single token) // n_threads_batch is the number of threads used for prompt and batch processing (multiple tok LLAMA_API void llama_set_n_threads(struct llama_context * ctx, int32_t n_threads, int32_ // Get the number of threads used for generation of a single token. LLAMA_API int32_t llama_n_threads(struct llama_context * ctx); // Get the number of threads used for prompt and batch processing (multiple token). LLAMA_API int32_t llama_n_threads_batch(struct llama_context * ctx); // Set whether the context outputs embeddings or not // TODO: rename to avoid confusion with llama_get_embeddings() LLAMA_API void llama_set_embeddings(struct llama_context * ctx, bool embeddings); // Set whether to use causal attention or not // If set to true, the model will only attend to the past tokens LLAMA_API void llama_set_causal_attn(struct llama_context * ctx, bool causal_attn); // Set whether the model is in warmup mode or not // If true, all model tensors are activated during llama_decode() to load and cache their weigh LLAMA_API void llama_set_warmup(struct llama_context * ctx, bool warmup); // Set abort callback LLAMA_API void llama_set_abort_callback(struct llama_context * ctx, ggml_abort_callbac // Wait until all computations are finished // This is automatically done when using one of the functions below to obtain the computation re // and is not necessary to call it explicitly in most cases LLAMA_API void llama_synchronize(struct llama_context * ctx); // Token logits obtained from the last call to llama_decode() // The logits for which llama_batch.logits[i] != 0 are stored contiguously // in the order they have appeared in the batch. // Rows: number of tokens for which llama_batch.logits[i] != 0 // Cols: n_vocab // TODO: deprecate in favor of llama_get_logits_ith() (ref: https://github.com/ggml-org/ LLAMA_API float * llama_get_logits(struct llama_context * ctx); // Logits for the ith token. For positive indices, Equivalent to: // llama_get_logits(ctx) + ctx->output_ids[i]*n_vocab // Negative indicies can be used to access logits in reverse order, -1 is the last logit. // returns NULL for invalid ids. LLAMA_API float * llama_get_logits_ith(struct llama_context * ctx, int32_t i); // Get all output token embeddings. // when pooling_type == LLAMA_POOLING_TYPE_NONE or when using a generative model, // the embeddings for which llama_batch.logits[i] != 0 are stored contiguously // in the order they have appeared in the batch. // shape: [n_outputs*n_embd] // Otherwise, returns NULL. // TODO: deprecate in favor of llama_get_embeddings_ith() (ref: https://github.com/ggml- LLAMA_API float * llama_get_embeddings(struct llama_context * ctx); // Get the embeddings for the ith token. For positive indices, Equivalent to: // llama_get_embeddings(ctx) + ctx->output_ids[i]*n_embd // Negative indicies can be used to access embeddings in reverse order, -1 is the last embedding // shape: [n_embd] (1-dimensional) // returns NULL for invalid ids. LLAMA_API float * llama_get_embeddings_ith(struct llama_context * ctx, int32_t i); // Get the embeddings for a sequence id // Returns NULL if pooling_type is LLAMA_POOLING_TYPE_NONE // when pooling_type == LLAMA_POOLING_TYPE_RANK, returns float[n_cls_out] with the rank(s // otherwise: float[n_embd] (1-dimensional) LLAMA_API float * llama_get_embeddings_seq(struct llama_context * ctx, llama_seq_id seq_ // // Vocab // LLAMA_API const char * llama_vocab_get_text(const struct llama_vocab * vocab, llama_token LLAMA_API float llama_vocab_get_score(const struct llama_vocab * vocab, llama_token toke LLAMA_API enum llama_token_attr llama_vocab_get_attr(const struct llama_vocab * vocab, l // Check if the token is supposed to end generation (end-of-generation, eg. EOS, EOT, etc.) LLAMA_API bool llama_vocab_is_eog(const struct llama_vocab * vocab, llama_token token); // Identify if Token Id is a control token or a render-able token LLAMA_API bool llama_vocab_is_control(const struct llama_vocab * vocab, llama_token toke // Special tokens LLAMA_API llama_token llama_vocab_bos(const struct llama_vocab * vocab); // beginning-of LLAMA_API llama_token llama_vocab_eos(const struct llama_vocab * vocab); // end-of-sente LLAMA_API llama_token llama_vocab_eot(const struct llama_vocab * vocab); // end-of-turn LLAMA_API llama_token llama_vocab_sep(const struct llama_vocab * vocab); // sentence sepa LLAMA_API llama_token llama_vocab_nl (const struct llama_vocab * vocab); // next-line LLAMA_API llama_token llama_vocab_pad(const struct llama_vocab * vocab); // padding LLAMA_API llama_token llama_vocab_mask(const struct llama_vocab * vocab); // mask LLAMA_API bool llama_vocab_get_add_bos(const struct llama_vocab * vocab); LLAMA_API bool llama_vocab_get_add_eos(const struct llama_vocab * vocab); LLAMA_API bool llama_vocab_get_add_sep(const struct llama_vocab * vocab); LLAMA_API llama_token llama_vocab_fim_pre(const struct llama_vocab * vocab); LLAMA_API llama_token llama_vocab_fim_suf(const struct llama_vocab * vocab); LLAMA_API llama_token llama_vocab_fim_mid(const struct llama_vocab * vocab); LLAMA_API llama_token llama_vocab_fim_pad(const struct llama_vocab * vocab); LLAMA_API llama_token llama_vocab_fim_rep(const struct llama_vocab * vocab); LLAMA_API llama_token llama_vocab_fim_sep(const struct llama_vocab * vocab); DEPRECATED(LLAMA_API const char * llama_token_get_text(const struct llama_vocab * vocab, DEPRECATED(LLAMA_API float llama_token_get_score(const struct llama_vocab * vocab, llam DEPRECATED(LLAMA_API enum llama_token_attr llama_token_get_attr(const struct llama_vo DEPRECATED(LLAMA_API bool llama_token_is_eog(const struct llama_vocab * vocab, llama_to DEPRECATED(LLAMA_API bool llama_token_is_control(const struct llama_vocab * vocab, llam DEPRECATED(LLAMA_API llama_token llama_token_bos(const struct llama_vocab * vocab), "us DEPRECATED(LLAMA_API llama_token llama_token_eos(const struct llama_vocab * vocab), "us DEPRECATED(LLAMA_API llama_token llama_token_eot(const struct llama_vocab * vocab), "us DEPRECATED(LLAMA_API llama_token llama_token_cls(const struct llama_vocab * vocab), "us DEPRECATED(LLAMA_API llama_token llama_token_sep(const struct llama_vocab * vocab), "us DEPRECATED(LLAMA_API llama_token llama_token_nl (const struct llama_vocab * vocab), "use DEPRECATED(LLAMA_API llama_token llama_token_pad(const struct llama_vocab * vocab), "us DEPRECATED(LLAMA_API bool llama_add_bos_token(const struct llama_vocab * vocab), "use ll DEPRECATED(LLAMA_API bool llama_add_eos_token(const struct llama_vocab * vocab), "use ll DEPRECATED(LLAMA_API llama_token llama_token_fim_pre(const struct llama_vocab * vocab) DEPRECATED(LLAMA_API llama_token llama_token_fim_suf(const struct llama_vocab * vocab) DEPRECATED(LLAMA_API llama_token llama_token_fim_mid(const struct llama_vocab * vocab) DEPRECATED(LLAMA_API llama_token llama_token_fim_pad(const struct llama_vocab * vocab) DEPRECATED(LLAMA_API llama_token llama_token_fim_rep(const struct llama_vocab * vocab) DEPRECATED(LLAMA_API llama_token llama_token_fim_sep(const struct llama_vocab * vocab) // CLS is equivalent to BOS DEPRECATED(LLAMA_API llama_token llama_vocab_cls(const struct llama_vocab * vocab), // c "use llama_vocab_bos instead"); // // Tokenization // // The API is thread-safe. // /// @details Convert the provided text into tokens. /// @param tokens The tokens pointer must be large enough to hold the resulting tokens. /// @return Returns the number of tokens on success, no more than n_tokens_max /// @return Returns a negative number on failure - the number of tokens that would have been retu /// @return Returns INT32_MIN on overflow (e.g., tokenization result size exceeds int32_t li /// @param add_special Allow to add BOS and EOS tokens if model is configured to do so. /// @param parse_special Allow tokenizing special and/or control tokens which otherwise are /// as plaintext. Does not insert a leading space. LLAMA_API int32_t llama_tokenize( const struct llama_vocab * vocab, const char * text, int32_t text_len, llama_token * tokens, int32_t n_tokens_max, bool add_special, bool parse_special); // Token Id -> Piece. // Uses the vocabulary in the provided context. // Does not write null terminator to the buffer. // User can skip up to 'lstrip' leading spaces before copying (useful when encoding/decoding m // @param special If true, special tokens are rendered in the output. LLAMA_API int32_t llama_token_to_piece( const struct llama_vocab * vocab, llama_token token, char * buf, int32_t length, int32_t lstrip, bool special); /// @details Convert the provided tokens into text (inverse of llama_tokenize()). /// @param text The char pointer must be large enough to hold the resulting text. /// @return Returns the number of chars/bytes on success, no more than text_len_max. /// @return Returns a negative number on failure - the number of chars/bytes that would have bee /// @param remove_special Allow to remove BOS and EOS tokens if model is configured to do so. /// @param unparse_special If true, special tokens are rendered in the output. LLAMA_API int32_t llama_detokenize( const struct llama_vocab * vocab, const llama_token * tokens, int32_t n_tokens, char * text, int32_t text_len_max, bool remove_special, bool unparse_special); // // Chat templates // /// Apply chat template. Inspired by hf apply_chat_template() on python. /// Both "model" and "custom_template" are optional, but at least one is required. "custom_te /// NOTE: This function does not use a jinja parser. It only support a pre-defined list of templa /// @param tmpl A Jinja template to use for this chat. If this is nullptr, the model’s default chat /// @param chat Pointer to a list of multiple llama_chat_message /// @param n_msg Number of llama_chat_message in this chat /// @param add_ass Whether to end the prompt with the token(s) that indicate the start of an assi /// @param buf A buffer to hold the output formatted prompt. The recommended alloc size is 2 * (to /// @param length The size of the allocated buffer /// @return The total number of bytes of the formatted prompt. If is it larger than the size of buf LLAMA_API int32_t llama_chat_apply_template( const char * tmpl, const struct llama_chat_message * chat, size_t n_msg, bool add_ass, char * buf, int32_t length); // Get list of built-in chat templates LLAMA_API int32_t llama_chat_builtin_templates(const char ** output, size_t len); // // Sampling API // // Sample usage: // // // prepare the sampling chain at the start // auto sparams = llama_sampler_chain_default_params(); // // llama_sampler * smpl = llama_sampler_chain_init(sparams); // // llama_sampler_chain_add(smpl, llama_sampler_init_top_k(50)); // llama_sampler_chain_add(smpl, llama_sampler_init_top_p(0.9, 1)); // llama_sampler_chain_add(smpl, llama_sampler_init_temp (0.8)); // // // typically, the chain should end with a sampler such as "greedy", "dist" or "mirostat" // // this sampler will be responsible to select the actual token // llama_sampler_chain_add(smpl, llama_sampler_init_dist(seed)); // // ... // // // decoding loop: // while (...) { // ... // // llama_decode(ctx, batch); // // // sample from the logits of the last token in the batch // const llama_token id = llama_sampler_sample(smpl, ctx, -1); // // // accepting the token updates the internal state of certain samplers (e.g. grammar, repeti // llama_sampler_accept(smpl, id); // ... // } // // llama_sampler_free(smpl); // // TODO: In the future, llama_sampler will be utilized to offload the sampling to the backends ( // typedef void * llama_sampler_context_t; // user code can implement the interface below in order to create custom llama_sampler struct llama_sampler_i { const char * (*name) (const struct llama_sampler * smpl); // can be NULL void (*accept)( struct llama_sampler * smpl, llama_token token); // can be NULL void (*apply) ( struct llama_sampler * smpl, llama_token_data_array * cur_p); // required void (*reset) ( struct llama_sampler * smpl); // can be NULL struct llama_sampler * (*clone) (const struct llama_sampler * smpl); // can be NULL if ctx is NU void (*free) ( struct llama_sampler * smpl); // can be NULL if ctx is NULL // TODO: API for internal libllama usage for appending the sampling to an existing ggml_cgraph //void (*apply_ggml) (struct llama_sampler * smpl, ...); }; struct llama_sampler { const struct llama_sampler_i * iface; llama_sampler_context_t ctx; }; // mirror of llama_sampler_i: LLAMA_API struct llama_sampler * llama_sampler_init (const struct llama_sampler_i * iface LLAMA_API const char * llama_sampler_name (const struct llama_sampler * smpl); LLAMA_API void llama_sampler_accept( struct llama_sampler * smpl, llama_token token); LLAMA_API void llama_sampler_apply ( struct llama_sampler * smpl, llama_token_data_array LLAMA_API void llama_sampler_reset ( struct llama_sampler * smpl); LLAMA_API struct llama_sampler * llama_sampler_clone (const struct llama_sampler * smpl); // important: do not free if the sampler has been added to a llama_sampler_chain (via llama_sam LLAMA_API void llama_sampler_free ( struct llama_sampler * smpl); // llama_sampler_chain // a type of llama_sampler that can chain multiple samplers one after another LLAMA_API struct llama_sampler * llama_sampler_chain_init(struct llama_sampler_chain_ // important: takes ownership of the sampler object and will free it when llama_sampler_free i LLAMA_API void llama_sampler_chain_add( struct llama_sampler * chain, struct llama_sampl LLAMA_API struct llama_sampler * llama_sampler_chain_get(const struct llama_sampler * ch LLAMA_API int llama_sampler_chain_n (const struct llama_sampler * chain); // after removing a sampler, the chain will no longer own it, and it will not be freed when the chai LLAMA_API struct llama_sampler * llama_sampler_chain_remove( struct llama_sampler * chai // available samplers: LLAMA_API struct llama_sampler * llama_sampler_init_greedy(void); LLAMA_API struct llama_sampler * llama_sampler_init_dist (uint32_t seed); /// @details Sorts candidate tokens by their logits in descending order and calculate probabi /// NOTE: Avoid using on the full vocabulary as the sorting can become slow. For example, apply t DEPRECATED(LLAMA_API struct llama_sampler * llama_sampler_init_softmax (void), "will be removed in the future (see https://github.com/ggml-org/llama.cpp/pull/9896#dis /// @details Top-K sampling described in academic paper "The Curious Case of Neural Text Degen /// Setting k <= 0 makes this a noop LLAMA_API struct llama_sampler * llama_sampler_init_top_k (int32_t k); /// @details Nucleus sampling described in academic paper "The Curious Case of Neural Text Deg LLAMA_API struct llama_sampler * llama_sampler_init_top_p (float p, size_t min_keep); /// @details Minimum P sampling as described in https://github.com/ggml-org/llama.cpp/pu LLAMA_API struct llama_sampler * llama_sampler_init_min_p (float p, size_t min_keep); /// @details Locally Typical Sampling implementation described in the paper https://arxiv. LLAMA_API struct llama_sampler * llama_sampler_init_typical (float p, size_t min_keep); /// #details Updates the logits l_i` = l_i/t. When t <= 0.0f, the maximum logit is kept at it's orig LLAMA_API struct llama_sampler * llama_sampler_init_temp (float t); /// @details Dynamic temperature implementation (a.k.a. entropy) described in the paper htt LLAMA_API struct llama_sampler * llama_sampler_init_temp_ext (float t, float delta, float /// @details XTC sampler as described in https://github.com/oobabooga/text-generation-w LLAMA_API struct llama_sampler * llama_sampler_init_xtc (float p, float t, size_t min_keep /// @details Top n sigma sampling as described in academic paper "Top-nσ: Not All Logits Are You N LLAMA_API struct llama_sampler * llama_sampler_init_top_n_sigma(float n); /// @details Mirostat 1.0 algorithm described in the paper https://arxiv.org/abs/2007.149 /// @param candidates A vector of `llama_token_data` containing the candidate tokens, their /// @param tau The target cross-entropy (or surprise) value you want to achieve for the generat /// @param eta The learning rate used to update `mu` based on the error between the target and obs /// @param m The number of tokens considered in the estimation of `s_hat`. This is an arbitrary v /// @param mu Maximum cross-entropy. This value is initialized to be twice the target cross-en LLAMA_API struct llama_sampler * llama_sampler_init_mirostat( int32_t n_vocab, uint32_t seed, float tau, float eta, int32_t m); /// @details Mirostat 2.0 algorithm described in the paper https://arxiv.org/abs/2007.149 /// @param candidates A vector of `llama_token_data` containing the candidate tokens, their /// @param tau The target cross-entropy (or surprise) value you want to achieve for the generat /// @param eta The learning rate used to update `mu` based on the error between the target and obs /// @param mu Maximum cross-entropy. This value is initialized to be twice the target cross-en LLAMA_API struct llama_sampler * llama_sampler_init_mirostat_v2( uint32_t seed, float tau, float eta); /// @details Intializes a GBNF grammar, see grammars/README.md for details. /// @param vocab The vocabulary that this grammar will be used with. /// @param grammar_str The production rules for the grammar, encoded as a string. Returns an em /// @param grammar_root The name of the start symbol for the grammar. LLAMA_API struct llama_sampler * llama_sampler_init_grammar( const struct llama_vocab * vocab, const char * grammar_str, const char * grammar_root); DEPRECATED(LLAMA_API struct llama_sampler * llama_sampler_init_grammar_lazy( const struct llama_vocab * vocab, const char * grammar_str, const char * grammar_root, const char ** trigger_words, size_t num_trigger_words, const llama_token * trigger_tokens, size_t num_trigger_tokens), "use llama_sampler_init_grammar_lazy_patterns instead"); /// @details Lazy grammar sampler, introduced in https://github.com/ggml-org/llama.cpp/ /// @param trigger_patterns A list of patterns that will trigger the grammar sampler. Pattern /// @param trigger_tokens A list of tokens that will trigger the grammar sampler. Grammar samp LLAMA_API struct llama_sampler * llama_sampler_init_grammar_lazy_patterns( const struct llama_vocab * vocab, const char * grammar_str, const char * grammar_root, const char ** trigger_patterns, size_t num_trigger_patterns, const llama_token * trigger_tokens, size_t num_trigger_tokens); /// NOTE: Avoid using on the full vocabulary as searching for repeated tokens can become slow. F LLAMA_API struct llama_sampler * llama_sampler_init_penalties( int32_t penalty_last_n, // last n tokens to penalize (0 = disable penalty, -1 = context size) float penalty_repeat, // 1.0 = disabled float penalty_freq, // 0.0 = disabled float penalty_present); // 0.0 = disabled /// @details DRY sampler, designed by p-e-w, as described in: https://github.com/oobabooga LLAMA_API struct llama_sampler * llama_sampler_init_dry( const struct llama_vocab * vocab, int32_t n_ctx_train, float dry_multiplier, float dry_base, int32_t dry_allowed_length, int32_t dry_penalty_last_n, const char ** seq_breakers, size_t num_breakers); LLAMA_API struct llama_sampler * llama_sampler_init_logit_bias( int32_t n_vocab, int32_t n_logit_bias, const llama_logit_bias * logit_bias); // this sampler is meant to be used for fill-in-the-middle infilling // it's supposed to be used after top_k + top_p sampling // // 1. if the sum of the EOG probs times the number of candidates is higher than the sum of the other p // 2. combine probs of tokens that have the same prefix // // example: // // - before: // "hel": 0.5 // "hell": 0.2 // "hello": 0.1 // "dummy": 0.1 // // - after: // "hel": 0.8 // "dummy": 0.1 // // 3. discard non-EOG tokens with low prob // 4. if no tokens are left -> pick EOT // LLAMA_API struct llama_sampler * llama_sampler_init_infill(const struct llama_vocab * vo // Returns the seed used by the sampler if applicable, LLAMA_DEFAULT_SEED otherwise LLAMA_API uint32_t llama_sampler_get_seed(const struct llama_sampler * smpl); /// @details Sample and accept a token from the idx-th output of the last evaluation // // Shorthand for: // const auto * logits = llama_get_logits_ith(ctx, idx); // llama_token_data_array cur_p = { ... init from logits ... }; // llama_sampler_apply(smpl, &cur_p); // auto token = cur_p.data[cur_p.selected].id; // llama_sampler_accept(smpl, token); // return token; // Returns the sampled token LLAMA_API llama_token llama_sampler_sample(struct llama_sampler * smpl, struct llama_co // TODO: extend in the future //LLAMA_API void llama_decode_with_sampler(struct llama_context * ctx, struct llama_sam // // Model split // /// @details Build a split GGUF final path for this chunk. /// llama_split_path(split_path, sizeof(split_path), "/models/ggml-model-q4_0", 2, 4) // Returns the split_path length. LLAMA_API int llama_split_path(char * split_path, size_t maxlen, const char * path_prefix, /// @details Extract the path prefix from the split_path if and only if the split_no and split_c /// llama_split_prefix(split_prefix, 64, "/models/ggml-model-q4_0-00002-of-00004.gg // Returns the split_prefix length. LLAMA_API int llama_split_prefix(char * split_prefix, size_t maxlen, const char * split_pa // Print system information LLAMA_API const char * llama_print_system_info(void); // Set callback for all future logging events. // If this is not called, or NULL is supplied, everything is output on stderr. LLAMA_API void llama_log_set(ggml_log_callback log_callback, void * user_data); // // Performance utils // // NOTE: Used by llama.cpp examples, avoid using in third-party apps. Instead, do your own perf // struct llama_perf_context_data { double t_start_ms; double t_load_ms; double t_p_eval_ms; double t_eval_ms; int32_t n_p_eval; int32_t n_eval; int32_t n_reused; // number of times a ggml compute graph had been reused }; struct llama_perf_sampler_data { double t_sample_ms; int32_t n_sample; }; LLAMA_API struct llama_perf_context_data llama_perf_context (const struct llama_contex LLAMA_API void llama_perf_context_print(const struct llama_context * ctx); LLAMA_API void llama_perf_context_reset( struct llama_context * ctx); // NOTE: the following work only with samplers constructed via llama_sampler_chain_init LLAMA_API struct llama_perf_sampler_data llama_perf_sampler (const struct llama_sample LLAMA_API void llama_perf_sampler_print(const struct llama_sampler * chain); LLAMA_API void llama_perf_sampler_reset( struct llama_sampler * chain); // // training // // function that returns whether or not a given tensor contains trainable parameters typedef bool (*llama_opt_param_filter)(const struct ggml_tensor * tensor, void * userdata // always returns true LLAMA_API bool llama_opt_param_filter_all(const struct ggml_tensor * tensor, void * userd struct llama_opt_params { uint32_t n_ctx_train; // assumed context size post training, use context size specified in ll llama_opt_param_filter param_filter; // callback for determining which tensors contain tr void * param_filter_ud; // userdata for determining which tensors contain trainable paramet ggml_opt_get_optimizer_params get_opt_pars; // callback for calculating optimizer param void * get_opt_pars_ud; // userdata for calculating optimizer parameters enum ggml_opt_optimizer_type optimizer_type; }; LLAMA_API void llama_opt_init(struct llama_context * lctx, struct llama_model * model, str LLAMA_API void llama_opt_epoch( struct llama_context * lctx, ggml_opt_dataset_t dataset, ggml_opt_result_t result_train, ggml_opt_result_t result_eval, int64_t idata_split, ggml_opt_epoch_callback callback_train, ggml_opt_epoch_callback callback_eval); #ifdef __cplusplus } #endif #endif // LLAMA_H
¤ Dauer der Verarbeitung: 0.27 Sekunden ¤*© Formatika GbR, Deutschland |
|
||||||||||||||
2026-08-25