2023-03-25 19:26:40 +01:00
|
|
|
#include "common.h"
|
2023-03-24 16:19:05 +01:00
|
|
|
|
2023-03-11 00:04:06 +01:00
|
|
|
#include <cassert>
|
2023-04-30 20:41:35 +02:00
|
|
|
#include <iostream>
|
2023-03-11 00:04:06 +01:00
|
|
|
#include <cstring>
|
2023-03-10 19:40:58 +01:00
|
|
|
#include <fstream>
|
2023-03-12 21:28:36 +01:00
|
|
|
#include <string>
|
2023-03-22 06:32:36 +01:00
|
|
|
#include <iterator>
|
|
|
|
#include <algorithm>
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
#include <sstream>
|
2023-05-15 04:25:42 +02:00
|
|
|
#include <unordered_set>
|
2023-06-06 21:33:23 +02:00
|
|
|
#include <regex>
|
2023-04-30 20:41:35 +02:00
|
|
|
|
|
|
|
#if defined(__APPLE__) && defined(__MACH__)
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <sys/sysctl.h>
|
|
|
|
#endif
|
2023-03-10 19:40:58 +01:00
|
|
|
|
2023-05-09 04:45:48 +02:00
|
|
|
#if defined(_WIN32)
|
|
|
|
#define WIN32_LEAN_AND_MEAN
|
|
|
|
#define NOMINMAX
|
|
|
|
#include <windows.h>
|
2023-04-08 17:49:39 +02:00
|
|
|
#include <fcntl.h>
|
|
|
|
#include <io.h>
|
2023-05-09 04:45:48 +02:00
|
|
|
#else
|
|
|
|
#include <sys/ioctl.h>
|
|
|
|
#include <unistd.h>
|
|
|
|
#include <wchar.h>
|
2023-03-28 16:09:55 +02:00
|
|
|
#endif
|
2023-03-12 21:15:00 +01:00
|
|
|
|
2023-06-16 20:23:53 +02:00
|
|
|
#if defined(_MSC_VER)
|
|
|
|
#pragma warning(disable: 4244 4267) // possible loss of data
|
|
|
|
#endif
|
|
|
|
|
2023-04-30 20:41:35 +02:00
|
|
|
int32_t get_num_physical_cores() {
|
2023-03-17 18:47:35 +01:00
|
|
|
#ifdef __linux__
|
2023-05-15 04:25:42 +02:00
|
|
|
// enumerate the set of thread siblings, num entries is num cores
|
|
|
|
std::unordered_set<std::string> siblings;
|
|
|
|
for (uint32_t cpu=0; cpu < UINT32_MAX; ++cpu) {
|
|
|
|
std::ifstream thread_siblings("/sys/devices/system/cpu"
|
|
|
|
+ std::to_string(cpu) + "/topology/thread_siblings");
|
|
|
|
if (!thread_siblings.is_open()) {
|
|
|
|
break; // no more cpus
|
2023-04-30 20:41:35 +02:00
|
|
|
}
|
2023-05-15 04:25:42 +02:00
|
|
|
std::string line;
|
|
|
|
if (std::getline(thread_siblings, line)) {
|
|
|
|
siblings.insert(line);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (siblings.size() > 0) {
|
|
|
|
return static_cast<int32_t>(siblings.size());
|
2023-04-30 20:41:35 +02:00
|
|
|
}
|
|
|
|
#elif defined(__APPLE__) && defined(__MACH__)
|
|
|
|
int32_t num_physical_cores;
|
|
|
|
size_t len = sizeof(num_physical_cores);
|
|
|
|
int result = sysctlbyname("hw.perflevel0.physicalcpu", &num_physical_cores, &len, NULL, 0);
|
|
|
|
if (result == 0) {
|
|
|
|
return num_physical_cores;
|
|
|
|
}
|
|
|
|
result = sysctlbyname("hw.physicalcpu", &num_physical_cores, &len, NULL, 0);
|
|
|
|
if (result == 0) {
|
|
|
|
return num_physical_cores;
|
2023-03-17 18:47:35 +01:00
|
|
|
}
|
2023-04-30 20:41:35 +02:00
|
|
|
#elif defined(_WIN32)
|
|
|
|
//TODO: Implement
|
|
|
|
#endif
|
|
|
|
unsigned int n_threads = std::thread::hardware_concurrency();
|
|
|
|
return n_threads > 0 ? (n_threads <= 4 ? n_threads : n_threads / 2) : 4;
|
|
|
|
}
|
2023-03-17 18:47:35 +01:00
|
|
|
|
2023-05-04 14:08:25 +02:00
|
|
|
void process_escapes(std::string& input) {
|
|
|
|
std::size_t input_len = input.length();
|
|
|
|
std::size_t output_idx = 0;
|
2023-05-03 03:46:20 +02:00
|
|
|
|
2023-05-04 14:08:25 +02:00
|
|
|
for (std::size_t input_idx = 0; input_idx < input_len; ++input_idx) {
|
|
|
|
if (input[input_idx] == '\\' && input_idx + 1 < input_len) {
|
|
|
|
switch (input[++input_idx]) {
|
|
|
|
case 'n': input[output_idx++] = '\n'; break;
|
|
|
|
case 'r': input[output_idx++] = '\r'; break;
|
|
|
|
case 't': input[output_idx++] = '\t'; break;
|
|
|
|
case '\'': input[output_idx++] = '\''; break;
|
|
|
|
case '\"': input[output_idx++] = '\"'; break;
|
|
|
|
case '\\': input[output_idx++] = '\\'; break;
|
|
|
|
default: input[output_idx++] = '\\';
|
|
|
|
input[output_idx++] = input[input_idx]; break;
|
2023-05-03 03:46:20 +02:00
|
|
|
}
|
2023-05-04 14:08:25 +02:00
|
|
|
} else {
|
|
|
|
input[output_idx++] = input[input_idx];
|
2023-05-03 03:46:20 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-05-04 14:08:25 +02:00
|
|
|
input.resize(output_idx);
|
2023-05-03 03:46:20 +02:00
|
|
|
}
|
|
|
|
|
2023-04-30 20:41:35 +02:00
|
|
|
bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
|
2023-03-23 18:54:28 +01:00
|
|
|
bool invalid_param = false;
|
2023-05-04 14:08:25 +02:00
|
|
|
bool escape_prompt = false;
|
2023-03-23 18:54:28 +01:00
|
|
|
std::string arg;
|
2023-04-02 04:41:12 +02:00
|
|
|
gpt_params default_params;
|
2023-05-12 16:34:55 +02:00
|
|
|
const std::string arg_prefix = "--";
|
2023-04-02 04:41:12 +02:00
|
|
|
|
2023-03-10 19:40:58 +01:00
|
|
|
for (int i = 1; i < argc; i++) {
|
2023-03-23 18:54:28 +01:00
|
|
|
arg = argv[i];
|
2023-05-12 16:34:55 +02:00
|
|
|
if (arg.compare(0, arg_prefix.size(), arg_prefix) == 0) {
|
|
|
|
std::replace(arg.begin(), arg.end(), '_', '-');
|
|
|
|
}
|
2023-03-10 19:40:58 +01:00
|
|
|
|
|
|
|
if (arg == "-s" || arg == "--seed") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-06-29 15:15:15 +02:00
|
|
|
params.seed = std::stoul(argv[i]);
|
2023-03-10 19:40:58 +01:00
|
|
|
} else if (arg == "-t" || arg == "--threads") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.n_threads = std::stoi(argv[i]);
|
2023-07-23 15:33:02 +02:00
|
|
|
if (params.n_threads <= 0) {
|
|
|
|
params.n_threads = std::thread::hardware_concurrency();
|
|
|
|
}
|
2023-03-10 19:40:58 +01:00
|
|
|
} else if (arg == "-p" || arg == "--prompt") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-05-04 14:08:25 +02:00
|
|
|
params.prompt = argv[i];
|
|
|
|
} else if (arg == "-e") {
|
|
|
|
escape_prompt = true;
|
2023-05-10 17:37:14 +02:00
|
|
|
} else if (arg == "--prompt-cache") {
|
2023-04-28 17:59:37 +02:00
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-05-10 17:37:14 +02:00
|
|
|
params.path_prompt_cache = argv[i];
|
|
|
|
} else if (arg == "--prompt-cache-all") {
|
|
|
|
params.prompt_cache_all = true;
|
2023-06-07 04:10:17 +02:00
|
|
|
} else if (arg == "--prompt-cache-ro") {
|
|
|
|
params.prompt_cache_ro = true;
|
2023-03-12 21:28:36 +01:00
|
|
|
} else if (arg == "-f" || arg == "--file") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
std::ifstream file(argv[i]);
|
2023-03-31 20:03:48 +02:00
|
|
|
if (!file) {
|
2023-04-14 21:58:43 +02:00
|
|
|
fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
|
2023-03-31 20:03:48 +02:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-03-19 17:37:02 +01:00
|
|
|
std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(params.prompt));
|
2023-03-19 18:04:44 +01:00
|
|
|
if (params.prompt.back() == '\n') {
|
|
|
|
params.prompt.pop_back();
|
|
|
|
}
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "-n" || arg == "--n-predict") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.n_predict = std::stoi(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--top-k") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.top_k = std::stoi(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "-c" || arg == "--ctx-size") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.n_ctx = std::stoi(argv[i]);
|
2023-07-23 14:09:47 +02:00
|
|
|
} else if (arg == "-gqa" || arg == "--gqa") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.n_gqa = std::stoi(argv[i]);
|
llama : add custom RoPE (#2054)
* Implement customizable RoPE
The original RoPE has pre-defined parameters
theta_i = 10000^(−2(i−1)/d), for i in [1, 2, ..., d/2]
Our customizable RoPE, ggml_rope_custom_inplace, uses
theta_i = scale * base^(−2(i−1)/d), for i in [1, 2, ..., d/2]
with the default matches the original
scale = 1.0
base = 10000
The new command line arguments
--rope-freq-base
--rope-freq-scale
set the two new RoPE parameter.
Recent researches show changing these two parameters extends the context limit with minimal loss.
1. Extending Context to 8K
kaiokendev
https://kaiokendev.github.io/til#extending-context-to-8k
2. Extending Context Window of Large Language Models via Positional Interpolation
Shouyuan Chen, Sherman Wong, Liangjian Chen, Yuandong Tian
https://arxiv.org/abs/2306.15595
3. NTK-Aware Scaled RoPE allows LLaMA models to have extended (8k+) context size without any fine-tuning and minimal perplexity degradation.
https://www.reddit.com/user/bloc97
https://www.reddit.com/r/LocalLLaMA/comments/14lz7j5/ntkaware_scaled_rope_allows_llama_models_to_have/
For the bold, try adding the following command line parameters to your favorite model:
-c 16384 --rope-freq-base 80000 --rope-freq-scale 0.5
* ggml-metal: fix custom rope
* common: fix argument names in help
* llama: increase MEM_REQ_EVAL for MODEL_3B
It avoids crashing for quantized weights on CPU.
Better ways to calculate the required buffer size would be better.
* llama: make MEM_REQ_EVAL depend on n_ctx
* server: use proper Content-Type in curl examples
Without the header Content-Type: application/json, curl will POST with
Content-Type: application/x-www-form-urlencoded
Though our simple server doesn't care, the httplib.h used has a limit
with CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
With Content-Type: application/json, we can send large json data.
* style : minor fixes, mostly indentations
* ggml : fix asserts
---------
Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>
2023-07-15 12:34:16 +02:00
|
|
|
} else if (arg == "--rope-freq-base") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.rope_freq_base = std::stof(argv[i]);
|
|
|
|
} else if (arg == "--rope-freq-scale") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.rope_freq_scale = std::stof(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--memory-f32") {
|
2023-03-24 22:17:37 +01:00
|
|
|
params.memory_f16 = false;
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--top-p") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.top_p = std::stof(argv[i]);
|
2023-03-10 19:40:58 +01:00
|
|
|
} else if (arg == "--temp") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.temp = std::stof(argv[i]);
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
} else if (arg == "--tfs") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.tfs_z = std::stof(argv[i]);
|
|
|
|
} else if (arg == "--typical") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.typical_p = std::stof(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--repeat-last-n") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.repeat_last_n = std::stoi(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--repeat-penalty") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.repeat_penalty = std::stof(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--frequency-penalty") {
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.frequency_penalty = std::stof(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--presence-penalty") {
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.presence_penalty = std::stof(argv[i]);
|
|
|
|
} else if (arg == "--mirostat") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.mirostat = std::stoi(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--mirostat-lr") {
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.mirostat_eta = std::stof(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "--mirostat-ent") {
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.mirostat_tau = std::stof(argv[i]);
|
2023-07-11 18:18:43 +02:00
|
|
|
} else if (arg == "--cfg-negative-prompt") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.cfg_negative_prompt = argv[i];
|
|
|
|
} else if (arg == "--cfg-scale") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.cfg_scale = std::stof(argv[i]);
|
2023-05-12 16:34:55 +02:00
|
|
|
} else if (arg == "-b" || arg == "--batch-size") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.n_batch = std::stoi(argv[i]);
|
2023-03-24 22:17:37 +01:00
|
|
|
params.n_batch = std::min(512, params.n_batch);
|
2023-03-25 20:36:22 +01:00
|
|
|
} else if (arg == "--keep") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-25 20:36:22 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.n_keep = std::stoi(argv[i]);
|
2023-07-18 13:24:43 +02:00
|
|
|
} else if (arg == "--chunks") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.n_chunks = std::stoi(argv[i]);
|
2023-03-10 19:40:58 +01:00
|
|
|
} else if (arg == "-m" || arg == "--model") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-03-23 18:54:28 +01:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.model = argv[i];
|
2023-05-28 19:14:24 +02:00
|
|
|
} else if (arg == "-a" || arg == "--alias") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.model_alias = argv[i];
|
2023-04-17 17:28:55 +02:00
|
|
|
} else if (arg == "--lora") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.lora_adapter = argv[i];
|
2023-07-13 15:58:25 +02:00
|
|
|
params.use_mmap = false;
|
2023-04-17 17:28:55 +02:00
|
|
|
} else if (arg == "--lora-base") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.lora_base = argv[i];
|
2023-03-12 22:13:28 +01:00
|
|
|
} else if (arg == "-i" || arg == "--interactive") {
|
|
|
|
params.interactive = true;
|
2023-03-24 16:05:13 +01:00
|
|
|
} else if (arg == "--embedding") {
|
|
|
|
params.embedding = true;
|
2023-03-22 18:16:35 +01:00
|
|
|
} else if (arg == "--interactive-first") {
|
2023-04-24 17:45:32 +02:00
|
|
|
params.interactive_first = true;
|
2023-03-19 17:37:02 +01:00
|
|
|
} else if (arg == "-ins" || arg == "--instruct") {
|
2023-04-14 21:58:43 +02:00
|
|
|
params.instruct = true;
|
2023-05-09 04:45:48 +02:00
|
|
|
} else if (arg == "--multiline-input") {
|
|
|
|
params.multiline_input = true;
|
2023-03-12 22:13:28 +01:00
|
|
|
} else if (arg == "--color") {
|
|
|
|
params.use_color = true;
|
2023-03-24 16:19:05 +01:00
|
|
|
} else if (arg == "--mlock") {
|
|
|
|
params.use_mlock = true;
|
2023-05-13 15:38:36 +02:00
|
|
|
} else if (arg == "--gpu-layers" || arg == "-ngl" || arg == "--n-gpu-layers") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-05-28 19:48:57 +02:00
|
|
|
#ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
|
2023-05-13 15:38:36 +02:00
|
|
|
params.n_gpu_layers = std::stoi(argv[i]);
|
2023-05-28 19:48:57 +02:00
|
|
|
#else
|
|
|
|
fprintf(stderr, "warning: not compiled with GPU offload support, --n-gpu-layers option will be ignored\n");
|
|
|
|
fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
|
|
|
|
#endif
|
2023-06-06 21:33:23 +02:00
|
|
|
} else if (arg == "--main-gpu" || arg == "-mg") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
#ifdef GGML_USE_CUBLAS
|
|
|
|
params.main_gpu = std::stoi(argv[i]);
|
|
|
|
#else
|
|
|
|
fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set a main GPU.\n");
|
|
|
|
#endif
|
|
|
|
} else if (arg == "--tensor-split" || arg == "-ts") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
#ifdef GGML_USE_CUBLAS
|
|
|
|
std::string arg_next = argv[i];
|
|
|
|
|
|
|
|
// split string by , and /
|
|
|
|
const std::regex regex{R"([,/]+)"};
|
|
|
|
std::sregex_token_iterator it{arg_next.begin(), arg_next.end(), regex, -1};
|
|
|
|
std::vector<std::string> split_arg{it, {}};
|
|
|
|
GGML_ASSERT(split_arg.size() <= LLAMA_MAX_DEVICES);
|
|
|
|
|
|
|
|
for (size_t i = 0; i < LLAMA_MAX_DEVICES; ++i) {
|
|
|
|
if (i < split_arg.size()) {
|
|
|
|
params.tensor_split[i] = std::stof(split_arg[i]);
|
|
|
|
} else {
|
|
|
|
params.tensor_split[i] = 0.0f;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set a tensor split.\n");
|
2023-06-14 19:47:19 +02:00
|
|
|
#endif // GGML_USE_CUBLAS
|
|
|
|
} else if (arg == "--low-vram" || arg == "-lv") {
|
|
|
|
#ifdef GGML_USE_CUBLAS
|
|
|
|
params.low_vram = true;
|
|
|
|
#else
|
|
|
|
fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set lower vram usage.\n");
|
2023-06-06 21:33:23 +02:00
|
|
|
#endif // GGML_USE_CUBLAS
|
Rewrite loading code to try to satisfy everyone:
- Support all three formats (ggml, ggmf, ggjt). (However, I didn't
include the hack needed to support GPT4All files without conversion.
Those can still be used after converting them with convert.py from my
other PR.)
- Support both mmap and read (mmap is used by default, but can be
disabled with `--no-mmap`, and is automatically disabled for pre-ggjt
files or on platforms where mmap is not supported).
- Support multi-file models like before, but automatically determine the
number of parts rather than requiring `--n_parts`.
- Improve validation and error checking.
- Stop using the per-file type field (f16) entirely in favor of just
relying on the per-tensor type/size fields. This has no immediate
benefit, but makes it easier to experiment with different formats, and
should make it easier to support the new GPTQ-for-LLaMa models in the
future (I have some work in progress on that front).
- Support VirtualLock on Windows (using the same `--mlock` option as on
Unix).
- Indicate loading progress when using mmap + mlock. (Which led me
to the interesting observation that on my Linux machine, with a
warm file cache, mlock actually takes some time, whereas mmap
without mlock starts almost instantly...)
- To help implement this, move mlock support from ggml to the
loading code.
- madvise/PrefetchVirtualMemory support (based on #740)
- Switch from ifstream to the `fopen` family of functions to avoid
unnecessary copying and, when mmap is enabled, allow reusing the same
file descriptor for both metadata reads and mmap (whereas the existing
implementation opens the file a second time to mmap).
- Quantization now produces a single-file output even with multi-file
inputs (not really a feature as much as 'it was easier this way').
Implementation notes:
I tried to factor the code into more discrete pieces than before.
Regarding code style: I tried to follow the code style, but I'm naughty
and used a few advanced C++ features repeatedly:
- Destructors to make it easier to ensure everything gets cleaned up.
- Exceptions. I don't even usually use exceptions when writing C++, and
I can remove them if desired... but here they make the loading code
much more succinct while still properly handling a variety of errors,
ranging from API calls failing to integer overflow and allocation
failure. The exceptions are converted to error codes at the
API boundary.)
Co-authored-by: Pavol Rusnak <pavol@rusnak.io> (for the bit I copied from #740)
2023-04-08 21:24:37 +02:00
|
|
|
} else if (arg == "--no-mmap") {
|
|
|
|
params.use_mmap = false;
|
2023-03-24 22:17:37 +01:00
|
|
|
} else if (arg == "--mtest") {
|
|
|
|
params.mem_test = true;
|
2023-06-26 19:57:59 +02:00
|
|
|
} else if (arg == "--numa") {
|
|
|
|
params.numa = true;
|
2023-06-04 22:34:30 +02:00
|
|
|
} else if (arg == "--export") {
|
|
|
|
params.export_cgraph = true;
|
2023-03-25 20:36:22 +01:00
|
|
|
} else if (arg == "--verbose-prompt") {
|
2023-03-25 16:16:50 +01:00
|
|
|
params.verbose_prompt = true;
|
2023-03-12 22:13:28 +01:00
|
|
|
} else if (arg == "-r" || arg == "--reverse-prompt") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-04-14 17:19:17 +02:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.antiprompt.push_back(argv[i]);
|
2023-03-21 17:27:42 +01:00
|
|
|
} else if (arg == "--perplexity") {
|
|
|
|
params.perplexity = true;
|
2023-07-22 14:21:24 +02:00
|
|
|
} else if (arg == "--perplexity-lines") {
|
|
|
|
params.perplexity_lines = true;
|
2023-03-19 19:22:48 +01:00
|
|
|
} else if (arg == "--ignore-eos") {
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
params.logit_bias[llama_token_eos()] = -INFINITY;
|
|
|
|
} else if (arg == "--no-penalize-nl") {
|
|
|
|
params.penalize_nl = false;
|
|
|
|
} else if (arg == "-l" || arg == "--logit-bias") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
std::stringstream ss(argv[i]);
|
|
|
|
llama_token key;
|
|
|
|
char sign;
|
|
|
|
std::string value_str;
|
|
|
|
try {
|
|
|
|
if (ss >> key && ss >> sign && std::getline(ss, value_str) && (sign == '+' || sign == '-')) {
|
|
|
|
params.logit_bias[key] = std::stof(value_str) * ((sign == '-') ? -1.0f : 1.0f);
|
|
|
|
} else {
|
|
|
|
throw std::exception();
|
|
|
|
}
|
2023-06-16 20:23:53 +02:00
|
|
|
} catch (const std::exception&) {
|
llama : new sampling algorithms (#1126)
* Sample interface, new samplers.
New samplers:
- locally typical sampling
- tail free sampling
- frequency and presence penalty
- mirostat
Ignore EOS fix: -inf should be used.
* mirostat
* Added --logit-bias and --no-penalize-nl, removed std::span
* Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
Use C++11, clarify llama API documentation, rename Mirostat parameters to --mirostat_lr and --mirostat_ent, add temperature sampling for Mirostat, simplify Mirostat sampling API parameters (removed N and *k)
* Save and load example adjust
* Tests
* Windows build fix
* Windows test fix
2023-04-29 07:34:41 +02:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-03-10 19:40:58 +01:00
|
|
|
} else if (arg == "-h" || arg == "--help") {
|
2023-04-14 21:58:43 +02:00
|
|
|
gpt_print_usage(argc, argv, default_params);
|
2023-03-10 19:40:58 +01:00
|
|
|
exit(0);
|
2023-03-19 19:36:19 +01:00
|
|
|
} else if (arg == "--random-prompt") {
|
|
|
|
params.random_prompt = true;
|
2023-03-25 13:03:19 +01:00
|
|
|
} else if (arg == "--in-prefix") {
|
2023-04-14 21:58:43 +02:00
|
|
|
if (++i >= argc) {
|
2023-04-14 17:19:17 +02:00
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
2023-04-14 21:58:43 +02:00
|
|
|
params.input_prefix = argv[i];
|
2023-05-04 17:41:12 +02:00
|
|
|
} else if (arg == "--in-suffix") {
|
|
|
|
if (++i >= argc) {
|
|
|
|
invalid_param = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
params.input_suffix = argv[i];
|
2023-03-10 19:40:58 +01:00
|
|
|
} else {
|
|
|
|
fprintf(stderr, "error: unknown argument: %s\n", arg.c_str());
|
2023-04-14 21:58:43 +02:00
|
|
|
gpt_print_usage(argc, argv, default_params);
|
2023-03-23 18:54:28 +01:00
|
|
|
exit(1);
|
2023-03-10 19:40:58 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-23 18:54:28 +01:00
|
|
|
if (invalid_param) {
|
|
|
|
fprintf(stderr, "error: invalid parameter for argument: %s\n", arg.c_str());
|
2023-04-14 21:58:43 +02:00
|
|
|
gpt_print_usage(argc, argv, default_params);
|
2023-03-23 18:54:28 +01:00
|
|
|
exit(1);
|
|
|
|
}
|
2023-05-10 17:37:14 +02:00
|
|
|
if (params.prompt_cache_all &&
|
|
|
|
(params.interactive || params.interactive_first ||
|
2023-05-19 19:24:59 +02:00
|
|
|
params.instruct)) {
|
2023-05-10 17:37:14 +02:00
|
|
|
fprintf(stderr, "error: --prompt-cache-all not supported in interactive mode yet\n");
|
|
|
|
gpt_print_usage(argc, argv, default_params);
|
|
|
|
exit(1);
|
|
|
|
}
|
2023-06-15 19:06:46 +02:00
|
|
|
|
2023-05-04 14:08:25 +02:00
|
|
|
if (escape_prompt) {
|
|
|
|
process_escapes(params.prompt);
|
2023-07-09 10:56:18 +02:00
|
|
|
process_escapes(params.input_prefix);
|
|
|
|
process_escapes(params.input_suffix);
|
2023-05-04 14:08:25 +02:00
|
|
|
}
|
2023-03-10 19:40:58 +01:00
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2023-04-14 21:58:43 +02:00
|
|
|
void gpt_print_usage(int /*argc*/, char ** argv, const gpt_params & params) {
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, "usage: %s [options]\n", argv[0]);
|
|
|
|
fprintf(stdout, "\n");
|
|
|
|
fprintf(stdout, "options:\n");
|
|
|
|
fprintf(stdout, " -h, --help show this help message and exit\n");
|
|
|
|
fprintf(stdout, " -i, --interactive run in interactive mode\n");
|
|
|
|
fprintf(stdout, " --interactive-first run in interactive mode and wait for input right away\n");
|
|
|
|
fprintf(stdout, " -ins, --instruct run in instruction mode (use with Alpaca models)\n");
|
|
|
|
fprintf(stdout, " --multiline-input allows you to write or paste multiple lines without ending each in '\\'\n");
|
|
|
|
fprintf(stdout, " -r PROMPT, --reverse-prompt PROMPT\n");
|
|
|
|
fprintf(stdout, " halt generation at PROMPT, return control in interactive mode\n");
|
|
|
|
fprintf(stdout, " (can be specified more than once for multiple prompts).\n");
|
|
|
|
fprintf(stdout, " --color colorise output to distinguish prompt and user input from generations\n");
|
|
|
|
fprintf(stdout, " -s SEED, --seed SEED RNG seed (default: -1, use random seed for < 0)\n");
|
|
|
|
fprintf(stdout, " -t N, --threads N number of threads to use during computation (default: %d)\n", params.n_threads);
|
|
|
|
fprintf(stdout, " -p PROMPT, --prompt PROMPT\n");
|
|
|
|
fprintf(stdout, " prompt to start generation with (default: empty)\n");
|
|
|
|
fprintf(stdout, " -e process prompt escapes sequences (\\n, \\r, \\t, \\', \\\", \\\\)\n");
|
|
|
|
fprintf(stdout, " --prompt-cache FNAME file to cache prompt state for faster startup (default: none)\n");
|
|
|
|
fprintf(stdout, " --prompt-cache-all if specified, saves user input and generations to cache as well.\n");
|
|
|
|
fprintf(stdout, " not supported with --interactive or other interactive options\n");
|
|
|
|
fprintf(stdout, " --prompt-cache-ro if specified, uses the prompt cache but does not update it.\n");
|
|
|
|
fprintf(stdout, " --random-prompt start with a randomized prompt.\n");
|
|
|
|
fprintf(stdout, " --in-prefix STRING string to prefix user inputs with (default: empty)\n");
|
|
|
|
fprintf(stdout, " --in-suffix STRING string to suffix after user inputs with (default: empty)\n");
|
|
|
|
fprintf(stdout, " -f FNAME, --file FNAME\n");
|
|
|
|
fprintf(stdout, " prompt file to start generation.\n");
|
|
|
|
fprintf(stdout, " -n N, --n-predict N number of tokens to predict (default: %d, -1 = infinity)\n", params.n_predict);
|
2023-07-23 14:09:47 +02:00
|
|
|
fprintf(stdout, " -c N, --ctx-size N size of the prompt context (default: %d)\n", params.n_ctx);
|
|
|
|
fprintf(stdout, " -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
|
|
|
|
fprintf(stdout, " -gqa N, --gqa N grouped-query attention factor (TEMP!!! use 8 for LLaMAv2 70B) (default: %d)\n", params.n_gqa);
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, " --top-k N top-k sampling (default: %d, 0 = disabled)\n", params.top_k);
|
|
|
|
fprintf(stdout, " --top-p N top-p sampling (default: %.1f, 1.0 = disabled)\n", (double)params.top_p);
|
|
|
|
fprintf(stdout, " --tfs N tail free sampling, parameter z (default: %.1f, 1.0 = disabled)\n", (double)params.tfs_z);
|
|
|
|
fprintf(stdout, " --typical N locally typical sampling, parameter p (default: %.1f, 1.0 = disabled)\n", (double)params.typical_p);
|
|
|
|
fprintf(stdout, " --repeat-last-n N last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)\n", params.repeat_last_n);
|
|
|
|
fprintf(stdout, " --repeat-penalty N penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)\n", (double)params.repeat_penalty);
|
|
|
|
fprintf(stdout, " --presence-penalty N repeat alpha presence penalty (default: %.1f, 0.0 = disabled)\n", (double)params.presence_penalty);
|
|
|
|
fprintf(stdout, " --frequency-penalty N repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)\n", (double)params.frequency_penalty);
|
|
|
|
fprintf(stdout, " --mirostat N use Mirostat sampling.\n");
|
|
|
|
fprintf(stdout, " Top K, Nucleus, Tail Free and Locally Typical samplers are ignored if used.\n");
|
|
|
|
fprintf(stdout, " (default: %d, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)\n", params.mirostat);
|
|
|
|
fprintf(stdout, " --mirostat-lr N Mirostat learning rate, parameter eta (default: %.1f)\n", (double)params.mirostat_eta);
|
|
|
|
fprintf(stdout, " --mirostat-ent N Mirostat target entropy, parameter tau (default: %.1f)\n", (double)params.mirostat_tau);
|
|
|
|
fprintf(stdout, " -l TOKEN_ID(+/-)BIAS, --logit-bias TOKEN_ID(+/-)BIAS\n");
|
|
|
|
fprintf(stdout, " modifies the likelihood of token appearing in the completion,\n");
|
|
|
|
fprintf(stdout, " i.e. `--logit-bias 15043+1` to increase likelihood of token ' Hello',\n");
|
|
|
|
fprintf(stdout, " or `--logit-bias 15043-1` to decrease likelihood of token ' Hello'\n");
|
|
|
|
fprintf(stdout, " --cfg-negative-prompt PROMPT \n");
|
|
|
|
fprintf(stdout, " negative prompt to use for guidance. (default: empty)\n");
|
|
|
|
fprintf(stdout, " --cfg-scale N strength of guidance (default: %f, 1.0 = disable)\n", params.cfg_scale);
|
|
|
|
fprintf(stdout, " --rope-freq-base N RoPE base frequency (default: %.1f)\n", params.rope_freq_base);
|
|
|
|
fprintf(stdout, " --rope-freq-scale N RoPE frequency scaling factor (default: %g)\n", params.rope_freq_scale);
|
|
|
|
fprintf(stdout, " --ignore-eos ignore end of stream token and continue generating (implies --logit-bias 2-inf)\n");
|
|
|
|
fprintf(stdout, " --no-penalize-nl do not penalize newline token\n");
|
|
|
|
fprintf(stdout, " --memory-f32 use f32 instead of f16 for memory key+value (default: disabled)\n");
|
|
|
|
fprintf(stdout, " not recommended: doubles context memory required and no measurable increase in quality\n");
|
|
|
|
fprintf(stdout, " --temp N temperature (default: %.1f)\n", (double)params.temp);
|
|
|
|
fprintf(stdout, " --perplexity compute perplexity over each ctx window of the prompt\n");
|
|
|
|
fprintf(stdout, " --perplexity-lines compute perplexity over each line of the prompt\n");
|
|
|
|
fprintf(stdout, " --keep number of tokens to keep from the initial prompt (default: %d, -1 = all)\n", params.n_keep);
|
|
|
|
fprintf(stdout, " --chunks N max number of chunks to process (default: %d, -1 = all)\n", params.n_chunks);
|
Rewrite loading code to try to satisfy everyone:
- Support all three formats (ggml, ggmf, ggjt). (However, I didn't
include the hack needed to support GPT4All files without conversion.
Those can still be used after converting them with convert.py from my
other PR.)
- Support both mmap and read (mmap is used by default, but can be
disabled with `--no-mmap`, and is automatically disabled for pre-ggjt
files or on platforms where mmap is not supported).
- Support multi-file models like before, but automatically determine the
number of parts rather than requiring `--n_parts`.
- Improve validation and error checking.
- Stop using the per-file type field (f16) entirely in favor of just
relying on the per-tensor type/size fields. This has no immediate
benefit, but makes it easier to experiment with different formats, and
should make it easier to support the new GPTQ-for-LLaMa models in the
future (I have some work in progress on that front).
- Support VirtualLock on Windows (using the same `--mlock` option as on
Unix).
- Indicate loading progress when using mmap + mlock. (Which led me
to the interesting observation that on my Linux machine, with a
warm file cache, mlock actually takes some time, whereas mmap
without mlock starts almost instantly...)
- To help implement this, move mlock support from ggml to the
loading code.
- madvise/PrefetchVirtualMemory support (based on #740)
- Switch from ifstream to the `fopen` family of functions to avoid
unnecessary copying and, when mmap is enabled, allow reusing the same
file descriptor for both metadata reads and mmap (whereas the existing
implementation opens the file a second time to mmap).
- Quantization now produces a single-file output even with multi-file
inputs (not really a feature as much as 'it was easier this way').
Implementation notes:
I tried to factor the code into more discrete pieces than before.
Regarding code style: I tried to follow the code style, but I'm naughty
and used a few advanced C++ features repeatedly:
- Destructors to make it easier to ensure everything gets cleaned up.
- Exceptions. I don't even usually use exceptions when writing C++, and
I can remove them if desired... but here they make the loading code
much more succinct while still properly handling a variety of errors,
ranging from API calls failing to integer overflow and allocation
failure. The exceptions are converted to error codes at the
API boundary.)
Co-authored-by: Pavol Rusnak <pavol@rusnak.io> (for the bit I copied from #740)
2023-04-08 21:24:37 +02:00
|
|
|
if (llama_mlock_supported()) {
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, " --mlock force system to keep model in RAM rather than swapping or compressing\n");
|
2023-03-24 16:19:05 +01:00
|
|
|
}
|
Rewrite loading code to try to satisfy everyone:
- Support all three formats (ggml, ggmf, ggjt). (However, I didn't
include the hack needed to support GPT4All files without conversion.
Those can still be used after converting them with convert.py from my
other PR.)
- Support both mmap and read (mmap is used by default, but can be
disabled with `--no-mmap`, and is automatically disabled for pre-ggjt
files or on platforms where mmap is not supported).
- Support multi-file models like before, but automatically determine the
number of parts rather than requiring `--n_parts`.
- Improve validation and error checking.
- Stop using the per-file type field (f16) entirely in favor of just
relying on the per-tensor type/size fields. This has no immediate
benefit, but makes it easier to experiment with different formats, and
should make it easier to support the new GPTQ-for-LLaMa models in the
future (I have some work in progress on that front).
- Support VirtualLock on Windows (using the same `--mlock` option as on
Unix).
- Indicate loading progress when using mmap + mlock. (Which led me
to the interesting observation that on my Linux machine, with a
warm file cache, mlock actually takes some time, whereas mmap
without mlock starts almost instantly...)
- To help implement this, move mlock support from ggml to the
loading code.
- madvise/PrefetchVirtualMemory support (based on #740)
- Switch from ifstream to the `fopen` family of functions to avoid
unnecessary copying and, when mmap is enabled, allow reusing the same
file descriptor for both metadata reads and mmap (whereas the existing
implementation opens the file a second time to mmap).
- Quantization now produces a single-file output even with multi-file
inputs (not really a feature as much as 'it was easier this way').
Implementation notes:
I tried to factor the code into more discrete pieces than before.
Regarding code style: I tried to follow the code style, but I'm naughty
and used a few advanced C++ features repeatedly:
- Destructors to make it easier to ensure everything gets cleaned up.
- Exceptions. I don't even usually use exceptions when writing C++, and
I can remove them if desired... but here they make the loading code
much more succinct while still properly handling a variety of errors,
ranging from API calls failing to integer overflow and allocation
failure. The exceptions are converted to error codes at the
API boundary.)
Co-authored-by: Pavol Rusnak <pavol@rusnak.io> (for the bit I copied from #740)
2023-04-08 21:24:37 +02:00
|
|
|
if (llama_mmap_supported()) {
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, " --no-mmap do not memory-map model (slower load but may reduce pageouts if not using mlock)\n");
|
Rewrite loading code to try to satisfy everyone:
- Support all three formats (ggml, ggmf, ggjt). (However, I didn't
include the hack needed to support GPT4All files without conversion.
Those can still be used after converting them with convert.py from my
other PR.)
- Support both mmap and read (mmap is used by default, but can be
disabled with `--no-mmap`, and is automatically disabled for pre-ggjt
files or on platforms where mmap is not supported).
- Support multi-file models like before, but automatically determine the
number of parts rather than requiring `--n_parts`.
- Improve validation and error checking.
- Stop using the per-file type field (f16) entirely in favor of just
relying on the per-tensor type/size fields. This has no immediate
benefit, but makes it easier to experiment with different formats, and
should make it easier to support the new GPTQ-for-LLaMa models in the
future (I have some work in progress on that front).
- Support VirtualLock on Windows (using the same `--mlock` option as on
Unix).
- Indicate loading progress when using mmap + mlock. (Which led me
to the interesting observation that on my Linux machine, with a
warm file cache, mlock actually takes some time, whereas mmap
without mlock starts almost instantly...)
- To help implement this, move mlock support from ggml to the
loading code.
- madvise/PrefetchVirtualMemory support (based on #740)
- Switch from ifstream to the `fopen` family of functions to avoid
unnecessary copying and, when mmap is enabled, allow reusing the same
file descriptor for both metadata reads and mmap (whereas the existing
implementation opens the file a second time to mmap).
- Quantization now produces a single-file output even with multi-file
inputs (not really a feature as much as 'it was easier this way').
Implementation notes:
I tried to factor the code into more discrete pieces than before.
Regarding code style: I tried to follow the code style, but I'm naughty
and used a few advanced C++ features repeatedly:
- Destructors to make it easier to ensure everything gets cleaned up.
- Exceptions. I don't even usually use exceptions when writing C++, and
I can remove them if desired... but here they make the loading code
much more succinct while still properly handling a variety of errors,
ranging from API calls failing to integer overflow and allocation
failure. The exceptions are converted to error codes at the
API boundary.)
Co-authored-by: Pavol Rusnak <pavol@rusnak.io> (for the bit I copied from #740)
2023-04-08 21:24:37 +02:00
|
|
|
}
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, " --numa attempt optimizations that help on some NUMA systems\n");
|
|
|
|
fprintf(stdout, " if run without this previously, it is recommended to drop the system page cache before using this\n");
|
|
|
|
fprintf(stdout, " see https://github.com/ggerganov/llama.cpp/issues/1437\n");
|
2023-05-28 19:48:57 +02:00
|
|
|
#ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, " -ngl N, --n-gpu-layers N\n");
|
|
|
|
fprintf(stdout, " number of layers to store in VRAM\n");
|
|
|
|
fprintf(stdout, " -ts SPLIT --tensor-split SPLIT\n");
|
|
|
|
fprintf(stdout, " how to split tensors across multiple GPUs, comma-separated list of proportions, e.g. 3,1\n");
|
|
|
|
fprintf(stdout, " -mg i, --main-gpu i the GPU to use for scratch and small tensors\n" );
|
|
|
|
fprintf(stdout, " -lv, --low-vram don't allocate VRAM scratch buffer\n" );
|
2023-05-28 19:48:57 +02:00
|
|
|
#endif
|
2023-07-23 13:59:48 +02:00
|
|
|
fprintf(stdout, " --mtest compute maximum memory usage\n");
|
|
|
|
fprintf(stdout, " --export export the computation graph to 'llama.ggml'\n");
|
|
|
|
fprintf(stdout, " --verbose-prompt print prompt before generation\n");
|
|
|
|
fprintf(stdout, " --lora FNAME apply LoRA adapter (implies --no-mmap)\n");
|
|
|
|
fprintf(stdout, " --lora-base FNAME optional model to use as a base for the layers modified by the LoRA adapter\n");
|
|
|
|
fprintf(stdout, " -m FNAME, --model FNAME\n");
|
|
|
|
fprintf(stdout, " model path (default: %s)\n", params.model.c_str());
|
|
|
|
fprintf(stdout, "\n");
|
2023-03-10 19:40:58 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
std::string gpt_random_prompt(std::mt19937 & rng) {
|
|
|
|
const int r = rng() % 10;
|
|
|
|
switch (r) {
|
|
|
|
case 0: return "So";
|
|
|
|
case 1: return "Once upon a time";
|
|
|
|
case 2: return "When";
|
|
|
|
case 3: return "The";
|
|
|
|
case 4: return "After";
|
|
|
|
case 5: return "If";
|
|
|
|
case 6: return "import";
|
|
|
|
case 7: return "He";
|
|
|
|
case 8: return "She";
|
|
|
|
case 9: return "They";
|
|
|
|
default: return "To";
|
|
|
|
}
|
|
|
|
|
|
|
|
return "The";
|
|
|
|
}
|
|
|
|
|
2023-03-22 06:32:36 +01:00
|
|
|
// TODO: not great allocating this every time
|
|
|
|
std::vector<llama_token> llama_tokenize(struct llama_context * ctx, const std::string & text, bool add_bos) {
|
2023-03-22 17:09:38 +01:00
|
|
|
// initialize to prompt numer of chars, since n_tokens <= n_prompt_chars
|
2023-05-08 16:41:54 +02:00
|
|
|
std::vector<llama_token> res(text.size() + (int) add_bos);
|
|
|
|
const int n = llama_tokenize(ctx, text.c_str(), res.data(), res.size(), add_bos);
|
2023-03-22 17:09:38 +01:00
|
|
|
assert(n >= 0);
|
2023-03-22 06:32:36 +01:00
|
|
|
res.resize(n);
|
2023-03-10 19:40:58 +01:00
|
|
|
|
2023-03-22 06:32:36 +01:00
|
|
|
return res;
|
2023-03-10 19:40:58 +01:00
|
|
|
}
|
2023-03-28 16:09:55 +02:00
|
|
|
|
2023-07-11 18:18:43 +02:00
|
|
|
struct llama_context_params llama_context_params_from_gpt_params(const gpt_params & params) {
|
2023-05-02 22:39:51 +02:00
|
|
|
auto lparams = llama_context_default_params();
|
|
|
|
|
2023-07-22 20:17:57 +02:00
|
|
|
lparams.n_ctx = params.n_ctx;
|
|
|
|
lparams.n_batch = params.n_batch;
|
2023-07-23 14:09:47 +02:00
|
|
|
lparams.n_gqa = params.n_gqa;
|
2023-07-22 20:17:57 +02:00
|
|
|
lparams.n_gpu_layers = params.n_gpu_layers;
|
|
|
|
lparams.main_gpu = params.main_gpu;
|
|
|
|
lparams.tensor_split = params.tensor_split;
|
|
|
|
lparams.low_vram = params.low_vram;
|
|
|
|
lparams.seed = params.seed;
|
|
|
|
lparams.f16_kv = params.memory_f16;
|
|
|
|
lparams.use_mmap = params.use_mmap;
|
|
|
|
lparams.use_mlock = params.use_mlock;
|
|
|
|
lparams.logits_all = params.perplexity;
|
|
|
|
lparams.embedding = params.embedding;
|
llama : add custom RoPE (#2054)
* Implement customizable RoPE
The original RoPE has pre-defined parameters
theta_i = 10000^(−2(i−1)/d), for i in [1, 2, ..., d/2]
Our customizable RoPE, ggml_rope_custom_inplace, uses
theta_i = scale * base^(−2(i−1)/d), for i in [1, 2, ..., d/2]
with the default matches the original
scale = 1.0
base = 10000
The new command line arguments
--rope-freq-base
--rope-freq-scale
set the two new RoPE parameter.
Recent researches show changing these two parameters extends the context limit with minimal loss.
1. Extending Context to 8K
kaiokendev
https://kaiokendev.github.io/til#extending-context-to-8k
2. Extending Context Window of Large Language Models via Positional Interpolation
Shouyuan Chen, Sherman Wong, Liangjian Chen, Yuandong Tian
https://arxiv.org/abs/2306.15595
3. NTK-Aware Scaled RoPE allows LLaMA models to have extended (8k+) context size without any fine-tuning and minimal perplexity degradation.
https://www.reddit.com/user/bloc97
https://www.reddit.com/r/LocalLLaMA/comments/14lz7j5/ntkaware_scaled_rope_allows_llama_models_to_have/
For the bold, try adding the following command line parameters to your favorite model:
-c 16384 --rope-freq-base 80000 --rope-freq-scale 0.5
* ggml-metal: fix custom rope
* common: fix argument names in help
* llama: increase MEM_REQ_EVAL for MODEL_3B
It avoids crashing for quantized weights on CPU.
Better ways to calculate the required buffer size would be better.
* llama: make MEM_REQ_EVAL depend on n_ctx
* server: use proper Content-Type in curl examples
Without the header Content-Type: application/json, curl will POST with
Content-Type: application/x-www-form-urlencoded
Though our simple server doesn't care, the httplib.h used has a limit
with CPPHTTPLIB_FORM_URL_ENCODED_PAYLOAD_MAX_LENGTH 8192
With Content-Type: application/json, we can send large json data.
* style : minor fixes, mostly indentations
* ggml : fix asserts
---------
Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>
2023-07-15 12:34:16 +02:00
|
|
|
lparams.rope_freq_base = params.rope_freq_base;
|
|
|
|
lparams.rope_freq_scale = params.rope_freq_scale;
|
2023-05-02 22:39:51 +02:00
|
|
|
|
2023-07-11 18:18:43 +02:00
|
|
|
return lparams;
|
|
|
|
}
|
|
|
|
|
|
|
|
std::tuple<struct llama_model *, struct llama_context *> llama_init_from_gpt_params(const gpt_params & params) {
|
|
|
|
auto lparams = llama_context_params_from_gpt_params(params);
|
|
|
|
|
2023-06-24 10:47:58 +02:00
|
|
|
llama_model * model = llama_load_model_from_file(params.model.c_str(), lparams);
|
|
|
|
if (model == NULL) {
|
|
|
|
fprintf(stderr, "%s: error: failed to load model '%s'\n", __func__, params.model.c_str());
|
|
|
|
return std::make_tuple(nullptr, nullptr);
|
|
|
|
}
|
2023-05-02 22:39:51 +02:00
|
|
|
|
2023-06-24 10:47:58 +02:00
|
|
|
llama_context * lctx = llama_new_context_with_model(model, lparams);
|
2023-05-02 22:39:51 +02:00
|
|
|
if (lctx == NULL) {
|
2023-06-24 10:47:58 +02:00
|
|
|
fprintf(stderr, "%s: error: failed to create context with model '%s'\n", __func__, params.model.c_str());
|
|
|
|
llama_free_model(model);
|
|
|
|
return std::make_tuple(nullptr, nullptr);
|
2023-05-02 22:39:51 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!params.lora_adapter.empty()) {
|
2023-06-24 10:47:58 +02:00
|
|
|
int err = llama_model_apply_lora_from_file(model,
|
2023-05-02 22:39:51 +02:00
|
|
|
params.lora_adapter.c_str(),
|
|
|
|
params.lora_base.empty() ? NULL : params.lora_base.c_str(),
|
|
|
|
params.n_threads);
|
|
|
|
if (err != 0) {
|
|
|
|
fprintf(stderr, "%s: error: failed to apply lora adapter\n", __func__);
|
2023-06-24 10:47:58 +02:00
|
|
|
llama_free(lctx);
|
|
|
|
llama_free_model(model);
|
|
|
|
return std::make_tuple(nullptr, nullptr);
|
2023-05-02 22:39:51 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-06-24 10:47:58 +02:00
|
|
|
return std::make_tuple(model, lctx);
|
2023-05-02 22:39:51 +02:00
|
|
|
}
|
|
|
|
|
2023-05-09 04:45:48 +02:00
|
|
|
void console_init(console_state & con_st) {
|
|
|
|
#if defined(_WIN32)
|
|
|
|
// Windows-specific console initialization
|
|
|
|
DWORD dwMode = 0;
|
|
|
|
con_st.hConsole = GetStdHandle(STD_OUTPUT_HANDLE);
|
|
|
|
if (con_st.hConsole == INVALID_HANDLE_VALUE || !GetConsoleMode(con_st.hConsole, &dwMode)) {
|
|
|
|
con_st.hConsole = GetStdHandle(STD_ERROR_HANDLE);
|
|
|
|
if (con_st.hConsole != INVALID_HANDLE_VALUE && (!GetConsoleMode(con_st.hConsole, &dwMode))) {
|
|
|
|
con_st.hConsole = NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (con_st.hConsole) {
|
|
|
|
// Enable ANSI colors on Windows 10+
|
|
|
|
if (con_st.use_color && !(dwMode & ENABLE_VIRTUAL_TERMINAL_PROCESSING)) {
|
|
|
|
SetConsoleMode(con_st.hConsole, dwMode | ENABLE_VIRTUAL_TERMINAL_PROCESSING);
|
|
|
|
}
|
|
|
|
// Set console output codepage to UTF8
|
|
|
|
SetConsoleOutputCP(CP_UTF8);
|
|
|
|
}
|
|
|
|
HANDLE hConIn = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
if (hConIn != INVALID_HANDLE_VALUE && GetConsoleMode(hConIn, &dwMode)) {
|
|
|
|
// Set console input codepage to UTF16
|
|
|
|
_setmode(_fileno(stdin), _O_WTEXT);
|
|
|
|
|
|
|
|
// Turn off ICANON (ENABLE_LINE_INPUT) and ECHO (ENABLE_ECHO_INPUT)
|
|
|
|
dwMode &= ~(ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT);
|
|
|
|
SetConsoleMode(hConIn, dwMode);
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
// POSIX-specific console initialization
|
|
|
|
struct termios new_termios;
|
|
|
|
tcgetattr(STDIN_FILENO, &con_st.prev_state);
|
|
|
|
new_termios = con_st.prev_state;
|
|
|
|
new_termios.c_lflag &= ~(ICANON | ECHO);
|
|
|
|
new_termios.c_cc[VMIN] = 1;
|
|
|
|
new_termios.c_cc[VTIME] = 0;
|
|
|
|
tcsetattr(STDIN_FILENO, TCSANOW, &new_termios);
|
|
|
|
|
|
|
|
con_st.tty = fopen("/dev/tty", "w+");
|
|
|
|
if (con_st.tty != nullptr) {
|
|
|
|
con_st.out = con_st.tty;
|
|
|
|
}
|
2023-05-09 19:53:28 +02:00
|
|
|
|
2023-05-09 04:45:48 +02:00
|
|
|
setlocale(LC_ALL, "");
|
2023-05-09 19:53:28 +02:00
|
|
|
#endif
|
2023-05-09 04:45:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
void console_cleanup(console_state & con_st) {
|
|
|
|
// Reset console color
|
|
|
|
console_set_color(con_st, CONSOLE_COLOR_DEFAULT);
|
|
|
|
|
|
|
|
#if !defined(_WIN32)
|
|
|
|
if (con_st.tty != nullptr) {
|
|
|
|
con_st.out = stdout;
|
|
|
|
fclose(con_st.tty);
|
|
|
|
con_st.tty = nullptr;
|
|
|
|
}
|
|
|
|
// Restore the terminal settings on POSIX systems
|
|
|
|
tcsetattr(STDIN_FILENO, TCSANOW, &con_st.prev_state);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
2023-03-28 16:09:55 +02:00
|
|
|
/* Keep track of current color of output, and emit ANSI code if it changes. */
|
2023-05-09 04:45:48 +02:00
|
|
|
void console_set_color(console_state & con_st, console_color_t color) {
|
2023-03-28 16:09:55 +02:00
|
|
|
if (con_st.use_color && con_st.color != color) {
|
2023-05-09 04:45:48 +02:00
|
|
|
fflush(stdout);
|
2023-03-28 16:09:55 +02:00
|
|
|
switch(color) {
|
|
|
|
case CONSOLE_COLOR_DEFAULT:
|
2023-05-09 04:45:48 +02:00
|
|
|
fprintf(con_st.out, ANSI_COLOR_RESET);
|
2023-03-28 16:09:55 +02:00
|
|
|
break;
|
|
|
|
case CONSOLE_COLOR_PROMPT:
|
2023-05-09 04:45:48 +02:00
|
|
|
fprintf(con_st.out, ANSI_COLOR_YELLOW);
|
2023-03-28 16:09:55 +02:00
|
|
|
break;
|
|
|
|
case CONSOLE_COLOR_USER_INPUT:
|
2023-05-09 04:45:48 +02:00
|
|
|
fprintf(con_st.out, ANSI_BOLD ANSI_COLOR_GREEN);
|
2023-03-28 16:09:55 +02:00
|
|
|
break;
|
2023-06-11 16:19:17 +02:00
|
|
|
case CONSOLE_COLOR_ERROR:
|
|
|
|
fprintf(con_st.out, ANSI_BOLD ANSI_COLOR_RED);
|
|
|
|
break;
|
2023-03-28 16:09:55 +02:00
|
|
|
}
|
|
|
|
con_st.color = color;
|
2023-05-09 04:45:48 +02:00
|
|
|
fflush(con_st.out);
|
2023-03-28 16:09:55 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-05-09 04:45:48 +02:00
|
|
|
char32_t getchar32() {
|
2023-05-20 09:40:02 +02:00
|
|
|
#if defined(_WIN32)
|
|
|
|
HANDLE hConsole = GetStdHandle(STD_INPUT_HANDLE);
|
|
|
|
wchar_t high_surrogate = 0;
|
|
|
|
|
|
|
|
while (true) {
|
|
|
|
INPUT_RECORD record;
|
|
|
|
DWORD count;
|
|
|
|
if (!ReadConsoleInputW(hConsole, &record, 1, &count) || count == 0) {
|
|
|
|
return WEOF;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (record.EventType == KEY_EVENT && record.Event.KeyEvent.bKeyDown) {
|
|
|
|
wchar_t wc = record.Event.KeyEvent.uChar.UnicodeChar;
|
|
|
|
if (wc == 0) {
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ((wc >= 0xD800) && (wc <= 0xDBFF)) { // Check if wc is a high surrogate
|
|
|
|
high_surrogate = wc;
|
|
|
|
continue;
|
|
|
|
} else if ((wc >= 0xDC00) && (wc <= 0xDFFF)) { // Check if wc is a low surrogate
|
|
|
|
if (high_surrogate != 0) { // Check if we have a high surrogate
|
|
|
|
return ((high_surrogate - 0xD800) << 10) + (wc - 0xDC00) + 0x10000;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
high_surrogate = 0; // Reset the high surrogate
|
|
|
|
return static_cast<char32_t>(wc);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#else
|
2023-05-09 04:45:48 +02:00
|
|
|
wchar_t wc = getwchar();
|
|
|
|
if (static_cast<wint_t>(wc) == WEOF) {
|
|
|
|
return WEOF;
|
2023-03-28 16:09:55 +02:00
|
|
|
}
|
2023-05-09 04:45:48 +02:00
|
|
|
|
|
|
|
#if WCHAR_MAX == 0xFFFF
|
|
|
|
if ((wc >= 0xD800) && (wc <= 0xDBFF)) { // Check if wc is a high surrogate
|
|
|
|
wchar_t low_surrogate = getwchar();
|
|
|
|
if ((low_surrogate >= 0xDC00) && (low_surrogate <= 0xDFFF)) { // Check if the next wchar is a low surrogate
|
|
|
|
return (static_cast<char32_t>(wc & 0x03FF) << 10) + (low_surrogate & 0x03FF) + 0x10000;
|
2023-03-28 16:09:55 +02:00
|
|
|
}
|
|
|
|
}
|
2023-05-09 04:45:48 +02:00
|
|
|
if ((wc >= 0xD800) && (wc <= 0xDFFF)) { // Invalid surrogate pair
|
|
|
|
return 0xFFFD; // Return the replacement character U+FFFD
|
2023-03-28 16:09:55 +02:00
|
|
|
}
|
2023-05-09 04:45:48 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
return static_cast<char32_t>(wc);
|
2023-05-20 09:40:02 +02:00
|
|
|
#endif
|
2023-03-28 16:09:55 +02:00
|
|
|
}
|
2023-04-08 17:49:39 +02:00
|
|
|
|
2023-05-09 04:45:48 +02:00
|
|
|
void pop_cursor(console_state & con_st) {
|
|
|
|
#if defined(_WIN32)
|
|
|
|
if (con_st.hConsole != NULL) {
|
|
|
|
CONSOLE_SCREEN_BUFFER_INFO bufferInfo;
|
|
|
|
GetConsoleScreenBufferInfo(con_st.hConsole, &bufferInfo);
|
|
|
|
|
|
|
|
COORD newCursorPosition = bufferInfo.dwCursorPosition;
|
|
|
|
if (newCursorPosition.X == 0) {
|
|
|
|
newCursorPosition.X = bufferInfo.dwSize.X - 1;
|
|
|
|
newCursorPosition.Y -= 1;
|
|
|
|
} else {
|
|
|
|
newCursorPosition.X -= 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
SetConsoleCursorPosition(con_st.hConsole, newCursorPosition);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
putc('\b', con_st.out);
|
2023-04-08 17:49:39 +02:00
|
|
|
}
|
2023-05-09 04:45:48 +02:00
|
|
|
|
|
|
|
int estimateWidth(char32_t codepoint) {
|
|
|
|
#if defined(_WIN32)
|
|
|
|
return 1;
|
|
|
|
#else
|
|
|
|
return wcwidth(codepoint);
|
2023-03-28 16:09:55 +02:00
|
|
|
#endif
|
2023-05-09 04:45:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
int put_codepoint(console_state & con_st, const char* utf8_codepoint, size_t length, int expectedWidth) {
|
|
|
|
#if defined(_WIN32)
|
|
|
|
CONSOLE_SCREEN_BUFFER_INFO bufferInfo;
|
|
|
|
if (!GetConsoleScreenBufferInfo(con_st.hConsole, &bufferInfo)) {
|
|
|
|
// go with the default
|
|
|
|
return expectedWidth;
|
|
|
|
}
|
|
|
|
COORD initialPosition = bufferInfo.dwCursorPosition;
|
|
|
|
DWORD nNumberOfChars = length;
|
|
|
|
WriteConsole(con_st.hConsole, utf8_codepoint, nNumberOfChars, &nNumberOfChars, NULL);
|
|
|
|
|
|
|
|
CONSOLE_SCREEN_BUFFER_INFO newBufferInfo;
|
|
|
|
GetConsoleScreenBufferInfo(con_st.hConsole, &newBufferInfo);
|
|
|
|
|
|
|
|
// Figure out our real position if we're in the last column
|
|
|
|
if (utf8_codepoint[0] != 0x09 && initialPosition.X == newBufferInfo.dwSize.X - 1) {
|
|
|
|
DWORD nNumberOfChars;
|
|
|
|
WriteConsole(con_st.hConsole, &" \b", 2, &nNumberOfChars, NULL);
|
|
|
|
GetConsoleScreenBufferInfo(con_st.hConsole, &newBufferInfo);
|
|
|
|
}
|
|
|
|
|
|
|
|
int width = newBufferInfo.dwCursorPosition.X - initialPosition.X;
|
|
|
|
if (width < 0) {
|
|
|
|
width += newBufferInfo.dwSize.X;
|
|
|
|
}
|
|
|
|
return width;
|
|
|
|
#else
|
|
|
|
// we can trust expectedWidth if we've got one
|
|
|
|
if (expectedWidth >= 0 || con_st.tty == nullptr) {
|
|
|
|
fwrite(utf8_codepoint, length, 1, con_st.out);
|
|
|
|
return expectedWidth;
|
|
|
|
}
|
|
|
|
|
|
|
|
fputs("\033[6n", con_st.tty); // Query cursor position
|
|
|
|
int x1, x2, y1, y2;
|
|
|
|
int results = 0;
|
|
|
|
results = fscanf(con_st.tty, "\033[%d;%dR", &y1, &x1);
|
|
|
|
|
|
|
|
fwrite(utf8_codepoint, length, 1, con_st.tty);
|
|
|
|
|
|
|
|
fputs("\033[6n", con_st.tty); // Query cursor position
|
|
|
|
results += fscanf(con_st.tty, "\033[%d;%dR", &y2, &x2);
|
|
|
|
|
|
|
|
if (results != 4) {
|
|
|
|
return expectedWidth;
|
|
|
|
}
|
|
|
|
|
|
|
|
int width = x2 - x1;
|
|
|
|
if (width < 0) {
|
|
|
|
// Calculate the width considering text wrapping
|
|
|
|
struct winsize w;
|
|
|
|
ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
|
|
|
|
width += w.ws_col;
|
|
|
|
}
|
|
|
|
return width;
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
void replace_last(console_state & con_st, char ch) {
|
|
|
|
#if defined(_WIN32)
|
|
|
|
pop_cursor(con_st);
|
|
|
|
put_codepoint(con_st, &ch, 1, 1);
|
|
|
|
#else
|
|
|
|
fprintf(con_st.out, "\b%c", ch);
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
void append_utf8(char32_t ch, std::string & out) {
|
|
|
|
if (ch <= 0x7F) {
|
|
|
|
out.push_back(static_cast<unsigned char>(ch));
|
|
|
|
} else if (ch <= 0x7FF) {
|
|
|
|
out.push_back(static_cast<unsigned char>(0xC0 | ((ch >> 6) & 0x1F)));
|
|
|
|
out.push_back(static_cast<unsigned char>(0x80 | (ch & 0x3F)));
|
|
|
|
} else if (ch <= 0xFFFF) {
|
|
|
|
out.push_back(static_cast<unsigned char>(0xE0 | ((ch >> 12) & 0x0F)));
|
|
|
|
out.push_back(static_cast<unsigned char>(0x80 | ((ch >> 6) & 0x3F)));
|
|
|
|
out.push_back(static_cast<unsigned char>(0x80 | (ch & 0x3F)));
|
|
|
|
} else if (ch <= 0x10FFFF) {
|
|
|
|
out.push_back(static_cast<unsigned char>(0xF0 | ((ch >> 18) & 0x07)));
|
|
|
|
out.push_back(static_cast<unsigned char>(0x80 | ((ch >> 12) & 0x3F)));
|
|
|
|
out.push_back(static_cast<unsigned char>(0x80 | ((ch >> 6) & 0x3F)));
|
|
|
|
out.push_back(static_cast<unsigned char>(0x80 | (ch & 0x3F)));
|
|
|
|
} else {
|
|
|
|
// Invalid Unicode code point
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Helper function to remove the last UTF-8 character from a string
|
|
|
|
void pop_back_utf8_char(std::string & line) {
|
|
|
|
if (line.empty()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
size_t pos = line.length() - 1;
|
|
|
|
|
|
|
|
// Find the start of the last UTF-8 character (checking up to 4 bytes back)
|
|
|
|
for (size_t i = 0; i < 3 && pos > 0; ++i, --pos) {
|
|
|
|
if ((line[pos] & 0xC0) != 0x80) break; // Found the start of the character
|
|
|
|
}
|
|
|
|
line.erase(pos);
|
|
|
|
}
|
|
|
|
|
|
|
|
bool console_readline(console_state & con_st, std::string & line) {
|
|
|
|
console_set_color(con_st, CONSOLE_COLOR_USER_INPUT);
|
|
|
|
if (con_st.out != stdout) {
|
|
|
|
fflush(stdout);
|
|
|
|
}
|
|
|
|
|
|
|
|
line.clear();
|
|
|
|
std::vector<int> widths;
|
|
|
|
bool is_special_char = false;
|
|
|
|
bool end_of_stream = false;
|
|
|
|
|
|
|
|
char32_t input_char;
|
|
|
|
while (true) {
|
|
|
|
fflush(con_st.out); // Ensure all output is displayed before waiting for input
|
|
|
|
input_char = getchar32();
|
|
|
|
|
|
|
|
if (input_char == '\r' || input_char == '\n') {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2023-05-19 19:14:51 +02:00
|
|
|
if (input_char == (char32_t) WEOF || input_char == 0x04 /* Ctrl+D*/) {
|
2023-05-09 04:45:48 +02:00
|
|
|
end_of_stream = true;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (is_special_char) {
|
|
|
|
console_set_color(con_st, CONSOLE_COLOR_USER_INPUT);
|
|
|
|
replace_last(con_st, line.back());
|
|
|
|
is_special_char = false;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (input_char == '\033') { // Escape sequence
|
|
|
|
char32_t code = getchar32();
|
|
|
|
if (code == '[' || code == 0x1B) {
|
|
|
|
// Discard the rest of the escape sequence
|
2023-05-19 19:14:51 +02:00
|
|
|
while ((code = getchar32()) != (char32_t) WEOF) {
|
2023-05-09 04:45:48 +02:00
|
|
|
if ((code >= 'A' && code <= 'Z') || (code >= 'a' && code <= 'z') || code == '~') {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else if (input_char == 0x08 || input_char == 0x7F) { // Backspace
|
|
|
|
if (!widths.empty()) {
|
|
|
|
int count;
|
|
|
|
do {
|
|
|
|
count = widths.back();
|
|
|
|
widths.pop_back();
|
|
|
|
// Move cursor back, print space, and move cursor back again
|
|
|
|
for (int i = 0; i < count; i++) {
|
|
|
|
replace_last(con_st, ' ');
|
|
|
|
pop_cursor(con_st);
|
|
|
|
}
|
|
|
|
pop_back_utf8_char(line);
|
|
|
|
} while (count == 0 && !widths.empty());
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
int offset = line.length();
|
|
|
|
append_utf8(input_char, line);
|
|
|
|
int width = put_codepoint(con_st, line.c_str() + offset, line.length() - offset, estimateWidth(input_char));
|
|
|
|
if (width < 0) {
|
|
|
|
width = 0;
|
|
|
|
}
|
|
|
|
widths.push_back(width);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!line.empty() && (line.back() == '\\' || line.back() == '/')) {
|
|
|
|
console_set_color(con_st, CONSOLE_COLOR_PROMPT);
|
|
|
|
replace_last(con_st, line.back());
|
|
|
|
is_special_char = true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
bool has_more = con_st.multiline_input;
|
|
|
|
if (is_special_char) {
|
|
|
|
replace_last(con_st, ' ');
|
|
|
|
pop_cursor(con_st);
|
|
|
|
|
|
|
|
char last = line.back();
|
|
|
|
line.pop_back();
|
|
|
|
if (last == '\\') {
|
|
|
|
line += '\n';
|
|
|
|
fputc('\n', con_st.out);
|
|
|
|
has_more = !has_more;
|
|
|
|
} else {
|
|
|
|
// llama will just eat the single space, it won't act as a space
|
|
|
|
if (line.length() == 1 && line.back() == ' ') {
|
|
|
|
line.clear();
|
|
|
|
pop_cursor(con_st);
|
|
|
|
}
|
|
|
|
has_more = false;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
if (end_of_stream) {
|
|
|
|
has_more = false;
|
|
|
|
} else {
|
|
|
|
line += '\n';
|
|
|
|
fputc('\n', con_st.out);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
fflush(con_st.out);
|
|
|
|
return has_more;
|
|
|
|
}
|