common.cpp 56 KB

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