common.cpp 134 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222
  1. #include "common.h"
  2. // Change JSON_ASSERT from assert() to GGML_ASSERT:
  3. #define JSON_ASSERT GGML_ASSERT
  4. #include "json.hpp"
  5. #include "json-schema-to-grammar.h"
  6. #include "llama.h"
  7. #include <algorithm>
  8. #include <cinttypes>
  9. #include <cmath>
  10. #include <codecvt>
  11. #include <cstdarg>
  12. #include <cstring>
  13. #include <ctime>
  14. #include <fstream>
  15. #include <iostream>
  16. #include <iterator>
  17. #include <regex>
  18. #include <sstream>
  19. #include <string>
  20. #include <unordered_map>
  21. #include <unordered_set>
  22. #include <vector>
  23. #if defined(__APPLE__) && defined(__MACH__)
  24. #include <sys/types.h>
  25. #include <sys/sysctl.h>
  26. #endif
  27. #if defined(_WIN32)
  28. #define WIN32_LEAN_AND_MEAN
  29. #ifndef NOMINMAX
  30. # define NOMINMAX
  31. #endif
  32. #include <locale>
  33. #include <windows.h>
  34. #include <fcntl.h>
  35. #include <io.h>
  36. #else
  37. #include <sys/ioctl.h>
  38. #include <sys/stat.h>
  39. #include <unistd.h>
  40. #endif
  41. #if defined(LLAMA_USE_CURL)
  42. #include <curl/curl.h>
  43. #include <curl/easy.h>
  44. #include <thread>
  45. #include <future>
  46. #endif
  47. #if defined(_MSC_VER)
  48. #pragma warning(disable: 4244 4267) // possible loss of data
  49. #endif
  50. #if (defined(GGML_USE_CUDA) || defined(GGML_USE_SYCL))
  51. #define GGML_USE_CUDA_SYCL
  52. #endif
  53. #if (defined(GGML_USE_CUDA) || defined(GGML_USE_SYCL)) || defined(GGML_USE_VULKAN)
  54. #define GGML_USE_CUDA_SYCL_VULKAN
  55. #endif
  56. #if defined(LLAMA_USE_CURL)
  57. #ifdef __linux__
  58. #include <linux/limits.h>
  59. #elif defined(_WIN32)
  60. #define PATH_MAX MAX_PATH
  61. #else
  62. #include <sys/syslimits.h>
  63. #endif
  64. #define LLAMA_CURL_MAX_URL_LENGTH 2084 // Maximum URL Length in Chrome: 2083
  65. #endif // LLAMA_USE_CURL
  66. using json = nlohmann::ordered_json;
  67. //
  68. // CPU utils
  69. //
  70. int32_t cpu_get_num_physical_cores() {
  71. #ifdef __linux__
  72. // enumerate the set of thread siblings, num entries is num cores
  73. std::unordered_set<std::string> siblings;
  74. for (uint32_t cpu=0; cpu < UINT32_MAX; ++cpu) {
  75. std::ifstream thread_siblings("/sys/devices/system/cpu/cpu"
  76. + std::to_string(cpu) + "/topology/thread_siblings");
  77. if (!thread_siblings.is_open()) {
  78. break; // no more cpus
  79. }
  80. std::string line;
  81. if (std::getline(thread_siblings, line)) {
  82. siblings.insert(line);
  83. }
  84. }
  85. if (!siblings.empty()) {
  86. return static_cast<int32_t>(siblings.size());
  87. }
  88. #elif defined(__APPLE__) && defined(__MACH__)
  89. int32_t num_physical_cores;
  90. size_t len = sizeof(num_physical_cores);
  91. int result = sysctlbyname("hw.perflevel0.physicalcpu", &num_physical_cores, &len, NULL, 0);
  92. if (result == 0) {
  93. return num_physical_cores;
  94. }
  95. result = sysctlbyname("hw.physicalcpu", &num_physical_cores, &len, NULL, 0);
  96. if (result == 0) {
  97. return num_physical_cores;
  98. }
  99. #elif defined(_WIN32)
  100. //TODO: Implement
  101. #endif
  102. unsigned int n_threads = std::thread::hardware_concurrency();
  103. return n_threads > 0 ? (n_threads <= 4 ? n_threads : n_threads / 2) : 4;
  104. }
  105. #if defined(__x86_64__) && defined(__linux__) && !defined(__ANDROID__)
  106. #include <pthread.h>
  107. static void cpuid(unsigned leaf, unsigned subleaf,
  108. unsigned *eax, unsigned *ebx, unsigned *ecx, unsigned *edx) {
  109. __asm__("movq\t%%rbx,%%rsi\n\t"
  110. "cpuid\n\t"
  111. "xchgq\t%%rbx,%%rsi"
  112. : "=a"(*eax), "=S"(*ebx), "=c"(*ecx), "=d"(*edx)
  113. : "0"(leaf), "2"(subleaf));
  114. }
  115. static int pin_cpu(int cpu) {
  116. cpu_set_t mask;
  117. CPU_ZERO(&mask);
  118. CPU_SET(cpu, &mask);
  119. return pthread_setaffinity_np(pthread_self(), sizeof(mask), &mask);
  120. }
  121. static bool is_hybrid_cpu(void) {
  122. unsigned eax, ebx, ecx, edx;
  123. cpuid(7, 0, &eax, &ebx, &ecx, &edx);
  124. return !!(edx & (1u << 15));
  125. }
  126. static bool is_running_on_efficiency_core(void) {
  127. unsigned eax, ebx, ecx, edx;
  128. cpuid(0x1a, 0, &eax, &ebx, &ecx, &edx);
  129. int intel_atom = 0x20;
  130. int core_type = (eax & 0xff000000u) >> 24;
  131. return core_type == intel_atom;
  132. }
  133. static int cpu_count_math_cpus(int n_cpu) {
  134. int result = 0;
  135. for (int cpu = 0; cpu < n_cpu; ++cpu) {
  136. if (pin_cpu(cpu)) {
  137. return -1;
  138. }
  139. if (is_running_on_efficiency_core()) {
  140. continue; // efficiency cores harm lockstep threading
  141. }
  142. ++cpu; // hyperthreading isn't useful for linear algebra
  143. ++result;
  144. }
  145. return result;
  146. }
  147. #endif // __x86_64__ && __linux__
  148. /**
  149. * Returns number of CPUs on system that are useful for math.
  150. */
  151. int32_t cpu_get_num_math() {
  152. #if defined(__x86_64__) && defined(__linux__) && !defined(__ANDROID__)
  153. int n_cpu = sysconf(_SC_NPROCESSORS_ONLN);
  154. if (n_cpu < 1) {
  155. return cpu_get_num_physical_cores();
  156. }
  157. if (is_hybrid_cpu()) {
  158. cpu_set_t affinity;
  159. if (!pthread_getaffinity_np(pthread_self(), sizeof(affinity), &affinity)) {
  160. int result = cpu_count_math_cpus(n_cpu);
  161. pthread_setaffinity_np(pthread_self(), sizeof(affinity), &affinity);
  162. if (result > 0) {
  163. return result;
  164. }
  165. }
  166. }
  167. #endif
  168. return cpu_get_num_physical_cores();
  169. }
  170. //
  171. // CLI argument parsing
  172. //
  173. void gpt_params_handle_hf_token(gpt_params & params) {
  174. if (params.hf_token.empty() && std::getenv("HF_TOKEN")) {
  175. params.hf_token = std::getenv("HF_TOKEN");
  176. }
  177. }
  178. void gpt_params_handle_model_default(gpt_params & params) {
  179. if (!params.hf_repo.empty()) {
  180. // short-hand to avoid specifying --hf-file -> default it to --model
  181. if (params.hf_file.empty()) {
  182. if (params.model.empty()) {
  183. throw std::invalid_argument("error: --hf-repo requires either --hf-file or --model\n");
  184. }
  185. params.hf_file = params.model;
  186. } else if (params.model.empty()) {
  187. params.model = fs_get_cache_file(string_split(params.hf_file, '/').back());
  188. }
  189. } else if (!params.model_url.empty()) {
  190. if (params.model.empty()) {
  191. auto f = string_split(params.model_url, '#').front();
  192. f = string_split(f, '?').front();
  193. params.model = fs_get_cache_file(string_split(f, '/').back());
  194. }
  195. } else if (params.model.empty()) {
  196. params.model = DEFAULT_MODEL_PATH;
  197. }
  198. }
  199. bool gpt_params_parse_ex(int argc, char ** argv, gpt_params & params) {
  200. bool invalid_param = false;
  201. std::string arg;
  202. const std::string arg_prefix = "--";
  203. llama_sampling_params & sparams = params.sparams;
  204. for (int i = 1; i < argc; i++) {
  205. arg = argv[i];
  206. if (arg.compare(0, arg_prefix.size(), arg_prefix) == 0) {
  207. std::replace(arg.begin(), arg.end(), '_', '-');
  208. }
  209. if (!gpt_params_find_arg(argc, argv, arg, params, i, invalid_param)) {
  210. throw std::invalid_argument("error: unknown argument: " + arg);
  211. }
  212. if (invalid_param) {
  213. throw std::invalid_argument("error: invalid parameter for argument: " + arg);
  214. }
  215. }
  216. if (params.prompt_cache_all && (params.interactive || params.interactive_first)) {
  217. throw std::invalid_argument("error: --prompt-cache-all not supported in interactive mode yet\n");
  218. }
  219. gpt_params_handle_model_default(params);
  220. gpt_params_handle_hf_token(params);
  221. if (params.escape) {
  222. string_process_escapes(params.prompt);
  223. string_process_escapes(params.input_prefix);
  224. string_process_escapes(params.input_suffix);
  225. string_process_escapes(sparams.cfg_negative_prompt);
  226. for (auto & antiprompt : params.antiprompt) {
  227. string_process_escapes(antiprompt);
  228. }
  229. }
  230. if (!params.kv_overrides.empty()) {
  231. params.kv_overrides.emplace_back();
  232. params.kv_overrides.back().key[0] = 0;
  233. }
  234. return true;
  235. }
  236. bool gpt_params_parse(int argc, char ** argv, gpt_params & params) {
  237. const auto params_org = params; // the example can modify the default params
  238. try {
  239. if (!gpt_params_parse_ex(argc, argv, params) || params.usage) {
  240. params = params_org;
  241. params.usage = true;
  242. return false;
  243. }
  244. } catch (const std::invalid_argument & ex) {
  245. fprintf(stderr, "%s\n", ex.what());
  246. params = params_org;
  247. return false;
  248. }
  249. return true;
  250. }
  251. #define CHECK_ARG if (++i >= argc) { invalid_param = true; return true; }
  252. bool gpt_params_find_arg(int argc, char ** argv, const std::string & arg, gpt_params & params, int & i, bool & invalid_param) {
  253. const char split_delim = ',';
  254. llama_sampling_params & sparams = params.sparams;
  255. if (arg == "-s" || arg == "--seed") {
  256. CHECK_ARG
  257. // TODO: this is temporary, in the future the sampling state will be moved fully to llama_sampling_context.
  258. params.seed = std::stoul(argv[i]);
  259. sparams.seed = std::stoul(argv[i]);
  260. return true;
  261. }
  262. if (arg == "-t" || arg == "--threads") {
  263. CHECK_ARG
  264. params.n_threads = std::stoi(argv[i]);
  265. if (params.n_threads <= 0) {
  266. params.n_threads = std::thread::hardware_concurrency();
  267. }
  268. return true;
  269. }
  270. if (arg == "-tb" || arg == "--threads-batch") {
  271. CHECK_ARG
  272. params.n_threads_batch = std::stoi(argv[i]);
  273. if (params.n_threads_batch <= 0) {
  274. params.n_threads_batch = std::thread::hardware_concurrency();
  275. }
  276. return true;
  277. }
  278. if (arg == "-td" || arg == "--threads-draft") {
  279. CHECK_ARG
  280. params.n_threads_draft = std::stoi(argv[i]);
  281. if (params.n_threads_draft <= 0) {
  282. params.n_threads_draft = std::thread::hardware_concurrency();
  283. }
  284. return true;
  285. }
  286. if (arg == "-tbd" || arg == "--threads-batch-draft") {
  287. CHECK_ARG
  288. params.n_threads_batch_draft = std::stoi(argv[i]);
  289. if (params.n_threads_batch_draft <= 0) {
  290. params.n_threads_batch_draft = std::thread::hardware_concurrency();
  291. }
  292. return true;
  293. }
  294. if (arg == "-p" || arg == "--prompt") {
  295. CHECK_ARG
  296. params.prompt = argv[i];
  297. return true;
  298. }
  299. if (arg == "-e" || arg == "--escape") {
  300. params.escape = true;
  301. return true;
  302. }
  303. if (arg == "--no-escape") {
  304. params.escape = false;
  305. return true;
  306. }
  307. if (arg == "--prompt-cache") {
  308. CHECK_ARG
  309. params.path_prompt_cache = argv[i];
  310. return true;
  311. }
  312. if (arg == "--prompt-cache-all") {
  313. params.prompt_cache_all = true;
  314. return true;
  315. }
  316. if (arg == "--prompt-cache-ro") {
  317. params.prompt_cache_ro = true;
  318. return true;
  319. }
  320. if (arg == "-bf" || arg == "--binary-file") {
  321. CHECK_ARG
  322. std::ifstream file(argv[i], std::ios::binary);
  323. if (!file) {
  324. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  325. invalid_param = true;
  326. return true;
  327. }
  328. // store the external file name in params
  329. params.prompt_file = argv[i];
  330. std::ostringstream ss;
  331. ss << file.rdbuf();
  332. params.prompt = ss.str();
  333. fprintf(stderr, "Read %zu bytes from binary file %s\n", params.prompt.size(), argv[i]);
  334. return true;
  335. }
  336. if (arg == "-f" || arg == "--file") {
  337. CHECK_ARG
  338. std::ifstream file(argv[i]);
  339. if (!file) {
  340. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  341. invalid_param = true;
  342. return true;
  343. }
  344. // store the external file name in params
  345. params.prompt_file = argv[i];
  346. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(params.prompt));
  347. if (!params.prompt.empty() && params.prompt.back() == '\n') {
  348. params.prompt.pop_back();
  349. }
  350. return true;
  351. }
  352. if (arg == "--in-file") {
  353. CHECK_ARG
  354. std::ifstream file(argv[i]);
  355. if (!file) {
  356. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  357. invalid_param = true;
  358. return true;
  359. }
  360. params.in_files.push_back(argv[i]);
  361. return true;
  362. }
  363. if (arg == "-n" || arg == "--predict" || arg == "--n-predict") {
  364. CHECK_ARG
  365. params.n_predict = std::stoi(argv[i]);
  366. return true;
  367. }
  368. if (arg == "--top-k") {
  369. CHECK_ARG
  370. sparams.top_k = std::stoi(argv[i]);
  371. return true;
  372. }
  373. if (arg == "-c" || arg == "--ctx-size") {
  374. CHECK_ARG
  375. params.n_ctx = std::stoi(argv[i]);
  376. return true;
  377. }
  378. if (arg == "--grp-attn-n" || arg == "-gan") {
  379. CHECK_ARG
  380. params.grp_attn_n = std::stoi(argv[i]);
  381. return true;
  382. }
  383. if (arg == "--grp-attn-w" || arg == "-gaw") {
  384. CHECK_ARG
  385. params.grp_attn_w = std::stoi(argv[i]);
  386. return true;
  387. }
  388. if (arg == "--rope-freq-base") {
  389. CHECK_ARG
  390. params.rope_freq_base = std::stof(argv[i]);
  391. return true;
  392. }
  393. if (arg == "--rope-freq-scale") {
  394. CHECK_ARG
  395. params.rope_freq_scale = std::stof(argv[i]);
  396. return true;
  397. }
  398. if (arg == "--rope-scaling") {
  399. CHECK_ARG
  400. std::string value(argv[i]);
  401. /**/ if (value == "none") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_NONE; }
  402. else if (value == "linear") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_LINEAR; }
  403. else if (value == "yarn") { params.rope_scaling_type = LLAMA_ROPE_SCALING_TYPE_YARN; }
  404. else { invalid_param = true; }
  405. return true;
  406. }
  407. if (arg == "--rope-scale") {
  408. CHECK_ARG
  409. params.rope_freq_scale = 1.0f / std::stof(argv[i]);
  410. return true;
  411. }
  412. if (arg == "--yarn-orig-ctx") {
  413. CHECK_ARG
  414. params.yarn_orig_ctx = std::stoi(argv[i]);
  415. return true;
  416. }
  417. if (arg == "--yarn-ext-factor") {
  418. CHECK_ARG
  419. params.yarn_ext_factor = std::stof(argv[i]);
  420. return true;
  421. }
  422. if (arg == "--yarn-attn-factor") {
  423. CHECK_ARG
  424. params.yarn_attn_factor = std::stof(argv[i]);
  425. return true;
  426. }
  427. if (arg == "--yarn-beta-fast") {
  428. CHECK_ARG
  429. params.yarn_beta_fast = std::stof(argv[i]);
  430. return true;
  431. }
  432. if (arg == "--yarn-beta-slow") {
  433. CHECK_ARG
  434. params.yarn_beta_slow = std::stof(argv[i]);
  435. return true;
  436. }
  437. if (arg == "--pooling") {
  438. CHECK_ARG
  439. std::string value(argv[i]);
  440. /**/ if (value == "none") { params.pooling_type = LLAMA_POOLING_TYPE_NONE; }
  441. else if (value == "mean") { params.pooling_type = LLAMA_POOLING_TYPE_MEAN; }
  442. else if (value == "cls") { params.pooling_type = LLAMA_POOLING_TYPE_CLS; }
  443. else if (value == "last") { params.pooling_type = LLAMA_POOLING_TYPE_LAST; }
  444. else { invalid_param = true; }
  445. return true;
  446. }
  447. if (arg == "--attention") {
  448. CHECK_ARG
  449. std::string value(argv[i]);
  450. /**/ if (value == "causal") { params.attention_type = LLAMA_ATTENTION_TYPE_CAUSAL; }
  451. else if (value == "non-causal") { params.attention_type = LLAMA_ATTENTION_TYPE_NON_CAUSAL; }
  452. else { invalid_param = true; }
  453. return true;
  454. }
  455. if (arg == "--defrag-thold" || arg == "-dt") {
  456. CHECK_ARG
  457. params.defrag_thold = std::stof(argv[i]);
  458. return true;
  459. }
  460. if (arg == "--samplers") {
  461. CHECK_ARG
  462. const auto sampler_names = string_split(argv[i], ';');
  463. sparams.samplers_sequence = llama_sampling_types_from_names(sampler_names, true);
  464. return true;
  465. }
  466. if (arg == "--sampling-seq") {
  467. CHECK_ARG
  468. sparams.samplers_sequence = llama_sampling_types_from_chars(argv[i]);
  469. return true;
  470. }
  471. if (arg == "--top-p") {
  472. CHECK_ARG
  473. sparams.top_p = std::stof(argv[i]);
  474. return true;
  475. }
  476. if (arg == "--min-p") {
  477. CHECK_ARG
  478. sparams.min_p = std::stof(argv[i]);
  479. return true;
  480. }
  481. if (arg == "--temp") {
  482. CHECK_ARG
  483. sparams.temp = std::stof(argv[i]);
  484. sparams.temp = std::max(sparams.temp, 0.0f);
  485. return true;
  486. }
  487. if (arg == "--tfs") {
  488. CHECK_ARG
  489. sparams.tfs_z = std::stof(argv[i]);
  490. return true;
  491. }
  492. if (arg == "--typical") {
  493. CHECK_ARG
  494. sparams.typical_p = std::stof(argv[i]);
  495. return true;
  496. }
  497. if (arg == "--repeat-last-n") {
  498. CHECK_ARG
  499. sparams.penalty_last_n = std::stoi(argv[i]);
  500. sparams.n_prev = std::max(sparams.n_prev, sparams.penalty_last_n);
  501. return true;
  502. }
  503. if (arg == "--repeat-penalty") {
  504. CHECK_ARG
  505. sparams.penalty_repeat = std::stof(argv[i]);
  506. return true;
  507. }
  508. if (arg == "--frequency-penalty") {
  509. CHECK_ARG
  510. sparams.penalty_freq = std::stof(argv[i]);
  511. return true;
  512. }
  513. if (arg == "--presence-penalty") {
  514. CHECK_ARG
  515. sparams.penalty_present = std::stof(argv[i]);
  516. return true;
  517. }
  518. if (arg == "--dynatemp-range") {
  519. CHECK_ARG
  520. sparams.dynatemp_range = std::stof(argv[i]);
  521. return true;
  522. }
  523. if (arg == "--dynatemp-exp") {
  524. CHECK_ARG
  525. sparams.dynatemp_exponent = std::stof(argv[i]);
  526. return true;
  527. }
  528. if (arg == "--mirostat") {
  529. CHECK_ARG
  530. sparams.mirostat = std::stoi(argv[i]);
  531. return true;
  532. }
  533. if (arg == "--mirostat-lr") {
  534. CHECK_ARG
  535. sparams.mirostat_eta = std::stof(argv[i]);
  536. return true;
  537. }
  538. if (arg == "--mirostat-ent") {
  539. CHECK_ARG
  540. sparams.mirostat_tau = std::stof(argv[i]);
  541. return true;
  542. }
  543. if (arg == "--cfg-negative-prompt") {
  544. CHECK_ARG
  545. sparams.cfg_negative_prompt = argv[i];
  546. return true;
  547. }
  548. if (arg == "--cfg-negative-prompt-file") {
  549. CHECK_ARG
  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. return true;
  555. }
  556. std::copy(std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>(), back_inserter(sparams.cfg_negative_prompt));
  557. if (!sparams.cfg_negative_prompt.empty() && sparams.cfg_negative_prompt.back() == '\n') {
  558. sparams.cfg_negative_prompt.pop_back();
  559. }
  560. return true;
  561. }
  562. if (arg == "--cfg-scale") {
  563. CHECK_ARG
  564. sparams.cfg_scale = std::stof(argv[i]);
  565. return true;
  566. }
  567. if (arg == "-b" || arg == "--batch-size") {
  568. CHECK_ARG
  569. params.n_batch = std::stoi(argv[i]);
  570. return true;
  571. }
  572. if (arg == "-ub" || arg == "--ubatch-size") {
  573. CHECK_ARG
  574. params.n_ubatch = std::stoi(argv[i]);
  575. return true;
  576. }
  577. if (arg == "--keep") {
  578. CHECK_ARG
  579. params.n_keep = std::stoi(argv[i]);
  580. return true;
  581. }
  582. if (arg == "--draft") {
  583. CHECK_ARG
  584. params.n_draft = std::stoi(argv[i]);
  585. return true;
  586. }
  587. if (arg == "--chunks") {
  588. CHECK_ARG
  589. params.n_chunks = std::stoi(argv[i]);
  590. return true;
  591. }
  592. if (arg == "-np" || arg == "--parallel") {
  593. CHECK_ARG
  594. params.n_parallel = std::stoi(argv[i]);
  595. return true;
  596. }
  597. if (arg == "-ns" || arg == "--sequences") {
  598. CHECK_ARG
  599. params.n_sequences = std::stoi(argv[i]);
  600. return true;
  601. }
  602. if (arg == "--p-split" || arg == "-ps") {
  603. CHECK_ARG
  604. params.p_split = std::stof(argv[i]);
  605. return true;
  606. }
  607. if (arg == "-m" || arg == "--model") {
  608. CHECK_ARG
  609. params.model = argv[i];
  610. return true;
  611. }
  612. if (arg == "-md" || arg == "--model-draft") {
  613. CHECK_ARG
  614. params.model_draft = argv[i];
  615. return true;
  616. }
  617. if (arg == "-a" || arg == "--alias") {
  618. CHECK_ARG
  619. params.model_alias = argv[i];
  620. return true;
  621. }
  622. if (arg == "-mu" || arg == "--model-url") {
  623. CHECK_ARG
  624. params.model_url = argv[i];
  625. return true;
  626. }
  627. if (arg == "-hft" || arg == "--hf-token") {
  628. if (++i >= argc) {
  629. invalid_param = true;
  630. return true;
  631. }
  632. params.hf_token = argv[i];
  633. return true;
  634. }
  635. if (arg == "-hfr" || arg == "--hf-repo") {
  636. CHECK_ARG
  637. params.hf_repo = argv[i];
  638. return true;
  639. }
  640. if (arg == "-hff" || arg == "--hf-file") {
  641. CHECK_ARG
  642. params.hf_file = argv[i];
  643. return true;
  644. }
  645. if (arg == "--lora") {
  646. CHECK_ARG
  647. params.lora_adapter.emplace_back(argv[i], 1.0f);
  648. params.use_mmap = false;
  649. return true;
  650. }
  651. if (arg == "--lora-scaled") {
  652. CHECK_ARG
  653. const char* lora_adapter = argv[i];
  654. CHECK_ARG
  655. params.lora_adapter.emplace_back(lora_adapter, std::stof(argv[i]));
  656. params.use_mmap = false;
  657. return true;
  658. }
  659. if (arg == "--lora-base") {
  660. CHECK_ARG
  661. params.lora_base = argv[i];
  662. return true;
  663. }
  664. if (arg == "--control-vector") {
  665. CHECK_ARG
  666. params.control_vectors.push_back({ 1.0f, argv[i], });
  667. return true;
  668. }
  669. if (arg == "--control-vector-scaled") {
  670. CHECK_ARG
  671. const char* fname = argv[i];
  672. CHECK_ARG
  673. params.control_vectors.push_back({ std::stof(argv[i]), fname, });
  674. return true;
  675. }
  676. if (arg == "--control-vector-layer-range") {
  677. CHECK_ARG
  678. params.control_vector_layer_start = std::stoi(argv[i]);
  679. CHECK_ARG
  680. params.control_vector_layer_end = std::stoi(argv[i]);
  681. return true;
  682. }
  683. if (arg == "--mmproj") {
  684. CHECK_ARG
  685. params.mmproj = argv[i];
  686. return true;
  687. }
  688. if (arg == "--image") {
  689. CHECK_ARG
  690. params.image.emplace_back(argv[i]);
  691. return true;
  692. }
  693. if (arg == "-i" || arg == "--interactive") {
  694. params.interactive = true;
  695. return true;
  696. }
  697. if (arg == "-sp" || arg == "--special") {
  698. params.special = true;
  699. return true;
  700. }
  701. if (arg == "--embedding" || arg == "--embeddings") {
  702. params.embedding = true;
  703. return true;
  704. }
  705. if (arg == "--embd-normalize") {
  706. CHECK_ARG
  707. params.embd_normalize = std::stoi(argv[i]);
  708. return true;
  709. }
  710. if (arg == "--embd-output-format") {
  711. CHECK_ARG
  712. params.embd_out = argv[i];
  713. return true;
  714. }
  715. if (arg == "--embd-separator") {
  716. CHECK_ARG
  717. params.embd_sep = argv[i];
  718. return true;
  719. }
  720. if (arg == "-if" || arg == "--interactive-first") {
  721. params.interactive_first = true;
  722. return true;
  723. }
  724. if (arg == "-cnv" || arg == "--conversation") {
  725. params.conversation = true;
  726. return true;
  727. }
  728. if (arg == "--infill") {
  729. params.infill = true;
  730. return true;
  731. }
  732. if (arg == "-dkvc" || arg == "--dump-kv-cache") {
  733. params.dump_kv_cache = true;
  734. return true;
  735. }
  736. if (arg == "-nkvo" || arg == "--no-kv-offload") {
  737. params.no_kv_offload = true;
  738. return true;
  739. }
  740. if (arg == "-ctk" || arg == "--cache-type-k") {
  741. params.cache_type_k = argv[++i];
  742. return true;
  743. }
  744. if (arg == "-ctv" || arg == "--cache-type-v") {
  745. params.cache_type_v = argv[++i];
  746. return true;
  747. }
  748. if (arg == "-mli" || arg == "--multiline-input") {
  749. params.multiline_input = true;
  750. return true;
  751. }
  752. if (arg == "--simple-io") {
  753. params.simple_io = true;
  754. return true;
  755. }
  756. if (arg == "-cb" || arg == "--cont-batching") {
  757. params.cont_batching = true;
  758. return true;
  759. }
  760. if (arg == "-fa" || arg == "--flash-attn") {
  761. params.flash_attn = true;
  762. return true;
  763. }
  764. if (arg == "-co" || arg == "--color") {
  765. params.use_color = true;
  766. return true;
  767. }
  768. if (arg == "--mlock") {
  769. params.use_mlock = true;
  770. return true;
  771. }
  772. if (arg == "-ngl" || arg == "--gpu-layers" || arg == "--n-gpu-layers") {
  773. CHECK_ARG
  774. params.n_gpu_layers = std::stoi(argv[i]);
  775. if (!llama_supports_gpu_offload()) {
  776. fprintf(stderr, "warning: not compiled with GPU offload support, --gpu-layers option will be ignored\n");
  777. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  778. }
  779. return true;
  780. }
  781. if (arg == "-ngld" || arg == "--gpu-layers-draft" || arg == "--gpu-layers-draft") {
  782. CHECK_ARG
  783. params.n_gpu_layers_draft = std::stoi(argv[i]);
  784. if (!llama_supports_gpu_offload()) {
  785. fprintf(stderr, "warning: not compiled with GPU offload support, --gpu-layers-draft option will be ignored\n");
  786. fprintf(stderr, "warning: see main README.md for information on enabling GPU BLAS support\n");
  787. }
  788. return true;
  789. }
  790. if (arg == "--main-gpu" || arg == "-mg") {
  791. CHECK_ARG
  792. params.main_gpu = std::stoi(argv[i]);
  793. #ifndef GGML_USE_CUDA_SYCL_VULKAN
  794. fprintf(stderr, "warning: llama.cpp was compiled without CUDA/SYCL/Vulkan. Setting the main GPU has no effect.\n");
  795. #endif // GGML_USE_CUDA_SYCL_VULKAN
  796. return true;
  797. }
  798. if (arg == "--split-mode" || arg == "-sm") {
  799. CHECK_ARG
  800. std::string arg_next = argv[i];
  801. if (arg_next == "none") {
  802. params.split_mode = LLAMA_SPLIT_MODE_NONE;
  803. }
  804. else if (arg_next == "layer") {
  805. params.split_mode = LLAMA_SPLIT_MODE_LAYER;
  806. }
  807. else if (arg_next == "row") {
  808. #ifdef GGML_USE_SYCL
  809. fprintf(stderr, "warning: The split mode value:[row] is not supported by llama.cpp with SYCL. It's developing.\nExit!\n");
  810. exit(1);
  811. #endif // GGML_USE_SYCL
  812. params.split_mode = LLAMA_SPLIT_MODE_ROW;
  813. }
  814. else {
  815. invalid_param = true;
  816. return true;
  817. }
  818. #ifndef GGML_USE_CUDA_SYCL_VULKAN
  819. fprintf(stderr, "warning: llama.cpp was compiled without CUDA/SYCL/Vulkan. Setting the split mode has no effect.\n");
  820. #endif // GGML_USE_CUDA_SYCL_VULKAN
  821. return true;
  822. }
  823. if (arg == "--tensor-split" || arg == "-ts") {
  824. CHECK_ARG
  825. std::string arg_next = argv[i];
  826. // split string by , and /
  827. const std::regex regex{ R"([,/]+)" };
  828. std::sregex_token_iterator it{ arg_next.begin(), arg_next.end(), regex, -1 };
  829. std::vector<std::string> split_arg{ it, {} };
  830. if (split_arg.size() >= llama_max_devices()) {
  831. invalid_param = true;
  832. return true;
  833. }
  834. for (size_t i = 0; i < llama_max_devices(); ++i) {
  835. if (i < split_arg.size()) {
  836. params.tensor_split[i] = std::stof(split_arg[i]);
  837. }
  838. else {
  839. params.tensor_split[i] = 0.0f;
  840. }
  841. }
  842. #ifndef GGML_USE_CUDA_SYCL_VULKAN
  843. fprintf(stderr, "warning: llama.cpp was compiled without CUDA/SYCL/Vulkan. Setting a tensor split has no effect.\n");
  844. #endif // GGML_USE_CUDA_SYCL_VULKAN
  845. return true;
  846. }
  847. if (arg == "--rpc") {
  848. CHECK_ARG
  849. params.rpc_servers = argv[i];
  850. return true;
  851. }
  852. if (arg == "--no-mmap") {
  853. params.use_mmap = false;
  854. return true;
  855. }
  856. if (arg == "--numa") {
  857. CHECK_ARG
  858. std::string value(argv[i]);
  859. /**/ if (value == "distribute" || value == "") { params.numa = GGML_NUMA_STRATEGY_DISTRIBUTE; }
  860. else if (value == "isolate") { params.numa = GGML_NUMA_STRATEGY_ISOLATE; }
  861. else if (value == "numactl") { params.numa = GGML_NUMA_STRATEGY_NUMACTL; }
  862. else { invalid_param = true; }
  863. return true;
  864. }
  865. if (arg == "-v" || arg == "--verbose") {
  866. params.verbosity = 1;
  867. return true;
  868. }
  869. if (arg == "--verbosity") {
  870. CHECK_ARG
  871. params.verbosity = std::stoi(argv[i]);
  872. return true;
  873. }
  874. if (arg == "--verbose-prompt") {
  875. params.verbose_prompt = true;
  876. return true;
  877. }
  878. if (arg == "--no-display-prompt") {
  879. params.display_prompt = false;
  880. return true;
  881. }
  882. if (arg == "-r" || arg == "--reverse-prompt") {
  883. CHECK_ARG
  884. params.antiprompt.emplace_back(argv[i]);
  885. return true;
  886. }
  887. if (arg == "-ld" || arg == "--logdir") {
  888. CHECK_ARG
  889. params.logdir = argv[i];
  890. if (params.logdir.back() != DIRECTORY_SEPARATOR) {
  891. params.logdir += DIRECTORY_SEPARATOR;
  892. }
  893. return true;
  894. }
  895. if (arg == "-lcs" || arg == "--lookup-cache-static") {
  896. CHECK_ARG
  897. params.lookup_cache_static = argv[i];
  898. return true;
  899. }
  900. if (arg == "-lcd" || arg == "--lookup-cache-dynamic") {
  901. CHECK_ARG
  902. params.lookup_cache_dynamic = argv[i];
  903. return true;
  904. }
  905. if (arg == "--save-all-logits" || arg == "--kl-divergence-base") {
  906. CHECK_ARG
  907. params.logits_file = argv[i];
  908. return true;
  909. }
  910. if (arg == "--perplexity" || arg == "--all-logits") {
  911. params.logits_all = true;
  912. return true;
  913. }
  914. if (arg == "--ppl-stride") {
  915. CHECK_ARG
  916. params.ppl_stride = std::stoi(argv[i]);
  917. return true;
  918. }
  919. if (arg == "--ppl-output-type") {
  920. CHECK_ARG
  921. params.ppl_output_type = std::stoi(argv[i]);
  922. return true;
  923. }
  924. if (arg == "-ptc" || arg == "--print-token-count") {
  925. CHECK_ARG
  926. params.n_print = std::stoi(argv[i]);
  927. return true;
  928. }
  929. if (arg == "--check-tensors") {
  930. params.check_tensors = true;
  931. return true;
  932. }
  933. if (arg == "--hellaswag") {
  934. params.hellaswag = true;
  935. return true;
  936. }
  937. if (arg == "--hellaswag-tasks") {
  938. CHECK_ARG
  939. params.hellaswag_tasks = std::stoi(argv[i]);
  940. return true;
  941. }
  942. if (arg == "--winogrande") {
  943. params.winogrande = true;
  944. return true;
  945. }
  946. if (arg == "--winogrande-tasks") {
  947. CHECK_ARG
  948. params.winogrande_tasks = std::stoi(argv[i]);
  949. return true;
  950. }
  951. if (arg == "--multiple-choice") {
  952. params.multiple_choice = true;
  953. return true;
  954. }
  955. if (arg == "--multiple-choice-tasks") {
  956. CHECK_ARG
  957. params.multiple_choice_tasks = std::stoi(argv[i]);
  958. return true;
  959. }
  960. if (arg == "--kl-divergence") {
  961. params.kl_divergence = true;
  962. return true;
  963. }
  964. if (arg == "--ignore-eos") {
  965. params.ignore_eos = true;
  966. return true;
  967. }
  968. if (arg == "--penalize-nl") {
  969. sparams.penalize_nl = true;
  970. return true;
  971. }
  972. if (arg == "-l" || arg == "--logit-bias") {
  973. CHECK_ARG
  974. std::stringstream ss(argv[i]);
  975. llama_token key;
  976. char sign;
  977. std::string value_str;
  978. try {
  979. if (ss >> key && ss >> sign && std::getline(ss, value_str) && (sign == '+' || sign == '-')) {
  980. sparams.logit_bias[key] = std::stof(value_str) * ((sign == '-') ? -1.0f : 1.0f);
  981. }
  982. else {
  983. throw std::exception();
  984. }
  985. }
  986. catch (const std::exception&) {
  987. invalid_param = true;
  988. return true;
  989. }
  990. return true;
  991. }
  992. if (arg == "-h" || arg == "--help" || arg == "--usage" ) {
  993. params.usage = true;
  994. return true;
  995. }
  996. if (arg == "--version") {
  997. fprintf(stderr, "version: %d (%s)\n", LLAMA_BUILD_NUMBER, LLAMA_COMMIT);
  998. fprintf(stderr, "built with %s for %s\n", LLAMA_COMPILER, LLAMA_BUILD_TARGET);
  999. exit(0);
  1000. }
  1001. if (arg == "--in-prefix-bos") {
  1002. params.input_prefix_bos = true;
  1003. params.enable_chat_template = false;
  1004. return true;
  1005. }
  1006. if (arg == "--in-prefix") {
  1007. CHECK_ARG
  1008. params.input_prefix = argv[i];
  1009. params.enable_chat_template = false;
  1010. return true;
  1011. }
  1012. if (arg == "--in-suffix") {
  1013. CHECK_ARG
  1014. params.input_suffix = argv[i];
  1015. params.enable_chat_template = false;
  1016. return true;
  1017. }
  1018. if (arg == "--spm-infill") {
  1019. params.spm_infill = true;
  1020. return true;
  1021. }
  1022. if (arg == "--grammar") {
  1023. CHECK_ARG
  1024. sparams.grammar = argv[i];
  1025. return true;
  1026. }
  1027. if (arg == "--grammar-file") {
  1028. CHECK_ARG
  1029. std::ifstream file(argv[i]);
  1030. if (!file) {
  1031. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  1032. invalid_param = true;
  1033. return true;
  1034. }
  1035. std::copy(
  1036. std::istreambuf_iterator<char>(file),
  1037. std::istreambuf_iterator<char>(),
  1038. std::back_inserter(sparams.grammar)
  1039. );
  1040. return true;
  1041. }
  1042. if (arg == "-j" || arg == "--json-schema") {
  1043. CHECK_ARG
  1044. sparams.grammar = json_schema_to_grammar(json::parse(argv[i]));
  1045. return true;
  1046. }
  1047. if (arg == "--override-kv") {
  1048. CHECK_ARG
  1049. if (!string_parse_kv_override(argv[i], params.kv_overrides)) {
  1050. fprintf(stderr, "error: Invalid type for KV override: %s\n", argv[i]);
  1051. invalid_param = true;
  1052. return true;
  1053. }
  1054. return true;
  1055. }
  1056. if (arg == "--host") {
  1057. CHECK_ARG
  1058. params.hostname = argv[i];
  1059. return true;
  1060. }
  1061. if (arg == "--port") {
  1062. CHECK_ARG
  1063. params.port = std::stoi(argv[i]);
  1064. return true;
  1065. }
  1066. if (arg == "--path") {
  1067. CHECK_ARG
  1068. params.public_path = argv[i];
  1069. return true;
  1070. }
  1071. if (arg == "--api-key") {
  1072. CHECK_ARG
  1073. params.api_keys.push_back(argv[i]);
  1074. return true;
  1075. }
  1076. if (arg == "--api-key-file") {
  1077. CHECK_ARG
  1078. std::ifstream key_file(argv[i]);
  1079. if (!key_file) {
  1080. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  1081. invalid_param = true;
  1082. return true;
  1083. }
  1084. std::string key;
  1085. while (std::getline(key_file, key)) {
  1086. if (!key.empty()) {
  1087. params.api_keys.push_back(key);
  1088. }
  1089. }
  1090. key_file.close();
  1091. return true;
  1092. }
  1093. if (arg == "--ssl-key-file") {
  1094. CHECK_ARG
  1095. params.ssl_file_key = argv[i];
  1096. return true;
  1097. }
  1098. if (arg == "--ssl-cert-file") {
  1099. CHECK_ARG
  1100. params.ssl_file_cert = argv[i];
  1101. return true;
  1102. }
  1103. if (arg == "--timeout" || arg == "-to") {
  1104. CHECK_ARG
  1105. params.timeout_read = std::stoi(argv[i]);
  1106. params.timeout_write = std::stoi(argv[i]);
  1107. return true;
  1108. }
  1109. if (arg == "--threads-http") {
  1110. CHECK_ARG
  1111. params.n_threads_http = std::stoi(argv[i]);
  1112. return true;
  1113. }
  1114. if (arg == "-spf" || arg == "--system-prompt-file") {
  1115. CHECK_ARG
  1116. std::ifstream file(argv[i]);
  1117. if (!file) {
  1118. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  1119. invalid_param = true;
  1120. return true;
  1121. }
  1122. std::string system_prompt;
  1123. std::copy(
  1124. std::istreambuf_iterator<char>(file),
  1125. std::istreambuf_iterator<char>(),
  1126. std::back_inserter(system_prompt)
  1127. );
  1128. params.system_prompt = system_prompt;
  1129. return true;
  1130. }
  1131. if (arg == "--log-format") {
  1132. CHECK_ARG
  1133. if (std::strcmp(argv[i], "json") == 0) {
  1134. params.log_json = true;
  1135. } else if (std::strcmp(argv[i], "text") == 0) {
  1136. params.log_json = false;
  1137. } else {
  1138. invalid_param = true;
  1139. return true;
  1140. }
  1141. return true;
  1142. }
  1143. if (arg == "--no-slots") {
  1144. params.endpoint_slots = false;
  1145. return true;
  1146. }
  1147. if (arg == "--metrics") {
  1148. params.endpoint_metrics = true;
  1149. return true;
  1150. }
  1151. if (arg == "--slot-save-path") {
  1152. CHECK_ARG
  1153. params.slot_save_path = argv[i];
  1154. // if doesn't end with DIRECTORY_SEPARATOR, add it
  1155. if (!params.slot_save_path.empty() && params.slot_save_path[params.slot_save_path.size() - 1] != DIRECTORY_SEPARATOR) {
  1156. params.slot_save_path += DIRECTORY_SEPARATOR;
  1157. }
  1158. return true;
  1159. }
  1160. if (arg == "--chat-template") {
  1161. CHECK_ARG
  1162. if (!llama_chat_verify_template(argv[i])) {
  1163. fprintf(stderr, "error: the supplied chat template is not supported: %s\n", argv[i]);
  1164. fprintf(stderr, "note: llama.cpp does not use jinja parser, we only support commonly used templates\n");
  1165. invalid_param = true;
  1166. return true;
  1167. }
  1168. params.chat_template = argv[i];
  1169. return true;
  1170. }
  1171. if (arg == "--slot-prompt-similarity" || arg == "-sps") {
  1172. CHECK_ARG
  1173. params.slot_prompt_similarity = std::stof(argv[i]);
  1174. return true;
  1175. }
  1176. if (arg == "-pps") {
  1177. params.is_pp_shared = true;
  1178. return true;
  1179. }
  1180. if (arg == "-npp") {
  1181. CHECK_ARG
  1182. auto p = string_split<int>(argv[i], split_delim);
  1183. params.n_pp.insert(params.n_pp.end(), p.begin(), p.end());
  1184. return true;
  1185. }
  1186. if (arg == "-ntg") {
  1187. CHECK_ARG
  1188. auto p = string_split<int>(argv[i], split_delim);
  1189. params.n_tg.insert(params.n_tg.end(), p.begin(), p.end());
  1190. return true;
  1191. }
  1192. if (arg == "-npl") {
  1193. CHECK_ARG
  1194. auto p = string_split<int>(argv[i], split_delim);
  1195. params.n_pl.insert(params.n_pl.end(), p.begin(), p.end());
  1196. return true;
  1197. }
  1198. if (arg == "--context-file") {
  1199. CHECK_ARG
  1200. std::ifstream file(argv[i], std::ios::binary);
  1201. if (!file) {
  1202. fprintf(stderr, "error: failed to open file '%s'\n", argv[i]);
  1203. invalid_param = true;
  1204. return true;
  1205. }
  1206. params.context_files.push_back(argv[i]);
  1207. return true;
  1208. }
  1209. if (arg == "--chunk-size") {
  1210. CHECK_ARG
  1211. params.chunk_size = std::stoi(argv[i]);
  1212. return true;
  1213. }
  1214. if (arg == "--chunk-separator") {
  1215. CHECK_ARG
  1216. params.chunk_separator = argv[i];
  1217. return true;
  1218. }
  1219. if (arg == "--junk") {
  1220. CHECK_ARG
  1221. params.n_junk = std::stoi(argv[i]);
  1222. return true;
  1223. }
  1224. if (arg == "--pos") {
  1225. CHECK_ARG
  1226. params.i_pos = std::stoi(argv[i]);
  1227. return true;
  1228. }
  1229. if (arg == "-o" || arg == "--output" || arg == "--output-file") {
  1230. CHECK_ARG
  1231. params.out_file = argv[i];
  1232. params.cvector_outfile = argv[i];
  1233. return true;
  1234. }
  1235. if (arg == "-ofreq" || arg == "--output-frequency") {
  1236. CHECK_ARG
  1237. params.n_out_freq = std::stoi(argv[i]);
  1238. return true;
  1239. }
  1240. if (arg == "--save-frequency") {
  1241. CHECK_ARG
  1242. params.n_save_freq = std::stoi(argv[i]);
  1243. return true;
  1244. }
  1245. if (arg == "--process-output") {
  1246. params.process_output = true;
  1247. return true;
  1248. }
  1249. if (arg == "--no-ppl") {
  1250. params.compute_ppl = false;
  1251. return true;
  1252. }
  1253. if (arg == "--chunk" || arg == "--from-chunk") {
  1254. CHECK_ARG
  1255. params.i_chunk = std::stoi(argv[i]);
  1256. return true;
  1257. }
  1258. // cvector params
  1259. if (arg == "--positive-file") {
  1260. CHECK_ARG
  1261. params.cvector_positive_file = argv[i];
  1262. return true;
  1263. }
  1264. if (arg == "--negative-file") {
  1265. CHECK_ARG
  1266. params.cvector_negative_file = argv[i];
  1267. return true;
  1268. }
  1269. if (arg == "--pca-batch") {
  1270. CHECK_ARG
  1271. params.n_pca_batch = std::stoi(argv[i]);
  1272. return true;
  1273. }
  1274. if (arg == "--pca-iter") {
  1275. CHECK_ARG
  1276. params.n_pca_iterations = std::stoi(argv[i]);
  1277. return true;
  1278. }
  1279. if (arg == "--method") {
  1280. CHECK_ARG
  1281. std::string value(argv[i]);
  1282. /**/ if (value == "pca") { params.cvector_dimre_method = DIMRE_METHOD_PCA; }
  1283. else if (value == "mean") { params.cvector_dimre_method = DIMRE_METHOD_MEAN; }
  1284. else { invalid_param = true; }
  1285. return true;
  1286. }
  1287. #ifndef LOG_DISABLE_LOGS
  1288. // Parse args for logging parameters
  1289. if (log_param_single_parse(argv[i])) {
  1290. // Do nothing, log_param_single_parse automatically does it's thing
  1291. // and returns if a match was found and parsed.
  1292. return true;
  1293. }
  1294. if (log_param_pair_parse( /*check_but_dont_parse*/ true, argv[i])) {
  1295. // We have a matching known parameter requiring an argument,
  1296. // now we need to check if there is anything after this argv
  1297. // and flag invalid_param or parse it.
  1298. CHECK_ARG
  1299. if (!log_param_pair_parse( /*check_but_dont_parse*/ false, argv[i - 1], argv[i])) {
  1300. invalid_param = true;
  1301. return true;
  1302. }
  1303. return true;
  1304. }
  1305. // End of Parse args for logging parameters
  1306. #endif // LOG_DISABLE_LOGS
  1307. return false;
  1308. }
  1309. #ifdef __GNUC__
  1310. #ifdef __MINGW32__
  1311. #define LLAMA_COMMON_ATTRIBUTE_FORMAT(...) __attribute__((format(gnu_printf, __VA_ARGS__)))
  1312. #else
  1313. #define LLAMA_COMMON_ATTRIBUTE_FORMAT(...) __attribute__((format(printf, __VA_ARGS__)))
  1314. #endif
  1315. #else
  1316. #define LLAMA_COMMON_ATTRIBUTE_FORMAT(...)
  1317. #endif
  1318. void gpt_params_print_usage(int /*argc*/, char ** argv, const gpt_params & params) {
  1319. const llama_sampling_params & sparams = params.sparams;
  1320. std::string sampler_type_chars;
  1321. std::string sampler_type_names;
  1322. for (const auto sampler_type : sparams.samplers_sequence) {
  1323. sampler_type_chars += static_cast<char>(sampler_type);
  1324. sampler_type_names += llama_sampling_type_to_str(sampler_type) + ";";
  1325. }
  1326. sampler_type_names.pop_back();
  1327. struct option_info {
  1328. LLAMA_COMMON_ATTRIBUTE_FORMAT(4, 5)
  1329. option_info(const std::string & tags, const char * args, const char * desc, ...) : tags(tags), args(args), desc(desc) {
  1330. va_list args_list;
  1331. va_start(args_list, desc);
  1332. char buffer[1024];
  1333. vsnprintf(buffer, sizeof(buffer), desc, args_list);
  1334. va_end(args_list);
  1335. this->desc = buffer;
  1336. }
  1337. option_info(const std::string & grp) : grp(grp) {}
  1338. std::string tags;
  1339. std::string args;
  1340. std::string desc;
  1341. std::string grp;
  1342. };
  1343. std::vector<option_info> options;
  1344. // TODO: filter by tags
  1345. options.push_back({ "general" });
  1346. options.push_back({ "*", "-h, --help, --usage", "print usage and exit" });
  1347. options.push_back({ "*", " --version", "show version and build info" });
  1348. options.push_back({ "*", "-v, --verbose", "print verbose information" });
  1349. options.push_back({ "*", " --verbosity N", "set specific verbosity level (default: %d)", params.verbosity });
  1350. options.push_back({ "*", " --verbose-prompt", "print a verbose prompt before generation (default: %s)", params.verbose_prompt ? "true" : "false" });
  1351. options.push_back({ "*", " --no-display-prompt", "don't print prompt at generation (default: %s)", !params.display_prompt ? "true" : "false" });
  1352. options.push_back({ "*", "-co, --color", "colorise output to distinguish prompt and user input from generations (default: %s)", params.use_color ? "true" : "false" });
  1353. options.push_back({ "*", "-s, --seed SEED", "RNG seed (default: %d, use random seed for < 0)", params.seed });
  1354. options.push_back({ "*", "-t, --threads N", "number of threads to use during generation (default: %d)", params.n_threads });
  1355. options.push_back({ "*", "-tb, --threads-batch N", "number of threads to use during batch and prompt processing (default: same as --threads)" });
  1356. options.push_back({ "speculative", "-td, --threads-draft N", "number of threads to use during generation (default: same as --threads)" });
  1357. options.push_back({ "speculative", "-tbd, --threads-batch-draft N",
  1358. "number of threads to use during batch and prompt processing (default: same as --threads-draft)" });
  1359. options.push_back({ "speculative", " --draft N", "number of tokens to draft for speculative decoding (default: %d)", params.n_draft });
  1360. options.push_back({ "speculative", "-ps, --p-split N", "speculative decoding split probability (default: %.1f)", (double)params.p_split });
  1361. options.push_back({ "*", "-lcs, --lookup-cache-static FNAME",
  1362. "path to static lookup cache to use for lookup decoding (not updated by generation)" });
  1363. options.push_back({ "*", "-lcd, --lookup-cache-dynamic FNAME",
  1364. "path to dynamic lookup cache to use for lookup decoding (updated by generation)" });
  1365. options.push_back({ "*", "-c, --ctx-size N", "size of the prompt context (default: %d, 0 = loaded from model)", params.n_ctx });
  1366. options.push_back({ "*", "-n, --predict N", "number of tokens to predict (default: %d, -1 = infinity, -2 = until context filled)", params.n_predict });
  1367. options.push_back({ "*", "-b, --batch-size N", "logical maximum batch size (default: %d)", params.n_batch });
  1368. options.push_back({ "*", "-ub, --ubatch-size N", "physical maximum batch size (default: %d)", params.n_ubatch });
  1369. options.push_back({ "*", " --keep N", "number of tokens to keep from the initial prompt (default: %d, -1 = all)", params.n_keep });
  1370. options.push_back({ "*", " --chunks N", "max number of chunks to process (default: %d, -1 = all)", params.n_chunks });
  1371. options.push_back({ "*", "-fa, --flash-attn", "enable Flash Attention (default: %s)", params.flash_attn ? "enabled" : "disabled" });
  1372. options.push_back({ "*", "-p, --prompt PROMPT", "prompt to start generation with\n"
  1373. "in conversation mode, this will be used as system prompt\n"
  1374. "(default: '%s')", params.prompt.c_str() });
  1375. options.push_back({ "*", "-f, --file FNAME", "a file containing the prompt (default: none)" });
  1376. options.push_back({ "*", " --in-file FNAME", "an input file (repeat to specify multiple files)" });
  1377. options.push_back({ "*", "-bf, --binary-file FNAME", "binary file containing the prompt (default: none)" });
  1378. options.push_back({ "*", "-e, --escape", "process escapes sequences (\\n, \\r, \\t, \\', \\\", \\\\) (default: %s)", params.escape ? "true" : "false" });
  1379. options.push_back({ "*", " --no-escape", "do not process escape sequences" });
  1380. options.push_back({ "main", "-ptc, --print-token-count N", "print token count every N tokens (default: %d)", params.n_print });
  1381. options.push_back({ "main", " --prompt-cache FNAME", "file to cache prompt state for faster startup (default: none)" });
  1382. options.push_back({ "main", " --prompt-cache-all", "if specified, saves user input and generations to cache as well\n"
  1383. "not supported with --interactive or other interactive options" });
  1384. options.push_back({ "main", " --prompt-cache-ro", "if specified, uses the prompt cache but does not update it" });
  1385. options.push_back({ "main", "-r, --reverse-prompt PROMPT",
  1386. "halt generation at PROMPT, return control in interactive mode\n"
  1387. "can be specified more than once for multiple prompts" });
  1388. options.push_back({ "main", "-sp, --special", "special tokens output enabled (default: %s)", params.special ? "true" : "false" });
  1389. options.push_back({ "main", "-cnv, --conversation", "run in conversation mode, does not print special tokens and suffix/prefix\n"
  1390. "if suffix/prefix are not specified, default chat template will be used\n"
  1391. "(default: %s)", params.conversation ? "true" : "false" });
  1392. options.push_back({ "main infill", "-i, --interactive", "run in interactive mode (default: %s)", params.interactive ? "true" : "false" });
  1393. options.push_back({ "main infill", "-if, --interactive-first", "run in interactive mode and wait for input right away (default: %s)", params.interactive_first ? "true" : "false" });
  1394. options.push_back({ "main infill", "-mli, --multiline-input", "allows you to write or paste multiple lines without ending each in '\\'" });
  1395. options.push_back({ "main infill", " --in-prefix-bos", "prefix BOS to user inputs, preceding the `--in-prefix` string" });
  1396. options.push_back({ "main infill", " --in-prefix STRING", "string to prefix user inputs with (default: empty)" });
  1397. options.push_back({ "main infill", " --in-suffix STRING", "string to suffix after user inputs with (default: empty)" });
  1398. options.push_back({ "server infill",
  1399. " --spm-infill", "use Suffix/Prefix/Middle pattern for infill (instead of Prefix/Suffix/Middle) as some models prefer this. (default: %s)", params.spm_infill ? "enabled" : "disabled" });
  1400. options.push_back({ "sampling" });
  1401. options.push_back({ "*", " --samplers SAMPLERS", "samplers that will be used for generation in the order, separated by \';\'\n"
  1402. "(default: %s)", sampler_type_names.c_str() });
  1403. options.push_back({ "*", " --sampling-seq SEQUENCE",
  1404. "simplified sequence for samplers that will be used (default: %s)", sampler_type_chars.c_str() });
  1405. options.push_back({ "*", " --ignore-eos", "ignore end of stream token and continue generating (implies --logit-bias EOS-inf)" });
  1406. options.push_back({ "*", " --penalize-nl", "penalize newline tokens (default: %s)", sparams.penalize_nl ? "true" : "false" });
  1407. options.push_back({ "*", " --temp N", "temperature (default: %.1f)", (double)sparams.temp });
  1408. options.push_back({ "*", " --top-k N", "top-k sampling (default: %d, 0 = disabled)", sparams.top_k });
  1409. options.push_back({ "*", " --top-p N", "top-p sampling (default: %.1f, 1.0 = disabled)", (double)sparams.top_p });
  1410. options.push_back({ "*", " --min-p N", "min-p sampling (default: %.1f, 0.0 = disabled)", (double)sparams.min_p });
  1411. options.push_back({ "*", " --tfs N", "tail free sampling, parameter z (default: %.1f, 1.0 = disabled)", (double)sparams.tfs_z });
  1412. options.push_back({ "*", " --typical N", "locally typical sampling, parameter p (default: %.1f, 1.0 = disabled)", (double)sparams.typical_p });
  1413. options.push_back({ "*", " --repeat-last-n N", "last n tokens to consider for penalize (default: %d, 0 = disabled, -1 = ctx_size)", sparams.penalty_last_n });
  1414. options.push_back({ "*", " --repeat-penalty N", "penalize repeat sequence of tokens (default: %.1f, 1.0 = disabled)", (double)sparams.penalty_repeat });
  1415. options.push_back({ "*", " --presence-penalty N", "repeat alpha presence penalty (default: %.1f, 0.0 = disabled)", (double)sparams.penalty_present });
  1416. options.push_back({ "*", " --frequency-penalty N", "repeat alpha frequency penalty (default: %.1f, 0.0 = disabled)", (double)sparams.penalty_freq });
  1417. options.push_back({ "*", " --dynatemp-range N", "dynamic temperature range (default: %.1f, 0.0 = disabled)", (double)sparams.dynatemp_range });
  1418. options.push_back({ "*", " --dynatemp-exp N", "dynamic temperature exponent (default: %.1f)", (double)sparams.dynatemp_exponent });
  1419. options.push_back({ "*", " --mirostat N", "use Mirostat sampling.\n"
  1420. "Top K, Nucleus, Tail Free and Locally Typical samplers are ignored if used.\n"
  1421. "(default: %d, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0)", sparams.mirostat });
  1422. options.push_back({ "*", " --mirostat-lr N", "Mirostat learning rate, parameter eta (default: %.1f)", (double)sparams.mirostat_eta });
  1423. options.push_back({ "*", " --mirostat-ent N", "Mirostat target entropy, parameter tau (default: %.1f)", (double)sparams.mirostat_tau });
  1424. options.push_back({ "*", " -l TOKEN_ID(+/-)BIAS", "modifies the likelihood of token appearing in the completion,\n"
  1425. "i.e. `--logit-bias 15043+1` to increase likelihood of token ' Hello',\n"
  1426. "or `--logit-bias 15043-1` to decrease likelihood of token ' Hello'" });
  1427. options.push_back({ "main", " --cfg-negative-prompt PROMPT",
  1428. "negative prompt to use for guidance (default: '%s')", sparams.cfg_negative_prompt.c_str() });
  1429. options.push_back({ "main", " --cfg-negative-prompt-file FNAME",
  1430. "negative prompt file to use for guidance" });
  1431. options.push_back({ "main", " --cfg-scale N", "strength of guidance (default: %.1f, 1.0 = disable)", (double)sparams.cfg_scale });
  1432. options.push_back({ "main", " --chat-template JINJA_TEMPLATE",
  1433. "set custom jinja chat template (default: template taken from model's metadata)\n"
  1434. "if suffix/prefix are specified, template will be disabled\n"
  1435. "only commonly used templates are accepted:\n"
  1436. "https://github.com/ggerganov/llama.cpp/wiki/Templates-supported-by-llama_chat_apply_template" });
  1437. options.push_back({ "grammar" });
  1438. options.push_back({ "*", " --grammar GRAMMAR", "BNF-like grammar to constrain generations (see samples in grammars/ dir) (default: '%s')", sparams.grammar.c_str() });
  1439. options.push_back({ "*", " --grammar-file FNAME", "file to read grammar from" });
  1440. options.push_back({ "*", "-j, --json-schema SCHEMA",
  1441. "JSON schema to constrain generations (https://json-schema.org/), e.g. `{}` for any JSON object\n"
  1442. "For schemas w/ external $refs, use --grammar + example/json_schema_to_grammar.py instead" });
  1443. options.push_back({ "embedding" });
  1444. options.push_back({ "embedding", " --pooling {none,mean,cls,last}",
  1445. "pooling type for embeddings, use model default if unspecified" });
  1446. options.push_back({ "embedding", " --attention {causal,non-causal}",
  1447. "attention type for embeddings, use model default if unspecified" });
  1448. options.push_back({ "context hacking" });
  1449. options.push_back({ "*", " --rope-scaling {none,linear,yarn}",
  1450. "RoPE frequency scaling method, defaults to linear unless specified by the model" });
  1451. options.push_back({ "*", " --rope-scale N", "RoPE context scaling factor, expands context by a factor of N" });
  1452. options.push_back({ "*", " --rope-freq-base N", "RoPE base frequency, used by NTK-aware scaling (default: loaded from model)" });
  1453. options.push_back({ "*", " --rope-freq-scale N", "RoPE frequency scaling factor, expands context by a factor of 1/N" });
  1454. options.push_back({ "*", " --yarn-orig-ctx N", "YaRN: original context size of model (default: %d = model training context size)", params.yarn_orig_ctx });
  1455. options.push_back({ "*", " --yarn-ext-factor N", "YaRN: extrapolation mix factor (default: %.1f, 0.0 = full interpolation)", (double)params.yarn_ext_factor });
  1456. options.push_back({ "*", " --yarn-attn-factor N", "YaRN: scale sqrt(t) or attention magnitude (default: %.1f)", (double)params.yarn_attn_factor });
  1457. options.push_back({ "*", " --yarn-beta-slow N", "YaRN: high correction dim or alpha (default: %.1f)", (double)params.yarn_beta_slow });
  1458. options.push_back({ "*", " --yarn-beta-fast N", "YaRN: low correction dim or beta (default: %.1f)", (double)params.yarn_beta_fast });
  1459. options.push_back({ "*", "-gan, --grp-attn-n N", "group-attention factor (default: %d)", params.grp_attn_n });
  1460. options.push_back({ "*", "-gaw, --grp-attn-w N", "group-attention width (default: %.1f)", (double)params.grp_attn_w });
  1461. options.push_back({ "*", "-dkvc, --dump-kv-cache", "verbose print of the KV cache" });
  1462. options.push_back({ "*", "-nkvo, --no-kv-offload", "disable KV offload" });
  1463. options.push_back({ "*", "-ctk, --cache-type-k TYPE", "KV cache data type for K (default: %s)", params.cache_type_k.c_str() });
  1464. options.push_back({ "*", "-ctv, --cache-type-v TYPE", "KV cache data type for V (default: %s)", params.cache_type_v.c_str() });
  1465. options.push_back({ "perplexity" });
  1466. options.push_back({ "perplexity", " --all-logits", "return logits for all tokens in the batch (default: %s)", params.logits_all ? "true" : "false" });
  1467. options.push_back({ "perplexity", " --hellaswag", "compute HellaSwag score over random tasks from datafile supplied with -f" });
  1468. options.push_back({ "perplexity", " --hellaswag-tasks N", "number of tasks to use when computing the HellaSwag score (default: %zu)", params.hellaswag_tasks });
  1469. options.push_back({ "perplexity", " --winogrande", "compute Winogrande score over random tasks from datafile supplied with -f" });
  1470. options.push_back({ "perplexity", " --winogrande-tasks N", "number of tasks to use when computing the Winogrande score (default: %zu)", params.winogrande_tasks });
  1471. options.push_back({ "perplexity", " --multiple-choice", "compute multiple choice score over random tasks from datafile supplied with -f" });
  1472. options.push_back({ "perplexity", " --multiple-choice-tasks N",
  1473. "number of tasks to use when computing the multiple choice score (default: %zu)", params.multiple_choice_tasks });
  1474. options.push_back({ "perplexity", " --kl-divergence", "computes KL-divergence to logits provided via --kl-divergence-base" });
  1475. options.push_back({ "perplexity", " --ppl-stride N", "stride for perplexity calculation (default: %d)", params.ppl_stride });
  1476. options.push_back({ "perplexity", " --ppl-output-type {0,1}",
  1477. "output type for perplexity calculation (default: %d)", params.ppl_output_type });
  1478. options.push_back({ "parallel" });
  1479. options.push_back({ "*", "-dt, --defrag-thold N", "KV cache defragmentation threshold (default: %.1f, < 0 - disabled)", (double)params.defrag_thold });
  1480. options.push_back({ "*", "-np, --parallel N", "number of parallel sequences to decode (default: %d)", params.n_parallel });
  1481. options.push_back({ "*", "-ns, --sequences N", "number of sequences to decode (default: %d)", params.n_sequences });
  1482. options.push_back({ "*", "-cb, --cont-batching", "enable continuous batching (a.k.a dynamic batching) (default: %s)", params.cont_batching ? "enabled" : "disabled" });
  1483. options.push_back({ "multi-modality" });
  1484. options.push_back({ "*", " --mmproj FILE", "path to a multimodal projector file for LLaVA. see examples/llava/README.md" });
  1485. options.push_back({ "*", " --image FILE", "path to an image file. use with multimodal models. Specify multiple times for batching" });
  1486. options.push_back({ "backend" });
  1487. options.push_back({ "*", " --rpc SERVERS", "comma separated list of RPC servers" });
  1488. if (llama_supports_mlock()) {
  1489. options.push_back({ "*", " --mlock", "force system to keep model in RAM rather than swapping or compressing" });
  1490. }
  1491. if (llama_supports_mmap()) {
  1492. options.push_back({ "*", " --no-mmap", "do not memory-map model (slower load but may reduce pageouts if not using mlock)" });
  1493. }
  1494. options.push_back({ "*", " --numa TYPE", "attempt optimizations that help on some NUMA systems\n"
  1495. " - distribute: spread execution evenly over all nodes\n"
  1496. " - isolate: only spawn threads on CPUs on the node that execution started on\n"
  1497. " - numactl: use the CPU map provided by numactl\n"
  1498. "if run without this previously, it is recommended to drop the system page cache before using this\n"
  1499. "see https://github.com/ggerganov/llama.cpp/issues/1437" });
  1500. if (llama_supports_gpu_offload()) {
  1501. options.push_back({ "*", "-ngl, --gpu-layers N",
  1502. "number of layers to store in VRAM" });
  1503. options.push_back({ "*", "-ngld, --gpu-layers-draft N",
  1504. "number of layers to store in VRAM for the draft model" });
  1505. options.push_back({ "*", "-sm, --split-mode SPLIT_MODE",
  1506. "how to split the model across multiple GPUs, one of:\n"
  1507. " - none: use one GPU only\n"
  1508. " - layer (default): split layers and KV across GPUs\n"
  1509. " - row: split rows across GPUs" });
  1510. options.push_back({ "*", "-ts, --tensor-split SPLIT",
  1511. "fraction of the model to offload to each GPU, comma-separated list of proportions, e.g. 3,1" });
  1512. options.push_back({ "*", "-mg, --main-gpu i", "the GPU to use for the model (with split-mode = none),\n"
  1513. "or for intermediate results and KV (with split-mode = row) (default: %d)", params.main_gpu });
  1514. }
  1515. options.push_back({ "model" });
  1516. options.push_back({ "*", " --check-tensors", "check model tensor data for invalid values (default: %s)", params.check_tensors ? "true" : "false" });
  1517. options.push_back({ "*", " --override-kv KEY=TYPE:VALUE",
  1518. "advanced option to override model metadata by key. may be specified multiple times.\n"
  1519. "types: int, float, bool, str. example: --override-kv tokenizer.ggml.add_bos_token=bool:false" });
  1520. options.push_back({ "*", " --lora FNAME", "apply LoRA adapter (implies --no-mmap)" });
  1521. options.push_back({ "*", " --lora-scaled FNAME S", "apply LoRA adapter with user defined scaling S (implies --no-mmap)" });
  1522. options.push_back({ "*", " --lora-base FNAME", "optional model to use as a base for the layers modified by the LoRA adapter" });
  1523. options.push_back({ "*", " --control-vector FNAME", "add a control vector\n"
  1524. "note: this argument can be repeated to add multiple control vectors" });
  1525. options.push_back({ "*", " --control-vector-scaled FNAME SCALE",
  1526. "add a control vector with user defined scaling SCALE\n"
  1527. "note: this argument can be repeated to add multiple scaled control vectors" });
  1528. options.push_back({ "*", " --control-vector-layer-range START END",
  1529. "layer range to apply the control vector(s) to, start and end inclusive" });
  1530. options.push_back({ "*", "-m, --model FNAME", "model path (default: models/$filename with filename from --hf-file\n"
  1531. "or --model-url if set, otherwise %s)", DEFAULT_MODEL_PATH });
  1532. options.push_back({ "*", "-md, --model-draft FNAME", "draft model for speculative decoding (default: unused)" });
  1533. options.push_back({ "*", "-mu, --model-url MODEL_URL", "model download url (default: unused)" });
  1534. options.push_back({ "*", "-hfr, --hf-repo REPO", "Hugging Face model repository (default: unused)" });
  1535. options.push_back({ "*", "-hff, --hf-file FILE", "Hugging Face model file (default: unused)" });
  1536. options.push_back({ "*", "-hft, --hf-token TOKEN", "Hugging Face access token (default: value from HF_TOKEN environment variable)" });
  1537. options.push_back({ "retrieval" });
  1538. options.push_back({ "retrieval", " --context-file FNAME", "file to load context from (repeat to specify multiple files)" });
  1539. options.push_back({ "retrieval", " --chunk-size N", "minimum length of embedded text chunks (default: %d)", params.chunk_size });
  1540. options.push_back({ "retrieval", " --chunk-separator STRING",
  1541. "separator between chunks (default: '%s')", params.chunk_separator.c_str() });
  1542. options.push_back({ "passkey" });
  1543. options.push_back({ "passkey", " --junk N", "number of times to repeat the junk text (default: %d)", params.n_junk });
  1544. options.push_back({ "passkey", " --pos N", "position of the passkey in the junk text (default: %d)", params.i_pos });
  1545. options.push_back({ "imatrix" });
  1546. options.push_back({ "imatrix", "-o, --output FNAME", "output file (default: '%s')", params.out_file.c_str() });
  1547. options.push_back({ "imatrix", " --output-frequency N", "output the imatrix every N iterations (default: %d)", params.n_out_freq });
  1548. options.push_back({ "imatrix", " --save-frequency N", "save an imatrix copy every N iterations (default: %d)", params.n_save_freq });
  1549. options.push_back({ "imatrix", " --process-output", "collect data for the output tensor (default: %s)", params.process_output ? "true" : "false" });
  1550. options.push_back({ "imatrix", " --no-ppl", "do not compute perplexity (default: %s)", params.compute_ppl ? "true" : "false" });
  1551. options.push_back({ "imatrix", " --chunk N", "start processing the input from chunk N (default: %d)", params.i_chunk });
  1552. options.push_back({ "bench" });
  1553. options.push_back({ "bench", "-pps", "is the prompt shared across parallel sequences (default: %s)", params.is_pp_shared ? "true" : "false" });
  1554. options.push_back({ "bench", "-npp n0,n1,...", "number of prompt tokens" });
  1555. options.push_back({ "bench", "-ntg n0,n1,...", "number of text generation tokens" });
  1556. options.push_back({ "bench", "-npl n0,n1,...", "number of parallel prompts" });
  1557. options.push_back({ "embedding" });
  1558. options.push_back({ "embedding", " --embd-normalize", "normalisation for embendings (default: %d) (-1=none, 0=max absolute int16, 1=taxicab, 2=euclidean, >2=p-norm)", params.embd_normalize });
  1559. options.push_back({ "embedding", " --embd-output-format", "empty = default, \"array\" = [[],[]...], \"json\" = openai style, \"json+\" = same \"json\" + cosine similarity matrix" });
  1560. options.push_back({ "embedding", " --embd-separator", "separator of embendings (default \\n) for example \"<#sep#>\"" });
  1561. options.push_back({ "server" });
  1562. options.push_back({ "server", " --host HOST", "ip address to listen (default: %s)", params.hostname.c_str() });
  1563. options.push_back({ "server", " --port PORT", "port to listen (default: %d)", params.port });
  1564. options.push_back({ "server", " --path PATH", "path to serve static files from (default: %s)", params.public_path.c_str() });
  1565. options.push_back({ "server", " --embedding(s)", "enable embedding endpoint (default: %s)", params.embedding ? "enabled" : "disabled" });
  1566. options.push_back({ "server", " --api-key KEY", "API key to use for authentication (default: none)" });
  1567. options.push_back({ "server", " --api-key-file FNAME", "path to file containing API keys (default: none)" });
  1568. options.push_back({ "server", " --ssl-key-file FNAME", "path to file a PEM-encoded SSL private key" });
  1569. options.push_back({ "server", " --ssl-cert-file FNAME", "path to file a PEM-encoded SSL certificate" });
  1570. options.push_back({ "server", " --timeout N", "server read/write timeout in seconds (default: %d)", params.timeout_read });
  1571. options.push_back({ "server", " --threads-http N", "number of threads used to process HTTP requests (default: %d)", params.n_threads_http });
  1572. options.push_back({ "server", " --system-prompt-file FNAME",
  1573. "set a file to load a system prompt (initial prompt of all slots), this is useful for chat applications" });
  1574. options.push_back({ "server", " --log-format {text,json}",
  1575. "log output format: json or text (default: json)" });
  1576. options.push_back({ "server", " --metrics", "enable prometheus compatible metrics endpoint (default: %s)", params.endpoint_metrics ? "enabled" : "disabled" });
  1577. options.push_back({ "server", " --no-slots", "disables slots monitoring endpoint (default: %s)", params.endpoint_slots ? "enabled" : "disabled" });
  1578. options.push_back({ "server", " --slot-save-path PATH", "path to save slot kv cache (default: disabled)" });
  1579. options.push_back({ "server", " --chat-template JINJA_TEMPLATE",
  1580. "set custom jinja chat template (default: template taken from model's metadata)\n"
  1581. "only commonly used templates are accepted:\n"
  1582. "https://github.com/ggerganov/llama.cpp/wiki/Templates-supported-by-llama_chat_apply_template" });
  1583. options.push_back({ "server", "-sps, --slot-prompt-similarity SIMILARITY",
  1584. "how much the prompt of a request must match the prompt of a slot in order to use that slot (default: %.2f, 0.0 = disabled)\n", params.slot_prompt_similarity });
  1585. #ifndef LOG_DISABLE_LOGS
  1586. options.push_back({ "logging" });
  1587. options.push_back({ "*", " --simple-io", "use basic IO for better compatibility in subprocesses and limited consoles" });
  1588. options.push_back({ "*", "-ld, --logdir LOGDIR", "path under which to save YAML logs (no logging if unset)" });
  1589. options.push_back({ "logging", " --log-test", "Run simple logging test" });
  1590. options.push_back({ "logging", " --log-disable", "Disable trace logs" });
  1591. options.push_back({ "logging", " --log-enable", "Enable trace logs" });
  1592. options.push_back({ "logging", " --log-file FNAME", "Specify a log filename (without extension)" });
  1593. options.push_back({ "logging", " --log-new", "Create a separate new log file on start. "
  1594. "Each log file will have unique name: \"<name>.<ID>.log\"" });
  1595. options.push_back({ "logging", " --log-append", "Don't truncate the old log file." });
  1596. #endif // LOG_DISABLE_LOGS
  1597. options.push_back({ "cvector" });
  1598. options.push_back({ "cvector", "-o, --output FNAME", "output file (default: '%s')", params.cvector_outfile.c_str() });
  1599. options.push_back({ "cvector", " --positive-file FNAME", "positive prompts file, one prompt per line (default: '%s')", params.cvector_positive_file.c_str() });
  1600. options.push_back({ "cvector", " --negative-file FNAME", "negative prompts file, one prompt per line (default: '%s')", params.cvector_negative_file.c_str() });
  1601. options.push_back({ "cvector", " --pca-batch N", "batch size used for PCA. Larger batch runs faster, but uses more memory (default: %d)", params.n_pca_batch });
  1602. options.push_back({ "cvector", " --pca-iter N", "number of iterations used for PCA (default: %d)", params.n_pca_iterations });
  1603. options.push_back({ "cvector", " --method {pca,mean}", "dimensionality reduction method to be used (default: pca)" });
  1604. printf("usage: %s [options]\n", argv[0]);
  1605. for (const auto & o : options) {
  1606. if (!o.grp.empty()) {
  1607. printf("\n%s:\n\n", o.grp.c_str());
  1608. continue;
  1609. }
  1610. printf(" %-32s", o.args.c_str());
  1611. if (o.args.length() > 30) {
  1612. printf("\n%34s", "");
  1613. }
  1614. const auto desc = o.desc;
  1615. size_t start = 0;
  1616. size_t end = desc.find('\n');
  1617. while (end != std::string::npos) {
  1618. printf("%s\n%34s", desc.substr(start, end - start).c_str(), "");
  1619. start = end + 1;
  1620. end = desc.find('\n', start);
  1621. }
  1622. printf("%s\n", desc.substr(start).c_str());
  1623. }
  1624. printf("\n");
  1625. }
  1626. std::string gpt_params_get_system_info(const gpt_params & params) {
  1627. std::ostringstream os;
  1628. os << "system_info: n_threads = " << params.n_threads;
  1629. if (params.n_threads_batch != -1) {
  1630. os << " (n_threads_batch = " << params.n_threads_batch << ")";
  1631. }
  1632. os << " / " << std::thread::hardware_concurrency() << " | " << llama_print_system_info();
  1633. return os.str();
  1634. }
  1635. //
  1636. // String utils
  1637. //
  1638. std::vector<std::string> string_split(std::string input, char separator) {
  1639. std::vector<std::string> parts;
  1640. size_t separator_pos = input.find(separator);
  1641. while (separator_pos != std::string::npos) {
  1642. std::string part = input.substr(0, separator_pos);
  1643. parts.emplace_back(part);
  1644. input = input.substr(separator_pos + 1);
  1645. separator_pos = input.find(separator);
  1646. }
  1647. parts.emplace_back(input);
  1648. return parts;
  1649. }
  1650. std::string string_strip(const std::string & str) {
  1651. size_t start = 0;
  1652. size_t end = str.size();
  1653. while (start < end && std::isspace(str[start])) {
  1654. start++;
  1655. }
  1656. while (end > start && std::isspace(str[end - 1])) {
  1657. end--;
  1658. }
  1659. return str.substr(start, end - start);
  1660. }
  1661. std::string string_get_sortable_timestamp() {
  1662. using clock = std::chrono::system_clock;
  1663. const clock::time_point current_time = clock::now();
  1664. const time_t as_time_t = clock::to_time_t(current_time);
  1665. char timestamp_no_ns[100];
  1666. std::strftime(timestamp_no_ns, 100, "%Y_%m_%d-%H_%M_%S", std::localtime(&as_time_t));
  1667. const int64_t ns = std::chrono::duration_cast<std::chrono::nanoseconds>(
  1668. current_time.time_since_epoch() % 1000000000).count();
  1669. char timestamp_ns[11];
  1670. snprintf(timestamp_ns, 11, "%09" PRId64, ns);
  1671. return std::string(timestamp_no_ns) + "." + std::string(timestamp_ns);
  1672. }
  1673. void string_process_escapes(std::string & input) {
  1674. std::size_t input_len = input.length();
  1675. std::size_t output_idx = 0;
  1676. for (std::size_t input_idx = 0; input_idx < input_len; ++input_idx) {
  1677. if (input[input_idx] == '\\' && input_idx + 1 < input_len) {
  1678. switch (input[++input_idx]) {
  1679. case 'n': input[output_idx++] = '\n'; break;
  1680. case 'r': input[output_idx++] = '\r'; break;
  1681. case 't': input[output_idx++] = '\t'; break;
  1682. case '\'': input[output_idx++] = '\''; break;
  1683. case '\"': input[output_idx++] = '\"'; break;
  1684. case '\\': input[output_idx++] = '\\'; break;
  1685. case 'x':
  1686. // Handle \x12, etc
  1687. if (input_idx + 2 < input_len) {
  1688. const char x[3] = { input[input_idx + 1], input[input_idx + 2], 0 };
  1689. char *err_p = nullptr;
  1690. const long val = std::strtol(x, &err_p, 16);
  1691. if (err_p == x + 2) {
  1692. input_idx += 2;
  1693. input[output_idx++] = char(val);
  1694. break;
  1695. }
  1696. }
  1697. // fall through
  1698. default: input[output_idx++] = '\\';
  1699. input[output_idx++] = input[input_idx]; break;
  1700. }
  1701. } else {
  1702. input[output_idx++] = input[input_idx];
  1703. }
  1704. }
  1705. input.resize(output_idx);
  1706. }
  1707. bool string_parse_kv_override(const char * data, std::vector<llama_model_kv_override> & overrides) {
  1708. const char * sep = strchr(data, '=');
  1709. if (sep == nullptr || sep - data >= 128) {
  1710. fprintf(stderr, "%s: malformed KV override '%s'\n", __func__, data);
  1711. return false;
  1712. }
  1713. llama_model_kv_override kvo;
  1714. std::strncpy(kvo.key, data, sep - data);
  1715. kvo.key[sep - data] = 0;
  1716. sep++;
  1717. if (strncmp(sep, "int:", 4) == 0) {
  1718. sep += 4;
  1719. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_INT;
  1720. kvo.val_i64 = std::atol(sep);
  1721. } else if (strncmp(sep, "float:", 6) == 0) {
  1722. sep += 6;
  1723. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_FLOAT;
  1724. kvo.val_f64 = std::atof(sep);
  1725. } else if (strncmp(sep, "bool:", 5) == 0) {
  1726. sep += 5;
  1727. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_BOOL;
  1728. if (std::strcmp(sep, "true") == 0) {
  1729. kvo.val_bool = true;
  1730. } else if (std::strcmp(sep, "false") == 0) {
  1731. kvo.val_bool = false;
  1732. } else {
  1733. fprintf(stderr, "%s: invalid boolean value for KV override '%s'\n", __func__, data);
  1734. return false;
  1735. }
  1736. } else if (strncmp(sep, "str:", 4) == 0) {
  1737. sep += 4;
  1738. kvo.tag = LLAMA_KV_OVERRIDE_TYPE_STR;
  1739. if (strlen(sep) > 127) {
  1740. fprintf(stderr, "%s: malformed KV override '%s', value cannot exceed 127 chars\n", __func__, data);
  1741. return false;
  1742. }
  1743. strncpy(kvo.val_str, sep, 127);
  1744. kvo.val_str[127] = '\0';
  1745. } else {
  1746. fprintf(stderr, "%s: invalid type for KV override '%s'\n", __func__, data);
  1747. return false;
  1748. }
  1749. overrides.emplace_back(std::move(kvo));
  1750. return true;
  1751. }
  1752. //
  1753. // Filesystem utils
  1754. //
  1755. // Validate if a filename is safe to use
  1756. // To validate a full path, split the path by the OS-specific path separator, and validate each part with this function
  1757. bool fs_validate_filename(const std::string & filename) {
  1758. if (!filename.length()) {
  1759. // Empty filename invalid
  1760. return false;
  1761. }
  1762. if (filename.length() > 255) {
  1763. // Limit at common largest possible filename on Linux filesystems
  1764. // to avoid unnecessary further validation
  1765. // (On systems with smaller limits it will be caught by the OS)
  1766. return false;
  1767. }
  1768. std::u32string filename_utf32;
  1769. try {
  1770. std::wstring_convert<std::codecvt_utf8<char32_t>, char32_t> converter;
  1771. filename_utf32 = converter.from_bytes(filename);
  1772. // If the reverse conversion mismatches, it means overlong UTF-8 sequences were used,
  1773. // or invalid encodings were encountered. Reject such attempts
  1774. std::string filename_reencoded = converter.to_bytes(filename_utf32);
  1775. if (filename_reencoded != filename) {
  1776. return false;
  1777. }
  1778. } catch (const std::exception &) {
  1779. return false;
  1780. }
  1781. // Check for forbidden codepoints:
  1782. // - Control characters
  1783. // - Unicode equivalents of illegal characters
  1784. // - UTF-16 surrogate pairs
  1785. // - UTF-8 replacement character
  1786. // - Byte order mark (BOM)
  1787. // - Illegal characters: / \ : * ? " < > |
  1788. for (char32_t c : filename_utf32) {
  1789. if (c <= 0x1F // Control characters (C0)
  1790. || c == 0x7F // Control characters (DEL)
  1791. || (c >= 0x80 && c <= 0x9F) // Control characters (C1)
  1792. || c == 0xFF0E // Fullwidth Full Stop (period equivalent)
  1793. || c == 0x2215 // Division Slash (forward slash equivalent)
  1794. || c == 0x2216 // Set Minus (backslash equivalent)
  1795. || (c >= 0xD800 && c <= 0xDFFF) // UTF-16 surrogate pairs
  1796. || c == 0xFFFD // Replacement Character (UTF-8)
  1797. || c == 0xFEFF // Byte Order Mark (BOM)
  1798. || c == '/' || c == '\\' || c == ':' || c == '*' // Illegal characters
  1799. || c == '?' || c == '"' || c == '<' || c == '>' || c == '|') {
  1800. return false;
  1801. }
  1802. }
  1803. // Reject any leading or trailing ' ', or any trailing '.', these are stripped on Windows and will cause a different filename
  1804. // Unicode and other whitespace is not affected, only 0x20 space
  1805. if (filename.front() == ' ' || filename.back() == ' ' || filename.back() == '.') {
  1806. return false;
  1807. }
  1808. // Reject any ".." (currently stricter than necessary, it should be fine to just check for == ".." instead)
  1809. if (filename.find("..") != std::string::npos) {
  1810. return false;
  1811. }
  1812. // Reject "."
  1813. if (filename == ".") {
  1814. return false;
  1815. }
  1816. return true;
  1817. }
  1818. // returns true if successful, false otherwise
  1819. bool fs_create_directory_with_parents(const std::string & path) {
  1820. #ifdef _WIN32
  1821. std::wstring_convert<std::codecvt_utf8<wchar_t>> converter;
  1822. std::wstring wpath = converter.from_bytes(path);
  1823. // if the path already exists, check whether it's a directory
  1824. const DWORD attributes = GetFileAttributesW(wpath.c_str());
  1825. if ((attributes != INVALID_FILE_ATTRIBUTES) && (attributes & FILE_ATTRIBUTE_DIRECTORY)) {
  1826. return true;
  1827. }
  1828. size_t pos_slash = 0;
  1829. // process path from front to back, procedurally creating directories
  1830. while ((pos_slash = path.find('\\', pos_slash)) != std::string::npos) {
  1831. const std::wstring subpath = wpath.substr(0, pos_slash);
  1832. const wchar_t * test = subpath.c_str();
  1833. const bool success = CreateDirectoryW(test, NULL);
  1834. if (!success) {
  1835. const DWORD error = GetLastError();
  1836. // if the path already exists, ensure that it's a directory
  1837. if (error == ERROR_ALREADY_EXISTS) {
  1838. const DWORD attributes = GetFileAttributesW(subpath.c_str());
  1839. if (attributes == INVALID_FILE_ATTRIBUTES || !(attributes & FILE_ATTRIBUTE_DIRECTORY)) {
  1840. return false;
  1841. }
  1842. } else {
  1843. return false;
  1844. }
  1845. }
  1846. pos_slash += 1;
  1847. }
  1848. return true;
  1849. #else
  1850. // if the path already exists, check whether it's a directory
  1851. struct stat info;
  1852. if (stat(path.c_str(), &info) == 0) {
  1853. return S_ISDIR(info.st_mode);
  1854. }
  1855. size_t pos_slash = 1; // skip leading slashes for directory creation
  1856. // process path from front to back, procedurally creating directories
  1857. while ((pos_slash = path.find('/', pos_slash)) != std::string::npos) {
  1858. const std::string subpath = path.substr(0, pos_slash);
  1859. struct stat info;
  1860. // if the path already exists, ensure that it's a directory
  1861. if (stat(subpath.c_str(), &info) == 0) {
  1862. if (!S_ISDIR(info.st_mode)) {
  1863. return false;
  1864. }
  1865. } else {
  1866. // create parent directories
  1867. const int ret = mkdir(subpath.c_str(), 0755);
  1868. if (ret != 0) {
  1869. return false;
  1870. }
  1871. }
  1872. pos_slash += 1;
  1873. }
  1874. return true;
  1875. #endif // _WIN32
  1876. }
  1877. std::string fs_get_cache_directory() {
  1878. std::string cache_directory = "";
  1879. auto ensure_trailing_slash = [](std::string p) {
  1880. // Make sure to add trailing slash
  1881. if (p.back() != DIRECTORY_SEPARATOR) {
  1882. p += DIRECTORY_SEPARATOR;
  1883. }
  1884. return p;
  1885. };
  1886. if (getenv("LLAMA_CACHE")) {
  1887. cache_directory = std::getenv("LLAMA_CACHE");
  1888. } else {
  1889. #ifdef __linux__
  1890. if (std::getenv("XDG_CACHE_HOME")) {
  1891. cache_directory = std::getenv("XDG_CACHE_HOME");
  1892. } else {
  1893. cache_directory = std::getenv("HOME") + std::string("/.cache/");
  1894. }
  1895. #elif defined(__APPLE__)
  1896. cache_directory = std::getenv("HOME") + std::string("/Library/Caches/");
  1897. #elif defined(_WIN32)
  1898. cache_directory = std::getenv("LOCALAPPDATA");
  1899. #endif // __linux__
  1900. cache_directory = ensure_trailing_slash(cache_directory);
  1901. cache_directory += "llama.cpp";
  1902. }
  1903. return ensure_trailing_slash(cache_directory);
  1904. }
  1905. std::string fs_get_cache_file(const std::string & filename) {
  1906. GGML_ASSERT(filename.find(DIRECTORY_SEPARATOR) == std::string::npos);
  1907. std::string cache_directory = fs_get_cache_directory();
  1908. const bool success = fs_create_directory_with_parents(cache_directory);
  1909. if (!success) {
  1910. throw std::runtime_error("failed to create cache directory: " + cache_directory);
  1911. }
  1912. return cache_directory + filename;
  1913. }
  1914. //
  1915. // Model utils
  1916. //
  1917. std::tuple<struct llama_model *, struct llama_context *> llama_init_from_gpt_params(gpt_params & params) {
  1918. auto mparams = llama_model_params_from_gpt_params(params);
  1919. llama_model * model = nullptr;
  1920. if (!params.hf_repo.empty() && !params.hf_file.empty()) {
  1921. model = llama_load_model_from_hf(params.hf_repo.c_str(), params.hf_file.c_str(), params.model.c_str(), params.hf_token.c_str(), mparams);
  1922. } else if (!params.model_url.empty()) {
  1923. model = llama_load_model_from_url(params.model_url.c_str(), params.model.c_str(), params.hf_token.c_str(), mparams);
  1924. } else {
  1925. model = llama_load_model_from_file(params.model.c_str(), mparams);
  1926. }
  1927. if (model == NULL) {
  1928. fprintf(stderr, "%s: error: failed to load model '%s'\n", __func__, params.model.c_str());
  1929. return std::make_tuple(nullptr, nullptr);
  1930. }
  1931. auto cparams = llama_context_params_from_gpt_params(params);
  1932. llama_context * lctx = llama_new_context_with_model(model, cparams);
  1933. if (lctx == NULL) {
  1934. fprintf(stderr, "%s: error: failed to create context with model '%s'\n", __func__, params.model.c_str());
  1935. llama_free_model(model);
  1936. return std::make_tuple(nullptr, nullptr);
  1937. }
  1938. if (!params.control_vectors.empty()) {
  1939. if (params.control_vector_layer_start <= 0) params.control_vector_layer_start = 1;
  1940. if (params.control_vector_layer_end <= 0) params.control_vector_layer_end = llama_n_layer(model);
  1941. const auto cvec = llama_control_vector_load(params.control_vectors);
  1942. if (cvec.n_embd == -1) {
  1943. llama_free(lctx);
  1944. llama_free_model(model);
  1945. return std::make_tuple(nullptr, nullptr);
  1946. }
  1947. int err = llama_control_vector_apply(lctx,
  1948. cvec.data.data(),
  1949. cvec.data.size(),
  1950. cvec.n_embd,
  1951. params.control_vector_layer_start,
  1952. params.control_vector_layer_end);
  1953. if (err) {
  1954. llama_free(lctx);
  1955. llama_free_model(model);
  1956. return std::make_tuple(nullptr, nullptr);
  1957. }
  1958. }
  1959. for (unsigned int i = 0; i < params.lora_adapter.size(); ++i) {
  1960. const std::string & lora_adapter = std::get<0>(params.lora_adapter[i]);
  1961. float lora_scale = std::get<1>(params.lora_adapter[i]);
  1962. int err = llama_model_apply_lora_from_file(model,
  1963. lora_adapter.c_str(),
  1964. lora_scale,
  1965. ((i > 0) || params.lora_base.empty())
  1966. ? NULL
  1967. : params.lora_base.c_str(),
  1968. params.n_threads);
  1969. if (err != 0) {
  1970. fprintf(stderr, "%s: error: failed to apply lora adapter\n", __func__);
  1971. llama_free(lctx);
  1972. llama_free_model(model);
  1973. return std::make_tuple(nullptr, nullptr);
  1974. }
  1975. }
  1976. if (params.ignore_eos) {
  1977. params.sparams.logit_bias[llama_token_eos(model)] = -INFINITY;
  1978. }
  1979. if (params.warmup) {
  1980. LOG("warming up the model with an empty run\n");
  1981. std::vector<llama_token> tmp;
  1982. llama_token bos = llama_token_bos(model);
  1983. llama_token eos = llama_token_eos(model);
  1984. // some models (e.g. T5) don't have a BOS token
  1985. if (bos != -1) {
  1986. tmp.push_back(bos);
  1987. }
  1988. tmp.push_back(eos);
  1989. if (llama_model_has_encoder(model)) {
  1990. llama_encode(lctx, llama_batch_get_one(tmp.data(), tmp.size(), 0, 0));
  1991. llama_token decoder_start_token_id = llama_model_decoder_start_token(model);
  1992. if (decoder_start_token_id == -1) {
  1993. decoder_start_token_id = bos;
  1994. }
  1995. tmp.clear();
  1996. tmp.push_back(decoder_start_token_id);
  1997. }
  1998. llama_decode(lctx, llama_batch_get_one(tmp.data(), std::min(tmp.size(), (size_t) params.n_batch), 0, 0));
  1999. llama_kv_cache_clear(lctx);
  2000. llama_synchronize(lctx);
  2001. llama_reset_timings(lctx);
  2002. }
  2003. return std::make_tuple(model, lctx);
  2004. }
  2005. struct llama_model_params llama_model_params_from_gpt_params(const gpt_params & params) {
  2006. auto mparams = llama_model_default_params();
  2007. if (params.n_gpu_layers != -1) {
  2008. mparams.n_gpu_layers = params.n_gpu_layers;
  2009. }
  2010. mparams.rpc_servers = params.rpc_servers.c_str();
  2011. mparams.main_gpu = params.main_gpu;
  2012. mparams.split_mode = params.split_mode;
  2013. mparams.tensor_split = params.tensor_split;
  2014. mparams.use_mmap = params.use_mmap;
  2015. mparams.use_mlock = params.use_mlock;
  2016. mparams.check_tensors = params.check_tensors;
  2017. if (params.kv_overrides.empty()) {
  2018. mparams.kv_overrides = NULL;
  2019. } else {
  2020. GGML_ASSERT(params.kv_overrides.back().key[0] == 0 && "KV overrides not terminated with empty key");
  2021. mparams.kv_overrides = params.kv_overrides.data();
  2022. }
  2023. return mparams;
  2024. }
  2025. static ggml_type kv_cache_type_from_str(const std::string & s) {
  2026. if (s == "f32") {
  2027. return GGML_TYPE_F32;
  2028. }
  2029. if (s == "f16") {
  2030. return GGML_TYPE_F16;
  2031. }
  2032. if (s == "q8_0") {
  2033. return GGML_TYPE_Q8_0;
  2034. }
  2035. if (s == "q4_0") {
  2036. return GGML_TYPE_Q4_0;
  2037. }
  2038. if (s == "q4_1") {
  2039. return GGML_TYPE_Q4_1;
  2040. }
  2041. if (s == "iq4_nl") {
  2042. return GGML_TYPE_IQ4_NL;
  2043. }
  2044. if (s == "q5_0") {
  2045. return GGML_TYPE_Q5_0;
  2046. }
  2047. if (s == "q5_1") {
  2048. return GGML_TYPE_Q5_1;
  2049. }
  2050. throw std::runtime_error("Invalid cache type: " + s);
  2051. }
  2052. struct llama_context_params llama_context_params_from_gpt_params(const gpt_params & params) {
  2053. auto cparams = llama_context_default_params();
  2054. cparams.n_ctx = params.n_ctx;
  2055. cparams.n_seq_max = params.n_parallel;
  2056. cparams.n_batch = params.n_batch;
  2057. cparams.n_ubatch = params.n_ubatch;
  2058. cparams.n_threads = params.n_threads;
  2059. cparams.n_threads_batch = params.n_threads_batch == -1 ? params.n_threads : params.n_threads_batch;
  2060. cparams.seed = params.seed;
  2061. cparams.logits_all = params.logits_all;
  2062. cparams.embeddings = params.embedding;
  2063. cparams.rope_scaling_type = params.rope_scaling_type;
  2064. cparams.rope_freq_base = params.rope_freq_base;
  2065. cparams.rope_freq_scale = params.rope_freq_scale;
  2066. cparams.yarn_ext_factor = params.yarn_ext_factor;
  2067. cparams.yarn_attn_factor = params.yarn_attn_factor;
  2068. cparams.yarn_beta_fast = params.yarn_beta_fast;
  2069. cparams.yarn_beta_slow = params.yarn_beta_slow;
  2070. cparams.yarn_orig_ctx = params.yarn_orig_ctx;
  2071. cparams.pooling_type = params.pooling_type;
  2072. cparams.attention_type = params.attention_type;
  2073. cparams.defrag_thold = params.defrag_thold;
  2074. cparams.cb_eval = params.cb_eval;
  2075. cparams.cb_eval_user_data = params.cb_eval_user_data;
  2076. cparams.offload_kqv = !params.no_kv_offload;
  2077. cparams.flash_attn = params.flash_attn;
  2078. cparams.type_k = kv_cache_type_from_str(params.cache_type_k);
  2079. cparams.type_v = kv_cache_type_from_str(params.cache_type_v);
  2080. return cparams;
  2081. }
  2082. #ifdef LLAMA_USE_CURL
  2083. static bool starts_with(const std::string & str, const std::string & prefix) {
  2084. // While we wait for C++20's std::string::starts_with...
  2085. return str.rfind(prefix, 0) == 0;
  2086. }
  2087. static bool llama_download_file(const std::string & url, const std::string & path, const std::string & hf_token) {
  2088. // Initialize libcurl
  2089. std::unique_ptr<CURL, decltype(&curl_easy_cleanup)> curl(curl_easy_init(), &curl_easy_cleanup);
  2090. if (!curl) {
  2091. fprintf(stderr, "%s: error initializing libcurl\n", __func__);
  2092. return false;
  2093. }
  2094. bool force_download = false;
  2095. // Set the URL, allow to follow http redirection
  2096. curl_easy_setopt(curl.get(), CURLOPT_URL, url.c_str());
  2097. curl_easy_setopt(curl.get(), CURLOPT_FOLLOWLOCATION, 1L);
  2098. // Check if hf-token or bearer-token was specified
  2099. if (!hf_token.empty()) {
  2100. std::string auth_header = "Authorization: Bearer ";
  2101. auth_header += hf_token.c_str();
  2102. struct curl_slist *http_headers = NULL;
  2103. http_headers = curl_slist_append(http_headers, auth_header.c_str());
  2104. curl_easy_setopt(curl.get(), CURLOPT_HTTPHEADER, http_headers);
  2105. }
  2106. #if defined(_WIN32)
  2107. // CURLSSLOPT_NATIVE_CA tells libcurl to use standard certificate store of
  2108. // operating system. Currently implemented under MS-Windows.
  2109. curl_easy_setopt(curl.get(), CURLOPT_SSL_OPTIONS, CURLSSLOPT_NATIVE_CA);
  2110. #endif
  2111. // Check if the file already exists locally
  2112. struct stat model_file_info;
  2113. auto file_exists = (stat(path.c_str(), &model_file_info) == 0);
  2114. // If the file exists, check its JSON metadata companion file.
  2115. std::string metadata_path = path + ".json";
  2116. nlohmann::json metadata;
  2117. std::string etag;
  2118. std::string last_modified;
  2119. if (file_exists) {
  2120. // Try and read the JSON metadata file (note: stream autoclosed upon exiting this block).
  2121. std::ifstream metadata_in(metadata_path);
  2122. if (metadata_in.good()) {
  2123. try {
  2124. metadata_in >> metadata;
  2125. fprintf(stderr, "%s: previous metadata file found %s: %s\n", __func__, metadata_path.c_str(), metadata.dump().c_str());
  2126. if (metadata.contains("url") && metadata.at("url").is_string()) {
  2127. auto previous_url = metadata.at("url").get<std::string>();
  2128. if (previous_url != url) {
  2129. fprintf(stderr, "%s: Model URL mismatch: %s != %s\n", __func__, url.c_str(), previous_url.c_str());
  2130. return false;
  2131. }
  2132. }
  2133. if (metadata.contains("etag") && metadata.at("etag").is_string()) {
  2134. etag = metadata.at("etag");
  2135. }
  2136. if (metadata.contains("lastModified") && metadata.at("lastModified").is_string()) {
  2137. last_modified = metadata.at("lastModified");
  2138. }
  2139. } catch (const nlohmann::json::exception & e) {
  2140. fprintf(stderr, "%s: error reading metadata file %s: %s\n", __func__, metadata_path.c_str(), e.what());
  2141. return false;
  2142. }
  2143. }
  2144. } else {
  2145. fprintf(stderr, "%s: no previous model file found %s\n", __func__, path.c_str());
  2146. }
  2147. // Send a HEAD request to retrieve the etag and last-modified headers
  2148. struct llama_load_model_from_url_headers {
  2149. std::string etag;
  2150. std::string last_modified;
  2151. };
  2152. llama_load_model_from_url_headers headers;
  2153. {
  2154. typedef size_t(*CURLOPT_HEADERFUNCTION_PTR)(char *, size_t, size_t, void *);
  2155. auto header_callback = [](char * buffer, size_t /*size*/, size_t n_items, void * userdata) -> size_t {
  2156. llama_load_model_from_url_headers *headers = (llama_load_model_from_url_headers *) userdata;
  2157. static std::regex header_regex("([^:]+): (.*)\r\n");
  2158. static std::regex etag_regex("ETag", std::regex_constants::icase);
  2159. static std::regex last_modified_regex("Last-Modified", std::regex_constants::icase);
  2160. std::string header(buffer, n_items);
  2161. std::smatch match;
  2162. if (std::regex_match(header, match, header_regex)) {
  2163. const std::string & key = match[1];
  2164. const std::string & value = match[2];
  2165. if (std::regex_match(key, match, etag_regex)) {
  2166. headers->etag = value;
  2167. } else if (std::regex_match(key, match, last_modified_regex)) {
  2168. headers->last_modified = value;
  2169. }
  2170. }
  2171. return n_items;
  2172. };
  2173. curl_easy_setopt(curl.get(), CURLOPT_NOBODY, 1L); // will trigger the HEAD verb
  2174. curl_easy_setopt(curl.get(), CURLOPT_NOPROGRESS, 1L); // hide head request progress
  2175. curl_easy_setopt(curl.get(), CURLOPT_HEADERFUNCTION, static_cast<CURLOPT_HEADERFUNCTION_PTR>(header_callback));
  2176. curl_easy_setopt(curl.get(), CURLOPT_HEADERDATA, &headers);
  2177. CURLcode res = curl_easy_perform(curl.get());
  2178. if (res != CURLE_OK) {
  2179. fprintf(stderr, "%s: curl_easy_perform() failed: %s\n", __func__, curl_easy_strerror(res));
  2180. return false;
  2181. }
  2182. long http_code = 0;
  2183. curl_easy_getinfo(curl.get(), CURLINFO_RESPONSE_CODE, &http_code);
  2184. if (http_code != 200) {
  2185. // HEAD not supported, we don't know if the file has changed
  2186. // force trigger downloading
  2187. force_download = true;
  2188. fprintf(stderr, "%s: HEAD invalid http status code received: %ld\n", __func__, http_code);
  2189. }
  2190. }
  2191. bool should_download = !file_exists || force_download;
  2192. if (!should_download) {
  2193. if (!etag.empty() && etag != headers.etag) {
  2194. fprintf(stderr, "%s: ETag header is different (%s != %s): triggering a new download\n", __func__, etag.c_str(), headers.etag.c_str());
  2195. should_download = true;
  2196. } else if (!last_modified.empty() && last_modified != headers.last_modified) {
  2197. fprintf(stderr, "%s: Last-Modified header is different (%s != %s): triggering a new download\n", __func__, last_modified.c_str(), headers.last_modified.c_str());
  2198. should_download = true;
  2199. }
  2200. }
  2201. if (should_download) {
  2202. std::string path_temporary = path + ".downloadInProgress";
  2203. if (file_exists) {
  2204. fprintf(stderr, "%s: deleting previous downloaded file: %s\n", __func__, path.c_str());
  2205. if (remove(path.c_str()) != 0) {
  2206. fprintf(stderr, "%s: unable to delete file: %s\n", __func__, path.c_str());
  2207. return false;
  2208. }
  2209. }
  2210. // Set the output file
  2211. struct FILE_deleter {
  2212. void operator()(FILE * f) const {
  2213. fclose(f);
  2214. }
  2215. };
  2216. std::unique_ptr<FILE, FILE_deleter> outfile(fopen(path_temporary.c_str(), "wb"));
  2217. if (!outfile) {
  2218. fprintf(stderr, "%s: error opening local file for writing: %s\n", __func__, path.c_str());
  2219. return false;
  2220. }
  2221. typedef size_t(*CURLOPT_WRITEFUNCTION_PTR)(void * data, size_t size, size_t nmemb, void * fd);
  2222. auto write_callback = [](void * data, size_t size, size_t nmemb, void * fd) -> size_t {
  2223. return fwrite(data, size, nmemb, (FILE *)fd);
  2224. };
  2225. curl_easy_setopt(curl.get(), CURLOPT_NOBODY, 0L);
  2226. curl_easy_setopt(curl.get(), CURLOPT_WRITEFUNCTION, static_cast<CURLOPT_WRITEFUNCTION_PTR>(write_callback));
  2227. curl_easy_setopt(curl.get(), CURLOPT_WRITEDATA, outfile.get());
  2228. // display download progress
  2229. curl_easy_setopt(curl.get(), CURLOPT_NOPROGRESS, 0L);
  2230. // helper function to hide password in URL
  2231. auto llama_download_hide_password_in_url = [](const std::string & url) -> std::string {
  2232. std::size_t protocol_pos = url.find("://");
  2233. if (protocol_pos == std::string::npos) {
  2234. return url; // Malformed URL
  2235. }
  2236. std::size_t at_pos = url.find('@', protocol_pos + 3);
  2237. if (at_pos == std::string::npos) {
  2238. return url; // No password in URL
  2239. }
  2240. return url.substr(0, protocol_pos + 3) + "********" + url.substr(at_pos);
  2241. };
  2242. // start the download
  2243. fprintf(stderr, "%s: downloading from %s to %s (server_etag:%s, server_last_modified:%s)...\n", __func__,
  2244. llama_download_hide_password_in_url(url).c_str(), path.c_str(), headers.etag.c_str(), headers.last_modified.c_str());
  2245. auto res = curl_easy_perform(curl.get());
  2246. if (res != CURLE_OK) {
  2247. fprintf(stderr, "%s: curl_easy_perform() failed: %s\n", __func__, curl_easy_strerror(res));
  2248. return false;
  2249. }
  2250. long http_code = 0;
  2251. curl_easy_getinfo (curl.get(), CURLINFO_RESPONSE_CODE, &http_code);
  2252. if (http_code < 200 || http_code >= 400) {
  2253. fprintf(stderr, "%s: invalid http status code received: %ld\n", __func__, http_code);
  2254. return false;
  2255. }
  2256. // Causes file to be closed explicitly here before we rename it.
  2257. outfile.reset();
  2258. // Write the updated JSON metadata file.
  2259. metadata.update({
  2260. {"url", url},
  2261. {"etag", headers.etag},
  2262. {"lastModified", headers.last_modified}
  2263. });
  2264. std::ofstream(metadata_path) << metadata.dump(4);
  2265. fprintf(stderr, "%s: file metadata saved: %s\n", __func__, metadata_path.c_str());
  2266. if (rename(path_temporary.c_str(), path.c_str()) != 0) {
  2267. fprintf(stderr, "%s: unable to rename file: %s to %s\n", __func__, path_temporary.c_str(), path.c_str());
  2268. return false;
  2269. }
  2270. }
  2271. return true;
  2272. }
  2273. struct llama_model * llama_load_model_from_url(
  2274. const char * model_url,
  2275. const char * path_model,
  2276. const char * hf_token,
  2277. const struct llama_model_params & params) {
  2278. // Basic validation of the model_url
  2279. if (!model_url || strlen(model_url) == 0) {
  2280. fprintf(stderr, "%s: invalid model_url\n", __func__);
  2281. return NULL;
  2282. }
  2283. if (!llama_download_file(model_url, path_model, hf_token)) {
  2284. return NULL;
  2285. }
  2286. // check for additional GGUFs split to download
  2287. int n_split = 0;
  2288. {
  2289. struct gguf_init_params gguf_params = {
  2290. /*.no_alloc = */ true,
  2291. /*.ctx = */ NULL,
  2292. };
  2293. auto * ctx_gguf = gguf_init_from_file(path_model, gguf_params);
  2294. if (!ctx_gguf) {
  2295. fprintf(stderr, "\n%s: failed to load input GGUF from %s\n", __func__, path_model);
  2296. return NULL;
  2297. }
  2298. auto key_n_split = gguf_find_key(ctx_gguf, LLM_KV_SPLIT_COUNT);
  2299. if (key_n_split >= 0) {
  2300. n_split = gguf_get_val_u16(ctx_gguf, key_n_split);
  2301. }
  2302. gguf_free(ctx_gguf);
  2303. }
  2304. if (n_split > 1) {
  2305. char split_prefix[PATH_MAX] = {0};
  2306. char split_url_prefix[LLAMA_CURL_MAX_URL_LENGTH] = {0};
  2307. // Verify the first split file format
  2308. // and extract split URL and PATH prefixes
  2309. {
  2310. if (!llama_split_prefix(split_prefix, sizeof(split_prefix), path_model, 0, n_split)) {
  2311. fprintf(stderr, "\n%s: unexpected model file name: %s"
  2312. " n_split=%d\n", __func__, path_model, n_split);
  2313. return NULL;
  2314. }
  2315. if (!llama_split_prefix(split_url_prefix, sizeof(split_url_prefix), model_url, 0, n_split)) {
  2316. fprintf(stderr, "\n%s: unexpected model url: %s"
  2317. " n_split=%d\n", __func__, model_url, n_split);
  2318. return NULL;
  2319. }
  2320. }
  2321. // Prepare download in parallel
  2322. std::vector<std::future<bool>> futures_download;
  2323. for (int idx = 1; idx < n_split; idx++) {
  2324. futures_download.push_back(std::async(std::launch::async, [&split_prefix, &split_url_prefix, &n_split, hf_token](int download_idx) -> bool {
  2325. char split_path[PATH_MAX] = {0};
  2326. llama_split_path(split_path, sizeof(split_path), split_prefix, download_idx, n_split);
  2327. char split_url[LLAMA_CURL_MAX_URL_LENGTH] = {0};
  2328. llama_split_path(split_url, sizeof(split_url), split_url_prefix, download_idx, n_split);
  2329. return llama_download_file(split_url, split_path, hf_token);
  2330. }, idx));
  2331. }
  2332. // Wait for all downloads to complete
  2333. for (auto & f : futures_download) {
  2334. if (!f.get()) {
  2335. return NULL;
  2336. }
  2337. }
  2338. }
  2339. return llama_load_model_from_file(path_model, params);
  2340. }
  2341. struct llama_model * llama_load_model_from_hf(
  2342. const char * repo,
  2343. const char * model,
  2344. const char * path_model,
  2345. const char * hf_token,
  2346. const struct llama_model_params & params) {
  2347. // construct hugging face model url:
  2348. //
  2349. // --repo ggml-org/models --file tinyllama-1.1b/ggml-model-f16.gguf
  2350. // https://huggingface.co/ggml-org/models/resolve/main/tinyllama-1.1b/ggml-model-f16.gguf
  2351. //
  2352. // --repo TheBloke/Mixtral-8x7B-v0.1-GGUF --file mixtral-8x7b-v0.1.Q4_K_M.gguf
  2353. // https://huggingface.co/TheBloke/Mixtral-8x7B-v0.1-GGUF/resolve/main/mixtral-8x7b-v0.1.Q4_K_M.gguf
  2354. //
  2355. std::string model_url = "https://huggingface.co/";
  2356. model_url += repo;
  2357. model_url += "/resolve/main/";
  2358. model_url += model;
  2359. return llama_load_model_from_url(model_url.c_str(), path_model, hf_token, params);
  2360. }
  2361. #else
  2362. struct llama_model * llama_load_model_from_url(
  2363. const char * /*model_url*/,
  2364. const char * /*path_model*/,
  2365. const char * /*hf_token*/,
  2366. const struct llama_model_params & /*params*/) {
  2367. fprintf(stderr, "%s: llama.cpp built without libcurl, downloading from an url not supported.\n", __func__);
  2368. return nullptr;
  2369. }
  2370. struct llama_model * llama_load_model_from_hf(
  2371. const char * /*repo*/,
  2372. const char * /*model*/,
  2373. const char * /*path_model*/,
  2374. const char * /*hf_token*/,
  2375. const struct llama_model_params & /*params*/) {
  2376. fprintf(stderr, "%s: llama.cpp built without libcurl, downloading from Hugging Face not supported.\n", __func__);
  2377. return nullptr;
  2378. }
  2379. #endif // LLAMA_USE_CURL
  2380. //
  2381. // Batch utils
  2382. //
  2383. void llama_batch_clear(struct llama_batch & batch) {
  2384. batch.n_tokens = 0;
  2385. }
  2386. void llama_batch_add(
  2387. struct llama_batch & batch,
  2388. llama_token id,
  2389. llama_pos pos,
  2390. const std::vector<llama_seq_id> & seq_ids,
  2391. bool logits) {
  2392. batch.token [batch.n_tokens] = id;
  2393. batch.pos [batch.n_tokens] = pos;
  2394. batch.n_seq_id[batch.n_tokens] = seq_ids.size();
  2395. for (size_t i = 0; i < seq_ids.size(); ++i) {
  2396. batch.seq_id[batch.n_tokens][i] = seq_ids[i];
  2397. }
  2398. batch.logits [batch.n_tokens] = logits;
  2399. batch.n_tokens++;
  2400. }
  2401. //
  2402. // Vocab utils
  2403. //
  2404. std::vector<llama_token> llama_tokenize(
  2405. const struct llama_context * ctx,
  2406. const std::string & text,
  2407. bool add_special,
  2408. bool parse_special) {
  2409. return llama_tokenize(llama_get_model(ctx), text, add_special, parse_special);
  2410. }
  2411. std::vector<llama_token> llama_tokenize(
  2412. const struct llama_model * model,
  2413. const std::string & text,
  2414. bool add_special,
  2415. bool parse_special) {
  2416. // upper limit for the number of tokens
  2417. int n_tokens = text.length() + 2 * add_special;
  2418. std::vector<llama_token> result(n_tokens);
  2419. n_tokens = llama_tokenize(model, text.data(), text.length(), result.data(), result.size(), add_special, parse_special);
  2420. if (n_tokens < 0) {
  2421. result.resize(-n_tokens);
  2422. int check = llama_tokenize(model, text.data(), text.length(), result.data(), result.size(), add_special, parse_special);
  2423. GGML_ASSERT(check == -n_tokens);
  2424. } else {
  2425. result.resize(n_tokens);
  2426. }
  2427. return result;
  2428. }
  2429. std::string llama_token_to_piece(const struct llama_context * ctx, llama_token token, bool special) {
  2430. std::string piece;
  2431. piece.resize(piece.capacity()); // using string internal cache, 15 bytes + '\n'
  2432. const int n_chars = llama_token_to_piece(llama_get_model(ctx), token, &piece[0], piece.size(), 0, special);
  2433. if (n_chars < 0) {
  2434. piece.resize(-n_chars);
  2435. int check = llama_token_to_piece(llama_get_model(ctx), token, &piece[0], piece.size(), 0, special);
  2436. GGML_ASSERT(check == -n_chars);
  2437. }
  2438. else {
  2439. piece.resize(n_chars);
  2440. }
  2441. return piece;
  2442. }
  2443. std::string llama_detokenize(llama_context * ctx, const std::vector<llama_token> & tokens, bool special) {
  2444. std::string text;
  2445. text.resize(std::max(text.capacity(), tokens.size()));
  2446. int32_t n_chars = llama_detokenize(llama_get_model(ctx), tokens.data(), (int32_t)tokens.size(), &text[0], (int32_t)text.size(), false, special);
  2447. if (n_chars < 0) {
  2448. text.resize(-n_chars);
  2449. n_chars = llama_detokenize(llama_get_model(ctx), tokens.data(), (int32_t)tokens.size(), &text[0], (int32_t)text.size(), false, special);
  2450. GGML_ASSERT(n_chars <= (int32_t)text.size()); // whitespace trimming is performed after per-token detokenization
  2451. }
  2452. text.resize(n_chars);
  2453. // NOTE: the original tokenizer decodes bytes after collecting the pieces.
  2454. return text;
  2455. }
  2456. bool llama_should_add_bos_token(const llama_model * model) {
  2457. const int add_bos = llama_add_bos_token(model);
  2458. return add_bos != -1 ? bool(add_bos) : (llama_vocab_type(model) == LLAMA_VOCAB_TYPE_SPM);
  2459. }
  2460. //
  2461. // Chat template utils
  2462. //
  2463. bool llama_chat_verify_template(const std::string & tmpl) {
  2464. llama_chat_message chat[] = {{"user", "test"}};
  2465. int res = llama_chat_apply_template(nullptr, tmpl.c_str(), chat, 1, true, nullptr, 0);
  2466. return res >= 0;
  2467. }
  2468. std::string llama_chat_apply_template(const struct llama_model * model,
  2469. const std::string & tmpl,
  2470. const std::vector<llama_chat_msg> & msgs,
  2471. bool add_ass) {
  2472. int alloc_size = 0;
  2473. bool fallback = false; // indicate if we must fallback to default chatml
  2474. std::vector<llama_chat_message> chat;
  2475. for (auto & msg : msgs) {
  2476. chat.push_back({msg.role.c_str(), msg.content.c_str()});
  2477. alloc_size += (msg.role.size() + msg.content.size()) * 1.25;
  2478. }
  2479. const char * ptr_tmpl = tmpl.empty() ? nullptr : tmpl.c_str();
  2480. std::vector<char> buf(alloc_size);
  2481. // run the first time to get the total output length
  2482. int32_t res = llama_chat_apply_template(model, ptr_tmpl, chat.data(), chat.size(), add_ass, buf.data(), buf.size());
  2483. // error: chat template is not supported
  2484. if (res < 0) {
  2485. if (ptr_tmpl != nullptr) {
  2486. // if the custom "tmpl" is not supported, we throw an error
  2487. // this is a bit redundant (for good), since we're not sure if user validated the custom template with llama_chat_verify_template()
  2488. throw std::runtime_error("this custom template is not supported");
  2489. } else {
  2490. // If the built-in template is not supported, we default to chatml
  2491. res = llama_chat_apply_template(nullptr, "chatml", chat.data(), chat.size(), add_ass, buf.data(), buf.size());
  2492. fallback = true;
  2493. }
  2494. }
  2495. // if it turns out that our buffer is too small, we resize it
  2496. if ((size_t) res > buf.size()) {
  2497. buf.resize(res);
  2498. res = llama_chat_apply_template(
  2499. fallback ? nullptr : model,
  2500. fallback ? "chatml" : ptr_tmpl,
  2501. chat.data(), chat.size(), add_ass, buf.data(), buf.size());
  2502. }
  2503. std::string formatted_chat(buf.data(), res);
  2504. return formatted_chat;
  2505. }
  2506. std::string llama_chat_format_single(const struct llama_model * model,
  2507. const std::string & tmpl,
  2508. const std::vector<llama_chat_msg> & past_msg,
  2509. const llama_chat_msg & new_msg,
  2510. bool add_ass) {
  2511. std::ostringstream ss;
  2512. auto fmt_past_msg = llama_chat_apply_template(model, tmpl, past_msg, false);
  2513. std::vector<llama_chat_msg> chat_new(past_msg);
  2514. // if the past_msg ends with a newline, we must preserve it in the formatted version
  2515. if (add_ass && !fmt_past_msg.empty() && fmt_past_msg.back() == '\n') {
  2516. ss << "\n";
  2517. };
  2518. // format chat with new_msg
  2519. chat_new.push_back(new_msg);
  2520. auto fmt_new_msg = llama_chat_apply_template(model, tmpl, chat_new, add_ass);
  2521. // get the diff part
  2522. ss << fmt_new_msg.substr(fmt_past_msg.size(), fmt_new_msg.size() - fmt_past_msg.size());
  2523. return ss.str();
  2524. }
  2525. std::string llama_chat_format_example(const struct llama_model * model,
  2526. const std::string & tmpl) {
  2527. std::vector<llama_chat_msg> msgs = {
  2528. {"system", "You are a helpful assistant"},
  2529. {"user", "Hello"},
  2530. {"assistant", "Hi there"},
  2531. {"user", "How are you?"},
  2532. };
  2533. return llama_chat_apply_template(model, tmpl, msgs, true);
  2534. }
  2535. //
  2536. // KV cache utils
  2537. //
  2538. void llama_kv_cache_dump_view(const llama_kv_cache_view & view, int row_size) {
  2539. static const char slot_chars[] = ".123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+";
  2540. 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",
  2541. view.n_cells, view.n_seq_max, view.used_cells, view.token_count, view.max_contiguous, view.max_contiguous_idx);
  2542. llama_kv_cache_view_cell * c_curr = view.cells;
  2543. llama_seq_id * cs_curr = view.cells_sequences;
  2544. for (int i = 0; i < view.n_cells; i++, c_curr++, cs_curr += view.n_seq_max) {
  2545. if (i % row_size == 0) {
  2546. printf("\n%5d: ", i);
  2547. }
  2548. int seq_count = 0;
  2549. for (int j = 0; j < view.n_seq_max; j++) {
  2550. if (cs_curr[j] >= 0) { seq_count++; }
  2551. }
  2552. putchar(slot_chars[std::min(sizeof(slot_chars) - 2, size_t(seq_count))]);
  2553. }
  2554. printf("\n=== Done dumping\n");
  2555. }
  2556. void llama_kv_cache_dump_view_seqs(const llama_kv_cache_view & view, int row_size) {
  2557. static const char slot_chars[] = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
  2558. 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",
  2559. view.n_cells, view.n_seq_max, view.used_cells, view.token_count, view.max_contiguous, view.max_contiguous_idx);
  2560. std::unordered_map<llama_seq_id, size_t> seqs;
  2561. llama_kv_cache_view_cell * c_curr = view.cells;
  2562. llama_seq_id * cs_curr = view.cells_sequences;
  2563. for (int i = 0; i < view.n_cells; i++, c_curr++, cs_curr += view.n_seq_max) {
  2564. for (int j = 0; j < view.n_seq_max; j++) {
  2565. if (cs_curr[j] < 0) { continue; }
  2566. if (seqs.find(cs_curr[j]) == seqs.end()) {
  2567. if (seqs.size() + 1 >= sizeof(slot_chars)) { break; }
  2568. const size_t sz = seqs.size();
  2569. seqs[cs_curr[j]] = sz;
  2570. }
  2571. }
  2572. if (seqs.size() + 1 >= sizeof(slot_chars)) { break; }
  2573. }
  2574. printf("=== Sequence legend: ");
  2575. for (const auto & it : seqs) {
  2576. printf("%zu=%d, ", it.second, it.first);
  2577. }
  2578. printf("'+'=other sequence ids");
  2579. c_curr = view.cells;
  2580. cs_curr = view.cells_sequences;
  2581. for (int i = 0; i < view.n_cells; i++, c_curr++, cs_curr += view.n_seq_max) {
  2582. if (i % row_size == 0) {
  2583. printf("\n%5d: ", i);
  2584. }
  2585. for (int j = 0; j < view.n_seq_max; j++) {
  2586. if (cs_curr[j] >= 0) {
  2587. const auto & it = seqs.find(cs_curr[j]);
  2588. putchar(it != seqs.end() ? int(slot_chars[it->second]) : '+');
  2589. } else {
  2590. putchar('.');
  2591. }
  2592. }
  2593. putchar(' ');
  2594. }
  2595. printf("\n=== Done dumping\n");
  2596. }
  2597. //
  2598. // Embedding utils
  2599. //
  2600. void llama_embd_normalize(const float * inp, float * out, int n, int embd_norm) {
  2601. double sum = 0.0;
  2602. switch (embd_norm) {
  2603. case -1: // no normalisation
  2604. sum = 1.0;
  2605. break;
  2606. case 0: // max absolute
  2607. for (int i = 0; i < n; i++) {
  2608. if (sum < std::abs(inp[i])) sum = std::abs(inp[i]);
  2609. }
  2610. sum /= 32760.0; // make an int16 range
  2611. break;
  2612. case 2: // euclidean
  2613. for (int i = 0; i < n; i++) {
  2614. sum += inp[i] * inp[i];
  2615. }
  2616. sum = std::sqrt(sum);
  2617. break;
  2618. default: // p-norm (euclidean is p-norm p=2)
  2619. for (int i = 0; i < n; i++) {
  2620. sum += std::pow(std::abs(inp[i]), embd_norm);
  2621. }
  2622. sum = std::pow(sum, 1.0 / embd_norm);
  2623. break;
  2624. }
  2625. const float norm = sum > 0.0 ? 1.0 / sum : 0.0f;
  2626. for (int i = 0; i < n; i++) {
  2627. out[i] = inp[i] * norm;
  2628. }
  2629. }
  2630. float llama_embd_similarity_cos(const float * embd1, const float * embd2, int n){
  2631. double sum = 0.0;
  2632. double sum1 = 0.0;
  2633. double sum2 = 0.0;
  2634. for (int i = 0; i < n; i++) {
  2635. sum += embd1[i] * embd2[i];
  2636. sum1 += embd1[i] * embd1[i];
  2637. sum2 += embd2[i] * embd2[i];
  2638. }
  2639. // Handle the case where one or both vectors are zero vectors
  2640. if (sum1 == 0.0 || sum2 == 0.0) {
  2641. if (sum1 == 0.0 && sum2 == 0.0) {
  2642. return 1.0f; // two zero vectors are similar
  2643. }
  2644. return 0.0f;
  2645. }
  2646. return sum / (sqrt(sum1) * sqrt(sum2));
  2647. }
  2648. //
  2649. // Control vector utils
  2650. //
  2651. static llama_control_vector_data llama_control_vector_load_one(const llama_control_vector_load_info & load_info) {
  2652. llama_control_vector_data result = { -1, {} };
  2653. ggml_context * ctx = nullptr;
  2654. struct gguf_init_params meta_gguf_params = {
  2655. /* .no_alloc = */ false,
  2656. /* .ctx = */ &ctx,
  2657. };
  2658. struct gguf_context * ctx_gguf = gguf_init_from_file(load_info.fname.c_str(), meta_gguf_params);
  2659. if (!ctx_gguf) {
  2660. fprintf(stderr, "%s: failed to load control vector file from %s\n", __func__, load_info.fname.c_str());
  2661. return result;
  2662. }
  2663. int32_t n_tensors = gguf_get_n_tensors(ctx_gguf);
  2664. if (n_tensors == 0) {
  2665. fprintf(stderr, "%s: no direction tensors found in %s\n", __func__, load_info.fname.c_str());
  2666. }
  2667. for (int i = 0; i < n_tensors; i++) {
  2668. std::string name = gguf_get_tensor_name(ctx_gguf, i);
  2669. int layer_idx = -1;
  2670. // split on '.'
  2671. size_t dotpos = name.find('.');
  2672. if (dotpos != std::string::npos && name.substr(0, dotpos) == "direction") {
  2673. try {
  2674. layer_idx = std::stoi(name.substr(dotpos + 1));
  2675. } catch (...) {
  2676. layer_idx = -1;
  2677. }
  2678. }
  2679. if (layer_idx < 0) {
  2680. fprintf(stderr, "%s: invalid/unparsable direction tensor layer index in %s\n", __func__, load_info.fname.c_str());
  2681. result.n_embd = -1;
  2682. break;
  2683. } else if (layer_idx == 0) {
  2684. fprintf(stderr, "%s: invalid (zero) direction tensor layer index in %s\n", __func__, load_info.fname.c_str());
  2685. result.n_embd = -1;
  2686. break;
  2687. }
  2688. struct ggml_tensor * tensor = ggml_get_tensor(ctx, name.c_str());
  2689. if (tensor->type != GGML_TYPE_F32) {
  2690. fprintf(stderr, "%s: invalid (non-F32) direction tensor type in %s\n", __func__, load_info.fname.c_str());
  2691. result.n_embd = -1;
  2692. break;
  2693. }
  2694. if (ggml_n_dims(tensor) != 1) {
  2695. fprintf(stderr, "%s: invalid (non-1D) direction tensor shape in %s\n", __func__, load_info.fname.c_str());
  2696. result.n_embd = -1;
  2697. break;
  2698. }
  2699. if (result.n_embd == -1) {
  2700. result.n_embd = ggml_nelements(tensor);
  2701. } else if (ggml_nelements(tensor) != result.n_embd) {
  2702. fprintf(stderr, "%s: direction tensor in %s does not match previous dimensions\n", __func__, load_info.fname.c_str());
  2703. result.n_embd = -1;
  2704. break;
  2705. }
  2706. // extend if necessary - do not store data for layer 0 (it's not used)
  2707. result.data.resize(std::max(result.data.size(), static_cast<size_t>(result.n_embd * layer_idx)), 0.0f);
  2708. const float * src = (const float *) tensor->data;
  2709. float * dst = result.data.data() + result.n_embd * (layer_idx - 1); // layer 1 at [0]
  2710. for (int j = 0; j < result.n_embd; j++) {
  2711. dst[j] += src[j] * load_info.strength; // allows multiple directions for same layer in same file
  2712. }
  2713. }
  2714. if (result.n_embd == -1) {
  2715. fprintf(stderr, "%s: skipping %s due to invalid direction tensors\n", __func__, load_info.fname.c_str());
  2716. result.data.clear();
  2717. }
  2718. gguf_free(ctx_gguf);
  2719. ggml_free(ctx);
  2720. return result;
  2721. }
  2722. llama_control_vector_data llama_control_vector_load(const std::vector<llama_control_vector_load_info> & load_infos) {
  2723. llama_control_vector_data result = { -1, {} };
  2724. for (const auto & info : load_infos) {
  2725. auto cur = llama_control_vector_load_one(info);
  2726. if (cur.n_embd == -1) {
  2727. result.n_embd = -1;
  2728. break;
  2729. }
  2730. if (result.n_embd != -1 && result.n_embd != cur.n_embd) {
  2731. fprintf(stderr, "%s: control vectors in %s does not match previous dimensions\n", __func__, info.fname.c_str());
  2732. result.n_embd = -1;
  2733. break;
  2734. }
  2735. if (result.n_embd == -1) {
  2736. result = std::move(cur);
  2737. } else {
  2738. result.data.resize(std::max(result.data.size(), cur.data.size()), 0.0f); // extend if necessary
  2739. for (size_t i = 0; i < cur.data.size(); i++) {
  2740. result.data[i] += cur.data[i];
  2741. }
  2742. }
  2743. }
  2744. if (result.n_embd == -1) {
  2745. fprintf(stderr, "%s: no valid control vector files passed\n", __func__);
  2746. result.data.clear();
  2747. }
  2748. return result;
  2749. }
  2750. //
  2751. // YAML utils
  2752. //
  2753. void yaml_dump_vector_float(FILE * stream, const char * prop_name, const std::vector<float> & data) {
  2754. if (data.empty()) {
  2755. fprintf(stream, "%s:\n", prop_name);
  2756. return;
  2757. }
  2758. fprintf(stream, "%s: [", prop_name);
  2759. for (size_t i = 0; i < data.size() - 1; ++i) {
  2760. fprintf(stream, "%e, ", data[i]);
  2761. }
  2762. fprintf(stream, "%e]\n", data.back());
  2763. }
  2764. void yaml_dump_vector_int(FILE * stream, const char * prop_name, const std::vector<int> & data) {
  2765. if (data.empty()) {
  2766. fprintf(stream, "%s:\n", prop_name);
  2767. return;
  2768. }
  2769. fprintf(stream, "%s: [", prop_name);
  2770. for (size_t i = 0; i < data.size() - 1; ++i) {
  2771. fprintf(stream, "%d, ", data[i]);
  2772. }
  2773. fprintf(stream, "%d]\n", data.back());
  2774. }
  2775. void yaml_dump_string_multiline(FILE * stream, const char * prop_name, const char * data) {
  2776. std::string data_str(data == NULL ? "" : data);
  2777. if (data_str.empty()) {
  2778. fprintf(stream, "%s:\n", prop_name);
  2779. return;
  2780. }
  2781. size_t pos_start = 0;
  2782. size_t pos_found = 0;
  2783. if (std::isspace(data_str[0]) || std::isspace(data_str.back())) {
  2784. data_str = std::regex_replace(data_str, std::regex("\n"), "\\n");
  2785. data_str = std::regex_replace(data_str, std::regex("\""), "\\\"");
  2786. data_str = std::regex_replace(data_str, std::regex(R"(\\[^n"])"), R"(\$&)");
  2787. data_str = "\"" + data_str + "\"";
  2788. fprintf(stream, "%s: %s\n", prop_name, data_str.c_str());
  2789. return;
  2790. }
  2791. if (data_str.find('\n') == std::string::npos) {
  2792. fprintf(stream, "%s: %s\n", prop_name, data_str.c_str());
  2793. return;
  2794. }
  2795. fprintf(stream, "%s: |\n", prop_name);
  2796. while ((pos_found = data_str.find('\n', pos_start)) != std::string::npos) {
  2797. fprintf(stream, " %s\n", data_str.substr(pos_start, pos_found-pos_start).c_str());
  2798. pos_start = pos_found + 1;
  2799. }
  2800. }
  2801. void yaml_dump_non_result_info(FILE * stream, const gpt_params & params, const llama_context * lctx,
  2802. const std::string & timestamp, const std::vector<int> & prompt_tokens, const char * model_desc) {
  2803. const llama_sampling_params & sparams = params.sparams;
  2804. fprintf(stream, "build_commit: %s\n", LLAMA_COMMIT);
  2805. fprintf(stream, "build_number: %d\n", LLAMA_BUILD_NUMBER);
  2806. fprintf(stream, "cpu_has_arm_fma: %s\n", ggml_cpu_has_arm_fma() ? "true" : "false");
  2807. fprintf(stream, "cpu_has_avx: %s\n", ggml_cpu_has_avx() ? "true" : "false");
  2808. fprintf(stream, "cpu_has_avx_vnni: %s\n", ggml_cpu_has_avx_vnni() ? "true" : "false");
  2809. fprintf(stream, "cpu_has_avx2: %s\n", ggml_cpu_has_avx2() ? "true" : "false");
  2810. fprintf(stream, "cpu_has_avx512: %s\n", ggml_cpu_has_avx512() ? "true" : "false");
  2811. fprintf(stream, "cpu_has_avx512_vbmi: %s\n", ggml_cpu_has_avx512_vbmi() ? "true" : "false");
  2812. fprintf(stream, "cpu_has_avx512_vnni: %s\n", ggml_cpu_has_avx512_vnni() ? "true" : "false");
  2813. fprintf(stream, "cpu_has_cuda: %s\n", ggml_cpu_has_cuda() ? "true" : "false");
  2814. fprintf(stream, "cpu_has_vulkan: %s\n", ggml_cpu_has_vulkan() ? "true" : "false");
  2815. fprintf(stream, "cpu_has_kompute: %s\n", ggml_cpu_has_kompute() ? "true" : "false");
  2816. fprintf(stream, "cpu_has_fma: %s\n", ggml_cpu_has_fma() ? "true" : "false");
  2817. fprintf(stream, "cpu_has_gpublas: %s\n", ggml_cpu_has_gpublas() ? "true" : "false");
  2818. fprintf(stream, "cpu_has_neon: %s\n", ggml_cpu_has_neon() ? "true" : "false");
  2819. fprintf(stream, "cpu_has_sve: %s\n", ggml_cpu_has_sve() ? "true" : "false");
  2820. fprintf(stream, "cpu_has_f16c: %s\n", ggml_cpu_has_f16c() ? "true" : "false");
  2821. fprintf(stream, "cpu_has_fp16_va: %s\n", ggml_cpu_has_fp16_va() ? "true" : "false");
  2822. fprintf(stream, "cpu_has_wasm_simd: %s\n", ggml_cpu_has_wasm_simd() ? "true" : "false");
  2823. fprintf(stream, "cpu_has_blas: %s\n", ggml_cpu_has_blas() ? "true" : "false");
  2824. fprintf(stream, "cpu_has_sse3: %s\n", ggml_cpu_has_sse3() ? "true" : "false");
  2825. fprintf(stream, "cpu_has_vsx: %s\n", ggml_cpu_has_vsx() ? "true" : "false");
  2826. fprintf(stream, "cpu_has_matmul_int8: %s\n", ggml_cpu_has_matmul_int8() ? "true" : "false");
  2827. #ifdef NDEBUG
  2828. fprintf(stream, "debug: false\n");
  2829. #else
  2830. fprintf(stream, "debug: true\n");
  2831. #endif // NDEBUG
  2832. fprintf(stream, "model_desc: %s\n", model_desc);
  2833. fprintf(stream, "n_vocab: %d # output size of the final layer, 32001 for some models\n", llama_n_vocab(llama_get_model(lctx)));
  2834. #ifdef __OPTIMIZE__
  2835. fprintf(stream, "optimize: true\n");
  2836. #else
  2837. fprintf(stream, "optimize: false\n");
  2838. #endif // __OPTIMIZE__
  2839. fprintf(stream, "time: %s\n", timestamp.c_str());
  2840. fprintf(stream, "\n");
  2841. fprintf(stream, "###############\n");
  2842. fprintf(stream, "# User Inputs #\n");
  2843. fprintf(stream, "###############\n");
  2844. fprintf(stream, "\n");
  2845. fprintf(stream, "alias: %s # default: unknown\n", params.model_alias.c_str());
  2846. fprintf(stream, "batch_size: %d # default: 512\n", params.n_batch);
  2847. yaml_dump_string_multiline(stream, "cfg_negative_prompt", sparams.cfg_negative_prompt.c_str());
  2848. fprintf(stream, "cfg_scale: %f # default: 1.0\n", sparams.cfg_scale);
  2849. fprintf(stream, "chunks: %d # default: -1 (unlimited)\n", params.n_chunks);
  2850. fprintf(stream, "color: %s # default: false\n", params.use_color ? "true" : "false");
  2851. fprintf(stream, "ctx_size: %d # default: 512\n", params.n_ctx);
  2852. fprintf(stream, "escape: %s # default: false\n", params.escape ? "true" : "false");
  2853. fprintf(stream, "file: # never logged, see prompt instead. Can still be specified for input.\n");
  2854. fprintf(stream, "frequency_penalty: %f # default: 0.0 \n", sparams.penalty_freq);
  2855. yaml_dump_string_multiline(stream, "grammar", sparams.grammar.c_str());
  2856. fprintf(stream, "grammar-file: # never logged, see grammar instead. Can still be specified for input.\n");
  2857. fprintf(stream, "hellaswag: %s # default: false\n", params.hellaswag ? "true" : "false");
  2858. fprintf(stream, "hellaswag_tasks: %zu # default: 400\n", params.hellaswag_tasks);
  2859. const auto logit_bias_eos = sparams.logit_bias.find(llama_token_eos(llama_get_model(lctx)));
  2860. const bool ignore_eos = logit_bias_eos != sparams.logit_bias.end() && logit_bias_eos->second == -INFINITY;
  2861. fprintf(stream, "ignore_eos: %s # default: false\n", ignore_eos ? "true" : "false");
  2862. yaml_dump_string_multiline(stream, "in_prefix", params.input_prefix.c_str());
  2863. fprintf(stream, "in_prefix_bos: %s # default: false\n", params.input_prefix_bos ? "true" : "false");
  2864. yaml_dump_string_multiline(stream, "in_suffix", params.input_prefix.c_str());
  2865. fprintf(stream, "interactive: %s # default: false\n", params.interactive ? "true" : "false");
  2866. fprintf(stream, "interactive_first: %s # default: false\n", params.interactive_first ? "true" : "false");
  2867. fprintf(stream, "keep: %d # default: 0\n", params.n_keep);
  2868. fprintf(stream, "logdir: %s # default: unset (no logging)\n", params.logdir.c_str());
  2869. fprintf(stream, "logit_bias:\n");
  2870. for (std::pair<llama_token, float> lb : sparams.logit_bias) {
  2871. if (ignore_eos && lb.first == logit_bias_eos->first) {
  2872. continue;
  2873. }
  2874. fprintf(stream, " %d: %f", lb.first, lb.second);
  2875. }
  2876. fprintf(stream, "lora:\n");
  2877. for (std::tuple<std::string, float> la : params.lora_adapter) {
  2878. if (std::get<1>(la) != 1.0f) {
  2879. continue;
  2880. }
  2881. fprintf(stream, " - %s\n", std::get<0>(la).c_str());
  2882. }
  2883. fprintf(stream, "lora_scaled:\n");
  2884. for (std::tuple<std::string, float> la : params.lora_adapter) {
  2885. if (std::get<1>(la) == 1.0f) {
  2886. continue;
  2887. }
  2888. fprintf(stream, " - %s: %f\n", std::get<0>(la).c_str(), std::get<1>(la));
  2889. }
  2890. fprintf(stream, "lora_base: %s\n", params.lora_base.c_str());
  2891. fprintf(stream, "main_gpu: %d # default: 0\n", params.main_gpu);
  2892. fprintf(stream, "min_keep: %d # default: 0 (disabled)\n", sparams.min_keep);
  2893. fprintf(stream, "mirostat: %d # default: 0 (disabled)\n", sparams.mirostat);
  2894. fprintf(stream, "mirostat_ent: %f # default: 5.0\n", sparams.mirostat_tau);
  2895. fprintf(stream, "mirostat_lr: %f # default: 0.1\n", sparams.mirostat_eta);
  2896. fprintf(stream, "mlock: %s # default: false\n", params.use_mlock ? "true" : "false");
  2897. fprintf(stream, "model: %s # default: %s\n", params.model.c_str(), DEFAULT_MODEL_PATH);
  2898. fprintf(stream, "model_draft: %s # default:\n", params.model_draft.c_str());
  2899. fprintf(stream, "multiline_input: %s # default: false\n", params.multiline_input ? "true" : "false");
  2900. fprintf(stream, "n_gpu_layers: %d # default: -1\n", params.n_gpu_layers);
  2901. fprintf(stream, "n_predict: %d # default: -1 (unlimited)\n", params.n_predict);
  2902. fprintf(stream, "n_probs: %d # only used by server binary, default: 0\n", sparams.n_probs);
  2903. fprintf(stream, "no_mmap: %s # default: false\n", !params.use_mmap ? "true" : "false");
  2904. fprintf(stream, "penalize_nl: %s # default: false\n", sparams.penalize_nl ? "true" : "false");
  2905. fprintf(stream, "ppl_output_type: %d # default: 0\n", params.ppl_output_type);
  2906. fprintf(stream, "ppl_stride: %d # default: 0\n", params.ppl_stride);
  2907. fprintf(stream, "presence_penalty: %f # default: 0.0\n", sparams.penalty_present);
  2908. yaml_dump_string_multiline(stream, "prompt", params.prompt.c_str());
  2909. fprintf(stream, "prompt_cache: %s\n", params.path_prompt_cache.c_str());
  2910. fprintf(stream, "prompt_cache_all: %s # default: false\n", params.prompt_cache_all ? "true" : "false");
  2911. fprintf(stream, "prompt_cache_ro: %s # default: false\n", params.prompt_cache_ro ? "true" : "false");
  2912. yaml_dump_vector_int(stream, "prompt_tokens", prompt_tokens);
  2913. fprintf(stream, "repeat_penalty: %f # default: 1.1\n", sparams.penalty_repeat);
  2914. fprintf(stream, "reverse_prompt:\n");
  2915. for (std::string ap : params.antiprompt) {
  2916. size_t pos = 0;
  2917. while ((pos = ap.find('\n', pos)) != std::string::npos) {
  2918. ap.replace(pos, 1, "\\n");
  2919. pos += 1;
  2920. }
  2921. fprintf(stream, " - %s\n", ap.c_str());
  2922. }
  2923. fprintf(stream, "rope_freq_base: %f # default: 10000.0\n", params.rope_freq_base);
  2924. fprintf(stream, "rope_freq_scale: %f # default: 1.0\n", params.rope_freq_scale);
  2925. fprintf(stream, "seed: %u # default: -1 (random seed)\n", params.seed);
  2926. fprintf(stream, "simple_io: %s # default: false\n", params.simple_io ? "true" : "false");
  2927. fprintf(stream, "cont_batching: %s # default: false\n", params.cont_batching ? "true" : "false");
  2928. fprintf(stream, "flash_attn: %s # default: false\n", params.flash_attn ? "true" : "false");
  2929. fprintf(stream, "temp: %f # default: 0.8\n", sparams.temp);
  2930. const std::vector<float> tensor_split_vector(params.tensor_split, params.tensor_split + llama_max_devices());
  2931. yaml_dump_vector_float(stream, "tensor_split", tensor_split_vector);
  2932. fprintf(stream, "tfs: %f # default: 1.0\n", sparams.tfs_z);
  2933. fprintf(stream, "threads: %d # default: %u\n", params.n_threads, std::thread::hardware_concurrency());
  2934. fprintf(stream, "top_k: %d # default: 40\n", sparams.top_k);
  2935. fprintf(stream, "top_p: %f # default: 0.95\n", sparams.top_p);
  2936. fprintf(stream, "min_p: %f # default: 0.0\n", sparams.min_p);
  2937. fprintf(stream, "typical_p: %f # default: 1.0\n", sparams.typical_p);
  2938. fprintf(stream, "verbose_prompt: %s # default: false\n", params.verbose_prompt ? "true" : "false");
  2939. fprintf(stream, "display_prompt: %s # default: true\n", params.display_prompt ? "true" : "false");
  2940. }