common.cpp 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270
  1. #include "common.h"
  2. #include "build-info.h"
  3. #include "llama.h"
  4. #include <algorithm>
  5. #include <cassert>
  6. #include <cmath>
  7. #include <cstring>
  8. #include <ctime>
  9. #include <fstream>
  10. #include <iterator>
  11. #include <iostream>
  12. #include <regex>
  13. #include <sstream>
  14. #include <string>
  15. #include <unordered_set>
  16. #include <vector>
  17. #include <cinttypes>
  18. #if defined(__APPLE__) && defined(__MACH__)
  19. #include <sys/types.h>
  20. #include <sys/sysctl.h>
  21. #endif
  22. #if defined(_WIN32)
  23. #define WIN32_LEAN_AND_MEAN
  24. #ifndef NOMINMAX
  25. # define NOMINMAX
  26. #endif
  27. #include <codecvt>
  28. #include <locale>
  29. #include <windows.h>
  30. #include <fcntl.h>
  31. #include <io.h>
  32. #else
  33. #include <sys/ioctl.h>
  34. #include <sys/stat.h>
  35. #include <unistd.h>
  36. #endif
  37. #if defined(_MSC_VER)
  38. #pragma warning(disable: 4244 4267) // possible loss of data
  39. #endif
  40. int32_t get_num_physical_cores() {
  41. #ifdef __linux__
  42. // enumerate the set of thread siblings, num entries is num cores
  43. std::unordered_set<std::string> siblings;
  44. for (uint32_t cpu=0; cpu < UINT32_MAX; ++cpu) {
  45. std::ifstream thread_siblings("/sys/devices/system/cpu"
  46. + std::to_string(cpu) + "/topology/thread_siblings");
  47. if (!thread_siblings.is_open()) {
  48. break; // no more cpus
  49. }
  50. std::string line;
  51. if (std::getline(thread_siblings, line)) {
  52. siblings.insert(line);
  53. }
  54. }
  55. if (!siblings.empty()) {
  56. return static_cast<int32_t>(siblings.size());
  57. }
  58. #elif defined(__APPLE__) && defined(__MACH__)
  59. int32_t num_physical_cores;
  60. size_t len = sizeof(num_physical_cores);
  61. int result = sysctlbyname("hw.perflevel0.physicalcpu", &num_physical_cores, &len, NULL, 0);
  62. if (result == 0) {
  63. return num_physical_cores;
  64. }
  65. result = sysctlbyname("hw.physicalcpu", &num_physical_cores, &len, NULL, 0);
  66. if (result == 0) {
  67. return num_physical_cores;
  68. }
  69. #elif defined(_WIN32)
  70. //TODO: Implement
  71. #endif
  72. unsigned int n_threads = std::thread::hardware_concurrency();
  73. return n_threads > 0 ? (n_threads <= 4 ? n_threads : n_threads / 2) : 4;
  74. }
  75. static void process_escapes(std::string& input) {
  76. std::size_t input_len = input.length();
  77. std::size_t output_idx = 0;
  78. for (std::size_t input_idx = 0; input_idx < input_len; ++input_idx) {
  79. if (input[input_idx] == '\\' && input_idx + 1 < input_len) {
  80. switch (input[++input_idx]) {
  81. case 'n': input[output_idx++] = '\n'; break;
  82. case 'r': input[output_idx++] = '\r'; break;
  83. case 't': input[output_idx++] = '\t'; break;
  84. case '\'': input[output_idx++] = '\''; break;
  85. case '\"': input[output_idx++] = '\"'; break;
  86. case '\\': input[output_idx++] = '\\'; break;
  87. default: input[output_idx++] = '\\';
  88. input[output_idx++] = input[input_idx]; break;
  89. }
  90. } else {
  91. input[output_idx++] = input[input_idx];
  92. }
  93. }
  94. input.resize(output_idx);
  95. }
  96. bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
  97. bool invalid_param = false;
  98. std::string arg;
  99. gpt_params default_params;
  100. const std::string arg_prefix = "--";
  101. for (int i = 1; i < argc; i++) {
  102. arg = argv[i];
  103. if (arg.compare(0, arg_prefix.size(), arg_prefix) == 0) {
  104. std::replace(arg.begin(), arg.end(), '_', '-');
  105. }
  106. if (arg == "-s" || arg == "--seed") {
  107. if (++i >= argc) {
  108. invalid_param = true;
  109. break;
  110. }
  111. params.seed = std::stoul(argv[i]);
  112. } else if (arg == "-t" || arg == "--threads") {
  113. if (++i >= argc) {
  114. invalid_param = true;
  115. break;
  116. }
  117. params.n_threads = std::stoi(argv[i]);
  118. if (params.n_threads <= 0) {
  119. params.n_threads = std::thread::hardware_concurrency();
  120. }
  121. } else if (arg == "-p" || arg == "--prompt") {
  122. if (++i >= argc) {
  123. invalid_param = true;
  124. break;
  125. }
  126. params.prompt = argv[i];
  127. } else if (arg == "-e" || arg == "--escape") {
  128. params.escape = true;
  129. } else if (arg == "--prompt-cache") {
  130. if (++i >= argc) {
  131. invalid_param = true;
  132. break;
  133. }
  134. params.path_prompt_cache = argv[i];
  135. } else if (arg == "--prompt-cache-all") {
  136. params.prompt_cache_all = true;
  137. } else if (arg == "--prompt-cache-ro") {
  138. params.prompt_cache_ro = true;
  139. } else if (arg == "-f" || arg == "--file") {
  140. if (++i >= argc) {
  141. invalid_param = true;
  142. break;
  143. }
  144. std::ifstream file(argv[i]);
  145. if (!file) {
  146. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  147. invalid_param = true;
  148. break;
  149. }
  150. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(params.prompt));
  151. if (params.prompt.back() == '\n') {
  152. params.prompt.pop_back();
  153. }
  154. } else if (arg == "-n" || arg == "--n-predict") {
  155. if (++i >= argc) {
  156. invalid_param = true;
  157. break;
  158. }
  159. params.n_predict = std::stoi(argv[i]);
  160. } else if (arg == "--top-k") {
  161. if (++i >= argc) {
  162. invalid_param = true;
  163. break;
  164. }
  165. params.top_k = std::stoi(argv[i]);
  166. } else if (arg == "-c" || arg == "--ctx-size") {
  167. if (++i >= argc) {
  168. invalid_param = true;
  169. break;
  170. }
  171. params.n_ctx = std::stoi(argv[i]);
  172. } else if (arg == "--rope-freq-base") {
  173. if (++i >= argc) {
  174. invalid_param = true;
  175. break;
  176. }
  177. params.rope_freq_base = std::stof(argv[i]);
  178. } else if (arg == "--rope-freq-scale") {
  179. if (++i >= argc) {
  180. invalid_param = true;
  181. break;
  182. }
  183. params.rope_freq_scale = std::stof(argv[i]);
  184. } else if (arg == "--rope-scale") {
  185. if (++i >= argc) {
  186. invalid_param = true;
  187. break;
  188. }
  189. params.rope_freq_scale = 1.0f/std::stof(argv[i]);
  190. } else if (arg == "--memory-f32") {
  191. params.memory_f16 = false;
  192. } else if (arg == "--top-p") {
  193. if (++i >= argc) {
  194. invalid_param = true;
  195. break;
  196. }
  197. params.top_p = std::stof(argv[i]);
  198. } else if (arg == "--temp") {
  199. if (++i >= argc) {
  200. invalid_param = true;
  201. break;
  202. }
  203. params.temp = std::stof(argv[i]);
  204. } else if (arg == "--tfs") {
  205. if (++i >= argc) {
  206. invalid_param = true;
  207. break;
  208. }
  209. params.tfs_z = std::stof(argv[i]);
  210. } else if (arg == "--typical") {
  211. if (++i >= argc) {
  212. invalid_param = true;
  213. break;
  214. }
  215. params.typical_p = std::stof(argv[i]);
  216. } else if (arg == "--repeat-last-n") {
  217. if (++i >= argc) {
  218. invalid_param = true;
  219. break;
  220. }
  221. params.repeat_last_n = std::stoi(argv[i]);
  222. } else if (arg == "--repeat-penalty") {
  223. if (++i >= argc) {
  224. invalid_param = true;
  225. break;
  226. }
  227. params.repeat_penalty = std::stof(argv[i]);
  228. } else if (arg == "--frequency-penalty") {
  229. if (++i >= argc) {
  230. invalid_param = true;
  231. break;
  232. }
  233. params.frequency_penalty = std::stof(argv[i]);
  234. } else if (arg == "--presence-penalty") {
  235. if (++i >= argc) {
  236. invalid_param = true;
  237. break;
  238. }
  239. params.presence_penalty = std::stof(argv[i]);
  240. } else if (arg == "--mirostat") {
  241. if (++i >= argc) {
  242. invalid_param = true;
  243. break;
  244. }
  245. params.mirostat = std::stoi(argv[i]);
  246. } else if (arg == "--mirostat-lr") {
  247. if (++i >= argc) {
  248. invalid_param = true;
  249. break;
  250. }
  251. params.mirostat_eta = std::stof(argv[i]);
  252. } else if (arg == "--mirostat-ent") {
  253. if (++i >= argc) {
  254. invalid_param = true;
  255. break;
  256. }
  257. params.mirostat_tau = std::stof(argv[i]);
  258. } else if (arg == "--cfg-negative-prompt") {
  259. if (++i >= argc) {
  260. invalid_param = true;
  261. break;
  262. }
  263. params.cfg_negative_prompt = argv[i];
  264. } else if (arg == "--cfg-negative-prompt-file") {
  265. if (++i >= argc) {
  266. invalid_param = true;
  267. break;
  268. }
  269. std::ifstream file(argv[i]);
  270. if (!file) {
  271. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  272. invalid_param = true;
  273. break;
  274. }
  275. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(params.cfg_negative_prompt));
  276. if (params.cfg_negative_prompt.back() == '\n') {
  277. params.cfg_negative_prompt.pop_back();
  278. }
  279. } else if (arg == "--cfg-scale") {
  280. if (++i >= argc) {
  281. invalid_param = true;
  282. break;
  283. }
  284. params.cfg_scale = std::stof(argv[i]);
  285. } else if (arg == "-b" || arg == "--batch-size") {
  286. if (++i >= argc) {
  287. invalid_param = true;
  288. break;
  289. }
  290. params.n_batch = std::stoi(argv[i]);
  291. } else if (arg == "--keep") {
  292. if (++i >= argc) {
  293. invalid_param = true;
  294. break;
  295. }
  296. params.n_keep = std::stoi(argv[i]);
  297. } else if (arg == "--draft") {
  298. if (++i >= argc) {
  299. invalid_param = true;
  300. break;
  301. }
  302. params.n_draft = std::stoi(argv[i]);
  303. } else if (arg == "--chunks") {
  304. if (++i >= argc) {
  305. invalid_param = true;
  306. break;
  307. }
  308. params.n_chunks = std::stoi(argv[i]);
  309. } else if (arg == "-m" || arg == "--model") {
  310. if (++i >= argc) {
  311. invalid_param = true;
  312. break;
  313. }
  314. params.model = argv[i];
  315. } else if (arg == "-md" || arg == "--model-draft") {
  316. if (++i >= argc) {
  317. invalid_param = true;
  318. break;
  319. }
  320. params.model_draft = argv[i];
  321. } else if (arg == "-a" || arg == "--alias") {
  322. if (++i >= argc) {
  323. invalid_param = true;
  324. break;
  325. }
  326. params.model_alias = argv[i];
  327. } else if (arg == "--lora") {
  328. if (++i >= argc) {
  329. invalid_param = true;
  330. break;
  331. }
  332. params.lora_adapter = argv[i];
  333. params.use_mmap = false;
  334. } else if (arg == "--lora-base") {
  335. if (++i >= argc) {
  336. invalid_param = true;
  337. break;
  338. }
  339. params.lora_base = argv[i];
  340. } else if (arg == "-i" || arg == "--interactive") {
  341. params.interactive = true;
  342. } else if (arg == "--embedding") {
  343. params.embedding = true;
  344. } else if (arg == "--interactive-first") {
  345. params.interactive_first = true;
  346. } else if (arg == "-ins" || arg == "--instruct") {
  347. params.instruct = true;
  348. } else if (arg == "--multiline-input") {
  349. params.multiline_input = true;
  350. } else if (arg == "--simple-io") {
  351. params.simple_io = true;
  352. } else if (arg == "--color") {
  353. params.use_color = true;
  354. } else if (arg == "--mlock") {
  355. params.use_mlock = true;
  356. } else if (arg == "--gpu-layers" || arg == "-ngl" || arg == "--n-gpu-layers") {
  357. if (++i >= argc) {
  358. invalid_param = true;
  359. break;
  360. }
  361. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  362. params.n_gpu_layers = std::stoi(argv[i]);
  363. #else
  364. fprintf(stderr, "warning: not compiled with GPU offload support, --n-gpu-layers option will be ignored\n");
  365. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  366. #endif
  367. } else if (arg == "--gpu-layers-draft" || arg == "-ngld" || arg == "--n-gpu-layers-draft") {
  368. if (++i >= argc) {
  369. invalid_param = true;
  370. break;
  371. }
  372. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  373. params.n_gpu_layers_draft = std::stoi(argv[i]);
  374. #else
  375. fprintf(stderr, "warning: not compiled with GPU offload support, --n-gpu-layers-draft option will be ignored\n");
  376. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  377. #endif
  378. } else if (arg == "--main-gpu" || arg == "-mg") {
  379. if (++i >= argc) {
  380. invalid_param = true;
  381. break;
  382. }
  383. #ifdef GGML_USE_CUBLAS
  384. params.main_gpu = std::stoi(argv[i]);
  385. #else
  386. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set a main GPU.\n");
  387. #endif
  388. } else if (arg == "--tensor-split" || arg == "-ts") {
  389. if (++i >= argc) {
  390. invalid_param = true;
  391. break;
  392. }
  393. #ifdef GGML_USE_CUBLAS
  394. std::string arg_next = argv[i];
  395. // split string by , and /
  396. const std::regex regex{R"([,/]+)"};
  397. std::sregex_token_iterator it{arg_next.begin(), arg_next.end(), regex, -1};
  398. std::vector<std::string> split_arg{it, {}};
  399. GGML_ASSERT(split_arg.size() <= LLAMA_MAX_DEVICES);
  400. for (size_t i = 0; i < LLAMA_MAX_DEVICES; ++i) {
  401. if (i < split_arg.size()) {
  402. params.tensor_split[i] = std::stof(split_arg[i]);
  403. } else {
  404. params.tensor_split[i] = 0.0f;
  405. }
  406. }
  407. #else
  408. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set a tensor split.\n");
  409. #endif // GGML_USE_CUBLAS
  410. } else if (arg == "--no-mul-mat-q" || arg == "-nommq") {
  411. #ifdef GGML_USE_CUBLAS
  412. params.mul_mat_q = false;
  413. #else
  414. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. Disabling mul_mat_q kernels has no effect.\n");
  415. #endif // GGML_USE_CUBLAS
  416. } else if (arg == "--low-vram" || arg == "-lv") {
  417. #ifdef GGML_USE_CUBLAS
  418. params.low_vram = true;
  419. #else
  420. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS. It is not possible to set lower vram usage.\n");
  421. #endif // GGML_USE_CUBLAS
  422. } else if (arg == "--no-mmap") {
  423. params.use_mmap = false;
  424. } else if (arg == "--numa") {
  425. params.numa = true;
  426. } else if (arg == "--export") {
  427. params.export_cgraph = true;
  428. } else if (arg == "--verbose-prompt") {
  429. params.verbose_prompt = true;
  430. } else if (arg == "-r" || arg == "--reverse-prompt") {
  431. if (++i >= argc) {
  432. invalid_param = true;
  433. break;
  434. }
  435. params.antiprompt.push_back(argv[i]);
  436. } else if (arg == "-ld" || arg == "--logdir") {
  437. if (++i >= argc) {
  438. invalid_param = true;
  439. break;
  440. }
  441. params.logdir = argv[i];
  442. if (params.logdir.back() != DIRECTORY_SEPARATOR) {
  443. params.logdir += DIRECTORY_SEPARATOR;
  444. }
  445. } else if (arg == "--perplexity") {
  446. params.perplexity = true;
  447. } else if (arg == "--ppl-stride") {
  448. if (++i >= argc) {
  449. invalid_param = true;
  450. break;
  451. }
  452. params.ppl_stride = std::stoi(argv[i]);
  453. } else if (arg == "--ppl-output-type") {
  454. if (++i >= argc) {
  455. invalid_param = true;
  456. break;
  457. }
  458. params.ppl_output_type = std::stoi(argv[i]);
  459. } else if (arg == "--hellaswag") {
  460. params.hellaswag = true;
  461. } else if (arg == "--hellaswag-tasks") {
  462. if (++i >= argc) {
  463. invalid_param = true;
  464. break;
  465. }
  466. params.hellaswag_tasks = std::stoi(argv[i]);
  467. } else if (arg == "--ignore-eos") {
  468. params.ignore_eos = true;
  469. } else if (arg == "--no-penalize-nl") {
  470. params.penalize_nl = false;
  471. } else if (arg == "-l" || arg == "--logit-bias") {
  472. if (++i >= argc) {
  473. invalid_param = true;
  474. break;
  475. }
  476. std::stringstream ss(argv[i]);
  477. llama_token key;
  478. char sign;
  479. std::string value_str;
  480. try {
  481. if (ss >> key && ss >> sign && std::getline(ss, value_str) && (sign == '+' || sign == '-')) {
  482. params.logit_bias[key] = std::stof(value_str) * ((sign == '-') ? -1.0f : 1.0f);
  483. } else {
  484. throw std::exception();
  485. }
  486. } catch (const std::exception&) {
  487. invalid_param = true;
  488. break;
  489. }
  490. } else if (arg == "-h" || arg == "--help") {
  491. gpt_print_usage(argc, argv, default_params);
  492. #ifndef LOG_DISABLE_LOGS
  493. log_print_usage();
  494. #endif // LOG_DISABLE_LOGS
  495. exit(0);
  496. } else if (arg == "--random-prompt") {
  497. params.random_prompt = true;
  498. } else if (arg == "--in-prefix-bos") {
  499. params.input_prefix_bos = true;
  500. } else if (arg == "--in-prefix") {
  501. if (++i >= argc) {
  502. invalid_param = true;
  503. break;
  504. }
  505. params.input_prefix = argv[i];
  506. } else if (arg == "--in-suffix") {
  507. if (++i >= argc) {
  508. invalid_param = true;
  509. break;
  510. }
  511. params.input_suffix = argv[i];
  512. } else if (arg == "--grammar") {
  513. if (++i >= argc) {
  514. invalid_param = true;
  515. break;
  516. }
  517. params.grammar = argv[i];
  518. } else if (arg == "--grammar-file") {
  519. if (++i >= argc) {
  520. invalid_param = true;
  521. break;
  522. }
  523. std::ifstream file(argv[i]);
  524. if (!file) {
  525. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  526. invalid_param = true;
  527. break;
  528. }
  529. std::copy(
  530. std::istreambuf_iterator<char>(file),
  531. std::istreambuf_iterator<char>(),
  532. std::back_inserter(params.grammar)
  533. );
  534. #ifndef LOG_DISABLE_LOGS
  535. // Parse args for logging parameters
  536. } else if ( log_param_single_parse( argv[i] ) ) {
  537. // Do nothing, log_param_single_parse automatically does it's thing
  538. // and returns if a match was found and parsed.
  539. } else if ( log_param_pair_parse( /*check_but_dont_parse*/ true, argv[i] ) ) {
  540. // We have a matching known parameter requiring an argument,
  541. // now we need to check if there is anything after this argv
  542. // and flag invalid_param or parse it.
  543. if (++i >= argc) {
  544. invalid_param = true;
  545. break;
  546. }
  547. if( !log_param_pair_parse( /*check_but_dont_parse*/ false, argv[i-1], argv[i]) ) {
  548. invalid_param = true;
  549. break;
  550. }
  551. // End of Parse args for logging parameters
  552. #endif // LOG_DISABLE_LOGS
  553. } else {
  554. fprintf(stderr, "error: unknown argument: %s\n", arg.c_str());
  555. gpt_print_usage(argc, argv, default_params);
  556. exit(1);
  557. }
  558. }
  559. if (invalid_param) {
  560. fprintf(stderr, "error: invalid parameter for argument: %s\n", arg.c_str());
  561. gpt_print_usage(argc, argv, default_params);
  562. exit(1);
  563. }
  564. if (params.prompt_cache_all &&
  565. (params.interactive || params.interactive_first ||
  566. params.instruct)) {
  567. fprintf(stderr, "error: --prompt-cache-all not supported in interactive mode yet\n");
  568. gpt_print_usage(argc, argv, default_params);
  569. exit(1);
  570. }
  571. if (params.escape) {
  572. process_escapes(params.prompt);
  573. process_escapes(params.input_prefix);
  574. process_escapes(params.input_suffix);
  575. }
  576. return true;
  577. }
  578. void gpt_print_usage(int /*argc*/, char ** argv, const gpt_params & params) {
  579. printf("usage: %s [options]\n", argv[0]);
  580. printf("\n");
  581. printf("options:\n");
  582. printf(" -h, --help show this help message and exit\n");
  583. printf(" -i, --interactive run in interactive mode\n");
  584. printf(" --interactive-first run in interactive mode and wait for input right away\n");
  585. printf(" -ins, --instruct run in instruction mode (use with Alpaca models)\n");
  586. printf(" --multiline-input allows you to write or paste multiple lines without ending each in '\\'\n");
  587. printf(" -r PROMPT, --reverse-prompt PROMPT\n");
  588. printf(" halt generation at PROMPT, return control in interactive mode\n");
  589. printf(" (can be specified more than once for multiple prompts).\n");
  590. printf(" --color colorise output to distinguish prompt and user input from generations\n");
  591. printf(" -s SEED, --seed SEED RNG seed (default: -1, use random seed for < 0)\n");
  592. printf(" -t N, --threads N number of threads to use during computation (default: %d)\n", params.n_threads);
  593. printf(" -p PROMPT, --prompt PROMPT\n");
  594. printf(" prompt to start generation with (default: empty)\n");
  595. printf(" -e, --escape process prompt escapes sequences (\\n, \\r, \\t, \\', \\\", \\\\)\n");
  596. printf(" --prompt-cache FNAME file to cache prompt state for faster startup (default: none)\n");
  597. printf(" --prompt-cache-all if specified, saves user input and generations to cache as well.\n");
  598. printf(" not supported with --interactive or other interactive options\n");
  599. printf(" --prompt-cache-ro if specified, uses the prompt cache but does not update it.\n");
  600. printf(" --random-prompt start with a randomized prompt.\n");
  601. printf(" --in-prefix-bos prefix BOS to user inputs, preceding the `--in-prefix` string\n");
  602. printf(" --in-prefix STRING string to prefix user inputs with (default: empty)\n");
  603. printf(" --in-suffix STRING string to suffix after user inputs with (default: empty)\n");
  604. printf(" -f FNAME, --file FNAME\n");
  605. printf(" prompt file to start generation.\n");
  606. printf(" -n N, --n-predict N number of tokens to predict (default: %d, -1 = infinity, -2 = until context filled)\n", params.n_predict);
  607. printf(" -c N, --ctx-size N size of the prompt context (default: %d)\n", params.n_ctx);
  608. printf(" -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
  609. printf(" --top-k N top-k sampling (default: %d, 0 = disabled)\n", params.top_k);
  610. printf(" --top-p N top-p sampling (default: %.1f, 1.0 = disabled)\n", (double)params.top_p);
  611. printf(" --tfs N tail free sampling, parameter z (default: %.1f, 1.0 = disabled)\n", (double)params.tfs_z);
  612. printf(" --typical N locally typical sampling, parameter p (default: %.1f, 1.0 = disabled)\n", (double)params.typical_p);
  613. printf(" --repeat-last-n N last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)\n", params.repeat_last_n);
  614. printf(" --repeat-penalty N penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)\n", (double)params.repeat_penalty);
  615. printf(" --presence-penalty N repeat alpha presence penalty (default: %.1f, 0.0 = disabled)\n", (double)params.presence_penalty);
  616. printf(" --frequency-penalty N repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)\n", (double)params.frequency_penalty);
  617. printf(" --mirostat N use Mirostat sampling.\n");
  618. printf(" Top K, Nucleus, Tail Free and Locally Typical samplers are ignored if used.\n");
  619. printf(" (default: %d, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)\n", params.mirostat);
  620. printf(" --mirostat-lr N Mirostat learning rate, parameter eta (default: %.1f)\n", (double)params.mirostat_eta);
  621. printf(" --mirostat-ent N Mirostat target entropy, parameter tau (default: %.1f)\n", (double)params.mirostat_tau);
  622. printf(" -l TOKEN_ID(+/-)BIAS, --logit-bias TOKEN_ID(+/-)BIAS\n");
  623. printf(" modifies the likelihood of token appearing in the completion,\n");
  624. printf(" i.e. `--logit-bias 15043+1` to increase likelihood of token ' Hello',\n");
  625. printf(" or `--logit-bias 15043-1` to decrease likelihood of token ' Hello'\n");
  626. printf(" --grammar GRAMMAR BNF-like grammar to constrain generations (see samples in grammars/ dir)\n");
  627. printf(" --grammar-file FNAME file to read grammar from\n");
  628. printf(" --cfg-negative-prompt PROMPT\n");
  629. printf(" negative prompt to use for guidance. (default: empty)\n");
  630. printf(" --cfg-negative-prompt-file FNAME\n");
  631. printf(" negative prompt file to use for guidance. (default: empty)\n");
  632. printf(" --cfg-scale N strength of guidance (default: %f, 1.0 = disable)\n", params.cfg_scale);
  633. printf(" --rope-scale N RoPE context linear scaling factor, inverse of --rope-freq-scale\n");
  634. printf(" --rope-freq-base N RoPE base frequency, used by NTK-aware scaling (default: loaded from model)\n");
  635. printf(" --rope-freq-scale N RoPE frequency linear scaling factor (default: loaded from model)\n");
  636. printf(" --ignore-eos ignore end of stream token and continue generating (implies --logit-bias 2-inf)\n");
  637. printf(" --no-penalize-nl do not penalize newline token\n");
  638. printf(" --memory-f32 use f32 instead of f16 for memory key+value (default: disabled)\n");
  639. printf(" not recommended: doubles context memory required and no measurable increase in quality\n");
  640. printf(" --temp N temperature (default: %.1f)\n", (double)params.temp);
  641. printf(" --perplexity compute perplexity over each ctx window of the prompt\n");
  642. printf(" --hellaswag compute HellaSwag score over random tasks from datafile supplied with -f\n");
  643. printf(" --hellaswag-tasks N number of tasks to use when computing the HellaSwag score (default: %zu)\n", params.hellaswag_tasks);
  644. printf(" --keep N number of tokens to keep from the initial prompt (default: %d, -1 = all)\n", params.n_keep);
  645. printf(" --draft N number of tokens to draft for speculative decoding (default: %d)\n", params.n_draft);
  646. printf(" --chunks N max number of chunks to process (default: %d, -1 = all)\n", params.n_chunks);
  647. if (llama_mlock_supported()) {
  648. printf(" --mlock force system to keep model in RAM rather than swapping or compressing\n");
  649. }
  650. if (llama_mmap_supported()) {
  651. printf(" --no-mmap do not memory-map model (slower load but may reduce pageouts if not using mlock)\n");
  652. }
  653. printf(" --numa attempt optimizations that help on some NUMA systems\n");
  654. printf(" if run without this previously, it is recommended to drop the system page cache before using this\n");
  655. printf(" see https://github.com/ggerganov/llama.cpp/issues/1437\n");
  656. #ifdef LLAMA_SUPPORTS_GPU_OFFLOAD
  657. printf(" -ngl N, --n-gpu-layers N\n");
  658. printf(" number of layers to store in VRAM\n");
  659. printf(" -ngld N, --n-gpu-layers-draft N\n");
  660. printf(" number of layers to store in VRAM for the draft model\n");
  661. printf(" -ts SPLIT --tensor-split SPLIT\n");
  662. printf(" how to split tensors across multiple GPUs, comma-separated list of proportions, e.g. 3,1\n");
  663. printf(" -mg i, --main-gpu i the GPU to use for scratch and small tensors\n");
  664. printf(" -lv, --low-vram don't allocate VRAM scratch buffer\n");
  665. #ifdef GGML_USE_CUBLAS
  666. printf(" -nommq, --no-mul-mat-q\n");
  667. printf(" use " GGML_CUBLAS_NAME " instead of custom mul_mat_q " GGML_CUDA_NAME " kernels.\n");
  668. printf(" Not recommended since this is both slower and uses more VRAM.\n");
  669. #endif // GGML_USE_CUBLAS
  670. #endif
  671. printf(" --export export the computation graph to 'llama.ggml'\n");
  672. printf(" --verbose-prompt print prompt before generation\n");
  673. fprintf(stderr, " --simple-io use basic IO for better compatibility in subprocesses and limited consoles\n");
  674. printf(" --lora FNAME apply LoRA adapter (implies --no-mmap)\n");
  675. printf(" --lora-base FNAME optional model to use as a base for the layers modified by the LoRA adapter\n");
  676. printf(" -m FNAME, --model FNAME\n");
  677. printf(" model path (default: %s)\n", params.model.c_str());
  678. printf(" -md FNAME, --model-draft FNAME\n");
  679. printf(" draft model for speculative decoding (default: %s)\n", params.model.c_str());
  680. printf(" -ld LOGDIR, --logdir LOGDIR\n");
  681. printf(" path under which to save YAML logs (no logging if unset)\n");
  682. printf("\n");
  683. }
  684. std::string gpt_random_prompt(std::mt19937 & rng) {
  685. const int r = rng() % 10;
  686. switch (r) {
  687. case 0: return "So";
  688. case 1: return "Once upon a time";
  689. case 2: return "When";
  690. case 3: return "The";
  691. case 4: return "After";
  692. case 5: return "If";
  693. case 6: return "import";
  694. case 7: return "He";
  695. case 8: return "She";
  696. case 9: return "They";
  697. default: return "To";
  698. }
  699. return "The";
  700. }
  701. //
  702. // Model utils
  703. //
  704. struct llama_context_params llama_context_params_from_gpt_params(const gpt_params & params) {
  705. auto lparams = llama_context_default_params();
  706. lparams.n_ctx = params.n_ctx;
  707. lparams.n_batch = params.n_batch;
  708. if (params.n_gpu_layers != -1) {
  709. lparams.n_gpu_layers = params.n_gpu_layers;
  710. }
  711. lparams.main_gpu = params.main_gpu;
  712. lparams.tensor_split = params.tensor_split;
  713. lparams.low_vram = params.low_vram;
  714. lparams.mul_mat_q = params.mul_mat_q;
  715. lparams.seed = params.seed;
  716. lparams.f16_kv = params.memory_f16;
  717. lparams.use_mmap = params.use_mmap;
  718. lparams.use_mlock = params.use_mlock;
  719. lparams.logits_all = params.perplexity;
  720. lparams.embedding = params.embedding;
  721. lparams.rope_freq_base = params.rope_freq_base;
  722. lparams.rope_freq_scale = params.rope_freq_scale;
  723. return lparams;
  724. }
  725. std::tuple<struct llama_model *, struct llama_context *> llama_init_from_gpt_params(gpt_params & params) {
  726. auto lparams = llama_context_params_from_gpt_params(params);
  727. llama_model * model = llama_load_model_from_file(params.model.c_str(), lparams);
  728. if (model == NULL) {
  729. fprintf(stderr, "%s: error: failed to load model '%s'\n", __func__, params.model.c_str());
  730. return std::make_tuple(nullptr, nullptr);
  731. }
  732. llama_context * lctx = llama_new_context_with_model(model, lparams);
  733. if (lctx == NULL) {
  734. fprintf(stderr, "%s: error: failed to create context with model '%s'\n", __func__, params.model.c_str());
  735. llama_free_model(model);
  736. return std::make_tuple(nullptr, nullptr);
  737. }
  738. if (!params.lora_adapter.empty()) {
  739. int err = llama_model_apply_lora_from_file(model,
  740. params.lora_adapter.c_str(),
  741. params.lora_base.empty() ? NULL : params.lora_base.c_str(),
  742. params.n_threads);
  743. if (err != 0) {
  744. fprintf(stderr, "%s: error: failed to apply lora adapter\n", __func__);
  745. llama_free(lctx);
  746. llama_free_model(model);
  747. return std::make_tuple(nullptr, nullptr);
  748. }
  749. }
  750. if (params.ignore_eos) {
  751. params.logit_bias[llama_token_eos(lctx)] = -INFINITY;
  752. }
  753. {
  754. LOG("warming up the model with an empty run\n");
  755. const std::vector<llama_token> tmp = { llama_token_bos(lctx), llama_token_eos(lctx), };
  756. llama_eval(lctx, tmp.data(), std::min(tmp.size(), (size_t) params.n_batch), 0, params.n_threads);
  757. llama_reset_timings(lctx);
  758. }
  759. return std::make_tuple(model, lctx);
  760. }
  761. //
  762. // Vocab utils
  763. //
  764. std::vector<llama_token> llama_tokenize(
  765. struct llama_context * ctx,
  766. const std::string & text,
  767. bool add_bos) {
  768. // upper limit for the number of tokens
  769. int n_tokens = text.length() + add_bos;
  770. std::vector<llama_token> result(n_tokens);
  771. n_tokens = llama_tokenize(ctx, text.data(), text.length(), result.data(), result.size(), add_bos);
  772. if (n_tokens < 0) {
  773. result.resize(-n_tokens);
  774. int check = llama_tokenize(ctx, text.data(), text.length(), result.data(), result.size(), add_bos);
  775. GGML_ASSERT(check == -n_tokens);
  776. } else {
  777. result.resize(n_tokens);
  778. }
  779. return result;
  780. }
  781. std::string llama_token_to_piece(const struct llama_context * ctx, llama_token token) {
  782. std::vector<char> result(8, 0);
  783. const int n_tokens = llama_token_to_piece(ctx, token, result.data(), result.size());
  784. if (n_tokens < 0) {
  785. result.resize(-n_tokens);
  786. int check = llama_token_to_piece(ctx, token, result.data(), result.size());
  787. GGML_ASSERT(check == -n_tokens);
  788. } else {
  789. result.resize(n_tokens);
  790. }
  791. return std::string(result.data(), result.size());
  792. }
  793. std::string llama_detokenize_spm(llama_context * ctx, const std::vector<llama_token> & tokens) {
  794. const llama_token bos_id = llama_token_bos(ctx);
  795. std::string piece;
  796. std::string result;
  797. for (size_t i = 0; i < tokens.size(); ++i) {
  798. piece = llama_token_to_piece(ctx, tokens[i]);
  799. // remove the leading space of the first non-BOS token
  800. if (((tokens[0] == bos_id && i == 1) || (tokens[0] != bos_id && i == 0)) && piece[0] == ' ') {
  801. piece = piece.substr(1);
  802. }
  803. result += piece;
  804. }
  805. return result;
  806. }
  807. std::string llama_detokenize_bpe(llama_context * ctx, const std::vector<llama_token> & tokens) {
  808. std::string piece;
  809. std::string result;
  810. for (size_t i = 0; i < tokens.size(); ++i) {
  811. piece = llama_token_to_piece(ctx, tokens[i]);
  812. result += piece;
  813. }
  814. return result;
  815. }
  816. //
  817. // Sampling utils
  818. //
  819. llama_token llama_sample_token(
  820. struct llama_context * ctx,
  821. struct llama_context * ctx_guidance,
  822. struct llama_grammar * grammar,
  823. const struct gpt_params & params,
  824. const std::vector<llama_token> & last_tokens,
  825. std::vector<llama_token_data> & candidates,
  826. int idx) {
  827. const int n_ctx = llama_n_ctx(ctx);
  828. const int n_vocab = llama_n_vocab(ctx);
  829. const float temp = params.temp;
  830. const int32_t top_k = params.top_k <= 0 ? n_vocab : params.top_k;
  831. const float top_p = params.top_p;
  832. const float tfs_z = params.tfs_z;
  833. const float typical_p = params.typical_p;
  834. const int32_t repeat_last_n = params.repeat_last_n < 0 ? n_ctx : params.repeat_last_n;
  835. const float repeat_penalty = params.repeat_penalty;
  836. const float alpha_presence = params.presence_penalty;
  837. const float alpha_frequency = params.frequency_penalty;
  838. const int mirostat = params.mirostat;
  839. const float mirostat_tau = params.mirostat_tau;
  840. const float mirostat_eta = params.mirostat_eta;
  841. const bool penalize_nl = params.penalize_nl;
  842. llama_token id = 0;
  843. float * logits = llama_get_logits(ctx) + idx * n_vocab;
  844. // Apply params.logit_bias map
  845. for (auto it = params.logit_bias.begin(); it != params.logit_bias.end(); it++) {
  846. logits[it->first] += it->second;
  847. }
  848. candidates.clear();
  849. for (llama_token token_id = 0; token_id < n_vocab; token_id++) {
  850. candidates.emplace_back(llama_token_data{token_id, logits[token_id], 0.0f});
  851. }
  852. llama_token_data_array cur_p = { candidates.data(), candidates.size(), false };
  853. if (ctx_guidance) {
  854. llama_sample_classifier_free_guidance(ctx, &cur_p, ctx_guidance, params.cfg_scale);
  855. }
  856. // apply penalties
  857. if (!last_tokens.empty()) {
  858. const float nl_logit = logits[llama_token_nl(ctx)];
  859. const int last_n_repeat = std::min(std::min((int)last_tokens.size(), repeat_last_n), n_ctx);
  860. llama_sample_repetition_penalty(ctx, &cur_p,
  861. last_tokens.data() + last_tokens.size() - last_n_repeat,
  862. last_n_repeat, repeat_penalty);
  863. llama_sample_frequency_and_presence_penalties(ctx, &cur_p,
  864. last_tokens.data() + last_tokens.size() - last_n_repeat,
  865. last_n_repeat, alpha_frequency, alpha_presence);
  866. if (!penalize_nl) {
  867. for (size_t idx = 0; idx < cur_p.size; idx++) {
  868. if (cur_p.data[idx].id == llama_token_nl(ctx)) {
  869. cur_p.data[idx].logit = nl_logit;
  870. break;
  871. }
  872. }
  873. }
  874. }
  875. if (grammar != NULL) {
  876. llama_sample_grammar(ctx, &cur_p, grammar);
  877. }
  878. if (temp <= 0) {
  879. // Greedy sampling
  880. id = llama_sample_token_greedy(ctx, &cur_p);
  881. } else {
  882. if (mirostat == 1) {
  883. static float mirostat_mu = 2.0f * mirostat_tau;
  884. const int mirostat_m = 100;
  885. llama_sample_temperature(ctx, &cur_p, temp);
  886. id = llama_sample_token_mirostat(ctx, &cur_p, mirostat_tau, mirostat_eta, mirostat_m, &mirostat_mu);
  887. } else if (mirostat == 2) {
  888. static float mirostat_mu = 2.0f * mirostat_tau;
  889. llama_sample_temperature(ctx, &cur_p, temp);
  890. id = llama_sample_token_mirostat_v2(ctx, &cur_p, mirostat_tau, mirostat_eta, &mirostat_mu);
  891. } else {
  892. // Temperature sampling
  893. llama_sample_top_k (ctx, &cur_p, top_k, 1);
  894. llama_sample_tail_free (ctx, &cur_p, tfs_z, 1);
  895. llama_sample_typical (ctx, &cur_p, typical_p, 1);
  896. llama_sample_top_p (ctx, &cur_p, top_p, 1);
  897. llama_sample_temperature(ctx, &cur_p, temp);
  898. {
  899. const int n_top = 10;
  900. LOG("top %d candidates:\n", n_top);
  901. for (int i = 0; i < n_top; i++) {
  902. const llama_token id = cur_p.data[i].id;
  903. LOG(" - %5d: '%12s' (%.3f)\n", id, llama_token_to_piece(ctx, id).c_str(), cur_p.data[i].p);
  904. }
  905. }
  906. id = llama_sample_token(ctx, &cur_p);
  907. LOG("sampled token: %5d: '%s'\n", id, llama_token_to_piece(ctx, id).c_str());
  908. }
  909. }
  910. // printf("`%d`", candidates_p.size);
  911. if (grammar != NULL) {
  912. llama_grammar_accept_token(ctx, grammar, id);
  913. }
  914. return id;
  915. }
  916. //
  917. // YAML utils
  918. //
  919. // returns true if successful, false otherwise
  920. bool create_directory_with_parents(const std::string & path) {
  921. #ifdef _WIN32
  922. std::wstring_convert<std::codecvt_utf8<wchar_t>> converter;
  923. std::wstring wpath = converter.from_bytes(path);
  924. // if the path already exists, check whether it's a directory
  925. const DWORD attributes = GetFileAttributesW(wpath.c_str());
  926. if ((attributes != INVALID_FILE_ATTRIBUTES) && (attributes & FILE_ATTRIBUTE_DIRECTORY)) {
  927. return true;
  928. }
  929. size_t pos_slash = 0;
  930. // process path from front to back, procedurally creating directories
  931. while ((pos_slash = path.find('\\', pos_slash)) != std::string::npos) {
  932. const std::wstring subpath = wpath.substr(0, pos_slash);
  933. const wchar_t * test = subpath.c_str();
  934. const bool success = CreateDirectoryW(test, NULL);
  935. if (!success) {
  936. const DWORD error = GetLastError();
  937. // if the path already exists, ensure that it's a directory
  938. if (error == ERROR_ALREADY_EXISTS) {
  939. const DWORD attributes = GetFileAttributesW(subpath.c_str());
  940. if (attributes == INVALID_FILE_ATTRIBUTES || !(attributes & FILE_ATTRIBUTE_DIRECTORY)) {
  941. return false;
  942. }
  943. } else {
  944. return false;
  945. }
  946. }
  947. pos_slash += 1;
  948. }
  949. return true;
  950. #else
  951. // if the path already exists, check whether it's a directory
  952. struct stat info;
  953. if (stat(path.c_str(), &info) == 0) {
  954. return S_ISDIR(info.st_mode);
  955. }
  956. size_t pos_slash = 1; // skip leading slashes for directory creation
  957. // process path from front to back, procedurally creating directories
  958. while ((pos_slash = path.find('/', pos_slash)) != std::string::npos) {
  959. const std::string subpath = path.substr(0, pos_slash);
  960. struct stat info;
  961. // if the path already exists, ensure that it's a directory
  962. if (stat(subpath.c_str(), &info) == 0) {
  963. if (!S_ISDIR(info.st_mode)) {
  964. return false;
  965. }
  966. } else {
  967. // create parent directories
  968. const int ret = mkdir(subpath.c_str(), 0755);
  969. if (ret != 0) {
  970. return false;
  971. }
  972. }
  973. pos_slash += 1;
  974. }
  975. return true;
  976. #endif // _WIN32
  977. }
  978. void dump_vector_float_yaml(FILE * stream, const char * prop_name, const std::vector<float> & data) {
  979. if (data.empty()) {
  980. fprintf(stream, "%s:\n", prop_name);
  981. return;
  982. }
  983. fprintf(stream, "%s: [", prop_name);
  984. for (size_t i = 0; i < data.size() - 1; ++i) {
  985. fprintf(stream, "%e, ", data[i]);
  986. }
  987. fprintf(stream, "%e]\n", data.back());
  988. }
  989. void dump_vector_int_yaml(FILE * stream, const char * prop_name, const std::vector<int> & data) {
  990. if (data.empty()) {
  991. fprintf(stream, "%s:\n", prop_name);
  992. return;
  993. }
  994. fprintf(stream, "%s: [", prop_name);
  995. for (size_t i = 0; i < data.size() - 1; ++i) {
  996. fprintf(stream, "%d, ", data[i]);
  997. }
  998. fprintf(stream, "%d]\n", data.back());
  999. }
  1000. void dump_string_yaml_multiline(FILE * stream, const char * prop_name, const char * data) {
  1001. std::string data_str(data == NULL ? "" : data);
  1002. if (data_str.empty()) {
  1003. fprintf(stream, "%s:\n", prop_name);
  1004. return;
  1005. }
  1006. size_t pos_start = 0;
  1007. size_t pos_found = 0;
  1008. if (!data_str.empty() && (std::isspace(data_str[0]) || std::isspace(data_str.back()))) {
  1009. data_str = std::regex_replace(data_str, std::regex("\n"), "\\n");
  1010. data_str = std::regex_replace(data_str, std::regex("\""), "\\\"");
  1011. data_str = "\"" + data_str + "\"";
  1012. fprintf(stream, "%s: %s\n", prop_name, data_str.c_str());
  1013. return;
  1014. }
  1015. if (data_str.find('\n') == std::string::npos) {
  1016. fprintf(stream, "%s: %s\n", prop_name, data_str.c_str());
  1017. return;
  1018. }
  1019. fprintf(stream, "%s: |\n", prop_name);
  1020. while ((pos_found = data_str.find('\n', pos_start)) != std::string::npos) {
  1021. fprintf(stream, " %s\n", data_str.substr(pos_start, pos_found-pos_start).c_str());
  1022. pos_start = pos_found + 1;
  1023. }
  1024. }
  1025. std::string get_sortable_timestamp() {
  1026. using clock = std::chrono::system_clock;
  1027. const clock::time_point current_time = clock::now();
  1028. const time_t as_time_t = clock::to_time_t(current_time);
  1029. char timestamp_no_ns[100];
  1030. std::strftime(timestamp_no_ns, 100, "%Y_%m_%d-%H_%M_%S", std::localtime(&as_time_t));
  1031. const int64_t ns = std::chrono::duration_cast<std::chrono::nanoseconds>(
  1032. current_time.time_since_epoch() % 1000000000).count();
  1033. char timestamp_ns[11];
  1034. snprintf(timestamp_ns, 11, "%09" PRId64, ns);
  1035. return std::string(timestamp_no_ns) + "." + std::string(timestamp_ns);
  1036. }
  1037. void dump_non_result_info_yaml(FILE * stream, const gpt_params & params, const llama_context * lctx,
  1038. const std::string & timestamp, const std::vector<int> & prompt_tokens, const char * model_desc) {
  1039. fprintf(stream, "build_commit: %s\n", BUILD_COMMIT);
  1040. fprintf(stream, "build_number: %d\n", BUILD_NUMBER);
  1041. fprintf(stream, "cpu_has_arm_fma: %s\n", ggml_cpu_has_arm_fma() ? "true" : "false");
  1042. fprintf(stream, "cpu_has_avx: %s\n", ggml_cpu_has_avx() ? "true" : "false");
  1043. fprintf(stream, "cpu_has_avx2: %s\n", ggml_cpu_has_avx2() ? "true" : "false");
  1044. fprintf(stream, "cpu_has_avx512: %s\n", ggml_cpu_has_avx512() ? "true" : "false");
  1045. fprintf(stream, "cpu_has_avx512_vbmi: %s\n", ggml_cpu_has_avx512_vbmi() ? "true" : "false");
  1046. fprintf(stream, "cpu_has_avx512_vnni: %s\n", ggml_cpu_has_avx512_vnni() ? "true" : "false");
  1047. fprintf(stream, "cpu_has_blas: %s\n", ggml_cpu_has_blas() ? "true" : "false");
  1048. fprintf(stream, "cpu_has_cublas: %s\n", ggml_cpu_has_cublas() ? "true" : "false");
  1049. fprintf(stream, "cpu_has_clblast: %s\n", ggml_cpu_has_clblast() ? "true" : "false");
  1050. fprintf(stream, "cpu_has_fma: %s\n", ggml_cpu_has_fma() ? "true" : "false");
  1051. fprintf(stream, "cpu_has_gpublas: %s\n", ggml_cpu_has_gpublas() ? "true" : "false");
  1052. fprintf(stream, "cpu_has_neon: %s\n", ggml_cpu_has_neon() ? "true" : "false");
  1053. fprintf(stream, "cpu_has_f16c: %s\n", ggml_cpu_has_f16c() ? "true" : "false");
  1054. fprintf(stream, "cpu_has_fp16_va: %s\n", ggml_cpu_has_fp16_va() ? "true" : "false");
  1055. fprintf(stream, "cpu_has_wasm_simd: %s\n", ggml_cpu_has_wasm_simd() ? "true" : "false");
  1056. fprintf(stream, "cpu_has_blas: %s\n", ggml_cpu_has_blas() ? "true" : "false");
  1057. fprintf(stream, "cpu_has_sse3: %s\n", ggml_cpu_has_sse3() ? "true" : "false");
  1058. fprintf(stream, "cpu_has_vsx: %s\n", ggml_cpu_has_vsx() ? "true" : "false");
  1059. #ifdef NDEBUG
  1060. fprintf(stream, "debug: false\n");
  1061. #else
  1062. fprintf(stream, "debug: true\n");
  1063. #endif // NDEBUG
  1064. fprintf(stream, "model_desc: %s\n", model_desc);
  1065. fprintf(stream, "n_vocab: %d # output size of the final layer, 32001 for some models\n", llama_n_vocab(lctx));
  1066. #ifdef __OPTIMIZE__
  1067. fprintf(stream, "optimize: true\n");
  1068. #else
  1069. fprintf(stream, "optimize: false\n");
  1070. #endif // __OPTIMIZE__
  1071. fprintf(stream, "time: %s\n", timestamp.c_str());
  1072. fprintf(stream, "\n");
  1073. fprintf(stream, "###############\n");
  1074. fprintf(stream, "# User Inputs #\n");
  1075. fprintf(stream, "###############\n");
  1076. fprintf(stream, "\n");
  1077. fprintf(stream, "alias: %s # default: unknown\n", params.model_alias.c_str());
  1078. fprintf(stream, "batch_size: %d # default: 512\n", params.n_batch);
  1079. dump_string_yaml_multiline(stream, "cfg_negative_prompt", params.cfg_negative_prompt.c_str());
  1080. fprintf(stream, "cfg_scale: %f # default: 1.0\n", params.cfg_scale);
  1081. fprintf(stream, "chunks: %d # default: -1 (unlimited)\n", params.n_chunks);
  1082. fprintf(stream, "color: %s # default: false\n", params.use_color ? "true" : "false");
  1083. fprintf(stream, "ctx_size: %d # default: 512\n", params.n_ctx);
  1084. fprintf(stream, "escape: %s # default: false\n", params.escape ? "true" : "false");
  1085. fprintf(stream, "export: %s # default: false\n", params.export_cgraph ? "true" : "false");
  1086. fprintf(stream, "file: # never logged, see prompt instead. Can still be specified for input.\n");
  1087. fprintf(stream, "frequency_penalty: %f # default: 0.0 \n", params.frequency_penalty);
  1088. dump_string_yaml_multiline(stream, "grammar", params.grammar.c_str());
  1089. fprintf(stream, "grammar-file: # never logged, see grammar instead. Can still be specified for input.\n");
  1090. fprintf(stream, "hellaswag: %s # default: false\n", params.hellaswag ? "true" : "false");
  1091. fprintf(stream, "hellaswag_tasks: %zu # default: 400\n", params.hellaswag_tasks);
  1092. const auto logit_bias_eos = params.logit_bias.find(llama_token_eos(lctx));
  1093. const bool ignore_eos = logit_bias_eos != params.logit_bias.end() && logit_bias_eos->second == -INFINITY;
  1094. fprintf(stream, "ignore_eos: %s # default: false\n", ignore_eos ? "true" : "false");
  1095. dump_string_yaml_multiline(stream, "in_prefix", params.input_prefix.c_str());
  1096. fprintf(stream, "in_prefix_bos: %s # default: false\n", params.input_prefix_bos ? "true" : "false");
  1097. dump_string_yaml_multiline(stream, "in_suffix", params.input_prefix.c_str());
  1098. fprintf(stream, "instruct: %s # default: false\n", params.instruct ? "true" : "false");
  1099. fprintf(stream, "interactive: %s # default: false\n", params.interactive ? "true" : "false");
  1100. fprintf(stream, "interactive_first: %s # default: false\n", params.interactive_first ? "true" : "false");
  1101. fprintf(stream, "keep: %d # default: 0\n", params.n_keep);
  1102. fprintf(stream, "logdir: %s # default: unset (no logging)\n", params.logdir.c_str());
  1103. fprintf(stream, "logit_bias:\n");
  1104. for (std::pair<llama_token, float> lb : params.logit_bias) {
  1105. if (ignore_eos && lb.first == logit_bias_eos->first) {
  1106. continue;
  1107. }
  1108. fprintf(stream, " %d: %f", lb.first, lb.second);
  1109. }
  1110. fprintf(stream, "lora: %s\n", params.lora_adapter.c_str());
  1111. fprintf(stream, "lora_base: %s\n", params.lora_base.c_str());
  1112. fprintf(stream, "low_vram: %s # default: false\n", params.low_vram ? "true" : "false");
  1113. fprintf(stream, "main_gpu: %d # default: 0\n", params.main_gpu);
  1114. fprintf(stream, "memory_f32: %s # default: false\n", !params.memory_f16 ? "true" : "false");
  1115. fprintf(stream, "mirostat: %d # default: 0 (disabled)\n", params.mirostat);
  1116. fprintf(stream, "mirostat_ent: %f # default: 5.0\n", params.mirostat_tau);
  1117. fprintf(stream, "mirostat_lr: %f # default: 0.1\n", params.mirostat_eta);
  1118. fprintf(stream, "mlock: %s # default: false\n", params.use_mlock ? "true" : "false");
  1119. fprintf(stream, "model: %s # default: models/7B/ggml-model.bin\n", params.model.c_str());
  1120. fprintf(stream, "model_draft: %s # default:\n", params.model_draft.c_str());
  1121. fprintf(stream, "multiline_input: %s # default: false\n", params.multiline_input ? "true" : "false");
  1122. fprintf(stream, "n_gpu_layers: %d # default: -1\n", params.n_gpu_layers);
  1123. fprintf(stream, "n_predict: %d # default: -1 (unlimited)\n", params.n_predict);
  1124. fprintf(stream, "n_probs: %d # only used by server binary, default: 0\n", params.n_probs);
  1125. fprintf(stream, "no_mmap: %s # default: false\n", !params.use_mmap ? "true" : "false");
  1126. fprintf(stream, "no_mul_mat_q: %s # default: false\n", !params.mul_mat_q ? "true" : "false");
  1127. fprintf(stream, "no_penalize_nl: %s # default: false\n", !params.penalize_nl ? "true" : "false");
  1128. fprintf(stream, "numa: %s # default: false\n", params.numa ? "true" : "false");
  1129. fprintf(stream, "ppl_output_type: %d # default: 0\n", params.ppl_output_type);
  1130. fprintf(stream, "ppl_stride: %d # default: 0\n", params.ppl_stride);
  1131. fprintf(stream, "presence_penalty: %f # default: 0.0\n", params.presence_penalty);
  1132. dump_string_yaml_multiline(stream, "prompt", params.prompt.c_str());
  1133. fprintf(stream, "prompt_cache: %s\n", params.path_prompt_cache.c_str());
  1134. fprintf(stream, "prompt_cache_all: %s # default: false\n", params.prompt_cache_all ? "true" : "false");
  1135. fprintf(stream, "prompt_cache_ro: %s # default: false\n", params.prompt_cache_ro ? "true" : "false");
  1136. dump_vector_int_yaml(stream, "prompt_tokens", prompt_tokens);
  1137. fprintf(stream, "random_prompt: %s # default: false\n", params.random_prompt ? "true" : "false");
  1138. fprintf(stream, "repeat_penalty: %f # default: 1.1\n", params.repeat_penalty);
  1139. fprintf(stream, "reverse_prompt:\n");
  1140. for (std::string ap : params.antiprompt) {
  1141. size_t pos = 0;
  1142. while ((pos = ap.find('\n', pos)) != std::string::npos) {
  1143. ap.replace(pos, 1, "\\n");
  1144. pos += 1;
  1145. }
  1146. fprintf(stream, " - %s\n", ap.c_str());
  1147. }
  1148. fprintf(stream, "rope_freq_base: %f # default: 10000.0\n", params.rope_freq_base);
  1149. fprintf(stream, "rope_freq_scale: %f # default: 1.0\n", params.rope_freq_scale);
  1150. fprintf(stream, "seed: %d # default: -1 (random seed)\n", params.seed);
  1151. fprintf(stream, "simple_io: %s # default: false\n", params.simple_io ? "true" : "false");
  1152. fprintf(stream, "temp: %f # default: 0.8\n", params.temp);
  1153. const std::vector<float> tensor_split_vector(params.tensor_split, params.tensor_split + LLAMA_MAX_DEVICES);
  1154. dump_vector_float_yaml(stream, "tensor_split", tensor_split_vector);
  1155. fprintf(stream, "tfs: %f # default: 1.0\n", params.tfs_z);
  1156. fprintf(stream, "threads: %d # default: %d\n", params.n_threads, std::thread::hardware_concurrency());
  1157. fprintf(stream, "top_k: %d # default: 40\n", params.top_k);
  1158. fprintf(stream, "top_p: %f # default: 0.95\n", params.top_p);
  1159. fprintf(stream, "typical_p: %f # default: 1.0\n", params.typical_p);
  1160. fprintf(stream, "verbose_prompt: %s # default: false\n", params.verbose_prompt ? "true" : "false");
  1161. }