common.cpp 54 KB

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