common.cpp 39 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002
  1. #include "common.h"
  2. #include <cassert>
  3. #include <iostream>
  4. #include <cstring>
  5. #include <fstream>
  6. #include <string>
  7. #include <iterator>
  8. #include <algorithm>
  9. #include <sstream>
  10. #include <unordered_set>
  11. #include <regex>
  12. #if defined(__APPLE__) && defined(__MACH__)
  13. #include <sys/types.h>
  14. #include <sys/sysctl.h>
  15. #endif
  16. #if defined(_WIN32)
  17. #define WIN32_LEAN_AND_MEAN
  18. #define NOMINMAX
  19. #include <windows.h>
  20. #include <fcntl.h>
  21. #include <io.h>
  22. #else
  23. #include <sys/ioctl.h>
  24. #include <unistd.h>
  25. #include <wchar.h>
  26. #endif
  27. #if defined(_MSC_VER)
  28. #pragma warning(disable: 4244 4267) // possible loss of data
  29. #endif
  30. int32_t get_num_physical_cores() {
  31. #ifdef __linux__
  32. // enumerate the set of thread siblings, num entries is num cores
  33. std::unordered_set<std::string> siblings;
  34. for (uint32_t cpu=0; cpu < UINT32_MAX; ++cpu) {
  35. std::ifstream thread_siblings("/sys/devices/system/cpu"
  36. + std::to_string(cpu) + "/topology/thread_siblings");
  37. if (!thread_siblings.is_open()) {
  38. break; // no more cpus
  39. }
  40. std::string line;
  41. if (std::getline(thread_siblings, line)) {
  42. siblings.insert(line);
  43. }
  44. }
  45. if (siblings.size() > 0) {
  46. return static_cast<int32_t>(siblings.size());
  47. }
  48. #elif defined(__APPLE__) && defined(__MACH__)
  49. int32_t num_physical_cores;
  50. size_t len = sizeof(num_physical_cores);
  51. int result = sysctlbyname("hw.perflevel0.physicalcpu", &num_physical_cores, &len, NULL, 0);
  52. if (result == 0) {
  53. return num_physical_cores;
  54. }
  55. result = sysctlbyname("hw.physicalcpu", &num_physical_cores, &len, NULL, 0);
  56. if (result == 0) {
  57. return num_physical_cores;
  58. }
  59. #elif defined(_WIN32)
  60. //TODO: Implement
  61. #endif
  62. unsigned int n_threads = std::thread::hardware_concurrency();
  63. return n_threads > 0 ? (n_threads <= 4 ? n_threads : n_threads / 2) : 4;
  64. }
  65. void process_escapes(std::string& input) {
  66. std::size_t input_len = input.length();
  67. std::size_t output_idx = 0;
  68. for (std::size_t input_idx = 0; input_idx < input_len; ++input_idx) {
  69. if (input[input_idx] == '\\' && input_idx + 1 < input_len) {
  70. switch (input[++input_idx]) {
  71. case 'n': input[output_idx++] = '\n'; break;
  72. case 'r': input[output_idx++] = '\r'; break;
  73. case 't': input[output_idx++] = '\t'; break;
  74. case '\'': input[output_idx++] = '\''; break;
  75. case '\"': input[output_idx++] = '\"'; break;
  76. case '\\': input[output_idx++] = '\\'; break;
  77. default: input[output_idx++] = '\\';
  78. input[output_idx++] = input[input_idx]; break;
  79. }
  80. } else {
  81. input[output_idx++] = input[input_idx];
  82. }
  83. }
  84. input.resize(output_idx);
  85. }
  86. bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
  87. bool invalid_param = false;
  88. bool escape_prompt = false;
  89. std::string arg;
  90. gpt_params default_params;
  91. const std::string arg_prefix = "--";
  92. for (int i = 1; i < argc; i++) {
  93. arg = argv[i];
  94. if (arg.compare(0, arg_prefix.size(), arg_prefix) == 0) {
  95. std::replace(arg.begin(), arg.end(), '_', '-');
  96. }
  97. if (arg == "-s" || arg == "--seed") {
  98. if (++i >= argc) {
  99. invalid_param = true;
  100. break;
  101. }
  102. params.seed = std::stoul(argv[i]);
  103. } else if (arg == "-t" || arg == "--threads") {
  104. if (++i >= argc) {
  105. invalid_param = true;
  106. break;
  107. }
  108. params.n_threads = std::stoi(argv[i]);
  109. } else if (arg == "-p" || arg == "--prompt") {
  110. if (++i >= argc) {
  111. invalid_param = true;
  112. break;
  113. }
  114. params.prompt = argv[i];
  115. } else if (arg == "-e") {
  116. escape_prompt = true;
  117. } else if (arg == "--prompt-cache") {
  118. if (++i >= argc) {
  119. invalid_param = true;
  120. break;
  121. }
  122. params.path_prompt_cache = argv[i];
  123. } else if (arg == "--prompt-cache-all") {
  124. params.prompt_cache_all = true;
  125. } else if (arg == "--prompt-cache-ro") {
  126. params.prompt_cache_ro = true;
  127. } else if (arg == "-f" || arg == "--file") {
  128. if (++i >= argc) {
  129. invalid_param = true;
  130. break;
  131. }
  132. std::ifstream file(argv[i]);
  133. if (!file) {
  134. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  135. invalid_param = true;
  136. break;
  137. }
  138. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(params.prompt));
  139. if (params.prompt.back() == '\n') {
  140. params.prompt.pop_back();
  141. }
  142. } else if (arg == "-n" || arg == "--n-predict") {
  143. if (++i >= argc) {
  144. invalid_param = true;
  145. break;
  146. }
  147. params.n_predict = std::stoi(argv[i]);
  148. } else if (arg == "--top-k") {
  149. if (++i >= argc) {
  150. invalid_param = true;
  151. break;
  152. }
  153. params.top_k = std::stoi(argv[i]);
  154. } else if (arg == "-c" || arg == "--ctx-size") {
  155. if (++i >= argc) {
  156. invalid_param = true;
  157. break;
  158. }
  159. params.n_ctx = std::stoi(argv[i]);
  160. } else if (arg == "--rope-freq-base") {
  161. if (++i >= argc) {
  162. invalid_param = true;
  163. break;
  164. }
  165. params.rope_freq_base = std::stof(argv[i]);
  166. } else if (arg == "--rope-freq-scale") {
  167. if (++i >= argc) {
  168. invalid_param = true;
  169. break;
  170. }
  171. params.rope_freq_scale = std::stof(argv[i]);
  172. } else if (arg == "--memory-f32") {
  173. params.memory_f16 = false;
  174. } else if (arg == "--top-p") {
  175. if (++i >= argc) {
  176. invalid_param = true;
  177. break;
  178. }
  179. params.top_p = std::stof(argv[i]);
  180. } else if (arg == "--temp") {
  181. if (++i >= argc) {
  182. invalid_param = true;
  183. break;
  184. }
  185. params.temp = std::stof(argv[i]);
  186. } else if (arg == "--tfs") {
  187. if (++i >= argc) {
  188. invalid_param = true;
  189. break;
  190. }
  191. params.tfs_z = std::stof(argv[i]);
  192. } else if (arg == "--typical") {
  193. if (++i >= argc) {
  194. invalid_param = true;
  195. break;
  196. }
  197. params.typical_p = std::stof(argv[i]);
  198. } else if (arg == "--repeat-last-n") {
  199. if (++i >= argc) {
  200. invalid_param = true;
  201. break;
  202. }
  203. params.repeat_last_n = std::stoi(argv[i]);
  204. } else if (arg == "--repeat-penalty") {
  205. if (++i >= argc) {
  206. invalid_param = true;
  207. break;
  208. }
  209. params.repeat_penalty = std::stof(argv[i]);
  210. } else if (arg == "--frequency-penalty") {
  211. if (++i >= argc) {
  212. invalid_param = true;
  213. break;
  214. }
  215. params.frequency_penalty = std::stof(argv[i]);
  216. } else if (arg == "--presence-penalty") {
  217. if (++i >= argc) {
  218. invalid_param = true;
  219. break;
  220. }
  221. params.presence_penalty = std::stof(argv[i]);
  222. } else if (arg == "--mirostat") {
  223. if (++i >= argc) {
  224. invalid_param = true;
  225. break;
  226. }
  227. params.mirostat = std::stoi(argv[i]);
  228. } else if (arg == "--mirostat-lr") {
  229. if (++i >= argc) {
  230. invalid_param = true;
  231. break;
  232. }
  233. params.mirostat_eta = std::stof(argv[i]);
  234. } else if (arg == "--mirostat-ent") {
  235. if (++i >= argc) {
  236. invalid_param = true;
  237. break;
  238. }
  239. params.mirostat_tau = std::stof(argv[i]);
  240. } else if (arg == "--cfg-negative-prompt") {
  241. if (++i >= argc) {
  242. invalid_param = true;
  243. break;
  244. }
  245. params.cfg_negative_prompt = argv[i];
  246. } else if (arg == "--cfg-scale") {
  247. if (++i >= argc) {
  248. invalid_param = true;
  249. break;
  250. }
  251. params.cfg_scale = std::stof(argv[i]);
  252. } else if (arg == "-b" || arg == "--batch-size") {
  253. if (++i >= argc) {
  254. invalid_param = true;
  255. break;
  256. }
  257. params.n_batch = std::stoi(argv[i]);
  258. params.n_batch = std::min(512, params.n_batch);
  259. } else if (arg == "--keep") {
  260. if (++i >= argc) {
  261. invalid_param = true;
  262. break;
  263. }
  264. params.n_keep = std::stoi(argv[i]);
  265. } else if (arg == "--chunks") {
  266. if (++i >= argc) {
  267. invalid_param = true;
  268. break;
  269. }
  270. params.n_chunks = std::stoi(argv[i]);
  271. } else if (arg == "-m" || arg == "--model") {
  272. if (++i >= argc) {
  273. invalid_param = true;
  274. break;
  275. }
  276. params.model = argv[i];
  277. } else if (arg == "-a" || arg == "--alias") {
  278. if (++i >= argc) {
  279. invalid_param = true;
  280. break;
  281. }
  282. params.model_alias = argv[i];
  283. } else if (arg == "--lora") {
  284. if (++i >= argc) {
  285. invalid_param = true;
  286. break;
  287. }
  288. params.lora_adapter = argv[i];
  289. params.use_mmap = false;
  290. } else if (arg == "--lora-base") {
  291. if (++i >= argc) {
  292. invalid_param = true;
  293. break;
  294. }
  295. params.lora_base = argv[i];
  296. } else if (arg == "-i" || arg == "--interactive") {
  297. params.interactive = true;
  298. } else if (arg == "--embedding") {
  299. params.embedding = true;
  300. } else if (arg == "--interactive-first") {
  301. params.interactive_first = true;
  302. } else if (arg == "-ins" || arg == "--instruct") {
  303. params.instruct = true;
  304. } else if (arg == "--multiline-input") {
  305. params.multiline_input = true;
  306. } else if (arg == "--color") {
  307. params.use_color = true;
  308. } else if (arg == "--mlock") {
  309. params.use_mlock = true;
  310. } else if (arg == "--gpu-layers" || arg == "-ngl" || arg == "--n-gpu-layers") {
  311. if (++i >= argc) {
  312. invalid_param = true;
  313. break;
  314. }
  315. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  316. params.n_gpu_layers = std::stoi(argv[i]);
  317. #else
  318. fprintf(stderr, "warning: not compiled with GPU offload support, --n-gpu-layers option will be ignored\n");
  319. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  320. #endif
  321. } else if (arg == "--main-gpu" || arg == "-mg") {
  322. if (++i >= argc) {
  323. invalid_param = true;
  324. break;
  325. }
  326. #ifdef GGML_USE_CUBLAS
  327. params.main_gpu = std::stoi(argv[i]);
  328. #else
  329. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set a main GPU.\n");
  330. #endif
  331. } else if (arg == "--tensor-split" || arg == "-ts") {
  332. if (++i >= argc) {
  333. invalid_param = true;
  334. break;
  335. }
  336. #ifdef GGML_USE_CUBLAS
  337. std::string arg_next = argv[i];
  338. // split string by , and /
  339. const std::regex regex{R"([,/]+)"};
  340. std::sregex_token_iterator it{arg_next.begin(), arg_next.end(), regex, -1};
  341. std::vector<std::string> split_arg{it, {}};
  342. GGML_ASSERT(split_arg.size() <= LLAMA_MAX_DEVICES);
  343. for (size_t i = 0; i < LLAMA_MAX_DEVICES; ++i) {
  344. if (i < split_arg.size()) {
  345. params.tensor_split[i] = std::stof(split_arg[i]);
  346. } else {
  347. params.tensor_split[i] = 0.0f;
  348. }
  349. }
  350. #else
  351. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set a tensor split.\n");
  352. #endif // GGML_USE_CUBLAS
  353. } else if (arg == "--low-vram" || arg == "-lv") {
  354. #ifdef GGML_USE_CUBLAS
  355. params.low_vram = true;
  356. #else
  357. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set lower vram usage.\n");
  358. #endif // GGML_USE_CUBLAS
  359. } else if (arg == "--no-mmap") {
  360. params.use_mmap = false;
  361. } else if (arg == "--mtest") {
  362. params.mem_test = true;
  363. } else if (arg == "--numa") {
  364. params.numa = true;
  365. } else if (arg == "--export") {
  366. params.export_cgraph = true;
  367. } else if (arg == "--verbose-prompt") {
  368. params.verbose_prompt = true;
  369. } else if (arg == "-r" || arg == "--reverse-prompt") {
  370. if (++i >= argc) {
  371. invalid_param = true;
  372. break;
  373. }
  374. params.antiprompt.push_back(argv[i]);
  375. } else if (arg == "--perplexity") {
  376. params.perplexity = true;
  377. } else if (arg == "--perplexity-lines") {
  378. params.perplexity_lines = true;
  379. } else if (arg == "--ignore-eos") {
  380. params.logit_bias[llama_token_eos()] = -INFINITY;
  381. } else if (arg == "--no-penalize-nl") {
  382. params.penalize_nl = false;
  383. } else if (arg == "-l" || arg == "--logit-bias") {
  384. if (++i >= argc) {
  385. invalid_param = true;
  386. break;
  387. }
  388. std::stringstream ss(argv[i]);
  389. llama_token key;
  390. char sign;
  391. std::string value_str;
  392. try {
  393. if (ss >> key && ss >> sign && std::getline(ss, value_str) && (sign == '+' || sign == '-')) {
  394. params.logit_bias[key] = std::stof(value_str) * ((sign == '-') ? -1.0f : 1.0f);
  395. } else {
  396. throw std::exception();
  397. }
  398. } catch (const std::exception&) {
  399. invalid_param = true;
  400. break;
  401. }
  402. } else if (arg == "-h" || arg == "--help") {
  403. gpt_print_usage(argc, argv, default_params);
  404. exit(0);
  405. } else if (arg == "--random-prompt") {
  406. params.random_prompt = true;
  407. } else if (arg == "--in-prefix") {
  408. if (++i >= argc) {
  409. invalid_param = true;
  410. break;
  411. }
  412. params.input_prefix = argv[i];
  413. } else if (arg == "--in-suffix") {
  414. if (++i >= argc) {
  415. invalid_param = true;
  416. break;
  417. }
  418. params.input_suffix = argv[i];
  419. } else {
  420. fprintf(stderr, "error: unknown argument: %s\n", arg.c_str());
  421. gpt_print_usage(argc, argv, default_params);
  422. exit(1);
  423. }
  424. }
  425. if (invalid_param) {
  426. fprintf(stderr, "error: invalid parameter for argument: %s\n", arg.c_str());
  427. gpt_print_usage(argc, argv, default_params);
  428. exit(1);
  429. }
  430. if (params.prompt_cache_all &&
  431. (params.interactive || params.interactive_first ||
  432. params.instruct)) {
  433. fprintf(stderr, "error: --prompt-cache-all not supported in interactive mode yet\n");
  434. gpt_print_usage(argc, argv, default_params);
  435. exit(1);
  436. }
  437. if (escape_prompt) {
  438. process_escapes(params.prompt);
  439. process_escapes(params.input_prefix);
  440. process_escapes(params.input_suffix);
  441. }
  442. return true;
  443. }
  444. void gpt_print_usage(int /*argc*/, char ** argv, const gpt_params & params) {
  445. fprintf(stderr, "usage: %s [options]\n", argv[0]);
  446. fprintf(stderr, "\n");
  447. fprintf(stderr, "options:\n");
  448. fprintf(stderr, " -h, --help show this help message and exit\n");
  449. fprintf(stderr, " -i, --interactive run in interactive mode\n");
  450. fprintf(stderr, " --interactive-first run in interactive mode and wait for input right away\n");
  451. fprintf(stderr, " -ins, --instruct run in instruction mode (use with Alpaca models)\n");
  452. fprintf(stderr, " --multiline-input allows you to write or paste multiple lines without ending each in '\\'\n");
  453. fprintf(stderr, " -r PROMPT, --reverse-prompt PROMPT\n");
  454. fprintf(stderr, " halt generation at PROMPT, return control in interactive mode\n");
  455. fprintf(stderr, " (can be specified more than once for multiple prompts).\n");
  456. fprintf(stderr, " --color colorise output to distinguish prompt and user input from generations\n");
  457. fprintf(stderr, " -s SEED, --seed SEED RNG seed (default: -1, use random seed for < 0)\n");
  458. fprintf(stderr, " -t N, --threads N number of threads to use during computation (default: %d)\n", params.n_threads);
  459. fprintf(stderr, " -p PROMPT, --prompt PROMPT\n");
  460. fprintf(stderr, " prompt to start generation with (default: empty)\n");
  461. fprintf(stderr, " -e process prompt escapes sequences (\\n, \\r, \\t, \\', \\\", \\\\)\n");
  462. fprintf(stderr, " --prompt-cache FNAME file to cache prompt state for faster startup (default: none)\n");
  463. fprintf(stderr, " --prompt-cache-all if specified, saves user input and generations to cache as well.\n");
  464. fprintf(stderr, " not supported with --interactive or other interactive options\n");
  465. fprintf(stderr, " --prompt-cache-ro if specified, uses the prompt cache but does not update it.\n");
  466. fprintf(stderr, " --random-prompt start with a randomized prompt.\n");
  467. fprintf(stderr, " --in-prefix STRING string to prefix user inputs with (default: empty)\n");
  468. fprintf(stderr, " --in-suffix STRING string to suffix after user inputs with (default: empty)\n");
  469. fprintf(stderr, " -f FNAME, --file FNAME\n");
  470. fprintf(stderr, " prompt file to start generation.\n");
  471. fprintf(stderr, " -n N, --n-predict N number of tokens to predict (default: %d, -1 = infinity)\n", params.n_predict);
  472. fprintf(stderr, " --top-k N top-k sampling (default: %d, 0 = disabled)\n", params.top_k);
  473. fprintf(stderr, " --top-p N top-p sampling (default: %.1f, 1.0 = disabled)\n", (double)params.top_p);
  474. fprintf(stderr, " --tfs N tail free sampling, parameter z (default: %.1f, 1.0 = disabled)\n", (double)params.tfs_z);
  475. fprintf(stderr, " --typical N locally typical sampling, parameter p (default: %.1f, 1.0 = disabled)\n", (double)params.typical_p);
  476. fprintf(stderr, " --repeat-last-n N last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)\n", params.repeat_last_n);
  477. fprintf(stderr, " --repeat-penalty N penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)\n", (double)params.repeat_penalty);
  478. fprintf(stderr, " --presence-penalty N repeat alpha presence penalty (default: %.1f, 0.0 = disabled)\n", (double)params.presence_penalty);
  479. fprintf(stderr, " --frequency-penalty N repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)\n", (double)params.frequency_penalty);
  480. fprintf(stderr, " --mirostat N use Mirostat sampling.\n");
  481. fprintf(stderr, " Top K, Nucleus, Tail Free and Locally Typical samplers are ignored if used.\n");
  482. fprintf(stderr, " (default: %d, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)\n", params.mirostat);
  483. fprintf(stderr, " --mirostat-lr N Mirostat learning rate, parameter eta (default: %.1f)\n", (double)params.mirostat_eta);
  484. fprintf(stderr, " --mirostat-ent N Mirostat target entropy, parameter tau (default: %.1f)\n", (double)params.mirostat_tau);
  485. fprintf(stderr, " -l TOKEN_ID(+/-)BIAS, --logit-bias TOKEN_ID(+/-)BIAS\n");
  486. fprintf(stderr, " modifies the likelihood of token appearing in the completion,\n");
  487. fprintf(stderr, " i.e. `--logit-bias 15043+1` to increase likelihood of token ' Hello',\n");
  488. fprintf(stderr, " or `--logit-bias 15043-1` to decrease likelihood of token ' Hello'\n");
  489. fprintf(stderr, " --cfg-negative-prompt PROMPT \n");
  490. fprintf(stderr, " negative prompt to use for guidance. (default: empty)\n");
  491. fprintf(stderr, " --cfg-scale N strength of guidance (default: %f, 1.0 = disable)\n", params.cfg_scale);
  492. fprintf(stderr, " -c N, --ctx-size N size of the prompt context (default: %d)\n", params.n_ctx);
  493. fprintf(stderr, " --rope-freq-base N RoPE base frequency (default: %.1f)\n", params.rope_freq_base);
  494. fprintf(stderr, " --rope-freq-scale N RoPE frequency scaling factor (default: %g)\n", params.rope_freq_scale);
  495. fprintf(stderr, " --ignore-eos ignore end of stream token and continue generating (implies --logit-bias 2-inf)\n");
  496. fprintf(stderr, " --no-penalize-nl do not penalize newline token\n");
  497. fprintf(stderr, " --memory-f32 use f32 instead of f16 for memory key+value (default: disabled)\n");
  498. fprintf(stderr, " not recommended: doubles context memory required and no measurable increase in quality\n");
  499. fprintf(stderr, " --temp N temperature (default: %.1f)\n", (double)params.temp);
  500. fprintf(stderr, " -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
  501. fprintf(stderr, " --perplexity compute perplexity over each ctx window of the prompt\n");
  502. fprintf(stderr, " --perplexity-lines compute perplexity over each line of the prompt\n");
  503. fprintf(stderr, " --keep number of tokens to keep from the initial prompt (default: %d, -1 = all)\n", params.n_keep);
  504. fprintf(stderr, " --chunks N max number of chunks to process (default: %d, -1 = all)\n", params.n_chunks);
  505. if (llama_mlock_supported()) {
  506. fprintf(stderr, " --mlock force system to keep model in RAM rather than swapping or compressing\n");
  507. }
  508. if (llama_mmap_supported()) {
  509. fprintf(stderr, " --no-mmap do not memory-map model (slower load but may reduce pageouts if not using mlock)\n");
  510. }
  511. fprintf(stderr, " --numa attempt optimizations that help on some NUMA systems\n");
  512. fprintf(stderr, " if run without this previously, it is recommended to drop the system page cache before using this\n");
  513. fprintf(stderr, " see https://github.com/ggerganov/llama.cpp/issues/1437\n");
  514. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  515. fprintf(stderr, " -ngl N, --n-gpu-layers N\n");
  516. fprintf(stderr, " number of layers to store in VRAM\n");
  517. fprintf(stderr, " -ts SPLIT --tensor-split SPLIT\n");
  518. fprintf(stderr, " how to split tensors across multiple GPUs, comma-separated list of proportions, e.g. 3,1\n");
  519. fprintf(stderr, " -mg i, --main-gpu i the GPU to use for scratch and small tensors\n" );
  520. fprintf(stderr, " -lv, --low-vram don't allocate VRAM scratch buffer\n" );
  521. #endif
  522. fprintf(stderr, " --mtest compute maximum memory usage\n");
  523. fprintf(stderr, " --export export the computation graph to 'llama.ggml'\n");
  524. fprintf(stderr, " --verbose-prompt print prompt before generation\n");
  525. fprintf(stderr, " --lora FNAME apply LoRA adapter (implies --no-mmap)\n");
  526. fprintf(stderr, " --lora-base FNAME optional model to use as a base for the layers modified by the LoRA adapter\n");
  527. fprintf(stderr, " -m FNAME, --model FNAME\n");
  528. fprintf(stderr, " model path (default: %s)\n", params.model.c_str());
  529. fprintf(stderr, "\n");
  530. }
  531. std::string gpt_random_prompt(std::mt19937 & rng) {
  532. const int r = rng() % 10;
  533. switch (r) {
  534. case 0: return "So";
  535. case 1: return "Once upon a time";
  536. case 2: return "When";
  537. case 3: return "The";
  538. case 4: return "After";
  539. case 5: return "If";
  540. case 6: return "import";
  541. case 7: return "He";
  542. case 8: return "She";
  543. case 9: return "They";
  544. default: return "To";
  545. }
  546. return "The";
  547. }
  548. // TODO: not great allocating this every time
  549. std::vector<llama_token> llama_tokenize(struct llama_context * ctx, const std::string & text, bool add_bos) {
  550. // initialize to prompt numer of chars, since n_tokens <= n_prompt_chars
  551. std::vector<llama_token> res(text.size() + (int) add_bos);
  552. const int n = llama_tokenize(ctx, text.c_str(), res.data(), res.size(), add_bos);
  553. assert(n >= 0);
  554. res.resize(n);
  555. return res;
  556. }
  557. struct llama_context_params llama_context_params_from_gpt_params(const gpt_params & params) {
  558. auto lparams = llama_context_default_params();
  559. lparams.n_ctx = params.n_ctx;
  560. lparams.n_batch = params.n_batch;
  561. lparams.n_gpu_layers = params.n_gpu_layers;
  562. lparams.main_gpu = params.main_gpu;
  563. lparams.tensor_split = params.tensor_split;
  564. lparams.low_vram = params.low_vram;
  565. lparams.seed = params.seed;
  566. lparams.f16_kv = params.memory_f16;
  567. lparams.use_mmap = params.use_mmap;
  568. lparams.use_mlock = params.use_mlock;
  569. lparams.logits_all = params.perplexity;
  570. lparams.embedding = params.embedding;
  571. lparams.rope_freq_base = params.rope_freq_base;
  572. lparams.rope_freq_scale = params.rope_freq_scale;
  573. return lparams;
  574. }
  575. std::tuple<struct llama_model *, struct llama_context *> llama_init_from_gpt_params(const gpt_params & params) {
  576. auto lparams = llama_context_params_from_gpt_params(params);
  577. llama_model * model = llama_load_model_from_file(params.model.c_str(), lparams);
  578. if (model == NULL) {
  579. fprintf(stderr, "%s: error: failed to load model '%s'\n", __func__, params.model.c_str());
  580. return std::make_tuple(nullptr, nullptr);
  581. }
  582. llama_context * lctx = llama_new_context_with_model(model, lparams);
  583. if (lctx == NULL) {
  584. fprintf(stderr, "%s: error: failed to create context with model '%s'\n", __func__, params.model.c_str());
  585. llama_free_model(model);
  586. return std::make_tuple(nullptr, nullptr);
  587. }
  588. if (!params.lora_adapter.empty()) {
  589. int err = llama_model_apply_lora_from_file(model,
  590. params.lora_adapter.c_str(),
  591. params.lora_base.empty() ? NULL : params.lora_base.c_str(),
  592. params.n_threads);
  593. if (err != 0) {
  594. fprintf(stderr, "%s: error: failed to apply lora adapter\n", __func__);
  595. llama_free(lctx);
  596. llama_free_model(model);
  597. return std::make_tuple(nullptr, nullptr);
  598. }
  599. }
  600. return std::make_tuple(model, lctx);
  601. }
  602. void console_init(console_state & con_st) {
  603. #if defined(_WIN32)
  604. // Windows-specific console initialization
  605. DWORD dwMode = 0;
  606. con_st.hConsole = GetStdHandle(STD_OUTPUT_HANDLE);
  607. if (con_st.hConsole == INVALID_HANDLE_VALUE || !GetConsoleMode(con_st.hConsole, &dwMode)) {
  608. con_st.hConsole = GetStdHandle(STD_ERROR_HANDLE);
  609. if (con_st.hConsole != INVALID_HANDLE_VALUE && (!GetConsoleMode(con_st.hConsole, &dwMode))) {
  610. con_st.hConsole = NULL;
  611. }
  612. }
  613. if (con_st.hConsole) {
  614. // Enable ANSI colors on Windows 10+
  615. if (con_st.use_color && !(dwMode & ENABLE_VIRTUAL_TERMINAL_PROCESSING)) {
  616. SetConsoleMode(con_st.hConsole, dwMode | ENABLE_VIRTUAL_TERMINAL_PROCESSING);
  617. }
  618. // Set console output codepage to UTF8
  619. SetConsoleOutputCP(CP_UTF8);
  620. }
  621. HANDLE hConIn = GetStdHandle(STD_INPUT_HANDLE);
  622. if (hConIn != INVALID_HANDLE_VALUE && GetConsoleMode(hConIn, &dwMode)) {
  623. // Set console input codepage to UTF16
  624. _setmode(_fileno(stdin), _O_WTEXT);
  625. // Turn off ICANON (ENABLE_LINE_INPUT) and ECHO (ENABLE_ECHO_INPUT)
  626. dwMode &= ~(ENABLE_LINE_INPUT | ENABLE_ECHO_INPUT);
  627. SetConsoleMode(hConIn, dwMode);
  628. }
  629. #else
  630. // POSIX-specific console initialization
  631. struct termios new_termios;
  632. tcgetattr(STDIN_FILENO, &con_st.prev_state);
  633. new_termios = con_st.prev_state;
  634. new_termios.c_lflag &= ~(ICANON | ECHO);
  635. new_termios.c_cc[VMIN] = 1;
  636. new_termios.c_cc[VTIME] = 0;
  637. tcsetattr(STDIN_FILENO, TCSANOW, &new_termios);
  638. con_st.tty = fopen("/dev/tty", "w+");
  639. if (con_st.tty != nullptr) {
  640. con_st.out = con_st.tty;
  641. }
  642. setlocale(LC_ALL, "");
  643. #endif
  644. }
  645. void console_cleanup(console_state & con_st) {
  646. // Reset console color
  647. console_set_color(con_st, CONSOLE_COLOR_DEFAULT);
  648. #if !defined(_WIN32)
  649. if (con_st.tty != nullptr) {
  650. con_st.out = stdout;
  651. fclose(con_st.tty);
  652. con_st.tty = nullptr;
  653. }
  654. // Restore the terminal settings on POSIX systems
  655. tcsetattr(STDIN_FILENO, TCSANOW, &con_st.prev_state);
  656. #endif
  657. }
  658. /* Keep track of current color of output, and emit ANSI code if it changes. */
  659. void console_set_color(console_state & con_st, console_color_t color) {
  660. if (con_st.use_color && con_st.color != color) {
  661. fflush(stdout);
  662. switch(color) {
  663. case CONSOLE_COLOR_DEFAULT:
  664. fprintf(con_st.out, ANSI_COLOR_RESET);
  665. break;
  666. case CONSOLE_COLOR_PROMPT:
  667. fprintf(con_st.out, ANSI_COLOR_YELLOW);
  668. break;
  669. case CONSOLE_COLOR_USER_INPUT:
  670. fprintf(con_st.out, ANSI_BOLD ANSI_COLOR_GREEN);
  671. break;
  672. case CONSOLE_COLOR_ERROR:
  673. fprintf(con_st.out, ANSI_BOLD ANSI_COLOR_RED);
  674. break;
  675. }
  676. con_st.color = color;
  677. fflush(con_st.out);
  678. }
  679. }
  680. char32_t getchar32() {
  681. #if defined(_WIN32)
  682. HANDLE hConsole = GetStdHandle(STD_INPUT_HANDLE);
  683. wchar_t high_surrogate = 0;
  684. while (true) {
  685. INPUT_RECORD record;
  686. DWORD count;
  687. if (!ReadConsoleInputW(hConsole, &record, 1, &count) || count == 0) {
  688. return WEOF;
  689. }
  690. if (record.EventType == KEY_EVENT && record.Event.KeyEvent.bKeyDown) {
  691. wchar_t wc = record.Event.KeyEvent.uChar.UnicodeChar;
  692. if (wc == 0) {
  693. continue;
  694. }
  695. if ((wc >= 0xD800) && (wc <= 0xDBFF)) { // Check if wc is a high surrogate
  696. high_surrogate = wc;
  697. continue;
  698. } else if ((wc >= 0xDC00) && (wc <= 0xDFFF)) { // Check if wc is a low surrogate
  699. if (high_surrogate != 0) { // Check if we have a high surrogate
  700. return ((high_surrogate - 0xD800) << 10) + (wc - 0xDC00) + 0x10000;
  701. }
  702. }
  703. high_surrogate = 0; // Reset the high surrogate
  704. return static_cast<char32_t>(wc);
  705. }
  706. }
  707. #else
  708. wchar_t wc = getwchar();
  709. if (static_cast<wint_t>(wc) == WEOF) {
  710. return WEOF;
  711. }
  712. #if WCHAR_MAX == 0xFFFF
  713. if ((wc >= 0xD800) && (wc <= 0xDBFF)) { // Check if wc is a high surrogate
  714. wchar_t low_surrogate = getwchar();
  715. if ((low_surrogate >= 0xDC00) && (low_surrogate <= 0xDFFF)) { // Check if the next wchar is a low surrogate
  716. return (static_cast<char32_t>(wc & 0x03FF) << 10) + (low_surrogate & 0x03FF) + 0x10000;
  717. }
  718. }
  719. if ((wc >= 0xD800) && (wc <= 0xDFFF)) { // Invalid surrogate pair
  720. return 0xFFFD; // Return the replacement character U+FFFD
  721. }
  722. #endif
  723. return static_cast<char32_t>(wc);
  724. #endif
  725. }
  726. void pop_cursor(console_state & con_st) {
  727. #if defined(_WIN32)
  728. if (con_st.hConsole != NULL) {
  729. CONSOLE_SCREEN_BUFFER_INFO bufferInfo;
  730. GetConsoleScreenBufferInfo(con_st.hConsole, &bufferInfo);
  731. COORD newCursorPosition = bufferInfo.dwCursorPosition;
  732. if (newCursorPosition.X == 0) {
  733. newCursorPosition.X = bufferInfo.dwSize.X - 1;
  734. newCursorPosition.Y -= 1;
  735. } else {
  736. newCursorPosition.X -= 1;
  737. }
  738. SetConsoleCursorPosition(con_st.hConsole, newCursorPosition);
  739. return;
  740. }
  741. #endif
  742. putc('\b', con_st.out);
  743. }
  744. int estimateWidth(char32_t codepoint) {
  745. #if defined(_WIN32)
  746. return 1;
  747. #else
  748. return wcwidth(codepoint);
  749. #endif
  750. }
  751. int put_codepoint(console_state & con_st, const char* utf8_codepoint, size_t length, int expectedWidth) {
  752. #if defined(_WIN32)
  753. CONSOLE_SCREEN_BUFFER_INFO bufferInfo;
  754. if (!GetConsoleScreenBufferInfo(con_st.hConsole, &bufferInfo)) {
  755. // go with the default
  756. return expectedWidth;
  757. }
  758. COORD initialPosition = bufferInfo.dwCursorPosition;
  759. DWORD nNumberOfChars = length;
  760. WriteConsole(con_st.hConsole, utf8_codepoint, nNumberOfChars, &nNumberOfChars, NULL);
  761. CONSOLE_SCREEN_BUFFER_INFO newBufferInfo;
  762. GetConsoleScreenBufferInfo(con_st.hConsole, &newBufferInfo);
  763. // Figure out our real position if we're in the last column
  764. if (utf8_codepoint[0] != 0x09 && initialPosition.X == newBufferInfo.dwSize.X - 1) {
  765. DWORD nNumberOfChars;
  766. WriteConsole(con_st.hConsole, &" \b", 2, &nNumberOfChars, NULL);
  767. GetConsoleScreenBufferInfo(con_st.hConsole, &newBufferInfo);
  768. }
  769. int width = newBufferInfo.dwCursorPosition.X - initialPosition.X;
  770. if (width < 0) {
  771. width += newBufferInfo.dwSize.X;
  772. }
  773. return width;
  774. #else
  775. // we can trust expectedWidth if we've got one
  776. if (expectedWidth >= 0 || con_st.tty == nullptr) {
  777. fwrite(utf8_codepoint, length, 1, con_st.out);
  778. return expectedWidth;
  779. }
  780. fputs("\033[6n", con_st.tty); // Query cursor position
  781. int x1, x2, y1, y2;
  782. int results = 0;
  783. results = fscanf(con_st.tty, "\033[%d;%dR", &y1, &x1);
  784. fwrite(utf8_codepoint, length, 1, con_st.tty);
  785. fputs("\033[6n", con_st.tty); // Query cursor position
  786. results += fscanf(con_st.tty, "\033[%d;%dR", &y2, &x2);
  787. if (results != 4) {
  788. return expectedWidth;
  789. }
  790. int width = x2 - x1;
  791. if (width < 0) {
  792. // Calculate the width considering text wrapping
  793. struct winsize w;
  794. ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
  795. width += w.ws_col;
  796. }
  797. return width;
  798. #endif
  799. }
  800. void replace_last(console_state & con_st, char ch) {
  801. #if defined(_WIN32)
  802. pop_cursor(con_st);
  803. put_codepoint(con_st, &ch, 1, 1);
  804. #else
  805. fprintf(con_st.out, "\b%c", ch);
  806. #endif
  807. }
  808. void append_utf8(char32_t ch, std::string & out) {
  809. if (ch <= 0x7F) {
  810. out.push_back(static_cast<unsigned char>(ch));
  811. } else if (ch <= 0x7FF) {
  812. out.push_back(static_cast<unsigned char>(0xC0 | ((ch >> 6) & 0x1F)));
  813. out.push_back(static_cast<unsigned char>(0x80 | (ch & 0x3F)));
  814. } else if (ch <= 0xFFFF) {
  815. out.push_back(static_cast<unsigned char>(0xE0 | ((ch >> 12) & 0x0F)));
  816. out.push_back(static_cast<unsigned char>(0x80 | ((ch >> 6) & 0x3F)));
  817. out.push_back(static_cast<unsigned char>(0x80 | (ch & 0x3F)));
  818. } else if (ch <= 0x10FFFF) {
  819. out.push_back(static_cast<unsigned char>(0xF0 | ((ch >> 18) & 0x07)));
  820. out.push_back(static_cast<unsigned char>(0x80 | ((ch >> 12) & 0x3F)));
  821. out.push_back(static_cast<unsigned char>(0x80 | ((ch >> 6) & 0x3F)));
  822. out.push_back(static_cast<unsigned char>(0x80 | (ch & 0x3F)));
  823. } else {
  824. // Invalid Unicode code point
  825. }
  826. }
  827. // Helper function to remove the last UTF-8 character from a string
  828. void pop_back_utf8_char(std::string & line) {
  829. if (line.empty()) {
  830. return;
  831. }
  832. size_t pos = line.length() - 1;
  833. // Find the start of the last UTF-8 character (checking up to 4 bytes back)
  834. for (size_t i = 0; i < 3 && pos > 0; ++i, --pos) {
  835. if ((line[pos] & 0xC0) != 0x80) break; // Found the start of the character
  836. }
  837. line.erase(pos);
  838. }
  839. bool console_readline(console_state & con_st, std::string & line) {
  840. console_set_color(con_st, CONSOLE_COLOR_USER_INPUT);
  841. if (con_st.out != stdout) {
  842. fflush(stdout);
  843. }
  844. line.clear();
  845. std::vector<int> widths;
  846. bool is_special_char = false;
  847. bool end_of_stream = false;
  848. char32_t input_char;
  849. while (true) {
  850. fflush(con_st.out); // Ensure all output is displayed before waiting for input
  851. input_char = getchar32();
  852. if (input_char == '\r' || input_char == '\n') {
  853. break;
  854. }
  855. if (input_char == (char32_t) WEOF || input_char == 0x04 /* Ctrl+D*/) {
  856. end_of_stream = true;
  857. break;
  858. }
  859. if (is_special_char) {
  860. console_set_color(con_st, CONSOLE_COLOR_USER_INPUT);
  861. replace_last(con_st, line.back());
  862. is_special_char = false;
  863. }
  864. if (input_char == '\033') { // Escape sequence
  865. char32_t code = getchar32();
  866. if (code == '[' || code == 0x1B) {
  867. // Discard the rest of the escape sequence
  868. while ((code = getchar32()) != (char32_t) WEOF) {
  869. if ((code >= 'A' && code <= 'Z') || (code >= 'a' && code <= 'z') || code == '~') {
  870. break;
  871. }
  872. }
  873. }
  874. } else if (input_char == 0x08 || input_char == 0x7F) { // Backspace
  875. if (!widths.empty()) {
  876. int count;
  877. do {
  878. count = widths.back();
  879. widths.pop_back();
  880. // Move cursor back, print space, and move cursor back again
  881. for (int i = 0; i < count; i++) {
  882. replace_last(con_st, ' ');
  883. pop_cursor(con_st);
  884. }
  885. pop_back_utf8_char(line);
  886. } while (count == 0 && !widths.empty());
  887. }
  888. } else {
  889. int offset = line.length();
  890. append_utf8(input_char, line);
  891. int width = put_codepoint(con_st, line.c_str() + offset, line.length() - offset, estimateWidth(input_char));
  892. if (width < 0) {
  893. width = 0;
  894. }
  895. widths.push_back(width);
  896. }
  897. if (!line.empty() && (line.back() == '\\' || line.back() == '/')) {
  898. console_set_color(con_st, CONSOLE_COLOR_PROMPT);
  899. replace_last(con_st, line.back());
  900. is_special_char = true;
  901. }
  902. }
  903. bool has_more = con_st.multiline_input;
  904. if (is_special_char) {
  905. replace_last(con_st, ' ');
  906. pop_cursor(con_st);
  907. char last = line.back();
  908. line.pop_back();
  909. if (last == '\\') {
  910. line += '\n';
  911. fputc('\n', con_st.out);
  912. has_more = !has_more;
  913. } else {
  914. // llama will just eat the single space, it won't act as a space
  915. if (line.length() == 1 && line.back() == ' ') {
  916. line.clear();
  917. pop_cursor(con_st);
  918. }
  919. has_more = false;
  920. }
  921. } else {
  922. if (end_of_stream) {
  923. has_more = false;
  924. } else {
  925. line += '\n';
  926. fputc('\n', con_st.out);
  927. }
  928. }
  929. fflush(con_st.out);
  930. return has_more;
  931. }