common.cpp 36 KB

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