Coverage Report

Created: 2025-12-28 06:26

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/llama.cpp/common/sampling.cpp
Line
Count
Source
1
#include "sampling.h"
2
3
#include "common.h"
4
#include "log.h"
5
6
#include <algorithm>
7
#include <cmath>
8
#include <cstring>
9
#include <unordered_map>
10
11
// the ring buffer works similarly to std::deque, but with a fixed capacity
12
// TODO: deduplicate with llama-impl.h
13
template<typename T>
14
struct ring_buffer {
15
0
    ring_buffer(size_t cap) : capacity(cap), data(cap) {}
16
17
    T & front() {
18
        if (sz == 0) {
19
            throw std::runtime_error("ring buffer is empty");
20
        }
21
        return data[first];
22
    }
23
24
    const T & front() const {
25
        if (sz == 0) {
26
            throw std::runtime_error("ring buffer is empty");
27
        }
28
        return data[first];
29
    }
30
31
    T & back() {
32
        if (sz == 0) {
33
            throw std::runtime_error("ring buffer is empty");
34
        }
35
        return data[pos];
36
    }
37
38
    const T & back() const {
39
        if (sz == 0) {
40
            throw std::runtime_error("ring buffer is empty");
41
        }
42
        return data[pos];
43
    }
44
45
0
    void push_back(const T & value) {
46
0
        if (sz == capacity) {
47
            // advance the start when buffer is full
48
0
            first = (first + 1) % capacity;
49
0
        } else {
50
0
            sz++;
51
0
        }
52
0
        data[pos] = value;
53
0
        pos = (pos + 1) % capacity;
54
0
    }
55
56
    T pop_front() {
57
        if (sz == 0) {
58
            throw std::runtime_error("ring buffer is empty");
59
        }
60
        T value = data[first];
61
        first = (first + 1) % capacity;
62
        sz--;
63
        return value;
64
    }
65
66
0
    const T & rat(size_t i) const {
67
0
        if (i >= sz) {
68
0
            throw std::runtime_error("ring buffer: index out of bounds");
69
0
        }
70
0
        return data[(first + sz - i - 1) % capacity];
71
0
    }
72
73
    std::vector<T> to_vector() const {
74
        std::vector<T> result;
75
        result.reserve(sz);
76
        for (size_t i = 0; i < sz; i++) {
77
            result.push_back(data[(first + i) % capacity]);
78
        }
79
        return result;
80
    }
81
82
0
    void clear() {
83
        // here only reset the status of the buffer
84
0
        sz = 0;
85
0
        first = 0;
86
0
        pos = 0;
87
0
    }
88
89
    bool empty() const {
90
        return sz == 0;
91
    }
92
93
0
    size_t size() const {
94
0
        return sz;
95
0
    }
96
97
    size_t capacity = 0;
98
    size_t sz = 0;
99
    size_t first = 0;
100
    size_t pos = 0;
101
    std::vector<T> data;
102
};
103
104
struct common_sampler {
105
    common_params_sampling params;
106
107
    struct llama_sampler * grmr;
108
    struct llama_sampler * chain;
109
110
    ring_buffer<llama_token> prev;
111
112
    std::vector<llama_token_data> cur;
113
114
    llama_token_data_array cur_p;
115
116
0
    void reset() {
117
0
        prev.clear();
118
119
0
        llama_sampler_reset(chain);
120
0
    }
121
122
0
    void set_logits(struct llama_context * ctx, int idx) {
123
0
        const auto * logits = llama_get_logits_ith(ctx, idx);
124
125
0
        const llama_model * model = llama_get_model(ctx);
126
0
        const llama_vocab * vocab = llama_model_get_vocab(model);
127
128
0
        const int n_vocab = llama_vocab_n_tokens(vocab);
129
130
0
        cur.resize(n_vocab);
131
132
0
        for (llama_token token_id = 0; token_id < n_vocab; token_id++) {
133
0
            cur[token_id] = llama_token_data{token_id, logits[token_id], 0.0f};
134
0
        }
135
136
0
        cur_p = { cur.data(), cur.size(), -1, false };
137
0
    }
138
139
0
    common_time_meas tm() {
140
0
        return common_time_meas(t_total_us, params.no_perf);
141
0
    }
142
143
    mutable int64_t t_total_us = 0;
144
};
145
146
0
std::string common_params_sampling::print() const {
147
0
    char result[1024];
148
149
0
    snprintf(result, sizeof(result),
150
0
            "\trepeat_last_n = %d, repeat_penalty = %.3f, frequency_penalty = %.3f, presence_penalty = %.3f\n"
151
0
            "\tdry_multiplier = %.3f, dry_base = %.3f, dry_allowed_length = %d, dry_penalty_last_n = %d\n"
152
0
            "\ttop_k = %d, top_p = %.3f, min_p = %.3f, xtc_probability = %.3f, xtc_threshold = %.3f, typical_p = %.3f, top_n_sigma = %.3f, temp = %.3f\n"
153
0
            "\tmirostat = %d, mirostat_lr = %.3f, mirostat_ent = %.3f",
154
0
            penalty_last_n, penalty_repeat, penalty_freq, penalty_present,
155
0
            dry_multiplier, dry_base, dry_allowed_length, dry_penalty_last_n,
156
0
            top_k, top_p, min_p, xtc_probability, xtc_threshold, typ_p, top_n_sigma, temp,
157
0
            mirostat, mirostat_eta, mirostat_tau);
158
159
0
    return std::string(result);
160
0
}
161
162
0
struct common_sampler * common_sampler_init(const struct llama_model * model, const struct common_params_sampling & params) {
163
0
    const llama_vocab * vocab = llama_model_get_vocab(model);
164
165
0
    llama_sampler_chain_params lparams = llama_sampler_chain_default_params();
166
167
0
    lparams.no_perf = params.no_perf;
168
169
0
    llama_sampler * grmr = nullptr;
170
0
    llama_sampler * chain = llama_sampler_chain_init(lparams);
171
172
0
    std::vector<llama_sampler *> samplers;
173
174
0
    if (params.grammar.compare(0, 11, "%llguidance") == 0) {
175
#ifdef LLAMA_USE_LLGUIDANCE
176
        grmr = llama_sampler_init_llg(vocab, "lark", params.grammar.c_str());
177
#else
178
0
        GGML_ABORT("llguidance (cmake -DLLAMA_LLGUIDANCE=ON) is not enabled");
179
0
#endif // LLAMA_USE_LLGUIDANCE
180
0
    } else {
181
0
        std::vector<std::string> trigger_patterns;
182
0
        std::vector<std::string> patterns_anywhere;
183
0
        std::vector<llama_token> trigger_tokens;
184
0
        for (const auto & trigger : params.grammar_triggers) {
185
0
            switch (trigger.type) {
186
0
                case COMMON_GRAMMAR_TRIGGER_TYPE_WORD:
187
0
                {
188
0
                    const auto & word = trigger.value;
189
0
                    patterns_anywhere.push_back(regex_escape(word));
190
0
                    break;
191
0
                }
192
0
                case COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN:
193
0
                {
194
0
                    patterns_anywhere.push_back(trigger.value);
195
0
                    break;
196
0
                }
197
0
                case COMMON_GRAMMAR_TRIGGER_TYPE_PATTERN_FULL:
198
0
                {
199
0
                    trigger_patterns.push_back(trigger.value);
200
0
                    break;
201
0
                }
202
0
                case COMMON_GRAMMAR_TRIGGER_TYPE_TOKEN:
203
0
                {
204
0
                    const auto token = trigger.token;
205
0
                    trigger_tokens.push_back(token);
206
0
                    break;
207
0
                }
208
0
                default:
209
0
                    GGML_ASSERT(false && "unknown trigger type");
210
0
            }
211
0
        }
212
213
0
        if (!patterns_anywhere.empty()) {
214
0
            trigger_patterns.push_back("^[\\s\\S]*?(" + string_join(patterns_anywhere, "|") + ")[\\s\\S]*");
215
0
        }
216
217
0
        std::vector<const char *> trigger_patterns_c;
218
0
        trigger_patterns_c.reserve(trigger_patterns.size());
219
0
        for (const auto & regex : trigger_patterns) {
220
0
            trigger_patterns_c.push_back(regex.c_str());
221
0
        }
222
223
0
        if (!params.grammar.empty()) {
224
0
             if (params.grammar_lazy) {
225
0
                 grmr = llama_sampler_init_grammar_lazy_patterns(vocab, params.grammar.c_str(), "root",
226
0
                         trigger_patterns_c.data(), trigger_patterns_c.size(),
227
0
                         trigger_tokens.data(), trigger_tokens.size());
228
0
             } else {
229
0
                 grmr = llama_sampler_init_grammar(vocab, params.grammar.c_str(), "root");
230
0
             }
231
0
        }
232
0
    }
233
234
0
    if (params.has_logit_bias()) {
235
0
        samplers.push_back(llama_sampler_init_logit_bias(llama_vocab_n_tokens(vocab), params.logit_bias.size(), params.logit_bias.data()));
236
0
    }
237
238
0
    if (params.mirostat == 0) {
239
0
        for (const auto & cnstr : params.samplers) {
240
0
            switch (cnstr) {
241
0
                case COMMON_SAMPLER_TYPE_DRY:
242
0
                    {
243
0
                        std::vector<const char *> c_breakers;
244
0
                        c_breakers.reserve(params.dry_sequence_breakers.size());
245
0
                        for (const auto & str : params.dry_sequence_breakers) {
246
0
                            c_breakers.push_back(str.c_str());
247
0
                        }
248
249
0
                        samplers.push_back(llama_sampler_init_dry    (vocab, llama_model_n_ctx_train(model), params.dry_multiplier, params.dry_base, params.dry_allowed_length, params.dry_penalty_last_n, c_breakers.data(), c_breakers.size()));
250
0
                    }
251
0
                    break;
252
0
                case COMMON_SAMPLER_TYPE_TOP_K:
253
0
                    samplers.push_back(llama_sampler_init_top_k      (params.top_k));
254
0
                    break;
255
0
                case COMMON_SAMPLER_TYPE_TOP_P:
256
0
                    samplers.push_back(llama_sampler_init_top_p      (params.top_p, params.min_keep));
257
0
                    break;
258
0
                case COMMON_SAMPLER_TYPE_TOP_N_SIGMA:
259
0
                    samplers.push_back(llama_sampler_init_top_n_sigma(params.top_n_sigma));
260
0
                    break;
261
0
                case COMMON_SAMPLER_TYPE_MIN_P:
262
0
                    samplers.push_back(llama_sampler_init_min_p      (params.min_p, params.min_keep));
263
0
                    break;
264
0
                case COMMON_SAMPLER_TYPE_XTC:
265
0
                    samplers.push_back(llama_sampler_init_xtc        (params.xtc_probability, params.xtc_threshold, params.min_keep, params.seed));
266
0
                    break;
267
0
                case COMMON_SAMPLER_TYPE_TYPICAL_P:
268
0
                    samplers.push_back(llama_sampler_init_typical    (params.typ_p, params.min_keep));
269
0
                    break;
270
0
                case COMMON_SAMPLER_TYPE_TEMPERATURE:
271
0
                    samplers.push_back(llama_sampler_init_temp_ext   (params.temp, params.dynatemp_range, params.dynatemp_exponent));
272
0
                    break;
273
0
                case COMMON_SAMPLER_TYPE_INFILL:
274
0
                    samplers.push_back(llama_sampler_init_infill     (vocab));
275
0
                    break;
276
0
                case COMMON_SAMPLER_TYPE_PENALTIES:
277
0
                    samplers.push_back(llama_sampler_init_penalties  (params.penalty_last_n, params.penalty_repeat, params.penalty_freq, params.penalty_present));
278
0
                    break;
279
0
                default:
280
0
                    GGML_ASSERT(false && "unknown sampler type");
281
0
            }
282
0
        }
283
284
0
        samplers.push_back(llama_sampler_init_dist(params.seed));
285
0
    } else if (params.mirostat == 1) {
286
0
        samplers.push_back(llama_sampler_init_temp(params.temp));
287
0
        samplers.push_back(llama_sampler_init_mirostat(llama_vocab_n_tokens(vocab), params.seed, params.mirostat_tau, params.mirostat_eta, 100));
288
0
    } else if (params.mirostat == 2) {
289
0
        samplers.push_back(llama_sampler_init_temp(params.temp));
290
0
        samplers.push_back(llama_sampler_init_mirostat_v2(params.seed, params.mirostat_tau, params.mirostat_eta));
291
0
    } else {
292
0
        GGML_ASSERT(false && "unknown mirostat version");
293
0
    }
294
295
0
    for (auto * smpl : samplers) {
296
0
        llama_sampler_chain_add(chain, smpl);
297
0
    }
298
299
0
    auto * result = new common_sampler {
300
0
        /* .params  = */ params,
301
0
        /* .grmr    = */ grmr,
302
0
        /* .chain   = */ chain,
303
0
        /* .prev    = */ ring_buffer<llama_token>(std::max(32, params.n_prev)),
304
0
        /* .cur     = */ {},
305
0
        /* .cur_p   = */ {},
306
0
    };
307
308
0
    return result;
309
0
}
310
311
0
void common_sampler_free(struct common_sampler * gsmpl) {
312
0
    if (gsmpl) {
313
0
        llama_sampler_free(gsmpl->grmr);
314
0
        llama_sampler_free(gsmpl->chain);
315
316
0
        delete gsmpl;
317
0
    }
318
0
}
319
320
0
void common_sampler_accept(struct common_sampler * gsmpl, llama_token token, bool accept_grammar) {
321
0
    const auto tm = gsmpl->tm();
322
323
0
    if (gsmpl->grmr && accept_grammar) {
324
0
        llama_sampler_accept(gsmpl->grmr, token);
325
0
    }
326
327
0
    llama_sampler_accept(gsmpl->chain, token);
328
329
0
    gsmpl->prev.push_back(token);
330
0
}
331
332
0
void common_sampler_reset(struct common_sampler * gsmpl) {
333
0
    gsmpl->reset();
334
0
}
335
336
0
struct common_sampler * common_sampler_clone(common_sampler * gsmpl) {
337
0
    return new common_sampler {
338
0
        /* .params  = */ gsmpl->params,
339
0
        /* .grmr    = */ llama_sampler_clone(gsmpl->grmr),
340
0
        /* .chain   = */ llama_sampler_clone(gsmpl->chain),
341
0
        /* .prev    = */ gsmpl->prev,
342
0
        /* .cur     = */ gsmpl->cur,
343
0
        /* .cur_p   = */ gsmpl->cur_p,
344
0
    };
345
0
}
346
347
0
void common_perf_print(const struct llama_context * ctx, const struct common_sampler * gsmpl) {
348
    // TODO: measure grammar performance
349
350
0
    const double t_sampling_ms = gsmpl ? 1e-3*gsmpl->t_total_us : 0;
351
352
0
    llama_perf_sampler_data data_smpl;
353
0
    llama_perf_context_data data_ctx;
354
355
0
    memset(&data_smpl, 0, sizeof(data_smpl));
356
0
    memset(&data_ctx,  0, sizeof(data_ctx));
357
358
0
    if (gsmpl) {
359
0
        auto & data = data_smpl;
360
361
0
        data = llama_perf_sampler(gsmpl->chain);
362
363
        // note: the sampling time includes the samplers time + extra time spent in common/sampling
364
0
        LOG_INF("%s:    sampling time = %10.2f ms\n", __func__, t_sampling_ms);
365
0
        LOG_INF("%s:    samplers time = %10.2f ms / %5d tokens\n", __func__, data.t_sample_ms, data.n_sample);
366
0
    }
367
368
0
    if (ctx) {
369
0
        auto & data = data_ctx;
370
371
0
        data = llama_perf_context(ctx);
372
373
0
        const double t_end_ms = 1e-3 * ggml_time_us();
374
375
0
        const double t_total_ms = t_end_ms - data.t_start_ms;
376
0
        const double t_unacc_ms = t_total_ms - (t_sampling_ms + data.t_p_eval_ms + data.t_eval_ms);
377
0
        const double t_unacc_pc = 100.0 * t_unacc_ms /  t_total_ms;
378
379
0
        LOG_INF("%s:        load time = %10.2f ms\n", __func__, data.t_load_ms);
380
0
        LOG_INF("%s: prompt eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n",
381
0
                __func__, data.t_p_eval_ms, data.n_p_eval, data.t_p_eval_ms / data.n_p_eval, 1e3 / data.t_p_eval_ms * data.n_p_eval);
382
0
        LOG_INF("%s:        eval time = %10.2f ms / %5d runs   (%8.2f ms per token, %8.2f tokens per second)\n",
383
0
                __func__, data.t_eval_ms, data.n_eval, data.t_eval_ms / data.n_eval, 1e3 / data.t_eval_ms * data.n_eval);
384
0
        LOG_INF("%s:       total time = %10.2f ms / %5d tokens\n", __func__, (t_end_ms - data.t_start_ms), (data.n_p_eval + data.n_eval));
385
0
        LOG_INF("%s: unaccounted time = %10.2f ms / %5.1f %%      (total - sampling - prompt eval - eval) / (total)\n", __func__, t_unacc_ms, t_unacc_pc);
386
0
        LOG_INF("%s:    graphs reused = %10d\n", __func__, data.n_reused);
387
388
0
        llama_memory_breakdown_print(ctx);
389
0
    }
390
0
}
391
392
0
struct llama_sampler * common_sampler_get(const struct common_sampler * gsmpl) {
393
0
    return gsmpl->chain;
394
0
}
395
396
0
llama_token common_sampler_sample(struct common_sampler * gsmpl, struct llama_context * ctx, int idx, bool grammar_first) {
397
0
    llama_synchronize(ctx);
398
399
    // start measuring sampling time after the llama_context synchronization in order to not measure any ongoing async operations
400
0
    const auto tm = gsmpl->tm();
401
402
0
    llama_token id = LLAMA_TOKEN_NULL;
403
404
0
    auto & grmr  = gsmpl->grmr;
405
0
    auto & chain = gsmpl->chain;
406
0
    auto & cur_p = gsmpl->cur_p; // initialized by set_logits
407
408
0
    gsmpl->set_logits(ctx, idx);
409
410
0
    if (grammar_first) {
411
0
        llama_sampler_apply(grmr, &cur_p);
412
0
    }
413
414
0
    llama_sampler_apply(chain, &cur_p);
415
416
0
    id = cur_p.data[cur_p.selected].id;
417
418
0
    if (grammar_first) {
419
0
        return id;
420
0
    }
421
422
    // check if it the sampled token fits the grammar (grammar-based rejection sampling)
423
0
    {
424
0
        llama_token_data       single_token_data       = { id, 1.0f, 0.0f };
425
0
        llama_token_data_array single_token_data_array = { &single_token_data, 1, -1, false };
426
427
0
        llama_sampler_apply(grmr, &single_token_data_array);
428
429
0
        const bool is_valid = single_token_data_array.data[0].logit != -INFINITY;
430
0
        if (is_valid) {
431
0
            return id;
432
0
        }
433
0
    }
434
435
    // resampling:
436
    // if the token is not valid, sample again, but first apply the grammar sampler and then the sampling chain
437
0
    gsmpl->set_logits(ctx, idx);
438
439
0
    llama_sampler_apply(grmr,  &cur_p);
440
0
    llama_sampler_apply(chain, &cur_p);
441
442
0
    GGML_ASSERT(cur_p.selected != -1 && "no selected token during sampling - check your sampling configuration");
443
444
0
    id = cur_p.data[cur_p.selected].id;
445
446
0
    return id;
447
0
}
448
449
0
std::vector<llama_token> common_sampler_sample_and_accept_n(struct common_sampler * gsmpl, struct llama_context * ctx, const std::vector<int> & idxs, const llama_tokens & draft, bool grammar_first) {
450
0
    GGML_ASSERT(idxs.size() == draft.size() + 1 && "idxs.size() must be draft.size() + 1");
451
452
0
    std::vector<llama_token> result;
453
0
    result.reserve(idxs.size());
454
455
0
    size_t i = 0;
456
0
    for (; i < draft.size(); i++) {
457
0
        const llama_token id = common_sampler_sample(gsmpl, ctx, idxs[i], grammar_first);
458
459
0
        common_sampler_accept(gsmpl, id, true);
460
461
0
        result.push_back(id);
462
463
0
        if (draft[i] != id) {
464
0
            break;
465
0
        }
466
0
    }
467
468
0
    if (i == draft.size()) {
469
0
        const llama_token id = common_sampler_sample(gsmpl, ctx, idxs[i], grammar_first);
470
471
0
        common_sampler_accept(gsmpl, id, true);
472
473
0
        result.push_back(id);
474
0
    }
475
476
0
    return result;
477
0
}
478
479
0
std::vector<llama_token> common_sampler_sample_and_accept_n(struct common_sampler * gsmpl, struct llama_context * ctx, const llama_tokens & draft, bool grammar_first) {
480
0
    std::vector<int> idxs(draft.size() + 1);
481
0
    for (size_t i = 0; i < idxs.size(); ++i) {
482
0
        idxs[i] = i;
483
0
    }
484
485
0
    return common_sampler_sample_and_accept_n(gsmpl, ctx, idxs, draft, grammar_first);
486
0
}
487
488
0
uint32_t common_sampler_get_seed(const struct common_sampler * gsmpl) {
489
0
    return llama_sampler_get_seed(gsmpl->chain);
490
0
}
491
492
// helpers
493
494
0
llama_token_data_array * common_sampler_get_candidates(struct common_sampler * gsmpl, bool do_sort) {
495
0
    const auto tm = gsmpl->tm();
496
497
0
    auto * res = &gsmpl->cur_p;
498
499
0
    if (do_sort && !res->sorted) {
500
        // remember the selected token before sorting
501
0
        const llama_token id = res->data[res->selected].id;
502
503
0
        std::sort(res->data, res->data + res->size, [](const llama_token_data & a, const llama_token_data & b) {
504
0
            return a.p > b.p;
505
0
        });
506
507
        // restore the selected token after sorting
508
0
        for (size_t i = 0; i < res->size; ++i) {
509
0
            if (res->data[i].id == id) {
510
0
                res->selected = i;
511
0
                break;
512
0
            }
513
0
        }
514
515
0
        res->sorted = true;
516
0
    }
517
518
0
    return res;
519
0
}
520
521
0
llama_token common_sampler_last(const struct common_sampler * gsmpl) {
522
0
    return gsmpl->prev.rat(0);
523
0
}
524
525
0
std::string common_sampler_print(const struct common_sampler * gsmpl) {
526
0
    std::string result = "logits ";
527
528
0
    for (int i = 0; i < llama_sampler_chain_n(gsmpl->chain); i++) {
529
0
        const auto * smpl = llama_sampler_chain_get(gsmpl->chain, i);
530
0
        result += std::string("-> ");
531
0
        result += std::string(llama_sampler_name(smpl)) + " ";
532
0
    }
533
534
0
    return result;
535
0
}
536
537
0
std::string common_sampler_prev_str(common_sampler * gsmpl, llama_context * ctx_main, int n) {
538
0
    n = std::min(n, (int) gsmpl->prev.size());
539
540
0
    if (n <= 0) {
541
0
        return "";
542
0
    }
543
544
0
    std::string result;
545
0
    result.reserve(8*n); // 8 is the average length of a token [citation needed], TODO: compute this from the vocab
546
547
0
    for (int i = n - 1; i >= 0; i--) {
548
0
        const llama_token id = gsmpl->prev.rat(i);
549
550
0
        GGML_ASSERT(id != LLAMA_TOKEN_NULL && "null token in the sampling history - should not happen");
551
552
0
        result += common_token_to_piece(ctx_main, id);
553
0
    }
554
555
0
    return result;
556
0
}
557
558
0
char common_sampler_type_to_chr(enum common_sampler_type cnstr) {
559
0
    switch (cnstr) {
560
0
        case COMMON_SAMPLER_TYPE_DRY:         return 'd';
561
0
        case COMMON_SAMPLER_TYPE_TOP_K:       return 'k';
562
0
        case COMMON_SAMPLER_TYPE_TYPICAL_P:   return 'y';
563
0
        case COMMON_SAMPLER_TYPE_TOP_P:       return 'p';
564
0
        case COMMON_SAMPLER_TYPE_TOP_N_SIGMA: return 's';
565
0
        case COMMON_SAMPLER_TYPE_MIN_P:       return 'm';
566
0
        case COMMON_SAMPLER_TYPE_TEMPERATURE: return 't';
567
0
        case COMMON_SAMPLER_TYPE_XTC:         return 'x';
568
0
        case COMMON_SAMPLER_TYPE_INFILL:      return 'i';
569
0
        case COMMON_SAMPLER_TYPE_PENALTIES:   return 'e';
570
0
        default : return '?';
571
0
    }
572
0
}
573
574
0
std::string common_sampler_type_to_str(enum common_sampler_type cnstr) {
575
0
    switch (cnstr) {
576
0
        case COMMON_SAMPLER_TYPE_DRY:         return "dry";
577
0
        case COMMON_SAMPLER_TYPE_TOP_K:       return "top_k";
578
0
        case COMMON_SAMPLER_TYPE_TYPICAL_P:   return "typ_p";
579
0
        case COMMON_SAMPLER_TYPE_TOP_P:       return "top_p";
580
0
        case COMMON_SAMPLER_TYPE_TOP_N_SIGMA: return "top_n_sigma";
581
0
        case COMMON_SAMPLER_TYPE_MIN_P:       return "min_p";
582
0
        case COMMON_SAMPLER_TYPE_TEMPERATURE: return "temperature";
583
0
        case COMMON_SAMPLER_TYPE_XTC:         return "xtc";
584
0
        case COMMON_SAMPLER_TYPE_INFILL:      return "infill";
585
0
        case COMMON_SAMPLER_TYPE_PENALTIES:   return "penalties";
586
0
        default : return "";
587
0
    }
588
0
}
589
590
0
std::vector<common_sampler_type> common_sampler_types_from_names(const std::vector<std::string> & names, bool allow_alt_names) {
591
0
    std::unordered_map<std::string, common_sampler_type> sampler_canonical_name_map {
592
0
        { "dry",         COMMON_SAMPLER_TYPE_DRY },
593
0
        { "top_k",       COMMON_SAMPLER_TYPE_TOP_K },
594
0
        { "top_p",       COMMON_SAMPLER_TYPE_TOP_P },
595
0
        { "top_n_sigma", COMMON_SAMPLER_TYPE_TOP_N_SIGMA },
596
0
        { "typ_p",       COMMON_SAMPLER_TYPE_TYPICAL_P },
597
0
        { "min_p",       COMMON_SAMPLER_TYPE_MIN_P },
598
0
        { "temperature", COMMON_SAMPLER_TYPE_TEMPERATURE },
599
0
        { "xtc",         COMMON_SAMPLER_TYPE_XTC },
600
0
        { "infill",      COMMON_SAMPLER_TYPE_INFILL },
601
0
        { "penalties",   COMMON_SAMPLER_TYPE_PENALTIES },
602
0
    };
603
604
    // since samplers names are written multiple ways
605
    // make it ready for both system names and input names
606
0
    std::unordered_map<std::string, common_sampler_type> sampler_alt_name_map {
607
0
        { "top-k",       COMMON_SAMPLER_TYPE_TOP_K },
608
0
        { "top-p",       COMMON_SAMPLER_TYPE_TOP_P },
609
0
        { "top-n-sigma", COMMON_SAMPLER_TYPE_TOP_N_SIGMA },
610
0
        { "nucleus",     COMMON_SAMPLER_TYPE_TOP_P },
611
0
        { "typical-p",   COMMON_SAMPLER_TYPE_TYPICAL_P },
612
0
        { "typical",     COMMON_SAMPLER_TYPE_TYPICAL_P },
613
0
        { "typ-p",       COMMON_SAMPLER_TYPE_TYPICAL_P },
614
0
        { "typ",         COMMON_SAMPLER_TYPE_TYPICAL_P },
615
0
        { "min-p",       COMMON_SAMPLER_TYPE_MIN_P },
616
0
        { "temp",        COMMON_SAMPLER_TYPE_TEMPERATURE },
617
0
    };
618
619
0
    std::vector<common_sampler_type> samplers;
620
0
    samplers.reserve(names.size());
621
622
0
    for (const auto & name : names) {
623
0
        auto sampler = sampler_canonical_name_map.find(name);
624
0
        if (sampler != sampler_canonical_name_map.end()) {
625
0
            samplers.push_back(sampler->second);
626
0
            continue;
627
0
        }
628
0
        if (allow_alt_names) {
629
0
            sampler = sampler_alt_name_map.find(name);
630
0
            if (sampler != sampler_alt_name_map.end()) {
631
0
                samplers.push_back(sampler->second);
632
0
                continue;
633
0
            }
634
0
        }
635
0
        LOG_WRN("%s: unable to match sampler by name '%s'\n", __func__, name.c_str());
636
0
    }
637
638
0
    return samplers;
639
0
}
640
641
0
std::vector<common_sampler_type> common_sampler_types_from_chars(const std::string & chars) {
642
0
    std::unordered_map<char, common_sampler_type> sampler_name_map = {
643
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_DRY),         COMMON_SAMPLER_TYPE_DRY },
644
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_TOP_K),       COMMON_SAMPLER_TYPE_TOP_K },
645
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_TYPICAL_P),   COMMON_SAMPLER_TYPE_TYPICAL_P },
646
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_TOP_P),       COMMON_SAMPLER_TYPE_TOP_P },
647
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_TOP_N_SIGMA), COMMON_SAMPLER_TYPE_TOP_N_SIGMA },
648
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_MIN_P),       COMMON_SAMPLER_TYPE_MIN_P },
649
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_TEMPERATURE), COMMON_SAMPLER_TYPE_TEMPERATURE },
650
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_XTC),         COMMON_SAMPLER_TYPE_XTC },
651
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_INFILL),      COMMON_SAMPLER_TYPE_INFILL },
652
0
        { common_sampler_type_to_chr(COMMON_SAMPLER_TYPE_PENALTIES),   COMMON_SAMPLER_TYPE_PENALTIES },
653
0
    };
654
655
0
    std::vector<common_sampler_type> samplers;
656
0
    samplers.reserve(chars.size());
657
658
0
    for (const auto & c : chars) {
659
0
        const auto sampler = sampler_name_map.find(c);
660
0
        if (sampler != sampler_name_map.end()) {
661
0
            samplers.push_back(sampler->second);
662
0
        } else {
663
0
            LOG_WRN("%s: unable to match sampler by char '%c'\n", __func__, c);
664
0
        }
665
0
    }
666
667
0
    return samplers;
668
0
}