common.cpp 58 KB

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