common.cpp 79 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853
  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_map>
  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. #if (defined(GGML_USE_CUBLAS) || defined(GGML_USE_SYCL))
  41. #define GGML_USE_CUBLAS_SYCL
  42. #endif
  43. #if (defined(GGML_USE_CUBLAS) || defined(GGML_USE_SYCL)) || defined(GGML_USE_VULKAN)
  44. #define GGML_USE_CUBLAS_SYCL_VULKAN
  45. #endif
  46. int32_t get_num_physical_cores() {
  47. #ifdef __linux__
  48. // enumerate the set of thread siblings, num entries is num cores
  49. std::unordered_set<std::string> siblings;
  50. for (uint32_t cpu=0; cpu < UINT32_MAX; ++cpu) {
  51. std::ifstream thread_siblings("/sys/devices/system/cpu"
  52. + std::to_string(cpu) + "/topology/thread_siblings");
  53. if (!thread_siblings.is_open()) {
  54. break; // no more cpus
  55. }
  56. std::string line;
  57. if (std::getline(thread_siblings, line)) {
  58. siblings.insert(line);
  59. }
  60. }
  61. if (!siblings.empty()) {
  62. return static_cast<int32_t>(siblings.size());
  63. }
  64. #elif defined(__APPLE__) && defined(__MACH__)
  65. int32_t num_physical_cores;
  66. size_t len = sizeof(num_physical_cores);
  67. int result = sysctlbyname("hw.perflevel0.physicalcpu", &num_physical_cores, &len, NULL, 0);
  68. if (result == 0) {
  69. return num_physical_cores;
  70. }
  71. result = sysctlbyname("hw.physicalcpu", &num_physical_cores, &len, NULL, 0);
  72. if (result == 0) {
  73. return num_physical_cores;
  74. }
  75. #elif defined(_WIN32)
  76. //TODO: Implement
  77. #endif
  78. unsigned int n_threads = std::thread::hardware_concurrency();
  79. return n_threads > 0 ? (n_threads <= 4 ? n_threads : n_threads / 2) : 4;
  80. }
  81. void process_escapes(std::string& input) {
  82. std::size_t input_len = input.length();
  83. std::size_t output_idx = 0;
  84. for (std::size_t input_idx = 0; input_idx < input_len; ++input_idx) {
  85. if (input[input_idx] == '\\' && input_idx + 1 < input_len) {
  86. switch (input[++input_idx]) {
  87. case 'n': input[output_idx++] = '\n'; break;
  88. case 'r': input[output_idx++] = '\r'; break;
  89. case 't': input[output_idx++] = '\t'; break;
  90. case '\'': input[output_idx++] = '\''; break;
  91. case '\"': input[output_idx++] = '\"'; break;
  92. case '\\': input[output_idx++] = '\\'; break;
  93. case 'x':
  94. // Handle \x12, etc
  95. if (input_idx + 2 < input_len) {
  96. const char x[3] = { input[input_idx + 1], input[input_idx + 2], 0 };
  97. char *err_p = nullptr;
  98. const long val = std::strtol(x, &err_p, 16);
  99. if (err_p == x + 2) {
  100. input_idx += 2;
  101. input[output_idx++] = char(val);
  102. break;
  103. }
  104. }
  105. // fall through
  106. default: input[output_idx++] = '\\';
  107. input[output_idx++] = input[input_idx]; break;
  108. }
  109. } else {
  110. input[output_idx++] = input[input_idx];
  111. }
  112. }
  113. input.resize(output_idx);
  114. }
  115. bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
  116. bool result = true;
  117. try {
  118. if (!gpt_params_parse_ex(argc, argv, params)) {
  119. gpt_print_usage(argc, argv, gpt_params());
  120. exit(0);
  121. }
  122. }
  123. catch (const std::invalid_argument & ex) {
  124. fprintf(stderr, "%s\n", ex.what());
  125. gpt_print_usage(argc, argv, gpt_params());
  126. exit(1);
  127. }
  128. return result;
  129. }
  130. bool gpt_params_parse_ex(int argc, char ** argv, gpt_params & params) {
  131. bool invalid_param = false;
  132. std::string arg;
  133. const std::string arg_prefix = "--";
  134. llama_sampling_params & sparams = params.sparams;
  135. for (int i = 1; i < argc; i++) {
  136. arg = argv[i];
  137. if (arg.compare(0, arg_prefix.size(), arg_prefix) == 0) {
  138. std::replace(arg.begin(), arg.end(), '_', '-');
  139. }
  140. if (arg == "-s" || arg == "--seed") {
  141. if (++i >= argc) {
  142. invalid_param = true;
  143. break;
  144. }
  145. params.seed = std::stoul(argv[i]);
  146. } else if (arg == "-t" || arg == "--threads") {
  147. if (++i >= argc) {
  148. invalid_param = true;
  149. break;
  150. }
  151. params.n_threads = std::stoi(argv[i]);
  152. if (params.n_threads <= 0) {
  153. params.n_threads = std::thread::hardware_concurrency();
  154. }
  155. } else if (arg == "-tb" || arg == "--threads-batch") {
  156. if (++i >= argc) {
  157. invalid_param = true;
  158. break;
  159. }
  160. params.n_threads_batch = std::stoi(argv[i]);
  161. if (params.n_threads_batch <= 0) {
  162. params.n_threads_batch = std::thread::hardware_concurrency();
  163. }
  164. } else if (arg == "-td" || arg == "--threads-draft") {
  165. if (++i >= argc) {
  166. invalid_param = true;
  167. break;
  168. }
  169. params.n_threads_draft = std::stoi(argv[i]);
  170. if (params.n_threads_draft <= 0) {
  171. params.n_threads_draft = std::thread::hardware_concurrency();
  172. }
  173. } else if (arg == "-tbd" || arg == "--threads-batch-draft") {
  174. if (++i >= argc) {
  175. invalid_param = true;
  176. break;
  177. }
  178. params.n_threads_batch_draft = std::stoi(argv[i]);
  179. if (params.n_threads_batch_draft <= 0) {
  180. params.n_threads_batch_draft = std::thread::hardware_concurrency();
  181. }
  182. } else if (arg == "-p" || arg == "--prompt") {
  183. if (++i >= argc) {
  184. invalid_param = true;
  185. break;
  186. }
  187. params.prompt = argv[i];
  188. } else if (arg == "-e" || arg == "--escape") {
  189. params.escape = true;
  190. } else if (arg == "--prompt-cache") {
  191. if (++i >= argc) {
  192. invalid_param = true;
  193. break;
  194. }
  195. params.path_prompt_cache = argv[i];
  196. } else if (arg == "--prompt-cache-all") {
  197. params.prompt_cache_all = true;
  198. } else if (arg == "--prompt-cache-ro") {
  199. params.prompt_cache_ro = true;
  200. } else if (arg == "-bf" || arg == "--binary-file") {
  201. if (++i >= argc) {
  202. invalid_param = true;
  203. break;
  204. }
  205. std::ifstream file(argv[i], std::ios::binary);
  206. if (!file) {
  207. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  208. invalid_param = true;
  209. break;
  210. }
  211. // store the external file name in params
  212. params.prompt_file = argv[i];
  213. std::ostringstream ss;
  214. ss << file.rdbuf();
  215. params.prompt = ss.str();
  216. fprintf(stderr, "Read %zu bytes from binary file %s\n", params.prompt.size(), argv[i]);
  217. } else if (arg == "-f" || arg == "--file") {
  218. if (++i >= argc) {
  219. invalid_param = true;
  220. break;
  221. }
  222. std::ifstream file(argv[i]);
  223. if (!file) {
  224. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  225. invalid_param = true;
  226. break;
  227. }
  228. // store the external file name in params
  229. params.prompt_file = argv[i];
  230. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(params.prompt));
  231. if (!params.prompt.empty() && params.prompt.back() == '\n') {
  232. params.prompt.pop_back();
  233. }
  234. } else if (arg == "-n" || arg == "--n-predict") {
  235. if (++i >= argc) {
  236. invalid_param = true;
  237. break;
  238. }
  239. params.n_predict = std::stoi(argv[i]);
  240. } else if (arg == "--top-k") {
  241. if (++i >= argc) {
  242. invalid_param = true;
  243. break;
  244. }
  245. sparams.top_k = std::stoi(argv[i]);
  246. } else if (arg == "-c" || arg == "--ctx-size") {
  247. if (++i >= argc) {
  248. invalid_param = true;
  249. break;
  250. }
  251. params.n_ctx = std::stoi(argv[i]);
  252. } else if (arg == "--grp-attn-n" || arg == "-gan") {
  253. if (++i >= argc) {
  254. invalid_param = true;
  255. break;
  256. }
  257. params.grp_attn_n = std::stoi(argv[i]);
  258. } else if (arg == "--grp-attn-w" || arg == "-gaw") {
  259. if (++i >= argc) {
  260. invalid_param = true;
  261. break;
  262. }
  263. params.grp_attn_w = std::stoi(argv[i]);
  264. } else if (arg == "--rope-freq-base") {
  265. if (++i >= argc) {
  266. invalid_param = true;
  267. break;
  268. }
  269. params.rope_freq_base = std::stof(argv[i]);
  270. } else if (arg == "--rope-freq-scale") {
  271. if (++i >= argc) {
  272. invalid_param = true;
  273. break;
  274. }
  275. params.rope_freq_scale = std::stof(argv[i]);
  276. } else if (arg == "--rope-scaling") {
  277. if (++i >= argc) {
  278. invalid_param = true;
  279. break;
  280. }
  281. std::string value(argv[i]);
  282. /**/ if (value == "none") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_NONE; }
  283. else if (value == "linear") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_LINEAR; }
  284. else if (value == "yarn") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_YARN; }
  285. else { invalid_param = true; break; }
  286. } else if (arg == "--rope-scale") {
  287. if (++i >= argc) {
  288. invalid_param = true;
  289. break;
  290. }
  291. params.rope_freq_scale = 1.0f/std::stof(argv[i]);
  292. } else if (arg == "--yarn-orig-ctx") {
  293. if (++i >= argc) {
  294. invalid_param = true;
  295. break;
  296. }
  297. params.yarn_orig_ctx = std::stoi(argv[i]);
  298. } else if (arg == "--yarn-ext-factor") {
  299. if (++i >= argc) {
  300. invalid_param = true;
  301. break;
  302. }
  303. params.yarn_ext_factor = std::stof(argv[i]);
  304. } else if (arg == "--yarn-attn-factor") {
  305. if (++i >= argc) {
  306. invalid_param = true;
  307. break;
  308. }
  309. params.yarn_attn_factor = std::stof(argv[i]);
  310. } else if (arg == "--yarn-beta-fast") {
  311. if (++i >= argc) {
  312. invalid_param = true;
  313. break;
  314. }
  315. params.yarn_beta_fast = std::stof(argv[i]);
  316. } else if (arg == "--yarn-beta-slow") {
  317. if (++i >= argc) {
  318. invalid_param = true;
  319. break;
  320. }
  321. params.yarn_beta_slow = std::stof(argv[i]);
  322. } else if (arg == "--pooling") {
  323. if (++i >= argc) {
  324. invalid_param = true;
  325. break;
  326. }
  327. std::string value(argv[i]);
  328. /**/ if (value == "none") { params.pooling_type = LLAMA_POOLING_TYPE_NONE; }
  329. else if (value == "mean") { params.pooling_type = LLAMA_POOLING_TYPE_MEAN; }
  330. else if (value == "cls") { params.pooling_type = LLAMA_POOLING_TYPE_CLS; }
  331. else { invalid_param = true; break; }
  332. } else if (arg == "--defrag-thold" || arg == "-dt") {
  333. if (++i >= argc) {
  334. invalid_param = true;
  335. break;
  336. }
  337. params.defrag_thold = std::stof(argv[i]);
  338. } else if (arg == "--samplers") {
  339. if (++i >= argc) {
  340. invalid_param = true;
  341. break;
  342. }
  343. const auto sampler_names = string_split(argv[i], ';');
  344. sparams.samplers_sequence = sampler_types_from_names(sampler_names, true);
  345. } else if (arg == "--sampling-seq") {
  346. if (++i >= argc) {
  347. invalid_param = true;
  348. break;
  349. }
  350. sparams.samplers_sequence = sampler_types_from_chars(argv[i]);
  351. } else if (arg == "--top-p") {
  352. if (++i >= argc) {
  353. invalid_param = true;
  354. break;
  355. }
  356. sparams.top_p = std::stof(argv[i]);
  357. } else if (arg == "--min-p") {
  358. if (++i >= argc) {
  359. invalid_param = true;
  360. break;
  361. }
  362. sparams.min_p = std::stof(argv[i]);
  363. } else if (arg == "--temp") {
  364. if (++i >= argc) {
  365. invalid_param = true;
  366. break;
  367. }
  368. sparams.temp = std::stof(argv[i]);
  369. sparams.temp = std::max(sparams.temp, 0.0f);
  370. } else if (arg == "--tfs") {
  371. if (++i >= argc) {
  372. invalid_param = true;
  373. break;
  374. }
  375. sparams.tfs_z = std::stof(argv[i]);
  376. } else if (arg == "--typical") {
  377. if (++i >= argc) {
  378. invalid_param = true;
  379. break;
  380. }
  381. sparams.typical_p = std::stof(argv[i]);
  382. } else if (arg == "--repeat-last-n") {
  383. if (++i >= argc) {
  384. invalid_param = true;
  385. break;
  386. }
  387. sparams.penalty_last_n = std::stoi(argv[i]);
  388. sparams.n_prev = std::max(sparams.n_prev, sparams.penalty_last_n);
  389. } else if (arg == "--repeat-penalty") {
  390. if (++i >= argc) {
  391. invalid_param = true;
  392. break;
  393. }
  394. sparams.penalty_repeat = std::stof(argv[i]);
  395. } else if (arg == "--frequency-penalty") {
  396. if (++i >= argc) {
  397. invalid_param = true;
  398. break;
  399. }
  400. sparams.penalty_freq = std::stof(argv[i]);
  401. } else if (arg == "--presence-penalty") {
  402. if (++i >= argc) {
  403. invalid_param = true;
  404. break;
  405. }
  406. sparams.penalty_present = std::stof(argv[i]);
  407. } else if (arg == "--dynatemp-range") {
  408. if (++i >= argc) {
  409. invalid_param = true;
  410. break;
  411. }
  412. sparams.dynatemp_range = std::stof(argv[i]);
  413. } else if (arg == "--dynatemp-exp") {
  414. if (++i >= argc) {
  415. invalid_param = true;
  416. break;
  417. }
  418. sparams.dynatemp_exponent = std::stof(argv[i]);
  419. } else if (arg == "--mirostat") {
  420. if (++i >= argc) {
  421. invalid_param = true;
  422. break;
  423. }
  424. sparams.mirostat = std::stoi(argv[i]);
  425. } else if (arg == "--mirostat-lr") {
  426. if (++i >= argc) {
  427. invalid_param = true;
  428. break;
  429. }
  430. sparams.mirostat_eta = std::stof(argv[i]);
  431. } else if (arg == "--mirostat-ent") {
  432. if (++i >= argc) {
  433. invalid_param = true;
  434. break;
  435. }
  436. sparams.mirostat_tau = std::stof(argv[i]);
  437. } else if (arg == "--cfg-negative-prompt") {
  438. if (++i >= argc) {
  439. invalid_param = true;
  440. break;
  441. }
  442. sparams.cfg_negative_prompt = argv[i];
  443. } else if (arg == "--cfg-negative-prompt-file") {
  444. if (++i >= argc) {
  445. invalid_param = true;
  446. break;
  447. }
  448. std::ifstream file(argv[i]);
  449. if (!file) {
  450. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  451. invalid_param = true;
  452. break;
  453. }
  454. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(sparams.cfg_negative_prompt));
  455. if (!sparams.cfg_negative_prompt.empty() && sparams.cfg_negative_prompt.back() == '\n') {
  456. sparams.cfg_negative_prompt.pop_back();
  457. }
  458. } else if (arg == "--cfg-scale") {
  459. if (++i >= argc) {
  460. invalid_param = true;
  461. break;
  462. }
  463. sparams.cfg_scale = std::stof(argv[i]);
  464. } else if (arg == "-b" || arg == "--batch-size") {
  465. if (++i >= argc) {
  466. invalid_param = true;
  467. break;
  468. }
  469. params.n_batch = std::stoi(argv[i]);
  470. } else if (arg == "--keep") {
  471. if (++i >= argc) {
  472. invalid_param = true;
  473. break;
  474. }
  475. params.n_keep = std::stoi(argv[i]);
  476. } else if (arg == "--draft") {
  477. if (++i >= argc) {
  478. invalid_param = true;
  479. break;
  480. }
  481. params.n_draft = std::stoi(argv[i]);
  482. } else if (arg == "--chunks") {
  483. if (++i >= argc) {
  484. invalid_param = true;
  485. break;
  486. }
  487. params.n_chunks = std::stoi(argv[i]);
  488. } else if (arg == "-np" || arg == "--parallel") {
  489. if (++i >= argc) {
  490. invalid_param = true;
  491. break;
  492. }
  493. params.n_parallel = std::stoi(argv[i]);
  494. } else if (arg == "-ns" || arg == "--sequences") {
  495. if (++i >= argc) {
  496. invalid_param = true;
  497. break;
  498. }
  499. params.n_sequences = std::stoi(argv[i]);
  500. } else if (arg == "--p-split" || arg == "-ps") {
  501. if (++i >= argc) {
  502. invalid_param = true;
  503. break;
  504. }
  505. params.p_split = std::stof(argv[i]);
  506. } else if (arg == "-m" || arg == "--model") {
  507. if (++i >= argc) {
  508. invalid_param = true;
  509. break;
  510. }
  511. params.model = argv[i];
  512. } else if (arg == "-md" || arg == "--model-draft") {
  513. if (++i >= argc) {
  514. invalid_param = true;
  515. break;
  516. }
  517. params.model_draft = argv[i];
  518. } else if (arg == "-a" || arg == "--alias") {
  519. if (++i >= argc) {
  520. invalid_param = true;
  521. break;
  522. }
  523. params.model_alias = argv[i];
  524. } else if (arg == "--lora") {
  525. if (++i >= argc) {
  526. invalid_param = true;
  527. break;
  528. }
  529. params.lora_adapter.emplace_back(argv[i], 1.0f);
  530. params.use_mmap = false;
  531. } else if (arg == "--lora-scaled") {
  532. if (++i >= argc) {
  533. invalid_param = true;
  534. break;
  535. }
  536. const char * lora_adapter = argv[i];
  537. if (++i >= argc) {
  538. invalid_param = true;
  539. break;
  540. }
  541. params.lora_adapter.emplace_back(lora_adapter, std::stof(argv[i]));
  542. params.use_mmap = false;
  543. } else if (arg == "--lora-base") {
  544. if (++i >= argc) {
  545. invalid_param = true;
  546. break;
  547. }
  548. params.lora_base = argv[i];
  549. } else if (arg == "--mmproj") {
  550. if (++i >= argc) {
  551. invalid_param = true;
  552. break;
  553. }
  554. params.mmproj = argv[i];
  555. } else if (arg == "--image") {
  556. if (++i >= argc) {
  557. invalid_param = true;
  558. break;
  559. }
  560. params.image = argv[i];
  561. } else if (arg == "-i" || arg == "--interactive") {
  562. params.interactive = true;
  563. } else if (arg == "--embedding") {
  564. params.embedding = true;
  565. } else if (arg == "--interactive-first") {
  566. params.interactive_first = true;
  567. } else if (arg == "-ins" || arg == "--instruct") {
  568. params.instruct = true;
  569. } else if (arg == "-cml" || arg == "--chatml") {
  570. params.chatml = true;
  571. } else if (arg == "--infill") {
  572. params.infill = true;
  573. } else if (arg == "-dkvc" || arg == "--dump-kv-cache") {
  574. params.dump_kv_cache = true;
  575. } else if (arg == "-nkvo" || arg == "--no-kv-offload") {
  576. params.no_kv_offload = true;
  577. } else if (arg == "-ctk" || arg == "--cache-type-k") {
  578. params.cache_type_k = argv[++i];
  579. } else if (arg == "-ctv" || arg == "--cache-type-v") {
  580. params.cache_type_v = argv[++i];
  581. } else if (arg == "--multiline-input") {
  582. params.multiline_input = true;
  583. } else if (arg == "--simple-io") {
  584. params.simple_io = true;
  585. } else if (arg == "-cb" || arg == "--cont-batching") {
  586. params.cont_batching = true;
  587. } else if (arg == "--color") {
  588. params.use_color = true;
  589. } else if (arg == "--mlock") {
  590. params.use_mlock = true;
  591. } else if (arg == "--gpu-layers" || arg == "-ngl" || arg == "--n-gpu-layers") {
  592. if (++i >= argc) {
  593. invalid_param = true;
  594. break;
  595. }
  596. params.n_gpu_layers = std::stoi(argv[i]);
  597. if (!llama_supports_gpu_offload()) {
  598. fprintf(stderr, "warning: not compiled with GPU offload support, --n-gpu-layers option will be ignored\n");
  599. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  600. }
  601. } else if (arg == "--gpu-layers-draft" || arg == "-ngld" || arg == "--n-gpu-layers-draft") {
  602. if (++i >= argc) {
  603. invalid_param = true;
  604. break;
  605. }
  606. params.n_gpu_layers_draft = std::stoi(argv[i]);
  607. if (!llama_supports_gpu_offload()) {
  608. fprintf(stderr, "warning: not compiled with GPU offload support, --n-gpu-layers-draft option will be ignored\n");
  609. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  610. }
  611. } else if (arg == "--main-gpu" || arg == "-mg") {
  612. if (++i >= argc) {
  613. invalid_param = true;
  614. break;
  615. }
  616. params.main_gpu = std::stoi(argv[i]);
  617. #ifndef GGML_USE_CUBLAS_SYCL
  618. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS/SYCL. Setting the main GPU has no effect.\n");
  619. #endif // GGML_USE_CUBLAS_SYCL
  620. } else if (arg == "--split-mode" || arg == "-sm") {
  621. if (++i >= argc) {
  622. invalid_param = true;
  623. break;
  624. }
  625. std::string arg_next = argv[i];
  626. if (arg_next == "none") {
  627. params.split_mode = LLAMA_SPLIT_MODE_NONE;
  628. } else if (arg_next == "layer") {
  629. params.split_mode = LLAMA_SPLIT_MODE_LAYER;
  630. } else if (arg_next == "row") {
  631. #ifdef GGML_USE_SYCL
  632. fprintf(stderr, "warning: The split mode value:[row] is not supported by llama.cpp with SYCL. It's developing.\nExit!\n");
  633. exit(1);
  634. #endif // GGML_USE_SYCL
  635. params.split_mode = LLAMA_SPLIT_MODE_ROW;
  636. } else {
  637. invalid_param = true;
  638. break;
  639. }
  640. #ifndef GGML_USE_CUBLAS_SYCL
  641. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS/SYCL. Setting the split mode has no effect.\n");
  642. #endif // GGML_USE_CUBLAS_SYCL
  643. } else if (arg == "--tensor-split" || arg == "-ts") {
  644. if (++i >= argc) {
  645. invalid_param = true;
  646. break;
  647. }
  648. std::string arg_next = argv[i];
  649. // split string by , and /
  650. const std::regex regex{R"([,/]+)"};
  651. std::sregex_token_iterator it{arg_next.begin(), arg_next.end(), regex, -1};
  652. std::vector<std::string> split_arg{it, {}};
  653. if (split_arg.size() >= llama_max_devices()) {
  654. invalid_param = true;
  655. break;
  656. }
  657. for (size_t i = 0; i < llama_max_devices(); ++i) {
  658. if (i < split_arg.size()) {
  659. params.tensor_split[i] = std::stof(split_arg[i]);
  660. } else {
  661. params.tensor_split[i] = 0.0f;
  662. }
  663. }
  664. #ifndef GGML_USE_CUBLAS_SYCL_VULKAN
  665. fprintf(stderr, "warning: llama.cpp was compiled without cuBLAS/SYCL/Vulkan. Setting a tensor split has no effect.\n");
  666. #endif // GGML_USE_CUBLAS_SYCL
  667. } else if (arg == "--no-mmap") {
  668. params.use_mmap = false;
  669. } else if (arg == "--numa") {
  670. if (++i >= argc) {
  671. invalid_param = true;
  672. break;
  673. }
  674. std::string value(argv[i]);
  675. /**/ if (value == "distribute" || value == "") { params.numa = GGML_NUMA_STRATEGY_DISTRIBUTE; }
  676. else if (value == "isolate") { params.numa = GGML_NUMA_STRATEGY_ISOLATE; }
  677. else if (value == "numactl") { params.numa = GGML_NUMA_STRATEGY_NUMACTL; }
  678. else { invalid_param = true; break; }
  679. } else if (arg == "--verbose-prompt") {
  680. params.verbose_prompt = true;
  681. } else if (arg == "--no-display-prompt") {
  682. params.display_prompt = false;
  683. } else if (arg == "-r" || arg == "--reverse-prompt") {
  684. if (++i >= argc) {
  685. invalid_param = true;
  686. break;
  687. }
  688. params.antiprompt.emplace_back(argv[i]);
  689. } else if (arg == "-ld" || arg == "--logdir") {
  690. if (++i >= argc) {
  691. invalid_param = true;
  692. break;
  693. }
  694. params.logdir = argv[i];
  695. if (params.logdir.back() != DIRECTORY_SEPARATOR) {
  696. params.logdir += DIRECTORY_SEPARATOR;
  697. }
  698. } else if (arg == "--save-all-logits" || arg == "--kl-divergence-base") {
  699. if (++i >= argc) {
  700. invalid_param = true;
  701. break;
  702. }
  703. params.logits_file = argv[i];
  704. } else if (arg == "--perplexity" || arg == "--all-logits") {
  705. params.logits_all = true;
  706. } else if (arg == "--ppl-stride") {
  707. if (++i >= argc) {
  708. invalid_param = true;
  709. break;
  710. }
  711. params.ppl_stride = std::stoi(argv[i]);
  712. } else if (arg == "-ptc" || arg == "--print-token-count") {
  713. if (++i >= argc) {
  714. invalid_param = true;
  715. break;
  716. }
  717. params.n_print = std::stoi(argv[i]);
  718. } else if (arg == "--ppl-output-type") {
  719. if (++i >= argc) {
  720. invalid_param = true;
  721. break;
  722. }
  723. params.ppl_output_type = std::stoi(argv[i]);
  724. } else if (arg == "--hellaswag") {
  725. params.hellaswag = true;
  726. } else if (arg == "--hellaswag-tasks") {
  727. if (++i >= argc) {
  728. invalid_param = true;
  729. break;
  730. }
  731. params.hellaswag_tasks = std::stoi(argv[i]);
  732. } else if (arg == "--winogrande") {
  733. params.winogrande = true;
  734. } else if (arg == "--winogrande-tasks") {
  735. if (++i >= argc) {
  736. invalid_param = true;
  737. break;
  738. }
  739. params.winogrande_tasks = std::stoi(argv[i]);
  740. } else if (arg == "--multiple-choice") {
  741. params.multiple_choice = true;
  742. } else if (arg == "--multiple-choice-tasks") {
  743. if (++i >= argc) {
  744. invalid_param = true;
  745. break;
  746. }
  747. params.multiple_choice_tasks = std::stoi(argv[i]);
  748. } else if (arg == "--kl-divergence") {
  749. params.kl_divergence = true;
  750. } else if (arg == "--ignore-eos") {
  751. params.ignore_eos = true;
  752. } else if (arg == "--no-penalize-nl") {
  753. sparams.penalize_nl = false;
  754. } else if (arg == "-l" || arg == "--logit-bias") {
  755. if (++i >= argc) {
  756. invalid_param = true;
  757. break;
  758. }
  759. std::stringstream ss(argv[i]);
  760. llama_token key;
  761. char sign;
  762. std::string value_str;
  763. try {
  764. if (ss >> key && ss >> sign && std::getline(ss, value_str) && (sign == '+' || sign == '-')) {
  765. sparams.logit_bias[key] = std::stof(value_str) * ((sign == '-') ? -1.0f : 1.0f);
  766. } else {
  767. throw std::exception();
  768. }
  769. } catch (const std::exception&) {
  770. invalid_param = true;
  771. break;
  772. }
  773. } else if (arg == "-h" || arg == "--help") {
  774. return false;
  775. } else if (arg == "--version") {
  776. fprintf(stderr, "version: %d (%s)\n", LLAMA_BUILD_NUMBER, LLAMA_COMMIT);
  777. fprintf(stderr, "built with %s for %s\n", LLAMA_COMPILER, LLAMA_BUILD_TARGET);
  778. exit(0);
  779. } else if (arg == "--random-prompt") {
  780. params.random_prompt = true;
  781. } else if (arg == "--in-prefix-bos") {
  782. params.input_prefix_bos = true;
  783. } else if (arg == "--in-prefix") {
  784. if (++i >= argc) {
  785. invalid_param = true;
  786. break;
  787. }
  788. params.input_prefix = argv[i];
  789. } else if (arg == "--in-suffix") {
  790. if (++i >= argc) {
  791. invalid_param = true;
  792. break;
  793. }
  794. params.input_suffix = argv[i];
  795. } else if (arg == "--grammar") {
  796. if (++i >= argc) {
  797. invalid_param = true;
  798. break;
  799. }
  800. sparams.grammar = argv[i];
  801. } else if (arg == "--grammar-file") {
  802. if (++i >= argc) {
  803. invalid_param = true;
  804. break;
  805. }
  806. std::ifstream file(argv[i]);
  807. if (!file) {
  808. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  809. invalid_param = true;
  810. break;
  811. }
  812. std::copy(
  813. std::istreambuf_iterator<char>(file),
  814. std::istreambuf_iterator<char>(),
  815. std::back_inserter(sparams.grammar)
  816. );
  817. } else if (arg == "--override-kv") {
  818. if (++i >= argc) {
  819. invalid_param = true;
  820. break;
  821. }
  822. char * sep = strchr(argv[i], '=');
  823. if (sep == nullptr || sep - argv[i] >= 128) {
  824. fprintf(stderr, "error: Malformed KV override: %s\n", argv[i]);
  825. invalid_param = true;
  826. break;
  827. }
  828. struct llama_model_kv_override kvo;
  829. std::strncpy(kvo.key, argv[i], sep - argv[i]);
  830. kvo.key[sep - argv[i]] = 0;
  831. sep++;
  832. if (strncmp(sep, "int:", 4) == 0) {
  833. sep += 4;
  834. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_INT;
  835. kvo.int_value = std::atol(sep);
  836. } else if (strncmp(sep, "float:", 6) == 0) {
  837. sep += 6;
  838. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_FLOAT;
  839. kvo.float_value = std::atof(sep);
  840. } else if (strncmp(sep, "bool:", 5) == 0) {
  841. sep += 5;
  842. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_BOOL;
  843. if (std::strcmp(sep, "true") == 0) {
  844. kvo.bool_value = true;
  845. } else if (std::strcmp(sep, "false") == 0) {
  846. kvo.bool_value = false;
  847. } else {
  848. fprintf(stderr, "error: Invalid boolean value for KV override: %s\n", argv[i]);
  849. invalid_param = true;
  850. break;
  851. }
  852. } else {
  853. fprintf(stderr, "error: Invalid type for KV override: %s\n", argv[i]);
  854. invalid_param = true;
  855. break;
  856. }
  857. params.kv_overrides.push_back(kvo);
  858. #ifndef LOG_DISABLE_LOGS
  859. // Parse args for logging parameters
  860. } else if ( log_param_single_parse( argv[i] ) ) {
  861. // Do nothing, log_param_single_parse automatically does it's thing
  862. // and returns if a match was found and parsed.
  863. } else if ( log_param_pair_parse( /*check_but_dont_parse*/ true, argv[i] ) ) {
  864. // We have a matching known parameter requiring an argument,
  865. // now we need to check if there is anything after this argv
  866. // and flag invalid_param or parse it.
  867. if (++i >= argc) {
  868. invalid_param = true;
  869. break;
  870. }
  871. if( !log_param_pair_parse( /*check_but_dont_parse*/ false, argv[i-1], argv[i]) ) {
  872. invalid_param = true;
  873. break;
  874. }
  875. // End of Parse args for logging parameters
  876. #endif // LOG_DISABLE_LOGS
  877. } else {
  878. throw std::invalid_argument("error: unknown argument: " + arg);
  879. }
  880. }
  881. if (invalid_param) {
  882. throw std::invalid_argument("error: invalid parameter for argument: " + arg);
  883. }
  884. if (params.prompt_cache_all &&
  885. (params.interactive || params.interactive_first ||
  886. params.instruct)) {
  887. throw std::invalid_argument("error: --prompt-cache-all not supported in interactive mode yet\n");
  888. }
  889. if (params.escape) {
  890. process_escapes(params.prompt);
  891. process_escapes(params.input_prefix);
  892. process_escapes(params.input_suffix);
  893. process_escapes(sparams.cfg_negative_prompt);
  894. for (auto & antiprompt : params.antiprompt) {
  895. process_escapes(antiprompt);
  896. }
  897. }
  898. if (!params.kv_overrides.empty()) {
  899. params.kv_overrides.emplace_back();
  900. params.kv_overrides.back().key[0] = 0;
  901. }
  902. return true;
  903. }
  904. void gpt_print_usage(int /*argc*/, char ** argv, const gpt_params & params) {
  905. const llama_sampling_params & sparams = params.sparams;
  906. std::string sampler_type_chars;
  907. std::string sampler_type_names;
  908. for (const auto sampler_type : sparams.samplers_sequence) {
  909. sampler_type_chars += static_cast<char>(sampler_type);
  910. sampler_type_names += sampler_type_to_name_string(sampler_type) + ";";
  911. }
  912. sampler_type_names.pop_back();
  913. printf("\n");
  914. printf("usage: %s [options]\n", argv[0]);
  915. printf("\n");
  916. printf("options:\n");
  917. printf(" -h, --help show this help message and exit\n");
  918. printf(" --version show version and build info\n");
  919. printf(" -i, --interactive run in interactive mode\n");
  920. printf(" --interactive-first run in interactive mode and wait for input right away\n");
  921. printf(" -ins, --instruct run in instruction mode (use with Alpaca models)\n");
  922. printf(" -cml, --chatml run in chatml mode (use with ChatML-compatible models)\n");
  923. printf(" --multiline-input allows you to write or paste multiple lines without ending each in '\\'\n");
  924. printf(" -r PROMPT, --reverse-prompt PROMPT\n");
  925. printf(" halt generation at PROMPT, return control in interactive mode\n");
  926. printf(" (can be specified more than once for multiple prompts).\n");
  927. printf(" --color colorise output to distinguish prompt and user input from generations\n");
  928. printf(" -s SEED, --seed SEED RNG seed (default: -1, use random seed for < 0)\n");
  929. printf(" -t N, --threads N number of threads to use during generation (default: %d)\n", params.n_threads);
  930. printf(" -tb N, --threads-batch N\n");
  931. printf(" number of threads to use during batch and prompt processing (default: same as --threads)\n");
  932. printf(" -td N, --threads-draft N");
  933. printf(" number of threads to use during generation (default: same as --threads)\n");
  934. printf(" -tbd N, --threads-batch-draft N\n");
  935. printf(" number of threads to use during batch and prompt processing (default: same as --threads-draft)\n");
  936. printf(" -p PROMPT, --prompt PROMPT\n");
  937. printf(" prompt to start generation with (default: empty)\n");
  938. printf(" -e, --escape process prompt escapes sequences (\\n, \\r, \\t, \\', \\\", \\\\)\n");
  939. printf(" --prompt-cache FNAME file to cache prompt state for faster startup (default: none)\n");
  940. printf(" --prompt-cache-all if specified, saves user input and generations to cache as well.\n");
  941. printf(" not supported with --interactive or other interactive options\n");
  942. printf(" --prompt-cache-ro if specified, uses the prompt cache but does not update it.\n");
  943. printf(" --random-prompt start with a randomized prompt.\n");
  944. printf(" --in-prefix-bos prefix BOS to user inputs, preceding the `--in-prefix` string\n");
  945. printf(" --in-prefix STRING string to prefix user inputs with (default: empty)\n");
  946. printf(" --in-suffix STRING string to suffix after user inputs with (default: empty)\n");
  947. printf(" -f FNAME, --file FNAME\n");
  948. printf(" prompt file to start generation.\n");
  949. printf(" -bf FNAME, --binary-file FNAME\n");
  950. printf(" binary file containing multiple choice tasks.\n");
  951. printf(" -n N, --n-predict N number of tokens to predict (default: %d, -1 = infinity, -2 = until context filled)\n", params.n_predict);
  952. printf(" -c N, --ctx-size N size of the prompt context (default: %d, 0 = loaded from model)\n", params.n_ctx);
  953. printf(" -b N, --batch-size N batch size for prompt processing (default: %d)\n", params.n_batch);
  954. printf(" --samplers samplers that will be used for generation in the order, separated by \';\'\n");
  955. printf(" (default: %s)\n", sampler_type_names.c_str());
  956. printf(" --sampling-seq simplified sequence for samplers that will be used (default: %s)\n", sampler_type_chars.c_str());
  957. printf(" --top-k N top-k sampling (default: %d, 0 = disabled)\n", sparams.top_k);
  958. printf(" --top-p N top-p sampling (default: %.1f, 1.0 = disabled)\n", (double)sparams.top_p);
  959. printf(" --min-p N min-p sampling (default: %.1f, 0.0 = disabled)\n", (double)sparams.min_p);
  960. printf(" --tfs N tail free sampling, parameter z (default: %.1f, 1.0 = disabled)\n", (double)sparams.tfs_z);
  961. printf(" --typical N locally typical sampling, parameter p (default: %.1f, 1.0 = disabled)\n", (double)sparams.typical_p);
  962. printf(" --repeat-last-n N last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)\n", sparams.penalty_last_n);
  963. printf(" --repeat-penalty N penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)\n", (double)sparams.penalty_repeat);
  964. printf(" --presence-penalty N repeat alpha presence penalty (default: %.1f, 0.0 = disabled)\n", (double)sparams.penalty_present);
  965. printf(" --frequency-penalty N repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)\n", (double)sparams.penalty_freq);
  966. printf(" --dynatemp-range N dynamic temperature range (default: %.1f, 0.0 = disabled)\n", (double)sparams.dynatemp_range);
  967. printf(" --dynatemp-exp N dynamic temperature exponent (default: %.1f)\n", (double)sparams.dynatemp_exponent);
  968. printf(" --mirostat N use Mirostat sampling.\n");
  969. printf(" Top K, Nucleus, Tail Free and Locally Typical samplers are ignored if used.\n");
  970. printf(" (default: %d, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)\n", sparams.mirostat);
  971. printf(" --mirostat-lr N Mirostat learning rate, parameter eta (default: %.1f)\n", (double)sparams.mirostat_eta);
  972. printf(" --mirostat-ent N Mirostat target entropy, parameter tau (default: %.1f)\n", (double)sparams.mirostat_tau);
  973. printf(" -l TOKEN_ID(+/-)BIAS, --logit-bias TOKEN_ID(+/-)BIAS\n");
  974. printf(" modifies the likelihood of token appearing in the completion,\n");
  975. printf(" i.e. `--logit-bias 15043+1` to increase likelihood of token ' Hello',\n");
  976. printf(" or `--logit-bias 15043-1` to decrease likelihood of token ' Hello'\n");
  977. printf(" --grammar GRAMMAR BNF-like grammar to constrain generations (see samples in grammars/ dir)\n");
  978. printf(" --grammar-file FNAME file to read grammar from\n");
  979. printf(" --cfg-negative-prompt PROMPT\n");
  980. printf(" negative prompt to use for guidance. (default: empty)\n");
  981. printf(" --cfg-negative-prompt-file FNAME\n");
  982. printf(" negative prompt file to use for guidance. (default: empty)\n");
  983. printf(" --cfg-scale N strength of guidance (default: %f, 1.0 = disable)\n", sparams.cfg_scale);
  984. printf(" --rope-scaling {none,linear,yarn}\n");
  985. printf(" RoPE frequency scaling method, defaults to linear unless specified by the model\n");
  986. printf(" --rope-scale N RoPE context scaling factor, expands context by a factor of N\n");
  987. printf(" --rope-freq-base N RoPE base frequency, used by NTK-aware scaling (default: loaded from model)\n");
  988. printf(" --rope-freq-scale N RoPE frequency scaling factor, expands context by a factor of 1/N\n");
  989. printf(" --yarn-orig-ctx N YaRN: original context size of model (default: 0 = model training context size)\n");
  990. printf(" --yarn-ext-factor N YaRN: extrapolation mix factor (default: 1.0, 0.0 = full interpolation)\n");
  991. printf(" --yarn-attn-factor N YaRN: scale sqrt(t) or attention magnitude (default: 1.0)\n");
  992. printf(" --yarn-beta-slow N YaRN: high correction dim or alpha (default: %.1f)\n", params.yarn_beta_slow);
  993. printf(" --yarn-beta-fast N YaRN: low correction dim or beta (default: %.1f)\n", params.yarn_beta_fast);
  994. printf(" --pooling {none,mean,cls}\n");
  995. printf(" pooling type for embeddings, use model default if unspecified\n");
  996. printf(" -dt N, --defrag-thold N\n");
  997. printf(" KV cache defragmentation threshold (default: %.1f, < 0 - disabled)\n", params.defrag_thold);
  998. printf(" --ignore-eos ignore end of stream token and continue generating (implies --logit-bias 2-inf)\n");
  999. printf(" --no-penalize-nl do not penalize newline token\n");
  1000. printf(" --temp N temperature (default: %.1f)\n", (double)sparams.temp);
  1001. printf(" --all-logits return logits for all tokens in the batch (default: disabled)\n");
  1002. printf(" --hellaswag compute HellaSwag score over random tasks from datafile supplied with -f\n");
  1003. printf(" --hellaswag-tasks N number of tasks to use when computing the HellaSwag score (default: %zu)\n", params.hellaswag_tasks);
  1004. printf(" --winogrande compute Winogrande score over random tasks from datafile supplied with -f\n");
  1005. printf(" --winogrande-tasks N number of tasks to use when computing the Winogrande score (default: %zu)\n", params.winogrande_tasks);
  1006. printf(" --multiple-choice compute multiple choice score over random tasks from datafile supplied with -f\n");
  1007. printf(" --multiple-choice-tasks N number of tasks to use when computing the multiple choice score (default: %zu)\n", params.winogrande_tasks);
  1008. printf(" --kl-divergence computes KL-divergence to logits provided via --kl-divergence-base\n");
  1009. printf(" --keep N number of tokens to keep from the initial prompt (default: %d, -1 = all)\n", params.n_keep);
  1010. printf(" --draft N number of tokens to draft for speculative decoding (default: %d)\n", params.n_draft);
  1011. printf(" --chunks N max number of chunks to process (default: %d, -1 = all)\n", params.n_chunks);
  1012. printf(" -np N, --parallel N number of parallel sequences to decode (default: %d)\n", params.n_parallel);
  1013. printf(" -ns N, --sequences N number of sequences to decode (default: %d)\n", params.n_sequences);
  1014. printf(" -ps N, --p-split N speculative decoding split probability (default: %.1f)\n", (double)params.p_split);
  1015. printf(" -cb, --cont-batching enable continuous batching (a.k.a dynamic batching) (default: disabled)\n");
  1016. printf(" --mmproj MMPROJ_FILE path to a multimodal projector file for LLaVA. see examples/llava/README.md\n");
  1017. printf(" --image IMAGE_FILE path to an image file. use with multimodal models\n");
  1018. if (llama_supports_mlock()) {
  1019. printf(" --mlock force system to keep model in RAM rather than swapping or compressing\n");
  1020. }
  1021. if (llama_supports_mmap()) {
  1022. printf(" --no-mmap do not memory-map model (slower load but may reduce pageouts if not using mlock)\n");
  1023. }
  1024. printf(" --numa TYPE attempt optimizations that help on some NUMA systems\n");
  1025. printf(" - distribute: spread execution evenly over all nodes\n");
  1026. printf(" - isolate: only spawn threads on CPUs on the node that execution started on\n");
  1027. printf(" - numactl: use the CPU map provided by numactl\n");
  1028. printf(" if run without this previously, it is recommended to drop the system page cache before using this\n");
  1029. printf(" see https://github.com/ggerganov/llama.cpp/issues/1437\n");
  1030. if (llama_supports_gpu_offload()) {
  1031. printf(" -ngl N, --n-gpu-layers N\n");
  1032. printf(" number of layers to store in VRAM\n");
  1033. printf(" -ngld N, --n-gpu-layers-draft N\n");
  1034. printf(" number of layers to store in VRAM for the draft model\n");
  1035. printf(" -sm SPLIT_MODE, --split-mode SPLIT_MODE\n");
  1036. printf(" how to split the model across multiple GPUs, one of:\n");
  1037. printf(" - none: use one GPU only\n");
  1038. printf(" - layer (default): split layers and KV across GPUs\n");
  1039. printf(" - row: split rows across GPUs\n");
  1040. printf(" -ts SPLIT, --tensor-split SPLIT\n");
  1041. printf(" fraction of the model to offload to each GPU, comma-separated list of proportions, e.g. 3,1\n");
  1042. printf(" -mg i, --main-gpu i the GPU to use for the model (with split-mode = none),\n");
  1043. printf(" or for intermediate results and KV (with split-mode = row) (default: %d)\n", params.main_gpu);
  1044. }
  1045. printf(" --verbose-prompt print a verbose prompt before generation (default: %s)\n", params.verbose_prompt ? "true" : "false");
  1046. printf(" --no-display-prompt don't print prompt at generation (default: %s)\n", !params.display_prompt ? "true" : "false");
  1047. printf(" -gan N, --grp-attn-n N\n");
  1048. printf(" group-attention factor (default: %d)\n", params.grp_attn_n);
  1049. printf(" -gaw N, --grp-attn-w N\n");
  1050. printf(" group-attention width (default: %.1f)\n", (double)params.grp_attn_w);
  1051. printf(" -dkvc, --dump-kv-cache\n");
  1052. printf(" verbose print of the KV cache\n");
  1053. printf(" -nkvo, --no-kv-offload\n");
  1054. printf(" disable KV offload\n");
  1055. printf(" -ctk TYPE, --cache-type-k TYPE\n");
  1056. printf(" KV cache data type for K (default: %s)\n", params.cache_type_k.c_str());
  1057. printf(" -ctv TYPE, --cache-type-v TYPE\n");
  1058. printf(" KV cache data type for V (default: %s)\n", params.cache_type_v.c_str());
  1059. printf(" --simple-io use basic IO for better compatibility in subprocesses and limited consoles\n");
  1060. printf(" --lora FNAME apply LoRA adapter (implies --no-mmap)\n");
  1061. printf(" --lora-scaled FNAME S apply LoRA adapter with user defined scaling S (implies --no-mmap)\n");
  1062. printf(" --lora-base FNAME optional model to use as a base for the layers modified by the LoRA adapter\n");
  1063. printf(" -m FNAME, --model FNAME\n");
  1064. printf(" model path (default: %s)\n", params.model.c_str());
  1065. printf(" -md FNAME, --model-draft FNAME\n");
  1066. printf(" draft model for speculative decoding\n");
  1067. printf(" -ld LOGDIR, --logdir LOGDIR\n");
  1068. printf(" path under which to save YAML logs (no logging if unset)\n");
  1069. printf(" --override-kv KEY=TYPE:VALUE\n");
  1070. printf(" advanced option to override model metadata by key. may be specified multiple times.\n");
  1071. printf(" types: int, float, bool. example: --override-kv tokenizer.ggml.add_bos_token=bool:false\n");
  1072. printf(" -ptc N, --print-token-count N\n");
  1073. printf(" print token count every N tokens (default: %d)\n", params.n_print);
  1074. printf("\n");
  1075. #ifndef LOG_DISABLE_LOGS
  1076. log_print_usage();
  1077. #endif // LOG_DISABLE_LOGS
  1078. }
  1079. std::string get_system_info(const gpt_params & params) {
  1080. std::ostringstream os;
  1081. os << "system_info: n_threads = " << params.n_threads;
  1082. if (params.n_threads_batch != -1) {
  1083. os << " (n_threads_batch = " << params.n_threads_batch << ")";
  1084. }
  1085. os << " / " << std::thread::hardware_concurrency() << " | " << llama_print_system_info();
  1086. return os.str();
  1087. }
  1088. std::string gpt_random_prompt(std::mt19937 & rng) {
  1089. const int r = rng() % 10;
  1090. switch (r) {
  1091. case 0: return "So";
  1092. case 1: return "Once upon a time";
  1093. case 2: return "When";
  1094. case 3: return "The";
  1095. case 4: return "After";
  1096. case 5: return "If";
  1097. case 6: return "import";
  1098. case 7: return "He";
  1099. case 8: return "She";
  1100. case 9: return "They";
  1101. }
  1102. GGML_UNREACHABLE();
  1103. }
  1104. //
  1105. // String utils
  1106. //
  1107. std::vector<std::string> string_split(std::string input, char separator) {
  1108. std::vector<std::string> parts;
  1109. size_t separator_pos = input.find(separator);
  1110. while (separator_pos != std::string::npos) {
  1111. std::string part = input.substr(0, separator_pos);
  1112. parts.emplace_back(part);
  1113. input = input.substr(separator_pos + 1);
  1114. separator_pos = input.find(separator);
  1115. }
  1116. parts.emplace_back(input);
  1117. return parts;
  1118. }
  1119. std::vector<llama_sampler_type> sampler_types_from_names(const std::vector<std::string> & names, bool allow_alt_names) {
  1120. std::unordered_map<std::string, llama_sampler_type> sampler_canonical_name_map {
  1121. {"top_k", llama_sampler_type::TOP_K},
  1122. {"top_p", llama_sampler_type::TOP_P},
  1123. {"typical_p", llama_sampler_type::TYPICAL_P},
  1124. {"min_p", llama_sampler_type::MIN_P},
  1125. {"tfs_z", llama_sampler_type::TFS_Z},
  1126. {"temperature", llama_sampler_type::TEMPERATURE}
  1127. };
  1128. // since samplers names are written multiple ways
  1129. // make it ready for both system names and input names
  1130. std::unordered_map<std::string, llama_sampler_type> sampler_alt_name_map {
  1131. {"top-k", llama_sampler_type::TOP_K},
  1132. {"top-p", llama_sampler_type::TOP_P},
  1133. {"nucleus", llama_sampler_type::TOP_P},
  1134. {"typical-p", llama_sampler_type::TYPICAL_P},
  1135. {"typical", llama_sampler_type::TYPICAL_P},
  1136. {"min-p", llama_sampler_type::MIN_P},
  1137. {"tfs-z", llama_sampler_type::TFS_Z},
  1138. {"tfs", llama_sampler_type::TFS_Z},
  1139. {"temp", llama_sampler_type::TEMPERATURE}
  1140. };
  1141. std::vector<llama_sampler_type> sampler_types;
  1142. sampler_types.reserve(names.size());
  1143. for (const auto & name : names)
  1144. {
  1145. auto sampler_item = sampler_canonical_name_map.find(name);
  1146. if (sampler_item != sampler_canonical_name_map.end())
  1147. {
  1148. sampler_types.push_back(sampler_item->second);
  1149. }
  1150. else
  1151. {
  1152. if (allow_alt_names)
  1153. {
  1154. sampler_item = sampler_alt_name_map.find(name);
  1155. if (sampler_item != sampler_alt_name_map.end())
  1156. {
  1157. sampler_types.push_back(sampler_item->second);
  1158. }
  1159. }
  1160. }
  1161. }
  1162. return sampler_types;
  1163. }
  1164. std::vector<llama_sampler_type> sampler_types_from_chars(const std::string & names_string) {
  1165. std::unordered_map<char, llama_sampler_type> sampler_name_map {
  1166. {'k', llama_sampler_type::TOP_K},
  1167. {'p', llama_sampler_type::TOP_P},
  1168. {'y', llama_sampler_type::TYPICAL_P},
  1169. {'m', llama_sampler_type::MIN_P},
  1170. {'f', llama_sampler_type::TFS_Z},
  1171. {'t', llama_sampler_type::TEMPERATURE}
  1172. };
  1173. std::vector<llama_sampler_type> sampler_types;
  1174. sampler_types.reserve(names_string.size());
  1175. for (const auto & c : names_string) {
  1176. const auto sampler_item = sampler_name_map.find(c);
  1177. if (sampler_item != sampler_name_map.end()) {
  1178. sampler_types.push_back(sampler_item->second);
  1179. }
  1180. }
  1181. return sampler_types;
  1182. }
  1183. std::string sampler_type_to_name_string(llama_sampler_type sampler_type) {
  1184. switch (sampler_type) {
  1185. case llama_sampler_type::TOP_K: return "top_k";
  1186. case llama_sampler_type::TFS_Z: return "tfs_z";
  1187. case llama_sampler_type::TYPICAL_P: return "typical_p";
  1188. case llama_sampler_type::TOP_P: return "top_p";
  1189. case llama_sampler_type::MIN_P: return "min_p";
  1190. case llama_sampler_type::TEMPERATURE: return "temperature";
  1191. default : return "";
  1192. }
  1193. }
  1194. //
  1195. // Model utils
  1196. //
  1197. struct llama_model_params llama_model_params_from_gpt_params(const gpt_params & params) {
  1198. auto mparams = llama_model_default_params();
  1199. if (params.n_gpu_layers != -1) {
  1200. mparams.n_gpu_layers = params.n_gpu_layers;
  1201. }
  1202. mparams.main_gpu = params.main_gpu;
  1203. mparams.split_mode = params.split_mode;
  1204. mparams.tensor_split = params.tensor_split;
  1205. mparams.use_mmap = params.use_mmap;
  1206. mparams.use_mlock = params.use_mlock;
  1207. if (params.kv_overrides.empty()) {
  1208. mparams.kv_overrides = NULL;
  1209. } else {
  1210. GGML_ASSERT(params.kv_overrides.back().key[0] == 0 && "KV overrides not terminated with empty key");
  1211. mparams.kv_overrides = params.kv_overrides.data();
  1212. }
  1213. return mparams;
  1214. }
  1215. static ggml_type kv_cache_type_from_str(const std::string & s) {
  1216. if (s == "f32") {
  1217. return GGML_TYPE_F32;
  1218. }
  1219. if (s == "f16") {
  1220. return GGML_TYPE_F16;
  1221. }
  1222. if (s == "q8_0") {
  1223. return GGML_TYPE_Q8_0;
  1224. }
  1225. if (s == "q4_0") {
  1226. return GGML_TYPE_Q4_0;
  1227. }
  1228. if (s == "q4_1") {
  1229. return GGML_TYPE_Q4_1;
  1230. }
  1231. if (s == "q5_0") {
  1232. return GGML_TYPE_Q5_0;
  1233. }
  1234. if (s == "q5_1") {
  1235. return GGML_TYPE_Q5_1;
  1236. }
  1237. throw std::runtime_error("Invalid cache type: " + s);
  1238. }
  1239. struct llama_context_params llama_context_params_from_gpt_params(const gpt_params & params) {
  1240. auto cparams = llama_context_default_params();
  1241. cparams.n_ctx = params.n_ctx;
  1242. cparams.n_batch = params.n_batch;
  1243. cparams.n_threads = params.n_threads;
  1244. cparams.n_threads_batch = params.n_threads_batch == -1 ? params.n_threads : params.n_threads_batch;
  1245. cparams.seed = params.seed;
  1246. cparams.logits_all = params.logits_all;
  1247. cparams.embeddings = params.embedding;
  1248. cparams.rope_scaling_type = params.rope_scaling_type;
  1249. cparams.rope_freq_base = params.rope_freq_base;
  1250. cparams.rope_freq_scale = params.rope_freq_scale;
  1251. cparams.yarn_ext_factor = params.yarn_ext_factor;
  1252. cparams.yarn_attn_factor = params.yarn_attn_factor;
  1253. cparams.yarn_beta_fast = params.yarn_beta_fast;
  1254. cparams.yarn_beta_slow = params.yarn_beta_slow;
  1255. cparams.yarn_orig_ctx = params.yarn_orig_ctx;
  1256. cparams.pooling_type = params.pooling_type;
  1257. cparams.defrag_thold = params.defrag_thold;
  1258. cparams.offload_kqv = !params.no_kv_offload;
  1259. cparams.type_k = kv_cache_type_from_str(params.cache_type_k);
  1260. cparams.type_v = kv_cache_type_from_str(params.cache_type_v);
  1261. return cparams;
  1262. }
  1263. void llama_batch_clear(struct llama_batch & batch) {
  1264. batch.n_tokens = 0;
  1265. }
  1266. void llama_batch_add(
  1267. struct llama_batch & batch,
  1268. llama_token id,
  1269. llama_pos pos,
  1270. const std::vector<llama_seq_id> & seq_ids,
  1271. bool logits) {
  1272. batch.token [batch.n_tokens] = id;
  1273. batch.pos [batch.n_tokens] = pos;
  1274. batch.n_seq_id[batch.n_tokens] = seq_ids.size();
  1275. for (size_t i = 0; i < seq_ids.size(); ++i) {
  1276. batch.seq_id[batch.n_tokens][i] = seq_ids[i];
  1277. }
  1278. batch.logits [batch.n_tokens] = logits;
  1279. batch.n_tokens++;
  1280. }
  1281. std::tuple<struct llama_model *, struct llama_context *> llama_init_from_gpt_params(gpt_params & params) {
  1282. auto mparams = llama_model_params_from_gpt_params(params);
  1283. llama_model * model = llama_load_model_from_file(params.model.c_str(), mparams);
  1284. if (model == NULL) {
  1285. fprintf(stderr, "%s: error: failed to load model '%s'\n", __func__, params.model.c_str());
  1286. return std::make_tuple(nullptr, nullptr);
  1287. }
  1288. auto cparams = llama_context_params_from_gpt_params(params);
  1289. llama_context * lctx = llama_new_context_with_model(model, cparams);
  1290. if (lctx == NULL) {
  1291. fprintf(stderr, "%s: error: failed to create context with model '%s'\n", __func__, params.model.c_str());
  1292. llama_free_model(model);
  1293. return std::make_tuple(nullptr, nullptr);
  1294. }
  1295. for (unsigned int i = 0; i < params.lora_adapter.size(); ++i) {
  1296. const std::string& lora_adapter = std::get<0>(params.lora_adapter[i]);
  1297. float lora_scale = std::get<1>(params.lora_adapter[i]);
  1298. int err = llama_model_apply_lora_from_file(model,
  1299. lora_adapter.c_str(),
  1300. lora_scale,
  1301. ((i > 0) || params.lora_base.empty())
  1302. ? NULL
  1303. : params.lora_base.c_str(),
  1304. params.n_threads);
  1305. if (err != 0) {
  1306. fprintf(stderr, "%s: error: failed to apply lora adapter\n", __func__);
  1307. llama_free(lctx);
  1308. llama_free_model(model);
  1309. return std::make_tuple(nullptr, nullptr);
  1310. }
  1311. }
  1312. if (params.ignore_eos) {
  1313. params.sparams.logit_bias[llama_token_eos(model)] = -INFINITY;
  1314. }
  1315. {
  1316. LOG("warming up the model with an empty run\n");
  1317. std::vector<llama_token> tmp = { llama_token_bos(model), llama_token_eos(model), };
  1318. llama_decode(lctx, llama_batch_get_one(tmp.data(), std::min(tmp.size(), (size_t) params.n_batch), 0, 0));
  1319. llama_kv_cache_clear(lctx);
  1320. llama_reset_timings(lctx);
  1321. }
  1322. return std::make_tuple(model, lctx);
  1323. }
  1324. //
  1325. // Vocab utils
  1326. //
  1327. std::vector<llama_token> llama_tokenize(
  1328. const struct llama_context * ctx,
  1329. const std::string & text,
  1330. bool add_bos,
  1331. bool special) {
  1332. return llama_tokenize(llama_get_model(ctx), text, add_bos, special);
  1333. }
  1334. std::vector<llama_token> llama_tokenize(
  1335. const struct llama_model * model,
  1336. const std::string & text,
  1337. bool add_bos,
  1338. bool special) {
  1339. // upper limit for the number of tokens
  1340. int n_tokens = text.length() + add_bos;
  1341. std::vector<llama_token> result(n_tokens);
  1342. n_tokens = llama_tokenize(model, text.data(), text.length(), result.data(), result.size(), add_bos, special);
  1343. if (n_tokens < 0) {
  1344. result.resize(-n_tokens);
  1345. int check = llama_tokenize(model, text.data(), text.length(), result.data(), result.size(), add_bos, special);
  1346. GGML_ASSERT(check == -n_tokens);
  1347. } else {
  1348. result.resize(n_tokens);
  1349. }
  1350. return result;
  1351. }
  1352. std::string llama_token_to_piece(const struct llama_context * ctx, llama_token token) {
  1353. std::vector<char> result(8, 0);
  1354. const int n_tokens = llama_token_to_piece(llama_get_model(ctx), token, result.data(), result.size());
  1355. if (n_tokens < 0) {
  1356. result.resize(-n_tokens);
  1357. int check = llama_token_to_piece(llama_get_model(ctx), token, result.data(), result.size());
  1358. GGML_ASSERT(check == -n_tokens);
  1359. } else {
  1360. result.resize(n_tokens);
  1361. }
  1362. return std::string(result.data(), result.size());
  1363. }
  1364. std::string llama_detokenize_spm(llama_context * ctx, const std::vector<llama_token> & tokens) {
  1365. const llama_token bos_id = llama_token_bos(llama_get_model(ctx));
  1366. std::string piece;
  1367. std::string result;
  1368. for (size_t i = 0; i < tokens.size(); ++i) {
  1369. piece = llama_token_to_piece(ctx, tokens[i]);
  1370. // remove the leading space of the first non-BOS token
  1371. if (((tokens[0] == bos_id && i == 1) || (tokens[0] != bos_id && i == 0)) && piece[0] == ' ') {
  1372. piece = piece.substr(1);
  1373. }
  1374. result += piece;
  1375. }
  1376. return result;
  1377. }
  1378. std::string llama_detokenize_bpe(llama_context * ctx, const std::vector<llama_token> & tokens) {
  1379. std::string piece;
  1380. std::string result;
  1381. for (size_t i = 0; i < tokens.size(); ++i) {
  1382. piece = llama_token_to_piece(ctx, tokens[i]);
  1383. result += piece;
  1384. }
  1385. // NOTE: the original tokenizer decodes bytes after collecting the pieces.
  1386. return result;
  1387. }
  1388. bool llama_should_add_bos_token(const llama_model * model) {
  1389. const int add_bos = llama_add_bos_token(model);
  1390. return add_bos != -1 ? bool(add_bos) : (llama_vocab_type(model) == LLAMA_VOCAB_TYPE_SPM);
  1391. }
  1392. //
  1393. // YAML utils
  1394. //
  1395. // returns true if successful, false otherwise
  1396. bool create_directory_with_parents(const std::string & path) {
  1397. #ifdef _WIN32
  1398. std::wstring_convert<std::codecvt_utf8<wchar_t>> converter;
  1399. std::wstring wpath = converter.from_bytes(path);
  1400. // if the path already exists, check whether it's a directory
  1401. const DWORD attributes = GetFileAttributesW(wpath.c_str());
  1402. if ((attributes != INVALID_FILE_ATTRIBUTES) && (attributes & FILE_ATTRIBUTE_DIRECTORY)) {
  1403. return true;
  1404. }
  1405. size_t pos_slash = 0;
  1406. // process path from front to back, procedurally creating directories
  1407. while ((pos_slash = path.find('\\', pos_slash)) != std::string::npos) {
  1408. const std::wstring subpath = wpath.substr(0, pos_slash);
  1409. const wchar_t * test = subpath.c_str();
  1410. const bool success = CreateDirectoryW(test, NULL);
  1411. if (!success) {
  1412. const DWORD error = GetLastError();
  1413. // if the path already exists, ensure that it's a directory
  1414. if (error == ERROR_ALREADY_EXISTS) {
  1415. const DWORD attributes = GetFileAttributesW(subpath.c_str());
  1416. if (attributes == INVALID_FILE_ATTRIBUTES || !(attributes & FILE_ATTRIBUTE_DIRECTORY)) {
  1417. return false;
  1418. }
  1419. } else {
  1420. return false;
  1421. }
  1422. }
  1423. pos_slash += 1;
  1424. }
  1425. return true;
  1426. #else
  1427. // if the path already exists, check whether it's a directory
  1428. struct stat info;
  1429. if (stat(path.c_str(), &info) == 0) {
  1430. return S_ISDIR(info.st_mode);
  1431. }
  1432. size_t pos_slash = 1; // skip leading slashes for directory creation
  1433. // process path from front to back, procedurally creating directories
  1434. while ((pos_slash = path.find('/', pos_slash)) != std::string::npos) {
  1435. const std::string subpath = path.substr(0, pos_slash);
  1436. struct stat info;
  1437. // if the path already exists, ensure that it's a directory
  1438. if (stat(subpath.c_str(), &info) == 0) {
  1439. if (!S_ISDIR(info.st_mode)) {
  1440. return false;
  1441. }
  1442. } else {
  1443. // create parent directories
  1444. const int ret = mkdir(subpath.c_str(), 0755);
  1445. if (ret != 0) {
  1446. return false;
  1447. }
  1448. }
  1449. pos_slash += 1;
  1450. }
  1451. return true;
  1452. #endif // _WIN32
  1453. }
  1454. void dump_vector_float_yaml(FILE * stream, const char * prop_name, const std::vector<float> & data) {
  1455. if (data.empty()) {
  1456. fprintf(stream, "%s:\n", prop_name);
  1457. return;
  1458. }
  1459. fprintf(stream, "%s: [", prop_name);
  1460. for (size_t i = 0; i < data.size() - 1; ++i) {
  1461. fprintf(stream, "%e, ", data[i]);
  1462. }
  1463. fprintf(stream, "%e]\n", data.back());
  1464. }
  1465. void dump_vector_int_yaml(FILE * stream, const char * prop_name, const std::vector<int> & data) {
  1466. if (data.empty()) {
  1467. fprintf(stream, "%s:\n", prop_name);
  1468. return;
  1469. }
  1470. fprintf(stream, "%s: [", prop_name);
  1471. for (size_t i = 0; i < data.size() - 1; ++i) {
  1472. fprintf(stream, "%d, ", data[i]);
  1473. }
  1474. fprintf(stream, "%d]\n", data.back());
  1475. }
  1476. void dump_string_yaml_multiline(FILE * stream, const char * prop_name, const char * data) {
  1477. std::string data_str(data == NULL ? "" : data);
  1478. if (data_str.empty()) {
  1479. fprintf(stream, "%s:\n", prop_name);
  1480. return;
  1481. }
  1482. size_t pos_start = 0;
  1483. size_t pos_found = 0;
  1484. if (!data_str.empty() && (std::isspace(data_str[0]) || std::isspace(data_str.back()))) {
  1485. data_str = std::regex_replace(data_str, std::regex("\n"), "\\n");
  1486. data_str = std::regex_replace(data_str, std::regex("\""), "\\\"");
  1487. data_str = std::regex_replace(data_str, std::regex(R"(\\[^n"])"), R"(\$&)");
  1488. data_str = "\"" + data_str + "\"";
  1489. fprintf(stream, "%s: %s\n", prop_name, data_str.c_str());
  1490. return;
  1491. }
  1492. if (data_str.find('\n') == std::string::npos) {
  1493. fprintf(stream, "%s: %s\n", prop_name, data_str.c_str());
  1494. return;
  1495. }
  1496. fprintf(stream, "%s: |\n", prop_name);
  1497. while ((pos_found = data_str.find('\n', pos_start)) != std::string::npos) {
  1498. fprintf(stream, " %s\n", data_str.substr(pos_start, pos_found-pos_start).c_str());
  1499. pos_start = pos_found + 1;
  1500. }
  1501. }
  1502. std::string get_sortable_timestamp() {
  1503. using clock = std::chrono::system_clock;
  1504. const clock::time_point current_time = clock::now();
  1505. const time_t as_time_t = clock::to_time_t(current_time);
  1506. char timestamp_no_ns[100];
  1507. std::strftime(timestamp_no_ns, 100, "%Y_%m_%d-%H_%M_%S", std::localtime(&as_time_t));
  1508. const int64_t ns = std::chrono::duration_cast<std::chrono::nanoseconds>(
  1509. current_time.time_since_epoch() % 1000000000).count();
  1510. char timestamp_ns[11];
  1511. snprintf(timestamp_ns, 11, "%09" PRId64, ns);
  1512. return std::string(timestamp_no_ns) + "." + std::string(timestamp_ns);
  1513. }
  1514. void dump_non_result_info_yaml(FILE * stream, const gpt_params & params, const llama_context * lctx,
  1515. const std::string & timestamp, const std::vector<int> & prompt_tokens, const char * model_desc) {
  1516. const llama_sampling_params & sparams = params.sparams;
  1517. fprintf(stream, "build_commit: %s\n", LLAMA_COMMIT);
  1518. fprintf(stream, "build_number: %d\n", LLAMA_BUILD_NUMBER);
  1519. fprintf(stream, "cpu_has_arm_fma: %s\n", ggml_cpu_has_arm_fma() ? "true" : "false");
  1520. fprintf(stream, "cpu_has_avx: %s\n", ggml_cpu_has_avx() ? "true" : "false");
  1521. fprintf(stream, "cpu_has_avx_vnni: %s\n", ggml_cpu_has_avx_vnni() ? "true" : "false");
  1522. fprintf(stream, "cpu_has_avx2: %s\n", ggml_cpu_has_avx2() ? "true" : "false");
  1523. fprintf(stream, "cpu_has_avx512: %s\n", ggml_cpu_has_avx512() ? "true" : "false");
  1524. fprintf(stream, "cpu_has_avx512_vbmi: %s\n", ggml_cpu_has_avx512_vbmi() ? "true" : "false");
  1525. fprintf(stream, "cpu_has_avx512_vnni: %s\n", ggml_cpu_has_avx512_vnni() ? "true" : "false");
  1526. fprintf(stream, "cpu_has_cublas: %s\n", ggml_cpu_has_cublas() ? "true" : "false");
  1527. fprintf(stream, "cpu_has_vulkan: %s\n", ggml_cpu_has_vulkan() ? "true" : "false");
  1528. fprintf(stream, "cpu_has_clblast: %s\n", ggml_cpu_has_clblast() ? "true" : "false");
  1529. fprintf(stream, "cpu_has_kompute: %s\n", ggml_cpu_has_kompute() ? "true" : "false");
  1530. fprintf(stream, "cpu_has_fma: %s\n", ggml_cpu_has_fma() ? "true" : "false");
  1531. fprintf(stream, "cpu_has_gpublas: %s\n", ggml_cpu_has_gpublas() ? "true" : "false");
  1532. fprintf(stream, "cpu_has_neon: %s\n", ggml_cpu_has_neon() ? "true" : "false");
  1533. fprintf(stream, "cpu_has_f16c: %s\n", ggml_cpu_has_f16c() ? "true" : "false");
  1534. fprintf(stream, "cpu_has_fp16_va: %s\n", ggml_cpu_has_fp16_va() ? "true" : "false");
  1535. fprintf(stream, "cpu_has_wasm_simd: %s\n", ggml_cpu_has_wasm_simd() ? "true" : "false");
  1536. fprintf(stream, "cpu_has_blas: %s\n", ggml_cpu_has_blas() ? "true" : "false");
  1537. fprintf(stream, "cpu_has_sse3: %s\n", ggml_cpu_has_sse3() ? "true" : "false");
  1538. fprintf(stream, "cpu_has_vsx: %s\n", ggml_cpu_has_vsx() ? "true" : "false");
  1539. fprintf(stream, "cpu_has_matmul_int8: %s\n", ggml_cpu_has_matmul_int8() ? "true" : "false");
  1540. #ifdef NDEBUG
  1541. fprintf(stream, "debug: false\n");
  1542. #else
  1543. fprintf(stream, "debug: true\n");
  1544. #endif // NDEBUG
  1545. fprintf(stream, "model_desc: %s\n", model_desc);
  1546. fprintf(stream, "n_vocab: %d # output size of the final layer, 32001 for some models\n", llama_n_vocab(llama_get_model(lctx)));
  1547. #ifdef __OPTIMIZE__
  1548. fprintf(stream, "optimize: true\n");
  1549. #else
  1550. fprintf(stream, "optimize: false\n");
  1551. #endif // __OPTIMIZE__
  1552. fprintf(stream, "time: %s\n", timestamp.c_str());
  1553. fprintf(stream, "\n");
  1554. fprintf(stream, "###############\n");
  1555. fprintf(stream, "# User Inputs #\n");
  1556. fprintf(stream, "###############\n");
  1557. fprintf(stream, "\n");
  1558. fprintf(stream, "alias: %s # default: unknown\n", params.model_alias.c_str());
  1559. fprintf(stream, "batch_size: %d # default: 512\n", params.n_batch);
  1560. dump_string_yaml_multiline(stream, "cfg_negative_prompt", sparams.cfg_negative_prompt.c_str());
  1561. fprintf(stream, "cfg_scale: %f # default: 1.0\n", sparams.cfg_scale);
  1562. fprintf(stream, "chunks: %d # default: -1 (unlimited)\n", params.n_chunks);
  1563. fprintf(stream, "color: %s # default: false\n", params.use_color ? "true" : "false");
  1564. fprintf(stream, "ctx_size: %d # default: 512\n", params.n_ctx);
  1565. fprintf(stream, "escape: %s # default: false\n", params.escape ? "true" : "false");
  1566. fprintf(stream, "file: # never logged, see prompt instead. Can still be specified for input.\n");
  1567. fprintf(stream, "frequency_penalty: %f # default: 0.0 \n", sparams.penalty_freq);
  1568. dump_string_yaml_multiline(stream, "grammar", sparams.grammar.c_str());
  1569. fprintf(stream, "grammar-file: # never logged, see grammar instead. Can still be specified for input.\n");
  1570. fprintf(stream, "hellaswag: %s # default: false\n", params.hellaswag ? "true" : "false");
  1571. fprintf(stream, "hellaswag_tasks: %zu # default: 400\n", params.hellaswag_tasks);
  1572. const auto logit_bias_eos = sparams.logit_bias.find(llama_token_eos(llama_get_model(lctx)));
  1573. const bool ignore_eos = logit_bias_eos != sparams.logit_bias.end() && logit_bias_eos->second == -INFINITY;
  1574. fprintf(stream, "ignore_eos: %s # default: false\n", ignore_eos ? "true" : "false");
  1575. dump_string_yaml_multiline(stream, "in_prefix", params.input_prefix.c_str());
  1576. fprintf(stream, "in_prefix_bos: %s # default: false\n", params.input_prefix_bos ? "true" : "false");
  1577. dump_string_yaml_multiline(stream, "in_suffix", params.input_prefix.c_str());
  1578. fprintf(stream, "instruct: %s # default: false\n", params.instruct ? "true" : "false");
  1579. fprintf(stream, "interactive: %s # default: false\n", params.interactive ? "true" : "false");
  1580. fprintf(stream, "interactive_first: %s # default: false\n", params.interactive_first ? "true" : "false");
  1581. fprintf(stream, "keep: %d # default: 0\n", params.n_keep);
  1582. fprintf(stream, "logdir: %s # default: unset (no logging)\n", params.logdir.c_str());
  1583. fprintf(stream, "logit_bias:\n");
  1584. for (std::pair<llama_token, float> lb : sparams.logit_bias) {
  1585. if (ignore_eos && lb.first == logit_bias_eos->first) {
  1586. continue;
  1587. }
  1588. fprintf(stream, " %d: %f", lb.first, lb.second);
  1589. }
  1590. fprintf(stream, "lora:\n");
  1591. for (std::tuple<std::string, float> la : params.lora_adapter) {
  1592. if (std::get<1>(la) != 1.0f) {
  1593. continue;
  1594. }
  1595. fprintf(stream, " - %s\n", std::get<0>(la).c_str());
  1596. }
  1597. fprintf(stream, "lora_scaled:\n");
  1598. for (std::tuple<std::string, float> la : params.lora_adapter) {
  1599. if (std::get<1>(la) == 1.0f) {
  1600. continue;
  1601. }
  1602. fprintf(stream, " - %s: %f\n", std::get<0>(la).c_str(), std::get<1>(la));
  1603. }
  1604. fprintf(stream, "lora_base: %s\n", params.lora_base.c_str());
  1605. fprintf(stream, "main_gpu: %d # default: 0\n", params.main_gpu);
  1606. fprintf(stream, "min_keep: %d # default: 0 (disabled)\n", sparams.min_keep);
  1607. fprintf(stream, "mirostat: %d # default: 0 (disabled)\n", sparams.mirostat);
  1608. fprintf(stream, "mirostat_ent: %f # default: 5.0\n", sparams.mirostat_tau);
  1609. fprintf(stream, "mirostat_lr: %f # default: 0.1\n", sparams.mirostat_eta);
  1610. fprintf(stream, "mlock: %s # default: false\n", params.use_mlock ? "true" : "false");
  1611. fprintf(stream, "model: %s # default: models/7B/ggml-model.bin\n", params.model.c_str());
  1612. fprintf(stream, "model_draft: %s # default:\n", params.model_draft.c_str());
  1613. fprintf(stream, "multiline_input: %s # default: false\n", params.multiline_input ? "true" : "false");
  1614. fprintf(stream, "n_gpu_layers: %d # default: -1\n", params.n_gpu_layers);
  1615. fprintf(stream, "n_predict: %d # default: -1 (unlimited)\n", params.n_predict);
  1616. fprintf(stream, "n_probs: %d # only used by server binary, default: 0\n", sparams.n_probs);
  1617. fprintf(stream, "no_mmap: %s # default: false\n", !params.use_mmap ? "true" : "false");
  1618. fprintf(stream, "no_penalize_nl: %s # default: false\n", !sparams.penalize_nl ? "true" : "false");
  1619. fprintf(stream, "ppl_output_type: %d # default: 0\n", params.ppl_output_type);
  1620. fprintf(stream, "ppl_stride: %d # default: 0\n", params.ppl_stride);
  1621. fprintf(stream, "presence_penalty: %f # default: 0.0\n", sparams.penalty_present);
  1622. dump_string_yaml_multiline(stream, "prompt", params.prompt.c_str());
  1623. fprintf(stream, "prompt_cache: %s\n", params.path_prompt_cache.c_str());
  1624. fprintf(stream, "prompt_cache_all: %s # default: false\n", params.prompt_cache_all ? "true" : "false");
  1625. fprintf(stream, "prompt_cache_ro: %s # default: false\n", params.prompt_cache_ro ? "true" : "false");
  1626. dump_vector_int_yaml(stream, "prompt_tokens", prompt_tokens);
  1627. fprintf(stream, "random_prompt: %s # default: false\n", params.random_prompt ? "true" : "false");
  1628. fprintf(stream, "repeat_penalty: %f # default: 1.1\n", sparams.penalty_repeat);
  1629. fprintf(stream, "reverse_prompt:\n");
  1630. for (std::string ap : params.antiprompt) {
  1631. size_t pos = 0;
  1632. while ((pos = ap.find('\n', pos)) != std::string::npos) {
  1633. ap.replace(pos, 1, "\\n");
  1634. pos += 1;
  1635. }
  1636. fprintf(stream, " - %s\n", ap.c_str());
  1637. }
  1638. fprintf(stream, "rope_freq_base: %f # default: 10000.0\n", params.rope_freq_base);
  1639. fprintf(stream, "rope_freq_scale: %f # default: 1.0\n", params.rope_freq_scale);
  1640. fprintf(stream, "seed: %u # default: -1 (random seed)\n", params.seed);
  1641. fprintf(stream, "simple_io: %s # default: false\n", params.simple_io ? "true" : "false");
  1642. fprintf(stream, "cont_batching: %s # default: false\n", params.cont_batching ? "true" : "false");
  1643. fprintf(stream, "temp: %f # default: 0.8\n", sparams.temp);
  1644. const std::vector<float> tensor_split_vector(params.tensor_split, params.tensor_split + llama_max_devices());
  1645. dump_vector_float_yaml(stream, "tensor_split", tensor_split_vector);
  1646. fprintf(stream, "tfs: %f # default: 1.0\n", sparams.tfs_z);
  1647. fprintf(stream, "threads: %d # default: %u\n", params.n_threads, std::thread::hardware_concurrency());
  1648. fprintf(stream, "top_k: %d # default: 40\n", sparams.top_k);
  1649. fprintf(stream, "top_p: %f # default: 0.95\n", sparams.top_p);
  1650. fprintf(stream, "min_p: %f # default: 0.0\n", sparams.min_p);
  1651. fprintf(stream, "typical_p: %f # default: 1.0\n", sparams.typical_p);
  1652. fprintf(stream, "verbose_prompt: %s # default: false\n", params.verbose_prompt ? "true" : "false");
  1653. fprintf(stream, "display_prompt: %s # default: true\n", params.display_prompt ? "true" : "false");
  1654. }
  1655. //
  1656. // KV cache utils
  1657. //
  1658. void dump_kv_cache_view(const llama_kv_cache_view & view, int row_size) {
  1659. static const char slot_chars[] = ".123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+";
  1660. printf("=== Dumping KV cache. total cells %d, max sequences per cell %d, populated cells %d, total tokens in cache %d, largest empty slot=%d @ %d",
  1661. view.n_cells, view.n_max_seq, view.used_cells, view.token_count, view.max_contiguous, view.max_contiguous_idx);
  1662. llama_kv_cache_view_cell * c_curr = view.cells;
  1663. llama_seq_id * cs_curr = view.cells_sequences;
  1664. for (int i = 0; i < view.n_cells; i++, c_curr++, cs_curr += view.n_max_seq) {
  1665. if (i % row_size == 0) {
  1666. printf("\n%5d: ", i);
  1667. }
  1668. int seq_count = 0;
  1669. for (int j = 0; j < view.n_max_seq; j++) {
  1670. if (cs_curr[j] >= 0) { seq_count++; }
  1671. }
  1672. putchar(slot_chars[std::min(sizeof(slot_chars) - 2, size_t(seq_count))]);
  1673. }
  1674. printf("\n=== Done dumping\n");
  1675. }
  1676. void dump_kv_cache_view_seqs(const llama_kv_cache_view & view, int row_size) {
  1677. static const char slot_chars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  1678. printf("=== Dumping KV cache. total cells %d, max sequences per cell %d, populated cells %d, total tokens in cache %d, largest empty slot=%d @ %d\n",
  1679. view.n_cells, view.n_max_seq, view.used_cells, view.token_count, view.max_contiguous, view.max_contiguous_idx);
  1680. std::unordered_map<llama_seq_id, size_t> seqs;
  1681. llama_kv_cache_view_cell * c_curr = view.cells;
  1682. llama_seq_id * cs_curr = view.cells_sequences;
  1683. for (int i = 0; i < view.n_cells; i++, c_curr++, cs_curr += view.n_max_seq) {
  1684. for (int j = 0; j < view.n_max_seq; j++) {
  1685. if (cs_curr[j] < 0) { continue; }
  1686. if (seqs.find(cs_curr[j]) == seqs.end()) {
  1687. if (seqs.size() + 1 >= sizeof(slot_chars)) { break; }
  1688. const size_t sz = seqs.size();
  1689. seqs[cs_curr[j]] = sz;
  1690. }
  1691. }
  1692. if (seqs.size() + 1 >= sizeof(slot_chars)) { break; }
  1693. }
  1694. printf("=== Sequence legend: ");
  1695. for (const auto & it : seqs) {
  1696. printf("%zu=%d, ", it.second, it.first);
  1697. }
  1698. printf("'+'=other sequence ids");
  1699. c_curr = view.cells;
  1700. cs_curr = view.cells_sequences;
  1701. for (int i = 0; i < view.n_cells; i++, c_curr++, cs_curr += view.n_max_seq) {
  1702. if (i % row_size == 0) {
  1703. printf("\n%5d: ", i);
  1704. }
  1705. for (int j = 0; j < view.n_max_seq; j++) {
  1706. if (cs_curr[j] >= 0) {
  1707. const auto & it = seqs.find(cs_curr[j]);
  1708. putchar(it != seqs.end() ? int(slot_chars[it->second]) : '+');
  1709. } else {
  1710. putchar('.');
  1711. }
  1712. }
  1713. putchar(' ');
  1714. }
  1715. printf("\n=== Done dumping\n");
  1716. }