llama.cpp 361 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747
  1. #define LLAMA_API_INTERNAL
  2. #include "llama.h"
  3. #include "unicode.h"
  4. #include "ggml.h"
  5. #include "ggml-alloc.h"
  6. #ifdef GGML_USE_CUBLAS
  7. # include "ggml-cuda.h"
  8. #elif defined(GGML_USE_CLBLAST)
  9. # include "ggml-opencl.h"
  10. #endif
  11. #ifdef GGML_USE_METAL
  12. # include "ggml-metal.h"
  13. #endif
  14. #ifdef GGML_USE_MPI
  15. # include "ggml-mpi.h"
  16. #endif
  17. #ifndef QK_K
  18. # ifdef GGML_QKK_64
  19. # define QK_K 64
  20. # else
  21. # define QK_K 256
  22. # endif
  23. #endif
  24. #ifdef __has_include
  25. #if __has_include(<unistd.h>)
  26. #include <unistd.h>
  27. #if defined(_POSIX_MAPPED_FILES)
  28. #include <sys/mman.h>
  29. #endif
  30. #if defined(_POSIX_MEMLOCK_RANGE)
  31. #include <sys/resource.h>
  32. #endif
  33. #endif
  34. #endif
  35. #if defined(_WIN32)
  36. #define WIN32_LEAN_AND_MEAN
  37. #ifndef NOMINMAX
  38. #define NOMINMAX
  39. #endif
  40. #include <windows.h>
  41. #include <io.h>
  42. #endif
  43. #include <algorithm>
  44. #include <array>
  45. #include <cassert>
  46. #include <cinttypes>
  47. #include <climits>
  48. #include <cmath>
  49. #include <cstdarg>
  50. #include <cstddef>
  51. #include <cstdint>
  52. #include <cstdio>
  53. #include <cstring>
  54. #include <ctime>
  55. #include <forward_list>
  56. #include <fstream>
  57. #include <functional>
  58. #include <initializer_list>
  59. #include <map>
  60. #include <memory>
  61. #include <mutex>
  62. #include <numeric>
  63. #include <queue>
  64. #include <random>
  65. #include <regex>
  66. #include <set>
  67. #include <sstream>
  68. #include <thread>
  69. #include <unordered_map>
  70. #if defined(_MSC_VER)
  71. #pragma warning(disable: 4244 4267) // possible loss of data
  72. #endif
  73. #ifdef __GNUC__
  74. #ifdef __MINGW32__
  75. #define LLAMA_ATTRIBUTE_FORMAT(...) __attribute__((format(gnu_printf, __VA_ARGS__)))
  76. #else
  77. #define LLAMA_ATTRIBUTE_FORMAT(...) __attribute__((format(printf, __VA_ARGS__)))
  78. #endif
  79. #else
  80. #define LLAMA_ATTRIBUTE_FORMAT(...)
  81. #endif
  82. #define LLAMA_MAX_NODES 8192
  83. //
  84. // logging
  85. //
  86. LLAMA_ATTRIBUTE_FORMAT(2, 3)
  87. static void llama_log_internal (ggml_log_level level, const char* format, ...);
  88. static void llama_log_callback_default(ggml_log_level level, const char * text, void * user_data);
  89. #define LLAMA_LOG_INFO(...) llama_log_internal(GGML_LOG_LEVEL_INFO , __VA_ARGS__)
  90. #define LLAMA_LOG_WARN(...) llama_log_internal(GGML_LOG_LEVEL_WARN , __VA_ARGS__)
  91. #define LLAMA_LOG_ERROR(...) llama_log_internal(GGML_LOG_LEVEL_ERROR, __VA_ARGS__)
  92. //
  93. // helpers
  94. //
  95. static size_t utf8_len(char src) {
  96. const size_t lookup[] = { 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 3, 4 };
  97. uint8_t highbits = static_cast<uint8_t>(src) >> 4;
  98. return lookup[highbits];
  99. }
  100. static void replace_all(std::string & s, const std::string & search, const std::string & replace) {
  101. std::string result;
  102. for (size_t pos = 0; ; pos += search.length()) {
  103. auto new_pos = s.find(search, pos);
  104. if (new_pos == std::string::npos) {
  105. result += s.substr(pos, s.size() - pos);
  106. break;
  107. }
  108. result += s.substr(pos, new_pos - pos) + replace;
  109. pos = new_pos;
  110. }
  111. s = std::move(result);
  112. }
  113. static bool is_float_close(float a, float b, float abs_tol) {
  114. // Check for non-negative tolerance
  115. if (abs_tol < 0.0) {
  116. throw std::invalid_argument("Tolerance must be non-negative");
  117. }
  118. // Exact equality check
  119. if (a == b) {
  120. return true;
  121. }
  122. // Check for infinities
  123. if (std::isinf(a) || std::isinf(b)) {
  124. return false;
  125. }
  126. // Regular comparison using the provided absolute tolerance
  127. return std::fabs(b - a) <= abs_tol;
  128. }
  129. #ifdef GGML_USE_CPU_HBM
  130. #include <hbwmalloc.h>
  131. #endif
  132. static void zeros(std::ofstream & file, size_t n) {
  133. char zero = 0;
  134. for (size_t i = 0; i < n; ++i) {
  135. file.write(&zero, 1);
  136. }
  137. }
  138. LLAMA_ATTRIBUTE_FORMAT(1, 2)
  139. static std::string format(const char * fmt, ...) {
  140. va_list ap;
  141. va_list ap2;
  142. va_start(ap, fmt);
  143. va_copy(ap2, ap);
  144. int size = vsnprintf(NULL, 0, fmt, ap);
  145. GGML_ASSERT(size >= 0 && size < INT_MAX); // NOLINT
  146. std::vector<char> buf(size + 1);
  147. int size2 = vsnprintf(buf.data(), size + 1, fmt, ap2);
  148. GGML_ASSERT(size2 == size);
  149. va_end(ap2);
  150. va_end(ap);
  151. return std::string(buf.data(), size);
  152. }
  153. //
  154. // gguf constants (sync with gguf.py)
  155. //
  156. enum llm_arch {
  157. LLM_ARCH_LLAMA,
  158. LLM_ARCH_FALCON,
  159. LLM_ARCH_BAICHUAN,
  160. LLM_ARCH_GPT2,
  161. LLM_ARCH_GPTJ,
  162. LLM_ARCH_GPTNEOX,
  163. LLM_ARCH_MPT,
  164. LLM_ARCH_STARCODER,
  165. LLM_ARCH_PERSIMMON,
  166. LLM_ARCH_REFACT,
  167. LLM_ARCH_BLOOM,
  168. LLM_ARCH_STABLELM,
  169. LLM_ARCH_UNKNOWN,
  170. };
  171. static std::map<llm_arch, std::string> LLM_ARCH_NAMES = {
  172. { LLM_ARCH_LLAMA, "llama" },
  173. { LLM_ARCH_FALCON, "falcon" },
  174. { LLM_ARCH_GPT2, "gpt2" },
  175. { LLM_ARCH_GPTJ, "gptj" },
  176. { LLM_ARCH_GPTNEOX, "gptneox" },
  177. { LLM_ARCH_MPT, "mpt" },
  178. { LLM_ARCH_BAICHUAN, "baichuan" },
  179. { LLM_ARCH_STARCODER, "starcoder" },
  180. { LLM_ARCH_PERSIMMON, "persimmon" },
  181. { LLM_ARCH_REFACT, "refact" },
  182. { LLM_ARCH_BLOOM, "bloom" },
  183. { LLM_ARCH_STABLELM, "stablelm" },
  184. };
  185. enum llm_kv {
  186. LLM_KV_GENERAL_ARCHITECTURE,
  187. LLM_KV_GENERAL_QUANTIZATION_VERSION,
  188. LLM_KV_GENERAL_ALIGNMENT,
  189. LLM_KV_GENERAL_NAME,
  190. LLM_KV_GENERAL_AUTHOR,
  191. LLM_KV_GENERAL_URL,
  192. LLM_KV_GENERAL_DESCRIPTION,
  193. LLM_KV_GENERAL_LICENSE,
  194. LLM_KV_GENERAL_SOURCE_URL,
  195. LLM_KV_GENERAL_SOURCE_HF_REPO,
  196. LLM_KV_CONTEXT_LENGTH,
  197. LLM_KV_EMBEDDING_LENGTH,
  198. LLM_KV_BLOCK_COUNT,
  199. LLM_KV_FEED_FORWARD_LENGTH,
  200. LLM_KV_USE_PARALLEL_RESIDUAL,
  201. LLM_KV_TENSOR_DATA_LAYOUT,
  202. LLM_KV_ATTENTION_HEAD_COUNT,
  203. LLM_KV_ATTENTION_HEAD_COUNT_KV,
  204. LLM_KV_ATTENTION_MAX_ALIBI_BIAS,
  205. LLM_KV_ATTENTION_CLAMP_KQV,
  206. LLM_KV_ATTENTION_LAYERNORM_EPS,
  207. LLM_KV_ATTENTION_LAYERNORM_RMS_EPS,
  208. LLM_KV_ROPE_DIMENSION_COUNT,
  209. LLM_KV_ROPE_FREQ_BASE,
  210. LLM_KV_ROPE_SCALE_LINEAR,
  211. LLM_KV_ROPE_SCALING_TYPE,
  212. LLM_KV_ROPE_SCALING_FACTOR,
  213. LLM_KV_ROPE_SCALING_ORIG_CTX_LEN,
  214. LLM_KV_ROPE_SCALING_FINETUNED,
  215. LLM_KV_TOKENIZER_MODEL,
  216. LLM_KV_TOKENIZER_LIST,
  217. LLM_KV_TOKENIZER_TOKEN_TYPE,
  218. LLM_KV_TOKENIZER_SCORES,
  219. LLM_KV_TOKENIZER_MERGES,
  220. LLM_KV_TOKENIZER_BOS_ID,
  221. LLM_KV_TOKENIZER_EOS_ID,
  222. LLM_KV_TOKENIZER_UNK_ID,
  223. LLM_KV_TOKENIZER_SEP_ID,
  224. LLM_KV_TOKENIZER_PAD_ID,
  225. LLM_KV_TOKENIZER_ADD_BOS,
  226. LLM_KV_TOKENIZER_ADD_EOS,
  227. LLM_KV_TOKENIZER_HF_JSON,
  228. LLM_KV_TOKENIZER_RWKV,
  229. };
  230. static std::map<llm_kv, std::string> LLM_KV_NAMES = {
  231. { LLM_KV_GENERAL_ARCHITECTURE, "general.architecture" },
  232. { LLM_KV_GENERAL_QUANTIZATION_VERSION, "general.quantization_version" },
  233. { LLM_KV_GENERAL_ALIGNMENT, "general.alignment" },
  234. { LLM_KV_GENERAL_NAME, "general.name" },
  235. { LLM_KV_GENERAL_AUTHOR, "general.author" },
  236. { LLM_KV_GENERAL_URL, "general.url" },
  237. { LLM_KV_GENERAL_DESCRIPTION, "general.description" },
  238. { LLM_KV_GENERAL_LICENSE, "general.license" },
  239. { LLM_KV_GENERAL_SOURCE_URL, "general.source.url" },
  240. { LLM_KV_GENERAL_SOURCE_HF_REPO, "general.source.huggingface.repository" },
  241. { LLM_KV_CONTEXT_LENGTH, "%s.context_length" },
  242. { LLM_KV_EMBEDDING_LENGTH, "%s.embedding_length" },
  243. { LLM_KV_BLOCK_COUNT, "%s.block_count" },
  244. { LLM_KV_FEED_FORWARD_LENGTH, "%s.feed_forward_length" },
  245. { LLM_KV_USE_PARALLEL_RESIDUAL, "%s.use_parallel_residual" },
  246. { LLM_KV_TENSOR_DATA_LAYOUT, "%s.tensor_data_layout" },
  247. { LLM_KV_ATTENTION_HEAD_COUNT, "%s.attention.head_count" },
  248. { LLM_KV_ATTENTION_HEAD_COUNT_KV, "%s.attention.head_count_kv" },
  249. { LLM_KV_ATTENTION_MAX_ALIBI_BIAS, "%s.attention.max_alibi_bias" },
  250. { LLM_KV_ATTENTION_CLAMP_KQV, "%s.attention.clamp_kqv" },
  251. { LLM_KV_ATTENTION_LAYERNORM_EPS, "%s.attention.layer_norm_epsilon" },
  252. { LLM_KV_ATTENTION_LAYERNORM_RMS_EPS, "%s.attention.layer_norm_rms_epsilon" },
  253. { LLM_KV_ROPE_DIMENSION_COUNT, "%s.rope.dimension_count" },
  254. { LLM_KV_ROPE_FREQ_BASE, "%s.rope.freq_base" },
  255. { LLM_KV_ROPE_SCALE_LINEAR, "%s.rope.scale_linear" },
  256. { LLM_KV_ROPE_SCALING_TYPE, "%s.rope.scaling.type" },
  257. { LLM_KV_ROPE_SCALING_FACTOR, "%s.rope.scaling.factor" },
  258. { LLM_KV_ROPE_SCALING_ORIG_CTX_LEN, "%s.rope.scaling.original_context_length" },
  259. { LLM_KV_ROPE_SCALING_FINETUNED, "%s.rope.scaling.finetuned" },
  260. { LLM_KV_TOKENIZER_MODEL, "tokenizer.ggml.model" },
  261. { LLM_KV_TOKENIZER_LIST, "tokenizer.ggml.tokens" },
  262. { LLM_KV_TOKENIZER_TOKEN_TYPE, "tokenizer.ggml.token_type" },
  263. { LLM_KV_TOKENIZER_SCORES, "tokenizer.ggml.scores" },
  264. { LLM_KV_TOKENIZER_MERGES, "tokenizer.ggml.merges" },
  265. { LLM_KV_TOKENIZER_BOS_ID, "tokenizer.ggml.bos_token_id" },
  266. { LLM_KV_TOKENIZER_EOS_ID, "tokenizer.ggml.eos_token_id" },
  267. { LLM_KV_TOKENIZER_UNK_ID, "tokenizer.ggml.unknown_token_id" },
  268. { LLM_KV_TOKENIZER_SEP_ID, "tokenizer.ggml.seperator_token_id" },
  269. { LLM_KV_TOKENIZER_PAD_ID, "tokenizer.ggml.padding_token_id" },
  270. { LLM_KV_TOKENIZER_ADD_BOS, "tokenizer.ggml.add_bos_token" },
  271. { LLM_KV_TOKENIZER_ADD_EOS, "tokenizer.ggml.add_eos_token" },
  272. { LLM_KV_TOKENIZER_HF_JSON, "tokenizer.huggingface.json" },
  273. { LLM_KV_TOKENIZER_RWKV, "tokenizer.rwkv.world" },
  274. };
  275. struct LLM_KV {
  276. LLM_KV(llm_arch arch) : arch(arch) {}
  277. llm_arch arch;
  278. std::string operator()(llm_kv kv) const {
  279. return ::format(LLM_KV_NAMES[kv].c_str(), LLM_ARCH_NAMES[arch].c_str());
  280. }
  281. };
  282. enum llm_tensor {
  283. LLM_TENSOR_TOKEN_EMBD,
  284. LLM_TENSOR_TOKEN_EMBD_NORM,
  285. LLM_TENSOR_POS_EMBD,
  286. LLM_TENSOR_OUTPUT,
  287. LLM_TENSOR_OUTPUT_NORM,
  288. LLM_TENSOR_ROPE_FREQS,
  289. LLM_TENSOR_ATTN_Q,
  290. LLM_TENSOR_ATTN_K,
  291. LLM_TENSOR_ATTN_V,
  292. LLM_TENSOR_ATTN_QKV,
  293. LLM_TENSOR_ATTN_OUT,
  294. LLM_TENSOR_ATTN_NORM,
  295. LLM_TENSOR_ATTN_NORM_2,
  296. LLM_TENSOR_ATTN_ROT_EMBD,
  297. LLM_TENSOR_FFN_GATE,
  298. LLM_TENSOR_FFN_DOWN,
  299. LLM_TENSOR_FFN_UP,
  300. LLM_TENSOR_FFN_NORM,
  301. LLM_TENSOR_ATTN_Q_NORM,
  302. LLM_TENSOR_ATTN_K_NORM,
  303. };
  304. static std::map<llm_arch, std::map<llm_tensor, std::string>> LLM_TENSOR_NAMES = {
  305. {
  306. LLM_ARCH_LLAMA,
  307. {
  308. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  309. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  310. { LLM_TENSOR_OUTPUT, "output" },
  311. { LLM_TENSOR_ROPE_FREQS, "rope_freqs" },
  312. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  313. { LLM_TENSOR_ATTN_Q, "blk.%d.attn_q" },
  314. { LLM_TENSOR_ATTN_K, "blk.%d.attn_k" },
  315. { LLM_TENSOR_ATTN_V, "blk.%d.attn_v" },
  316. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  317. { LLM_TENSOR_ATTN_ROT_EMBD, "blk.%d.attn_rot_embd" },
  318. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  319. { LLM_TENSOR_FFN_GATE, "blk.%d.ffn_gate" },
  320. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  321. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  322. },
  323. },
  324. {
  325. LLM_ARCH_BAICHUAN,
  326. {
  327. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  328. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  329. { LLM_TENSOR_OUTPUT, "output" },
  330. { LLM_TENSOR_ROPE_FREQS, "rope_freqs" },
  331. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  332. { LLM_TENSOR_ATTN_Q, "blk.%d.attn_q" },
  333. { LLM_TENSOR_ATTN_K, "blk.%d.attn_k" },
  334. { LLM_TENSOR_ATTN_V, "blk.%d.attn_v" },
  335. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  336. { LLM_TENSOR_ATTN_ROT_EMBD, "blk.%d.attn_rot_embd" },
  337. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  338. { LLM_TENSOR_FFN_GATE, "blk.%d.ffn_gate" },
  339. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  340. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  341. },
  342. },
  343. {
  344. LLM_ARCH_FALCON,
  345. {
  346. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  347. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  348. { LLM_TENSOR_OUTPUT, "output" },
  349. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  350. { LLM_TENSOR_ATTN_NORM_2, "blk.%d.attn_norm_2" },
  351. { LLM_TENSOR_ATTN_QKV, "blk.%d.attn_qkv" },
  352. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  353. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  354. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  355. },
  356. },
  357. {
  358. LLM_ARCH_GPT2,
  359. {
  360. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  361. },
  362. },
  363. {
  364. LLM_ARCH_GPTJ,
  365. {
  366. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  367. },
  368. },
  369. {
  370. LLM_ARCH_GPTNEOX,
  371. {
  372. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  373. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  374. { LLM_TENSOR_OUTPUT, "output" },
  375. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  376. { LLM_TENSOR_ATTN_QKV, "blk.%d.attn_qkv" },
  377. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  378. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  379. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  380. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  381. },
  382. },
  383. {
  384. LLM_ARCH_PERSIMMON,
  385. {
  386. { LLM_TENSOR_TOKEN_EMBD, "token_embd"},
  387. { LLM_TENSOR_OUTPUT_NORM, "output_norm"},
  388. { LLM_TENSOR_OUTPUT, "output"},
  389. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm"},
  390. { LLM_TENSOR_ATTN_QKV, "blk.%d.attn_qkv"},
  391. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output"},
  392. { LLM_TENSOR_ATTN_Q_NORM, "blk.%d.attn_q_norm"},
  393. { LLM_TENSOR_ATTN_K_NORM, "blk.%d.attn_k_norm"},
  394. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm"},
  395. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down"},
  396. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up"},
  397. { LLM_TENSOR_ATTN_ROT_EMBD, "blk.%d.attn_rot_embd"},
  398. },
  399. },
  400. {
  401. LLM_ARCH_MPT,
  402. {
  403. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  404. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  405. { LLM_TENSOR_OUTPUT, "output" },
  406. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  407. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  408. { LLM_TENSOR_ATTN_QKV, "blk.%d.attn_qkv" },
  409. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  410. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  411. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  412. },
  413. },
  414. {
  415. LLM_ARCH_STARCODER,
  416. {
  417. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  418. { LLM_TENSOR_POS_EMBD, "position_embd" },
  419. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  420. { LLM_TENSOR_OUTPUT, "output" },
  421. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  422. { LLM_TENSOR_ATTN_QKV, "blk.%d.attn_qkv" },
  423. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  424. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  425. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  426. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  427. },
  428. },
  429. {
  430. LLM_ARCH_REFACT,
  431. {
  432. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  433. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  434. { LLM_TENSOR_OUTPUT, "output" },
  435. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  436. { LLM_TENSOR_ATTN_Q, "blk.%d.attn_q" },
  437. { LLM_TENSOR_ATTN_K, "blk.%d.attn_k" },
  438. { LLM_TENSOR_ATTN_V, "blk.%d.attn_v" },
  439. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  440. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  441. { LLM_TENSOR_FFN_GATE, "blk.%d.ffn_gate" },
  442. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  443. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  444. },
  445. },
  446. {
  447. LLM_ARCH_BLOOM,
  448. {
  449. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  450. { LLM_TENSOR_TOKEN_EMBD_NORM, "token_embd_norm" },
  451. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  452. { LLM_TENSOR_OUTPUT, "output" },
  453. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  454. { LLM_TENSOR_ATTN_QKV, "blk.%d.attn_qkv" },
  455. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  456. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  457. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  458. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  459. },
  460. },
  461. {
  462. LLM_ARCH_STABLELM,
  463. {
  464. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  465. { LLM_TENSOR_OUTPUT_NORM, "output_norm" },
  466. { LLM_TENSOR_OUTPUT, "output" },
  467. { LLM_TENSOR_ROPE_FREQS, "rope_freqs" },
  468. { LLM_TENSOR_ATTN_NORM, "blk.%d.attn_norm" },
  469. { LLM_TENSOR_ATTN_Q, "blk.%d.attn_q" },
  470. { LLM_TENSOR_ATTN_K, "blk.%d.attn_k" },
  471. { LLM_TENSOR_ATTN_V, "blk.%d.attn_v" },
  472. { LLM_TENSOR_ATTN_OUT, "blk.%d.attn_output" },
  473. { LLM_TENSOR_FFN_NORM, "blk.%d.ffn_norm" },
  474. { LLM_TENSOR_FFN_GATE, "blk.%d.ffn_gate" },
  475. { LLM_TENSOR_FFN_DOWN, "blk.%d.ffn_down" },
  476. { LLM_TENSOR_FFN_UP, "blk.%d.ffn_up" },
  477. },
  478. },
  479. {
  480. LLM_ARCH_UNKNOWN,
  481. {
  482. { LLM_TENSOR_TOKEN_EMBD, "token_embd" },
  483. },
  484. },
  485. };
  486. static llm_arch llm_arch_from_string(const std::string & name) {
  487. for (const auto & kv : LLM_ARCH_NAMES) { // NOLINT
  488. if (kv.second == name) {
  489. return kv.first;
  490. }
  491. }
  492. return LLM_ARCH_UNKNOWN;
  493. }
  494. // helper to handle gguf constants
  495. // usage:
  496. //
  497. // const auto tn = LLM_TN(LLM_ARCH_LLAMA);
  498. //
  499. // std::string name = tn(LLM_TENSOR_OUTPUT); -> "output"
  500. // std::string name = tn(LLM_TENSOR_TOKEN_EMBD, "bias"); -> "token_embd.bias"
  501. // std::string name = tn(LLM_TENSOR_ATTN_NORM, "weight", 3); -> "blk.3.attn_norm.weight"
  502. //
  503. struct LLM_TN {
  504. LLM_TN(llm_arch arch) : arch(arch) {}
  505. llm_arch arch;
  506. std::string operator()(llm_tensor tensor) const {
  507. return LLM_TENSOR_NAMES[arch].at(tensor);
  508. }
  509. std::string operator()(llm_tensor tensor, const std::string & suffix) const {
  510. return LLM_TENSOR_NAMES[arch].at(tensor) + "." + suffix;
  511. }
  512. std::string operator()(llm_tensor tensor, int bid) const {
  513. return ::format(LLM_TENSOR_NAMES[arch].at(tensor).c_str(), bid);
  514. }
  515. std::string operator()(llm_tensor tensor, const std::string & suffix, int bid) const {
  516. return ::format(LLM_TENSOR_NAMES[arch].at(tensor).c_str(), bid) + "." + suffix;
  517. }
  518. };
  519. //
  520. // gguf helpers
  521. //
  522. #define GGUF_GET_KEY(ctx, dst, func, type, req, key) \
  523. do { \
  524. const std::string skey(key); \
  525. const int kid = gguf_find_key(ctx, skey.c_str()); \
  526. if (kid >= 0) { \
  527. enum gguf_type ktype = gguf_get_kv_type(ctx, kid); \
  528. if (ktype != (type)) { \
  529. throw std::runtime_error(format("key %s has wrong type: %s", skey.c_str(), gguf_type_name(ktype))); \
  530. } \
  531. (dst) = func(ctx, kid); \
  532. } else if (req) { \
  533. throw std::runtime_error(format("key not found in model: %s", skey.c_str())); \
  534. } \
  535. } while (0)
  536. static std::map<int8_t, std::string> LLAMA_ROPE_SCALING_TYPES = {
  537. { LLAMA_ROPE_SCALING_NONE, "none" },
  538. { LLAMA_ROPE_SCALING_LINEAR, "linear" },
  539. { LLAMA_ROPE_SCALING_YARN, "yarn" },
  540. };
  541. static int8_t llama_rope_scaling_type_from_string(const std::string & name) {
  542. for (const auto & kv : LLAMA_ROPE_SCALING_TYPES) {
  543. if (kv.second == name) {
  544. return kv.first;
  545. }
  546. }
  547. return LLAMA_ROPE_SCALING_UNSPECIFIED;
  548. }
  549. static std::string gguf_data_to_str(enum gguf_type type, const void * data, int i) {
  550. switch (type) {
  551. case GGUF_TYPE_UINT8: return std::to_string(((const uint8_t *)data)[i]);
  552. case GGUF_TYPE_INT8: return std::to_string(((const int8_t *)data)[i]);
  553. case GGUF_TYPE_UINT16: return std::to_string(((const uint16_t *)data)[i]);
  554. case GGUF_TYPE_INT16: return std::to_string(((const int16_t *)data)[i]);
  555. case GGUF_TYPE_UINT32: return std::to_string(((const uint32_t *)data)[i]);
  556. case GGUF_TYPE_INT32: return std::to_string(((const int32_t *)data)[i]);
  557. case GGUF_TYPE_UINT64: return std::to_string(((const uint64_t *)data)[i]);
  558. case GGUF_TYPE_INT64: return std::to_string(((const int64_t *)data)[i]);
  559. case GGUF_TYPE_FLOAT32: return std::to_string(((const float *)data)[i]);
  560. case GGUF_TYPE_FLOAT64: return std::to_string(((const double *)data)[i]);
  561. case GGUF_TYPE_BOOL: return ((const bool *)data)[i] ? "true" : "false";
  562. default: return format("unknown type %d", type);
  563. }
  564. }
  565. static std::string gguf_kv_to_str(struct gguf_context * ctx_gguf, int i) {
  566. const enum gguf_type type = gguf_get_kv_type(ctx_gguf, i);
  567. switch (type) {
  568. case GGUF_TYPE_STRING:
  569. return gguf_get_val_str(ctx_gguf, i);
  570. case GGUF_TYPE_ARRAY:
  571. {
  572. const enum gguf_type arr_type = gguf_get_arr_type(ctx_gguf, i);
  573. int arr_n = gguf_get_arr_n(ctx_gguf, i);
  574. const void * data = gguf_get_arr_data(ctx_gguf, i);
  575. std::stringstream ss;
  576. ss << "[";
  577. for (int j = 0; j < arr_n; j++) {
  578. if (arr_type == GGUF_TYPE_STRING) {
  579. std::string val = gguf_get_arr_str(ctx_gguf, i, j);
  580. // escape quotes
  581. replace_all(val, "\\", "\\\\");
  582. replace_all(val, "\"", "\\\"");
  583. ss << '"' << val << '"';
  584. } else if (arr_type == GGUF_TYPE_ARRAY) {
  585. ss << "???";
  586. } else {
  587. ss << gguf_data_to_str(arr_type, data, j);
  588. }
  589. if (j < arr_n - 1) {
  590. ss << ", ";
  591. }
  592. }
  593. ss << "]";
  594. return ss.str();
  595. }
  596. default:
  597. return gguf_data_to_str(type, gguf_get_val_data(ctx_gguf, i), 0);
  598. }
  599. }
  600. //
  601. // ggml helpers
  602. //
  603. static void ggml_graph_compute_helper(std::vector<uint8_t> & buf, ggml_cgraph * graph, int n_threads) {
  604. struct ggml_cplan plan = ggml_graph_plan(graph, n_threads);
  605. if (plan.work_size > 0) {
  606. buf.resize(plan.work_size);
  607. plan.work_data = buf.data();
  608. }
  609. ggml_graph_compute(graph, &plan);
  610. }
  611. //
  612. // llama helpers
  613. //
  614. inline void * llama_host_malloc(size_t n) {
  615. #ifdef GGML_USE_CUBLAS
  616. if (ggml_cublas_loaded()) {
  617. return ggml_cuda_host_malloc(n);
  618. } else {
  619. return malloc(n);
  620. }
  621. #elif GGML_USE_METAL
  622. return ggml_metal_host_malloc(n);
  623. #elif GGML_USE_CPU_HBM
  624. return hbw_malloc(n);
  625. #else
  626. return malloc(n);
  627. #endif
  628. }
  629. inline void llama_host_free(void * ptr) {
  630. #ifdef GGML_USE_CUBLAS
  631. if (ggml_cublas_loaded()) {
  632. return ggml_cuda_host_free(ptr);
  633. } else {
  634. return free(ptr);
  635. }
  636. #elif GGML_USE_METAL
  637. return ggml_metal_host_free(ptr);
  638. #elif GGML_USE_CPU_HBM
  639. return hbw_free(ptr);
  640. #else
  641. return free(ptr);
  642. #endif
  643. }
  644. #if defined(_WIN32)
  645. static std::string llama_format_win_err(DWORD err) {
  646. LPSTR buf;
  647. size_t size = FormatMessageA(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
  648. NULL, err, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPSTR)&buf, 0, NULL);
  649. if (!size) {
  650. return "FormatMessageA failed";
  651. }
  652. std::string ret(buf, size);
  653. LocalFree(buf);
  654. return ret;
  655. }
  656. #endif
  657. struct llama_buffer {
  658. void * data = NULL;
  659. size_t size = 0;
  660. // fallback to malloc / free
  661. // useful in cases where CUDA can try to allocate PINNED memory
  662. bool fallback = false;
  663. void resize(size_t n) {
  664. llama_host_free(data);
  665. data = llama_host_malloc(n);
  666. if (!data) {
  667. fallback = true;
  668. data = malloc(n);
  669. } else {
  670. fallback = false;
  671. }
  672. GGML_ASSERT(data);
  673. size = n;
  674. }
  675. ~llama_buffer() {
  676. if (data) {
  677. if (fallback) { // NOLINT
  678. free(data);
  679. } else {
  680. llama_host_free(data);
  681. }
  682. }
  683. data = NULL;
  684. }
  685. };
  686. struct llama_file {
  687. // use FILE * so we don't have to re-open the file to mmap
  688. FILE * fp;
  689. size_t size;
  690. llama_file(const char * fname, const char * mode) {
  691. fp = std::fopen(fname, mode);
  692. if (fp == NULL) {
  693. throw std::runtime_error(format("failed to open %s: %s", fname, strerror(errno)));
  694. }
  695. seek(0, SEEK_END);
  696. size = tell();
  697. seek(0, SEEK_SET);
  698. }
  699. size_t tell() const {
  700. #ifdef _WIN32
  701. __int64 ret = _ftelli64(fp);
  702. #else
  703. long ret = std::ftell(fp);
  704. #endif
  705. GGML_ASSERT(ret != -1); // this really shouldn't fail
  706. return (size_t) ret;
  707. }
  708. void seek(size_t offset, int whence) const {
  709. #ifdef _WIN32
  710. int ret = _fseeki64(fp, (__int64) offset, whence);
  711. #else
  712. int ret = std::fseek(fp, (long) offset, whence);
  713. #endif
  714. GGML_ASSERT(ret == 0); // same
  715. }
  716. void read_raw(void * ptr, size_t len) const {
  717. if (len == 0) {
  718. return;
  719. }
  720. errno = 0;
  721. std::size_t ret = std::fread(ptr, len, 1, fp);
  722. if (ferror(fp)) {
  723. throw std::runtime_error(format("read error: %s", strerror(errno)));
  724. }
  725. if (ret != 1) {
  726. throw std::runtime_error(std::string("unexpectedly reached end of file"));
  727. }
  728. }
  729. uint32_t read_u32() const {
  730. uint32_t ret;
  731. read_raw(&ret, sizeof(ret));
  732. return ret;
  733. }
  734. void write_raw(const void * ptr, size_t len) const {
  735. if (len == 0) {
  736. return;
  737. }
  738. errno = 0;
  739. size_t ret = std::fwrite(ptr, len, 1, fp);
  740. if (ret != 1) {
  741. throw std::runtime_error(format("write error: %s", strerror(errno)));
  742. }
  743. }
  744. void write_u32(std::uint32_t val) const {
  745. write_raw(&val, sizeof(val));
  746. }
  747. ~llama_file() {
  748. if (fp) {
  749. std::fclose(fp);
  750. }
  751. }
  752. };
  753. struct llama_mmap {
  754. void * addr;
  755. size_t size;
  756. llama_mmap(const llama_mmap &) = delete;
  757. #ifdef _POSIX_MAPPED_FILES
  758. static constexpr bool SUPPORTED = true;
  759. llama_mmap(struct llama_file * file, size_t prefetch = (size_t) -1 /* -1 = max value */, bool numa = false) {
  760. size = file->size;
  761. int fd = fileno(file->fp);
  762. int flags = MAP_SHARED;
  763. // prefetch/readahead impairs performance on NUMA systems
  764. if (numa) { prefetch = 0; }
  765. #ifdef __linux__
  766. if (prefetch) { flags |= MAP_POPULATE; }
  767. #endif
  768. addr = mmap(NULL, file->size, PROT_READ, flags, fd, 0);
  769. if (addr == MAP_FAILED) {
  770. throw std::runtime_error(format("mmap failed: %s", strerror(errno)));
  771. }
  772. if (prefetch > 0) {
  773. // Advise the kernel to preload the mapped memory
  774. if (posix_madvise(addr, std::min(file->size, prefetch), POSIX_MADV_WILLNEED)) {
  775. fprintf(stderr, "warning: posix_madvise(.., POSIX_MADV_WILLNEED) failed: %s\n",
  776. strerror(errno));
  777. }
  778. }
  779. if (numa) {
  780. // advise the kernel not to use readahead
  781. // (because the next page might not belong on the same node)
  782. if (posix_madvise(addr, file->size, POSIX_MADV_RANDOM)) {
  783. fprintf(stderr, "warning: posix_madvise(.., POSIX_MADV_RANDOM) failed: %s\n",
  784. strerror(errno));
  785. }
  786. }
  787. }
  788. ~llama_mmap() {
  789. munmap(addr, size);
  790. }
  791. #elif defined(_WIN32)
  792. static constexpr bool SUPPORTED = true;
  793. llama_mmap(struct llama_file * file, bool prefetch = true, bool numa = false) {
  794. (void) numa;
  795. size = file->size;
  796. HANDLE hFile = (HANDLE) _get_osfhandle(_fileno(file->fp));
  797. HANDLE hMapping = CreateFileMappingA(hFile, NULL, PAGE_READONLY, 0, 0, NULL);
  798. DWORD error = GetLastError();
  799. if (hMapping == NULL) {
  800. throw std::runtime_error(format("CreateFileMappingA failed: %s", llama_format_win_err(error).c_str()));
  801. }
  802. addr = MapViewOfFile(hMapping, FILE_MAP_READ, 0, 0, 0);
  803. error = GetLastError();
  804. CloseHandle(hMapping);
  805. if (addr == NULL) {
  806. throw std::runtime_error(format("MapViewOfFile failed: %s", llama_format_win_err(error).c_str()));
  807. }
  808. if (prefetch) {
  809. // PrefetchVirtualMemory is only present on Windows 8 and above, so we dynamically load it
  810. BOOL (WINAPI *pPrefetchVirtualMemory) (HANDLE, ULONG_PTR, PWIN32_MEMORY_RANGE_ENTRY, ULONG);
  811. HMODULE hKernel32 = GetModuleHandleW(L"kernel32.dll");
  812. // may fail on pre-Windows 8 systems
  813. pPrefetchVirtualMemory = reinterpret_cast<decltype(pPrefetchVirtualMemory)> (GetProcAddress(hKernel32, "PrefetchVirtualMemory"));
  814. if (pPrefetchVirtualMemory) {
  815. // advise the kernel to preload the mapped memory
  816. WIN32_MEMORY_RANGE_ENTRY range;
  817. range.VirtualAddress = addr;
  818. range.NumberOfBytes = (SIZE_T)size;
  819. if (!pPrefetchVirtualMemory(GetCurrentProcess(), 1, &range, 0)) {
  820. fprintf(stderr, "warning: PrefetchVirtualMemory failed: %s\n",
  821. llama_format_win_err(GetLastError()).c_str());
  822. }
  823. }
  824. }
  825. }
  826. ~llama_mmap() {
  827. if (!UnmapViewOfFile(addr)) {
  828. fprintf(stderr, "warning: UnmapViewOfFile failed: %s\n",
  829. llama_format_win_err(GetLastError()).c_str());
  830. }
  831. }
  832. #else
  833. static constexpr bool SUPPORTED = false;
  834. llama_mmap(struct llama_file * file, bool prefetch = true, bool numa = false) {
  835. (void) file;
  836. (void) prefetch;
  837. (void) numa;
  838. throw std::runtime_error(std::string("mmap not supported"));
  839. }
  840. #endif
  841. };
  842. // Represents some region of memory being locked using mlock or VirtualLock;
  843. // will automatically unlock on destruction.
  844. struct llama_mlock {
  845. void * addr = NULL;
  846. size_t size = 0;
  847. bool failed_already = false;
  848. llama_mlock() {}
  849. llama_mlock(const llama_mlock &) = delete;
  850. ~llama_mlock() {
  851. if (size) {
  852. raw_unlock(addr, size);
  853. }
  854. }
  855. void init(void * ptr) {
  856. GGML_ASSERT(addr == NULL && size == 0); // NOLINT
  857. addr = ptr;
  858. }
  859. void grow_to(size_t target_size) {
  860. GGML_ASSERT(addr);
  861. if (failed_already) {
  862. return;
  863. }
  864. size_t granularity = lock_granularity();
  865. target_size = (target_size + granularity - 1) & ~(granularity - 1);
  866. if (target_size > size) {
  867. if (raw_lock((uint8_t *) addr + size, target_size - size)) {
  868. size = target_size;
  869. } else {
  870. failed_already = true;
  871. }
  872. }
  873. }
  874. #ifdef _POSIX_MEMLOCK_RANGE
  875. static constexpr bool SUPPORTED = true;
  876. static size_t lock_granularity() {
  877. return (size_t) sysconf(_SC_PAGESIZE);
  878. }
  879. #ifdef __APPLE__
  880. #define MLOCK_SUGGESTION \
  881. "Try increasing the sysctl values 'vm.user_wire_limit' and 'vm.global_user_wire_limit' and/or " \
  882. "decreasing 'vm.global_no_user_wire_amount'. Also try increasing RLIMIT_MLOCK (ulimit -l).\n"
  883. #else
  884. #define MLOCK_SUGGESTION \
  885. "Try increasing RLIMIT_MLOCK ('ulimit -l' as root).\n"
  886. #endif
  887. bool raw_lock(const void * addr, size_t size) const {
  888. if (!mlock(addr, size)) {
  889. return true;
  890. }
  891. char* errmsg = std::strerror(errno);
  892. bool suggest = (errno == ENOMEM);
  893. // Check if the resource limit is fine after all
  894. struct rlimit lock_limit;
  895. if (suggest && getrlimit(RLIMIT_MEMLOCK, &lock_limit)) {
  896. suggest = false;
  897. }
  898. if (suggest && (lock_limit.rlim_max > lock_limit.rlim_cur + size)) {
  899. suggest = false;
  900. }
  901. fprintf(stderr, "warning: failed to mlock %zu-byte buffer (after previously locking %zu bytes): %s\n%s",
  902. size, this->size, errmsg, suggest ? MLOCK_SUGGESTION : "");
  903. return false;
  904. }
  905. #undef MLOCK_SUGGESTION
  906. static void raw_unlock(void * addr, size_t size) {
  907. if (munlock(addr, size)) {
  908. fprintf(stderr, "warning: failed to munlock buffer: %s\n", std::strerror(errno));
  909. }
  910. }
  911. #elif defined(_WIN32)
  912. static constexpr bool SUPPORTED = true;
  913. static size_t lock_granularity() {
  914. SYSTEM_INFO si;
  915. GetSystemInfo(&si);
  916. return (size_t) si.dwPageSize;
  917. }
  918. bool raw_lock(void * ptr, size_t len) const {
  919. for (int tries = 1; ; tries++) {
  920. if (VirtualLock(ptr, len)) {
  921. return true;
  922. }
  923. if (tries == 2) {
  924. fprintf(stderr, "warning: failed to VirtualLock %zu-byte buffer (after previously locking %zu bytes): %s\n",
  925. len, size, llama_format_win_err(GetLastError()).c_str());
  926. return false;
  927. }
  928. // It failed but this was only the first try; increase the working
  929. // set size and try again.
  930. SIZE_T min_ws_size, max_ws_size;
  931. if (!GetProcessWorkingSetSize(GetCurrentProcess(), &min_ws_size, &max_ws_size)) {
  932. fprintf(stderr, "warning: GetProcessWorkingSetSize failed: %s\n",
  933. llama_format_win_err(GetLastError()).c_str());
  934. return false;
  935. }
  936. // Per MSDN: "The maximum number of pages that a process can lock
  937. // is equal to the number of pages in its minimum working set minus
  938. // a small overhead."
  939. // Hopefully a megabyte is enough overhead:
  940. size_t increment = len + 1048576;
  941. // The minimum must be <= the maximum, so we need to increase both:
  942. min_ws_size += increment;
  943. max_ws_size += increment;
  944. if (!SetProcessWorkingSetSize(GetCurrentProcess(), min_ws_size, max_ws_size)) {
  945. fprintf(stderr, "warning: SetProcessWorkingSetSize failed: %s\n",
  946. llama_format_win_err(GetLastError()).c_str());
  947. return false;
  948. }
  949. }
  950. }
  951. static void raw_unlock(void * ptr, size_t len) {
  952. if (!VirtualUnlock(ptr, len)) {
  953. fprintf(stderr, "warning: failed to VirtualUnlock buffer: %s\n",
  954. llama_format_win_err(GetLastError()).c_str());
  955. }
  956. }
  957. #else
  958. static constexpr bool SUPPORTED = false;
  959. static size_t lock_granularity() {
  960. return (size_t) 65536;
  961. }
  962. bool raw_lock(const void * addr, size_t len) const {
  963. fprintf(stderr, "warning: mlock not supported on this system\n");
  964. return false;
  965. }
  966. static void raw_unlock(const void * addr, size_t len) {}
  967. #endif
  968. };
  969. typedef void (*offload_func_t)(struct ggml_tensor * tensor);
  970. static void ggml_offload_nop(struct ggml_tensor * tensor) {
  971. (void) tensor;
  972. }
  973. static std::string llama_token_to_piece(const struct llama_context * ctx, llama_token token) {
  974. std::vector<char> result(8, 0);
  975. const int n_tokens = llama_token_to_piece(llama_get_model(ctx), token, result.data(), result.size());
  976. if (n_tokens < 0) {
  977. result.resize(-n_tokens);
  978. int check = llama_token_to_piece(llama_get_model(ctx), token, result.data(), result.size());
  979. GGML_ASSERT(check == -n_tokens);
  980. }
  981. else {
  982. result.resize(n_tokens);
  983. }
  984. return std::string(result.data(), result.size());
  985. }
  986. //
  987. // globals
  988. //
  989. struct llama_state {
  990. llama_state() {
  991. #ifdef GGML_USE_METAL
  992. ggml_metal_log_set_callback(log_callback, log_callback_user_data);
  993. #endif
  994. }
  995. // We save the log callback globally
  996. ggml_log_callback log_callback = llama_log_callback_default;
  997. void * log_callback_user_data = nullptr;
  998. };
  999. static llama_state g_state;
  1000. // available llama models
  1001. enum e_model {
  1002. MODEL_UNKNOWN,
  1003. MODEL_1B,
  1004. MODEL_3B,
  1005. MODEL_7B,
  1006. MODEL_8B,
  1007. MODEL_13B,
  1008. MODEL_15B,
  1009. MODEL_30B,
  1010. MODEL_34B,
  1011. MODEL_40B,
  1012. MODEL_65B,
  1013. MODEL_70B,
  1014. };
  1015. static const size_t kiB = 1024;
  1016. static const size_t MiB = 1024*kiB;
  1017. static const size_t GiB = 1024*MiB;
  1018. struct llama_hparams {
  1019. bool vocab_only;
  1020. uint32_t n_vocab;
  1021. uint32_t n_ctx_train; // context size the model was trained on
  1022. uint32_t n_embd;
  1023. uint32_t n_head;
  1024. uint32_t n_head_kv;
  1025. uint32_t n_layer;
  1026. uint32_t n_rot;
  1027. uint32_t n_ff;
  1028. float f_norm_eps;
  1029. float f_norm_rms_eps;
  1030. float rope_freq_base_train;
  1031. float rope_freq_scale_train;
  1032. uint32_t n_yarn_orig_ctx;
  1033. int8_t rope_scaling_type_train : 3;
  1034. bool rope_finetuned : 1;
  1035. float f_clamp_kqv;
  1036. float f_max_alibi_bias;
  1037. bool operator!=(const llama_hparams & other) const {
  1038. if (this->vocab_only != other.vocab_only) return true;
  1039. if (this->n_vocab != other.n_vocab) return true;
  1040. if (this->n_ctx_train != other.n_ctx_train) return true;
  1041. if (this->n_embd != other.n_embd) return true;
  1042. if (this->n_head != other.n_head) return true;
  1043. if (this->n_head_kv != other.n_head_kv) return true;
  1044. if (this->n_layer != other.n_layer) return true;
  1045. if (this->n_rot != other.n_rot) return true;
  1046. if (this->n_ff != other.n_ff) return true;
  1047. if (this->rope_finetuned != other.rope_finetuned) return true;
  1048. if (this->n_yarn_orig_ctx != other.n_yarn_orig_ctx) return true;
  1049. const float EPSILON = 1e-9;
  1050. if (!is_float_close(this->f_norm_eps, other.f_norm_eps, EPSILON)) return true;
  1051. if (!is_float_close(this->f_norm_rms_eps, other.f_norm_rms_eps, EPSILON)) return true;
  1052. if (!is_float_close(this->rope_freq_base_train, other.rope_freq_base_train, EPSILON)) return true;
  1053. if (!is_float_close(this->rope_freq_scale_train, other.rope_freq_scale_train, EPSILON)) return true;
  1054. return false;
  1055. }
  1056. uint32_t n_gqa() const {
  1057. return n_head/n_head_kv;
  1058. }
  1059. uint32_t n_embd_head() const {
  1060. return n_embd/n_head;
  1061. }
  1062. uint32_t n_embd_gqa() const {
  1063. return n_embd/n_gqa();
  1064. }
  1065. };
  1066. struct llama_cparams {
  1067. uint32_t n_ctx; // context size used during inference
  1068. uint32_t n_batch;
  1069. uint32_t n_threads; // number of threads to use for generation
  1070. uint32_t n_threads_batch; // number of threads to use for batch processing
  1071. float rope_freq_base;
  1072. float rope_freq_scale;
  1073. uint32_t n_yarn_orig_ctx;
  1074. // These hyperparameters are not exposed in GGUF, because all
  1075. // existing YaRN models use the same values for them.
  1076. float yarn_ext_factor;
  1077. float yarn_attn_factor;
  1078. float yarn_beta_fast;
  1079. float yarn_beta_slow;
  1080. bool mul_mat_q;
  1081. };
  1082. struct llama_layer {
  1083. // normalization
  1084. struct ggml_tensor * attn_norm;
  1085. struct ggml_tensor * attn_norm_b;
  1086. struct ggml_tensor * attn_norm_2;
  1087. struct ggml_tensor * attn_norm_2_b;
  1088. struct ggml_tensor * attn_q_norm;
  1089. struct ggml_tensor * attn_q_norm_b;
  1090. struct ggml_tensor * attn_k_norm;
  1091. struct ggml_tensor * attn_k_norm_b;
  1092. // attention
  1093. struct ggml_tensor * wq;
  1094. struct ggml_tensor * wk;
  1095. struct ggml_tensor * wv;
  1096. struct ggml_tensor * wo;
  1097. struct ggml_tensor * wqkv;
  1098. // attention bias
  1099. struct ggml_tensor * bo;
  1100. struct ggml_tensor * bqkv;
  1101. // normalization
  1102. struct ggml_tensor * ffn_norm;
  1103. struct ggml_tensor * ffn_norm_b;
  1104. // ff
  1105. struct ggml_tensor * ffn_gate; // w1
  1106. struct ggml_tensor * ffn_down; // w2
  1107. struct ggml_tensor * ffn_up; // w3
  1108. // ff bias
  1109. struct ggml_tensor * ffn_down_b; // b2
  1110. struct ggml_tensor * ffn_up_b; // b3
  1111. };
  1112. struct llama_kv_cell {
  1113. llama_pos pos = -1;
  1114. llama_pos delta = 0;
  1115. std::set<llama_seq_id> seq_id;
  1116. bool has_seq_id(const llama_seq_id & id) const {
  1117. return seq_id.find(id) != seq_id.end();
  1118. }
  1119. };
  1120. // ring-buffer of cached KV data
  1121. struct llama_kv_cache {
  1122. bool has_shift = false;
  1123. // Note: The value of head isn't only used to optimize searching
  1124. // for a free KV slot. llama_decode_internal also uses it, so it
  1125. // cannot be freely changed after a slot has been allocated.
  1126. uint32_t head = 0;
  1127. uint32_t size = 0;
  1128. uint32_t used = 0; // used cells (i.e. at least one seq_id)
  1129. // computed before each graph build
  1130. uint32_t n = 0;
  1131. std::vector<llama_kv_cell> cells;
  1132. struct ggml_tensor * k = NULL;
  1133. struct ggml_tensor * v = NULL;
  1134. struct ggml_context * ctx = NULL;
  1135. llama_buffer buf;
  1136. ~llama_kv_cache() {
  1137. if (ctx) {
  1138. ggml_free(ctx);
  1139. }
  1140. #ifdef GGML_USE_CUBLAS
  1141. if (ggml_cublas_loaded()) {
  1142. ggml_cuda_free_data(k);
  1143. ggml_cuda_free_data(v);
  1144. }
  1145. #endif
  1146. }
  1147. };
  1148. struct llama_vocab {
  1149. using id = int32_t;
  1150. using token = std::string;
  1151. using ttype = llama_token_type;
  1152. struct token_data {
  1153. token text;
  1154. float score;
  1155. ttype type;
  1156. };
  1157. enum llama_vocab_type type = LLAMA_VOCAB_TYPE_SPM;
  1158. std::unordered_map<token, id> token_to_id;
  1159. std::vector<token_data> id_to_token;
  1160. std::unordered_map<token, id> special_tokens_cache;
  1161. std::map<std::pair<std::string, std::string>, int> bpe_ranks;
  1162. // default LLaMA special tokens
  1163. id special_bos_id = 1;
  1164. id special_eos_id = 2;
  1165. id special_unk_id = 0;
  1166. id special_sep_id = -1;
  1167. id special_pad_id = -1;
  1168. int special_add_bos = -1; // -1 unknown, 1 add, 0 don't add.
  1169. int special_add_eos = -1; // -1 unknown, 1 add, 0 don't add.
  1170. id linefeed_id = 13;
  1171. id special_prefix_id = 32007;
  1172. id special_middle_id = 32009;
  1173. id special_suffix_id = 32008;
  1174. id special_eot_id = 32010;
  1175. int find_bpe_rank(std::string token_left, std::string token_right) const {
  1176. GGML_ASSERT(token_left.find(" ") == std::string::npos);
  1177. GGML_ASSERT(token_left.find("\n") == std::string::npos);
  1178. GGML_ASSERT(token_right.find(" ") == std::string::npos);
  1179. GGML_ASSERT(token_right.find("\n") == std::string::npos);
  1180. auto it = bpe_ranks.find(std::make_pair(token_left, token_right));
  1181. if (it == bpe_ranks.end()) {
  1182. return -1;
  1183. }
  1184. return it->second;
  1185. }
  1186. };
  1187. struct llama_model {
  1188. e_model type = MODEL_UNKNOWN;
  1189. llm_arch arch = LLM_ARCH_UNKNOWN;
  1190. llama_ftype ftype = LLAMA_FTYPE_ALL_F32;
  1191. std::string name = "n/a";
  1192. llama_hparams hparams = {};
  1193. llama_vocab vocab;
  1194. struct ggml_tensor * tok_embd;
  1195. struct ggml_tensor * pos_embd;
  1196. struct ggml_tensor * tok_norm;
  1197. struct ggml_tensor * tok_norm_b;
  1198. struct ggml_tensor * output_norm;
  1199. struct ggml_tensor * output_norm_b;
  1200. struct ggml_tensor * output;
  1201. std::vector<llama_layer> layers;
  1202. int n_gpu_layers;
  1203. // gguf metadata
  1204. std::unordered_map<std::string, std::string> gguf_kv;
  1205. // context
  1206. struct ggml_context * ctx = NULL;
  1207. // the model memory buffer
  1208. llama_buffer buf;
  1209. // model memory mapped file
  1210. std::unique_ptr<llama_mmap> mapping;
  1211. // objects representing data potentially being locked in memory
  1212. llama_mlock mlock_buf;
  1213. llama_mlock mlock_mmap;
  1214. // for quantize-stats only
  1215. std::vector<std::pair<std::string, struct ggml_tensor *>> tensors_by_name;
  1216. int64_t t_load_us = 0;
  1217. int64_t t_start_us = 0;
  1218. ~llama_model() {
  1219. if (ctx) {
  1220. ggml_free(ctx);
  1221. }
  1222. #ifdef GGML_USE_CUBLAS
  1223. if (ggml_cublas_loaded()) {
  1224. for (size_t i = 0; i < tensors_by_name.size(); ++i) {
  1225. ggml_cuda_free_data(tensors_by_name[i].second);
  1226. }
  1227. ggml_cuda_free_scratch();
  1228. }
  1229. #endif
  1230. #if defined(GGML_USE_CLBLAST)
  1231. for (size_t i = 0; i < tensors_by_name.size(); ++i) {
  1232. ggml_cl_free_data(tensors_by_name[i].second);
  1233. }
  1234. #endif
  1235. }
  1236. };
  1237. struct llama_context {
  1238. llama_context(const llama_model & model) : model(model), t_start_us(model.t_start_us), t_load_us(model.t_load_us) {}
  1239. ~llama_context() {
  1240. #ifdef GGML_USE_METAL
  1241. if (ctx_metal) {
  1242. ggml_metal_free(ctx_metal);
  1243. }
  1244. #endif
  1245. if (alloc) {
  1246. ggml_allocr_free(alloc);
  1247. }
  1248. }
  1249. llama_cparams cparams;
  1250. const llama_model & model;
  1251. // key + value cache for the self attention
  1252. struct llama_kv_cache kv_self;
  1253. std::mt19937 rng;
  1254. bool has_evaluated_once = false;
  1255. int64_t t_start_us;
  1256. int64_t t_load_us;
  1257. int64_t t_sample_us = 0;
  1258. int64_t t_p_eval_us = 0;
  1259. int64_t t_eval_us = 0;
  1260. int32_t n_sample = 0; // number of tokens sampled
  1261. int32_t n_p_eval = 0; // number of tokens in eval calls for the prompt (with batch size > 1)
  1262. int32_t n_eval = 0; // number of eval calls
  1263. // decode output (2-dimensional array: [n_tokens][n_vocab])
  1264. std::vector<float> logits;
  1265. bool logits_all = false;
  1266. // input embedding (1-dimensional array: [n_embd])
  1267. std::vector<float> embedding;
  1268. // reusable buffer for `struct ggml_graph_plan.work_data`
  1269. std::vector<uint8_t> work_buffer;
  1270. // memory buffers used to evaluate the model
  1271. llama_buffer buf_compute;
  1272. llama_buffer buf_alloc;
  1273. ggml_allocr * alloc = NULL;
  1274. #ifdef GGML_USE_METAL
  1275. ggml_metal_context * ctx_metal = NULL;
  1276. #endif
  1277. #ifdef GGML_USE_MPI
  1278. ggml_mpi_context * ctx_mpi = NULL;
  1279. #endif
  1280. };
  1281. //
  1282. // kv cache helpers
  1283. //
  1284. static bool llama_kv_cache_init(
  1285. const struct llama_hparams & hparams,
  1286. struct llama_kv_cache & cache,
  1287. ggml_type wtype,
  1288. uint32_t n_ctx,
  1289. int n_gpu_layers) {
  1290. const uint32_t n_embd = hparams.n_embd_gqa();
  1291. const uint32_t n_layer = hparams.n_layer;
  1292. const int64_t n_mem = n_layer*n_ctx;
  1293. const int64_t n_elements = n_embd*n_mem;
  1294. cache.has_shift = false;
  1295. cache.head = 0;
  1296. cache.size = n_ctx;
  1297. cache.used = 0;
  1298. cache.cells.clear();
  1299. cache.cells.resize(n_ctx);
  1300. cache.buf.resize(2u*n_elements*ggml_type_size(wtype) + 2u*ggml_tensor_overhead());
  1301. memset(cache.buf.data, 0, cache.buf.size);
  1302. struct ggml_init_params params;
  1303. params.mem_size = cache.buf.size;
  1304. params.mem_buffer = cache.buf.data;
  1305. params.no_alloc = false;
  1306. cache.ctx = ggml_init(params);
  1307. if (!cache.ctx) {
  1308. LLAMA_LOG_ERROR("%s: failed to allocate memory for kv cache\n", __func__);
  1309. return false;
  1310. }
  1311. cache.k = ggml_new_tensor_1d(cache.ctx, wtype, n_elements);
  1312. cache.v = ggml_new_tensor_1d(cache.ctx, wtype, n_elements);
  1313. ggml_set_name(cache.k, "cache_k");
  1314. ggml_set_name(cache.v, "cache_v");
  1315. (void) n_gpu_layers;
  1316. #ifdef GGML_USE_CUBLAS
  1317. if (ggml_cublas_loaded()) {
  1318. size_t vram_kv_cache = 0;
  1319. if (n_gpu_layers > (int)n_layer + 1) {
  1320. ggml_cuda_assign_buffers_no_scratch(cache.v);
  1321. LLAMA_LOG_INFO("%s: offloading v cache to GPU\n", __func__);
  1322. vram_kv_cache += ggml_nbytes(cache.v);
  1323. }
  1324. if (n_gpu_layers > (int)n_layer + 2) {
  1325. ggml_cuda_assign_buffers_no_scratch(cache.k);
  1326. LLAMA_LOG_INFO("%s: offloading k cache to GPU\n", __func__);
  1327. vram_kv_cache += ggml_nbytes(cache.k);
  1328. }
  1329. if (vram_kv_cache > 0) {
  1330. LLAMA_LOG_INFO("%s: VRAM kv self = %.2f MiB\n", __func__, vram_kv_cache / 1024.0 / 1024.0);
  1331. }
  1332. }
  1333. #endif
  1334. return true;
  1335. }
  1336. // find an empty slot of size "n_tokens" in the cache
  1337. // updates the cache head
  1338. // Note: On success, it's important that cache.head points
  1339. // to the first cell of the slot.
  1340. static bool llama_kv_cache_find_slot(
  1341. struct llama_kv_cache & cache,
  1342. const struct llama_batch & batch) {
  1343. const uint32_t n_ctx = cache.size;
  1344. const uint32_t n_tokens = batch.n_tokens;
  1345. if (n_tokens > n_ctx) {
  1346. LLAMA_LOG_ERROR("%s: n_tokens=%d > n_ctx=%d\n", __func__, n_tokens, n_ctx);
  1347. return false;
  1348. }
  1349. uint32_t n_tested = 0;
  1350. while (true) {
  1351. if (cache.head + n_tokens > n_ctx) {
  1352. n_tested += n_ctx - cache.head;
  1353. cache.head = 0;
  1354. continue;
  1355. }
  1356. bool found = true;
  1357. for (uint32_t i = 0; i < n_tokens; i++) {
  1358. if (cache.cells[cache.head + i].pos >= 0) {
  1359. found = false;
  1360. cache.head += i + 1;
  1361. n_tested += i + 1;
  1362. break;
  1363. }
  1364. }
  1365. if (found) {
  1366. break;
  1367. }
  1368. if (n_tested >= n_ctx) {
  1369. //LLAMA_LOG_ERROR("%s: failed to find a slot for %d tokens\n", __func__, n_tokens);
  1370. return false;
  1371. }
  1372. }
  1373. for (uint32_t i = 0; i < n_tokens; i++) {
  1374. cache.cells[cache.head + i].pos = batch.pos[i];
  1375. for (int32_t j = 0; j < batch.n_seq_id[i]; j++) {
  1376. cache.cells[cache.head + i].seq_id.insert(batch.seq_id[i][j]);
  1377. }
  1378. }
  1379. cache.used += n_tokens;
  1380. return true;
  1381. }
  1382. // find how many cells are currently in use
  1383. static int32_t llama_kv_cache_cell_max(const struct llama_kv_cache & cache) {
  1384. for (uint32_t i = cache.size - 1; i > 0; --i) {
  1385. if (cache.cells[i].pos >= 0 && !cache.cells[i].seq_id.empty()) {
  1386. return i + 1;
  1387. }
  1388. }
  1389. return 0;
  1390. }
  1391. static void llama_kv_cache_clear(struct llama_kv_cache & cache) {
  1392. for (int32_t i = 0; i < (int32_t) cache.size; ++i) {
  1393. cache.cells[i].pos = -1;
  1394. cache.cells[i].seq_id.clear();
  1395. }
  1396. cache.head = 0;
  1397. cache.used = 0;
  1398. }
  1399. static void llama_kv_cache_seq_rm(
  1400. struct llama_kv_cache & cache,
  1401. llama_seq_id seq_id,
  1402. llama_pos p0,
  1403. llama_pos p1) {
  1404. uint32_t new_head = cache.size;
  1405. if (p0 < 0) p0 = 0;
  1406. if (p1 < 0) p1 = std::numeric_limits<llama_pos>::max();
  1407. for (uint32_t i = 0; i < cache.size; ++i) {
  1408. if (cache.cells[i].pos >= p0 && cache.cells[i].pos < p1) {
  1409. if (seq_id < 0) {
  1410. cache.cells[i].seq_id.clear();
  1411. } else if (cache.cells[i].has_seq_id(seq_id)) {
  1412. cache.cells[i].seq_id.erase(seq_id);
  1413. } else {
  1414. continue;
  1415. }
  1416. if (cache.cells[i].seq_id.empty()) {
  1417. // keep count of the number of used cells
  1418. if (cache.cells[i].pos >= 0) cache.used--;
  1419. cache.cells[i].pos = -1;
  1420. if (new_head == cache.size) new_head = i;
  1421. }
  1422. }
  1423. }
  1424. // If we freed up a slot, set head to it so searching can start there.
  1425. if (new_head != cache.size && new_head < cache.head) cache.head = new_head;
  1426. }
  1427. static void llama_kv_cache_seq_cp(
  1428. struct llama_kv_cache & cache,
  1429. llama_seq_id seq_id_src,
  1430. llama_seq_id seq_id_dst,
  1431. llama_pos p0,
  1432. llama_pos p1) {
  1433. if (p0 < 0) p0 = 0;
  1434. if (p1 < 0) p1 = std::numeric_limits<llama_pos>::max();
  1435. cache.head = 0;
  1436. for (uint32_t i = 0; i < cache.size; ++i) {
  1437. if (cache.cells[i].has_seq_id(seq_id_src) && cache.cells[i].pos >= p0 && cache.cells[i].pos < p1) {
  1438. cache.cells[i].seq_id.insert(seq_id_dst);
  1439. }
  1440. }
  1441. }
  1442. static void llama_kv_cache_seq_keep(struct llama_kv_cache & cache, llama_seq_id seq_id) {
  1443. uint32_t new_head = cache.size;
  1444. for (uint32_t i = 0; i < cache.size; ++i) {
  1445. if (!cache.cells[i].has_seq_id(seq_id)) {
  1446. if (cache.cells[i].pos >= 0) cache.used--;
  1447. cache.cells[i].pos = -1;
  1448. cache.cells[i].seq_id.clear();
  1449. if (new_head == cache.size) new_head = i;
  1450. } else {
  1451. cache.cells[i].seq_id.clear();
  1452. cache.cells[i].seq_id.insert(seq_id);
  1453. }
  1454. }
  1455. // If we freed up a slot, set head to it so searching can start there.
  1456. if (new_head != cache.size && new_head < cache.head) cache.head = new_head;
  1457. }
  1458. static void llama_kv_cache_seq_shift(
  1459. struct llama_kv_cache & cache,
  1460. llama_seq_id seq_id,
  1461. llama_pos p0,
  1462. llama_pos p1,
  1463. llama_pos delta) {
  1464. uint32_t new_head = cache.size;
  1465. if (p0 < 0) p0 = 0;
  1466. if (p1 < 0) p1 = std::numeric_limits<llama_pos>::max();
  1467. for (uint32_t i = 0; i < cache.size; ++i) {
  1468. if (cache.cells[i].has_seq_id(seq_id) && cache.cells[i].pos >= p0 && cache.cells[i].pos < p1) {
  1469. cache.has_shift = true;
  1470. cache.cells[i].pos += delta;
  1471. cache.cells[i].delta += delta;
  1472. if (cache.cells[i].pos < 0) {
  1473. if (!cache.cells[i].seq_id.empty()) cache.used--;
  1474. cache.cells[i].pos = -1;
  1475. cache.cells[i].seq_id.clear();
  1476. if (new_head == cache.size) new_head = i;
  1477. }
  1478. }
  1479. }
  1480. // If we freed up a slot, set head to it so searching can start there.
  1481. // Otherwise we just start the next search from the beginning.
  1482. cache.head = new_head != cache.size ? new_head : 0;
  1483. }
  1484. //
  1485. // model loading and saving
  1486. //
  1487. enum llama_fver {
  1488. GGUF_FILE_VERSION_V1 = 1,
  1489. GGUF_FILE_VERSION_V2 = 2,
  1490. GGUF_FILE_VERSION_V3 = 3,
  1491. };
  1492. static const char * llama_file_version_name(llama_fver version) {
  1493. switch (version) {
  1494. case GGUF_FILE_VERSION_V1: return "GGUF V1 (support until nov 2023)";
  1495. case GGUF_FILE_VERSION_V2: return "GGUF V2";
  1496. case GGUF_FILE_VERSION_V3: return "GGUF V3 (latest)";
  1497. }
  1498. return "unknown";
  1499. }
  1500. static std::string llama_format_tensor_shape(const std::vector<int64_t> & ne) {
  1501. char buf[256];
  1502. snprintf(buf, sizeof(buf), "%5" PRId64, ne.at(0));
  1503. for (size_t i = 1; i < ne.size(); i++) {
  1504. snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf), ", %5" PRId64, ne.at(i));
  1505. }
  1506. return buf;
  1507. }
  1508. static std::string llama_format_tensor_shape(const struct ggml_tensor * t) {
  1509. char buf[256];
  1510. snprintf(buf, sizeof(buf), "%5" PRId64, t->ne[0]);
  1511. for (int i = 1; i < GGML_MAX_DIMS; i++) {
  1512. snprintf(buf + strlen(buf), sizeof(buf) - strlen(buf), ", %5" PRId64, t->ne[i]);
  1513. }
  1514. return buf;
  1515. }
  1516. struct llama_model_loader {
  1517. int n_kv = 0;
  1518. int n_tensors = 0;
  1519. int n_created = 0;
  1520. int64_t n_elements = 0;
  1521. size_t n_bytes = 0;
  1522. bool use_mmap = false;
  1523. llama_file file;
  1524. llama_ftype ftype;
  1525. llama_fver fver;
  1526. std::unique_ptr<llama_mmap> mapping;
  1527. struct gguf_context * ctx_gguf = NULL;
  1528. struct ggml_context * ctx_meta = NULL;
  1529. llama_model_loader(const std::string & fname, bool use_mmap) : file(fname.c_str(), "rb") {
  1530. struct gguf_init_params params = {
  1531. /*.no_alloc = */ true,
  1532. /*.ctx = */ &ctx_meta,
  1533. };
  1534. ctx_gguf = gguf_init_from_file(fname.c_str(), params);
  1535. if (!ctx_gguf) {
  1536. throw std::runtime_error(format("%s: failed to load model from %s\n", __func__, fname.c_str()));
  1537. }
  1538. n_kv = gguf_get_n_kv(ctx_gguf);
  1539. n_tensors = gguf_get_n_tensors(ctx_gguf);
  1540. fver = (enum llama_fver ) gguf_get_version(ctx_gguf);
  1541. for (int i = 0; i < n_tensors; i++) {
  1542. const char * name = gguf_get_tensor_name(ctx_gguf, i);
  1543. struct ggml_tensor * t = ggml_get_tensor(ctx_meta, name);
  1544. n_elements += ggml_nelements(t);
  1545. n_bytes += ggml_nbytes(t);
  1546. }
  1547. LLAMA_LOG_INFO("%s: loaded meta data with %d key-value pairs and %d tensors from %s (version %s)\n",
  1548. __func__, n_kv, n_tensors, fname.c_str(), llama_file_version_name(fver));
  1549. // determine file type based on the number of tensors for each quantization and print meta data
  1550. // TODO: make optional
  1551. {
  1552. std::map<enum ggml_type, uint32_t> n_type;
  1553. uint32_t n_type_max = 0;
  1554. enum ggml_type type_max = GGML_TYPE_F32;
  1555. for (int i = 0; i < n_tensors; i++) {
  1556. const char * name = gguf_get_tensor_name(ctx_gguf, i);
  1557. struct ggml_tensor * meta = ggml_get_tensor(ctx_meta, name);
  1558. n_type[meta->type]++;
  1559. if (n_type_max < n_type[meta->type]) {
  1560. n_type_max = n_type[meta->type];
  1561. type_max = meta->type;
  1562. }
  1563. LLAMA_LOG_INFO("%s: - tensor %4d: %32s %-8s [ %s ]\n", __func__, i, name, ggml_type_name(meta->type), llama_format_tensor_shape(meta).c_str());
  1564. }
  1565. switch (type_max) {
  1566. case GGML_TYPE_F32: ftype = LLAMA_FTYPE_ALL_F32; break;
  1567. case GGML_TYPE_F16: ftype = LLAMA_FTYPE_MOSTLY_F16; break;
  1568. case GGML_TYPE_Q4_0: ftype = LLAMA_FTYPE_MOSTLY_Q4_0; break;
  1569. case GGML_TYPE_Q4_1: ftype = LLAMA_FTYPE_MOSTLY_Q4_1; break;
  1570. case GGML_TYPE_Q5_0: ftype = LLAMA_FTYPE_MOSTLY_Q5_0; break;
  1571. case GGML_TYPE_Q5_1: ftype = LLAMA_FTYPE_MOSTLY_Q5_1; break;
  1572. case GGML_TYPE_Q8_0: ftype = LLAMA_FTYPE_MOSTLY_Q8_0; break;
  1573. case GGML_TYPE_Q2_K: ftype = LLAMA_FTYPE_MOSTLY_Q2_K; break;
  1574. case GGML_TYPE_Q3_K: ftype = LLAMA_FTYPE_MOSTLY_Q3_K_M; break;
  1575. case GGML_TYPE_Q4_K: ftype = LLAMA_FTYPE_MOSTLY_Q4_K_M; break;
  1576. case GGML_TYPE_Q5_K: ftype = LLAMA_FTYPE_MOSTLY_Q5_K_M; break;
  1577. case GGML_TYPE_Q6_K: ftype = LLAMA_FTYPE_MOSTLY_Q6_K; break;
  1578. default:
  1579. {
  1580. LLAMA_LOG_WARN("%s: unknown type %s\n", __func__, ggml_type_name(type_max));
  1581. ftype = LLAMA_FTYPE_ALL_F32;
  1582. } break;
  1583. }
  1584. // this is a way to mark that we have "guessed" the file type
  1585. ftype = (llama_ftype) (ftype | LLAMA_FTYPE_GUESSED);
  1586. {
  1587. const int kid = gguf_find_key(ctx_gguf, "general.file_type");
  1588. if (kid >= 0) {
  1589. ftype = (llama_ftype) gguf_get_val_u32(ctx_gguf, kid);
  1590. }
  1591. }
  1592. for (int i = 0; i < n_kv; i++) {
  1593. const char * name = gguf_get_key(ctx_gguf, i);
  1594. const enum gguf_type type = gguf_get_kv_type(ctx_gguf, i);
  1595. const std::string type_name =
  1596. type == GGUF_TYPE_ARRAY
  1597. ? format("%s[%s,%d]", gguf_type_name(type), gguf_type_name(gguf_get_arr_type(ctx_gguf, i)), gguf_get_arr_n(ctx_gguf, i))
  1598. : gguf_type_name(type);
  1599. std::string value = gguf_kv_to_str(ctx_gguf, i);
  1600. const size_t MAX_VALUE_LEN = 40;
  1601. if (value.size() > MAX_VALUE_LEN) {
  1602. value = format("%s...", value.substr(0, MAX_VALUE_LEN - 3).c_str());
  1603. }
  1604. replace_all(value, "\n", "\\n");
  1605. LLAMA_LOG_INFO("%s: - kv %3d: %42s %-16s = %s\n", __func__, i, name, type_name.c_str(), value.c_str());
  1606. }
  1607. // print type counts
  1608. for (auto & kv : n_type) {
  1609. if (kv.second == 0) {
  1610. continue;
  1611. }
  1612. LLAMA_LOG_INFO("%s: - type %4s: %4d tensors\n", __func__, ggml_type_name(kv.first), kv.second);
  1613. }
  1614. }
  1615. if (!llama_mmap::SUPPORTED) {
  1616. LLAMA_LOG_WARN("%s: mmap is not supported on this platform\n", __func__);
  1617. use_mmap = false;
  1618. }
  1619. this->use_mmap = use_mmap;
  1620. }
  1621. ~llama_model_loader() {
  1622. if (ctx_gguf) {
  1623. gguf_free(ctx_gguf);
  1624. }
  1625. if (ctx_meta) {
  1626. ggml_free(ctx_meta);
  1627. }
  1628. }
  1629. std::string get_arch_name() const {
  1630. const auto kv = LLM_KV(LLM_ARCH_UNKNOWN);
  1631. std::string arch_name;
  1632. GGUF_GET_KEY(ctx_gguf, arch_name, gguf_get_val_str, GGUF_TYPE_STRING, false, kv(LLM_KV_GENERAL_ARCHITECTURE));
  1633. return arch_name;
  1634. }
  1635. enum llm_arch get_arch() const {
  1636. const std::string arch_name = get_arch_name();
  1637. return llm_arch_from_string(arch_name);
  1638. }
  1639. const char * get_tensor_name(int i) const {
  1640. return gguf_get_tensor_name(ctx_gguf, i);
  1641. }
  1642. struct ggml_tensor * get_tensor_meta(int i) const {
  1643. return ggml_get_tensor(ctx_meta, get_tensor_name(i));
  1644. }
  1645. void calc_sizes(size_t & ctx_size_p, size_t & mmapped_size_p) const {
  1646. ctx_size_p = 0;
  1647. mmapped_size_p = 0;
  1648. for (int i = 0; i < n_tensors; i++) {
  1649. struct ggml_tensor * meta = get_tensor_meta(i);
  1650. ctx_size_p += sizeof(struct ggml_tensor) + GGML_OBJECT_SIZE;
  1651. (use_mmap ? mmapped_size_p : ctx_size_p) += ggml_nbytes_pad(meta);
  1652. }
  1653. }
  1654. struct ggml_tensor * create_tensor_for(struct ggml_context * ctx, struct ggml_tensor * meta, ggml_backend_type backend) {
  1655. if (backend != GGML_BACKEND_CPU) {
  1656. ggml_set_no_alloc(ctx, true);
  1657. }
  1658. struct ggml_tensor * tensor = ggml_dup_tensor(ctx, meta);
  1659. tensor->backend = backend; // TODO: ggml_set_backend
  1660. ggml_set_name(tensor, ggml_get_name(meta));
  1661. if (backend != GGML_BACKEND_CPU) {
  1662. ggml_set_no_alloc(ctx, use_mmap);
  1663. }
  1664. n_created++;
  1665. return tensor;
  1666. }
  1667. struct ggml_tensor * create_tensor(struct ggml_context * ctx, const std::string & name, const std::vector<int64_t> & ne, ggml_backend_type backend) {
  1668. struct ggml_tensor * cur = ggml_get_tensor(ctx_meta, name.c_str());
  1669. if (cur == NULL) {
  1670. throw std::runtime_error(format("%s: tensor '%s' not found", __func__, name.c_str()));
  1671. }
  1672. if (backend == GGML_BACKEND_GPU_SPLIT) {
  1673. if (ne.size() == 1) {
  1674. throw std::runtime_error(format("%s: 1-dimensional tensor '%s' cannot be split on the GPU", __func__, name.c_str()));
  1675. }
  1676. }
  1677. {
  1678. bool is_ok = true;
  1679. for (size_t i = 0; i < ne.size(); ++i) {
  1680. if (ne[i] != cur->ne[i]) {
  1681. is_ok = false;
  1682. break;
  1683. }
  1684. }
  1685. if (!is_ok) {
  1686. throw std::runtime_error(
  1687. format("%s: tensor '%s' has wrong shape; expected %s, got %s",
  1688. __func__, name.c_str(),
  1689. llama_format_tensor_shape(ne).c_str(),
  1690. llama_format_tensor_shape(cur).c_str()));
  1691. }
  1692. }
  1693. return create_tensor_for(ctx, cur, backend);
  1694. }
  1695. void done_getting_tensors() const {
  1696. if (n_created != n_tensors) {
  1697. throw std::runtime_error(format("%s: wrong number of tensors; expected %d, got %d", __func__, n_tensors, n_created));
  1698. }
  1699. }
  1700. size_t file_offset(const char * name) const {
  1701. const int idx = gguf_find_tensor(ctx_gguf, name);
  1702. if (idx < 0) {
  1703. throw std::runtime_error(format("%s: tensor '%s' not found in the file", __func__, name));
  1704. }
  1705. return gguf_get_data_offset(ctx_gguf) + gguf_get_tensor_offset(ctx_gguf, idx);
  1706. }
  1707. void load_data_for(struct ggml_tensor * cur) const {
  1708. const size_t offs = file_offset(ggml_get_name(cur));
  1709. if (use_mmap) {
  1710. cur->data = (uint8_t *) mapping->addr + offs;
  1711. } else {
  1712. file.seek(offs, SEEK_SET);
  1713. file.read_raw(cur->data, ggml_nbytes(cur));
  1714. }
  1715. }
  1716. void load_all_data(struct ggml_context * ctx, llama_progress_callback progress_callback, void * progress_callback_user_data, llama_mlock * lmlock) {
  1717. size_t size_data = 0;
  1718. size_t size_lock = 0;
  1719. size_t size_pref = 0; // prefetch
  1720. for (int i = 0; i < gguf_get_n_tensors(ctx_gguf); i++) {
  1721. struct ggml_tensor * cur = ggml_get_tensor(ctx, gguf_get_tensor_name(ctx_gguf, i));
  1722. size_data += ggml_nbytes(cur);
  1723. if (cur->backend == GGML_BACKEND_CPU) {
  1724. size_pref += ggml_nbytes(cur);
  1725. }
  1726. }
  1727. if (use_mmap) {
  1728. mapping.reset(new llama_mmap(&file, size_pref, ggml_is_numa()));
  1729. if (lmlock) {
  1730. lmlock->init(mapping->addr);
  1731. }
  1732. }
  1733. size_t done_size = 0;
  1734. for (int i = 0; i < gguf_get_n_tensors(ctx_gguf); i++) {
  1735. struct ggml_tensor * cur = ggml_get_tensor(ctx, gguf_get_tensor_name(ctx_gguf, i));
  1736. GGML_ASSERT(cur); // unused tensors should have been caught by load_data already
  1737. if (progress_callback) {
  1738. progress_callback((float) done_size / size_data, progress_callback_user_data);
  1739. }
  1740. // allocate temp buffer if not using mmap
  1741. if (!use_mmap && cur->data == NULL) {
  1742. GGML_ASSERT(cur->backend != GGML_BACKEND_CPU);
  1743. #ifdef GGML_USE_CPU_HBM
  1744. cur->data = (uint8_t*)hbw_malloc(ggml_nbytes(cur));
  1745. #else
  1746. cur->data = (uint8_t*)malloc(ggml_nbytes(cur));
  1747. #endif
  1748. }
  1749. load_data_for(cur);
  1750. switch (cur->backend) {
  1751. case GGML_BACKEND_CPU:
  1752. if (use_mmap && lmlock) {
  1753. size_lock += ggml_nbytes(cur);
  1754. lmlock->grow_to(size_lock);
  1755. }
  1756. break;
  1757. #ifdef GGML_USE_CUBLAS
  1758. case GGML_BACKEND_GPU:
  1759. case GGML_BACKEND_GPU_SPLIT:
  1760. // old code:
  1761. //ggml_cuda_transform_tensor(lt.data, lt.ggml_tensor);
  1762. // TODO: test if this works !!
  1763. ggml_cuda_transform_tensor(cur->data, cur);
  1764. if (!use_mmap) {
  1765. free(cur->data);
  1766. }
  1767. break;
  1768. #elif defined(GGML_USE_CLBLAST)
  1769. case GGML_BACKEND_GPU:
  1770. ggml_cl_transform_tensor(cur->data, cur);
  1771. if (!use_mmap) {
  1772. free(cur->data);
  1773. }
  1774. break;
  1775. #endif
  1776. default:
  1777. continue;
  1778. }
  1779. done_size += ggml_nbytes(cur);
  1780. }
  1781. }
  1782. };
  1783. //
  1784. // load LLaMA models
  1785. //
  1786. static std::string llama_model_arch_name(llm_arch arch) {
  1787. auto it = LLM_ARCH_NAMES.find(arch);
  1788. if (it == LLM_ARCH_NAMES.end()) {
  1789. return "unknown";
  1790. }
  1791. return it->second;
  1792. }
  1793. static std::string llama_model_ftype_name(llama_ftype ftype) {
  1794. if (ftype & LLAMA_FTYPE_GUESSED) {
  1795. return llama_model_ftype_name((enum llama_ftype) (ftype & ~LLAMA_FTYPE_GUESSED)) + " (guessed)";
  1796. }
  1797. switch (ftype) {
  1798. case LLAMA_FTYPE_ALL_F32: return "all F32";
  1799. case LLAMA_FTYPE_MOSTLY_F16: return "mostly F16";
  1800. case LLAMA_FTYPE_MOSTLY_Q4_0: return "mostly Q4_0";
  1801. case LLAMA_FTYPE_MOSTLY_Q4_1: return "mostly Q4_1";
  1802. case LLAMA_FTYPE_MOSTLY_Q4_1_SOME_F16:
  1803. return "mostly Q4_1, some F16";
  1804. case LLAMA_FTYPE_MOSTLY_Q5_0: return "mostly Q5_0";
  1805. case LLAMA_FTYPE_MOSTLY_Q5_1: return "mostly Q5_1";
  1806. case LLAMA_FTYPE_MOSTLY_Q8_0: return "mostly Q8_0";
  1807. // K-quants
  1808. case LLAMA_FTYPE_MOSTLY_Q2_K: return "mostly Q2_K";
  1809. case LLAMA_FTYPE_MOSTLY_Q3_K_S: return "mostly Q3_K - Small";
  1810. case LLAMA_FTYPE_MOSTLY_Q3_K_M: return "mostly Q3_K - Medium";
  1811. case LLAMA_FTYPE_MOSTLY_Q3_K_L: return "mostly Q3_K - Large";
  1812. case LLAMA_FTYPE_MOSTLY_Q4_K_S: return "mostly Q4_K - Small";
  1813. case LLAMA_FTYPE_MOSTLY_Q4_K_M: return "mostly Q4_K - Medium";
  1814. case LLAMA_FTYPE_MOSTLY_Q5_K_S: return "mostly Q5_K - Small";
  1815. case LLAMA_FTYPE_MOSTLY_Q5_K_M: return "mostly Q5_K - Medium";
  1816. case LLAMA_FTYPE_MOSTLY_Q6_K: return "mostly Q6_K";
  1817. default: return "unknown, may not work";
  1818. }
  1819. }
  1820. static const char * llama_model_type_name(e_model type) {
  1821. switch (type) {
  1822. case MODEL_1B: return "1B";
  1823. case MODEL_3B: return "3B";
  1824. case MODEL_7B: return "7B";
  1825. case MODEL_8B: return "8B";
  1826. case MODEL_13B: return "13B";
  1827. case MODEL_15B: return "15B";
  1828. case MODEL_30B: return "30B";
  1829. case MODEL_34B: return "34B";
  1830. case MODEL_40B: return "40B";
  1831. case MODEL_65B: return "65B";
  1832. case MODEL_70B: return "70B";
  1833. default: return "?B";
  1834. }
  1835. }
  1836. static void llm_load_arch(llama_model_loader & ml, llama_model & model) {
  1837. model.arch = ml.get_arch();
  1838. if (model.arch == LLM_ARCH_UNKNOWN) {
  1839. throw std::runtime_error("unknown model architecture: '" + ml.get_arch_name() + "'");
  1840. }
  1841. }
  1842. static void llm_load_hparams(
  1843. llama_model_loader & ml,
  1844. llama_model & model) {
  1845. struct gguf_context * ctx = ml.ctx_gguf;
  1846. const auto kv = LLM_KV(model.arch);
  1847. auto & hparams = model.hparams;
  1848. // get metadata as string
  1849. for (int i = 0; i < gguf_get_n_kv(ctx); i++) {
  1850. enum gguf_type type = gguf_get_kv_type(ctx, i);
  1851. if (type == GGUF_TYPE_ARRAY) {
  1852. continue;
  1853. }
  1854. const char * name = gguf_get_key(ctx, i);
  1855. const std::string value = gguf_kv_to_str(ctx, i);
  1856. model.gguf_kv.emplace(name, value);
  1857. }
  1858. // get general kv
  1859. GGUF_GET_KEY(ctx, model.name, gguf_get_val_str, GGUF_TYPE_STRING, false, kv(LLM_KV_GENERAL_NAME));
  1860. // get hparams kv
  1861. GGUF_GET_KEY(ctx, hparams.n_vocab, gguf_get_arr_n, GGUF_TYPE_ARRAY, true, kv(LLM_KV_TOKENIZER_LIST));
  1862. GGUF_GET_KEY(ctx, hparams.n_ctx_train, gguf_get_val_u32, GGUF_TYPE_UINT32, true, kv(LLM_KV_CONTEXT_LENGTH));
  1863. GGUF_GET_KEY(ctx, hparams.n_embd, gguf_get_val_u32, GGUF_TYPE_UINT32, true, kv(LLM_KV_EMBEDDING_LENGTH));
  1864. GGUF_GET_KEY(ctx, hparams.n_ff, gguf_get_val_u32, GGUF_TYPE_UINT32, true, kv(LLM_KV_FEED_FORWARD_LENGTH));
  1865. GGUF_GET_KEY(ctx, hparams.n_head, gguf_get_val_u32, GGUF_TYPE_UINT32, true, kv(LLM_KV_ATTENTION_HEAD_COUNT));
  1866. GGUF_GET_KEY(ctx, hparams.n_layer, gguf_get_val_u32, GGUF_TYPE_UINT32, true, kv(LLM_KV_BLOCK_COUNT));
  1867. // n_head_kv is optional, default to n_head
  1868. hparams.n_head_kv = hparams.n_head;
  1869. GGUF_GET_KEY(ctx, hparams.n_head_kv, gguf_get_val_u32, GGUF_TYPE_UINT32, false, kv(LLM_KV_ATTENTION_HEAD_COUNT_KV));
  1870. hparams.rope_finetuned = false;
  1871. GGUF_GET_KEY(ctx, hparams.rope_finetuned, gguf_get_val_bool, GGUF_TYPE_BOOL, false,
  1872. kv(LLM_KV_ROPE_SCALING_FINETUNED));
  1873. hparams.n_yarn_orig_ctx = hparams.n_ctx_train;
  1874. GGUF_GET_KEY(ctx, hparams.n_yarn_orig_ctx, gguf_get_val_u32, GGUF_TYPE_UINT32, false,
  1875. kv(LLM_KV_ROPE_SCALING_ORIG_CTX_LEN));
  1876. // rope_freq_base (optional)
  1877. hparams.rope_freq_base_train = 10000.0f;
  1878. GGUF_GET_KEY(ctx, hparams.rope_freq_base_train, gguf_get_val_f32, GGUF_TYPE_FLOAT32, false, kv(LLM_KV_ROPE_FREQ_BASE));
  1879. std::string rope_scaling("linear");
  1880. GGUF_GET_KEY(ctx, rope_scaling, gguf_get_val_str, GGUF_TYPE_STRING, false, kv(LLM_KV_ROPE_SCALING_TYPE));
  1881. hparams.rope_scaling_type_train = llama_rope_scaling_type_from_string(rope_scaling);
  1882. GGML_ASSERT(hparams.rope_scaling_type_train != LLAMA_ROPE_SCALING_UNSPECIFIED);
  1883. // rope_freq_scale (inverse of the kv) is optional
  1884. float ropescale = 0.0f;
  1885. GGUF_GET_KEY(ctx, ropescale, gguf_get_val_f32, GGUF_TYPE_FLOAT32, false, kv(LLM_KV_ROPE_SCALING_FACTOR));
  1886. if (ropescale == 0.0f) { // try the old key name
  1887. GGUF_GET_KEY(ctx, ropescale, gguf_get_val_f32, GGUF_TYPE_FLOAT32, false, kv(LLM_KV_ROPE_SCALE_LINEAR));
  1888. }
  1889. hparams.rope_freq_scale_train = ropescale == 0.0f ? 1.0f : 1.0f/ropescale;
  1890. // sanity check for n_rot (optional)
  1891. {
  1892. hparams.n_rot = hparams.n_embd / hparams.n_head;
  1893. GGUF_GET_KEY(ctx, hparams.n_rot, gguf_get_val_u32, GGUF_TYPE_UINT32, false, kv(LLM_KV_ROPE_DIMENSION_COUNT));
  1894. if (model.arch == LLM_ARCH_LLAMA || model.arch == LLM_ARCH_FALCON) {
  1895. if (hparams.n_rot != hparams.n_embd / hparams.n_head) {
  1896. throw std::runtime_error(format("invalid n_rot: %u, expected %u", hparams.n_rot, hparams.n_embd / hparams.n_head));
  1897. }
  1898. }
  1899. // gpt-neox n_rot = rotary_pct * (n_embd / n_head)
  1900. // gpt-j n_rot = rotary_dim
  1901. }
  1902. // arch-specific KVs
  1903. switch (model.arch) {
  1904. case LLM_ARCH_LLAMA:
  1905. {
  1906. GGUF_GET_KEY(ctx, hparams.f_norm_rms_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_RMS_EPS));
  1907. switch (hparams.n_layer) {
  1908. case 26: model.type = e_model::MODEL_3B; break;
  1909. case 32: model.type = e_model::MODEL_7B; break;
  1910. case 40: model.type = e_model::MODEL_13B; break;
  1911. case 48: model.type = e_model::MODEL_34B; break;
  1912. case 60: model.type = e_model::MODEL_30B; break;
  1913. case 80: model.type = hparams.n_head == hparams.n_head_kv ? e_model::MODEL_65B : e_model::MODEL_70B; break;
  1914. default: model.type = e_model::MODEL_UNKNOWN;
  1915. }
  1916. } break;
  1917. case LLM_ARCH_FALCON:
  1918. {
  1919. GGUF_GET_KEY(ctx, hparams.f_norm_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_EPS));
  1920. switch (hparams.n_layer) {
  1921. case 32: model.type = e_model::MODEL_7B; break;
  1922. case 60: model.type = e_model::MODEL_40B; break;
  1923. default: model.type = e_model::MODEL_UNKNOWN;
  1924. }
  1925. } break;
  1926. case LLM_ARCH_BAICHUAN:
  1927. {
  1928. GGUF_GET_KEY(ctx, hparams.f_norm_rms_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_RMS_EPS));
  1929. switch (hparams.n_layer) {
  1930. case 32: model.type = e_model::MODEL_7B; break;
  1931. case 40: model.type = e_model::MODEL_13B; break;
  1932. default: model.type = e_model::MODEL_UNKNOWN;
  1933. }
  1934. } break;
  1935. case LLM_ARCH_STARCODER:
  1936. {
  1937. GGUF_GET_KEY(ctx, hparams.f_norm_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_EPS));
  1938. switch (hparams.n_layer) {
  1939. case 24: model.type = e_model::MODEL_1B; break;
  1940. case 36: model.type = e_model::MODEL_3B; break;
  1941. case 42: model.type = e_model::MODEL_7B; break;
  1942. case 40: model.type = e_model::MODEL_15B; break;
  1943. default: model.type = e_model::MODEL_UNKNOWN;
  1944. }
  1945. } break;
  1946. case LLM_ARCH_PERSIMMON:
  1947. {
  1948. GGUF_GET_KEY(ctx, hparams.f_norm_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_EPS));
  1949. switch (hparams.n_layer) {
  1950. case 36: model.type = e_model::MODEL_8B; break;
  1951. default: model.type = e_model::MODEL_UNKNOWN;
  1952. }
  1953. } break;
  1954. case LLM_ARCH_REFACT:
  1955. {
  1956. GGUF_GET_KEY(ctx, hparams.f_norm_rms_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_RMS_EPS));
  1957. switch (hparams.n_layer) {
  1958. case 32: model.type = e_model::MODEL_1B; break;
  1959. default: model.type = e_model::MODEL_UNKNOWN;
  1960. }
  1961. } break;
  1962. case LLM_ARCH_BLOOM:
  1963. {
  1964. GGUF_GET_KEY(ctx, hparams.f_norm_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_EPS));
  1965. switch (hparams.n_layer) {
  1966. case 24: model.type = e_model::MODEL_1B; break;
  1967. case 30:
  1968. switch (hparams.n_embd) {
  1969. case 2560: model.type = e_model::MODEL_3B; break;
  1970. case 4096: model.type = e_model::MODEL_7B; break;
  1971. } break;
  1972. }
  1973. } break;
  1974. case LLM_ARCH_MPT:
  1975. {
  1976. hparams.f_clamp_kqv = 0.0f;
  1977. GGUF_GET_KEY(ctx, hparams.f_norm_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_EPS));
  1978. GGUF_GET_KEY(ctx, hparams.f_clamp_kqv, gguf_get_val_f32, GGUF_TYPE_FLOAT32, false, kv(LLM_KV_ATTENTION_CLAMP_KQV));
  1979. GGUF_GET_KEY(ctx, hparams.f_max_alibi_bias, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_MAX_ALIBI_BIAS));
  1980. switch (hparams.n_layer) {
  1981. case 32: model.type = e_model::MODEL_7B; break;
  1982. case 48: model.type = e_model::MODEL_30B; break;
  1983. default: model.type = e_model::MODEL_UNKNOWN;
  1984. }
  1985. } break;
  1986. case LLM_ARCH_STABLELM:
  1987. {
  1988. GGUF_GET_KEY(ctx, hparams.f_norm_eps, gguf_get_val_f32, GGUF_TYPE_FLOAT32, true, kv(LLM_KV_ATTENTION_LAYERNORM_EPS));
  1989. switch (hparams.n_layer) {
  1990. case 32: model.type = e_model::MODEL_3B; break;
  1991. default: model.type = e_model::MODEL_UNKNOWN;
  1992. }
  1993. } break;
  1994. default: (void)0;
  1995. }
  1996. model.ftype = ml.ftype;
  1997. }
  1998. // TODO: This should probably be in llama.h
  1999. static std::vector<llama_vocab::id> llama_tokenize_internal(const llama_vocab & vocab, std::string raw_text, bool bos, bool special = false);
  2000. static llama_token llama_byte_to_token(const llama_vocab & vocab, uint8_t ch);
  2001. static void llm_load_vocab(
  2002. llama_model_loader & ml,
  2003. llama_model & model) {
  2004. auto & vocab = model.vocab;
  2005. struct gguf_context * ctx = ml.ctx_gguf;
  2006. const auto kv = LLM_KV(model.arch);
  2007. const int token_idx = gguf_find_key(ctx, kv(LLM_KV_TOKENIZER_LIST).c_str());
  2008. if (token_idx == -1) {
  2009. throw std::runtime_error("cannot find tokenizer vocab in model file\n");
  2010. }
  2011. const float * scores = nullptr;
  2012. const int score_idx = gguf_find_key(ctx, kv(LLM_KV_TOKENIZER_SCORES).c_str());
  2013. if (score_idx != -1) {
  2014. scores = (const float * ) gguf_get_arr_data(ctx, score_idx);
  2015. }
  2016. const int * toktypes = nullptr;
  2017. const int toktype_idx = gguf_find_key(ctx, kv(LLM_KV_TOKENIZER_TOKEN_TYPE).c_str());
  2018. if (toktype_idx != -1) {
  2019. toktypes = (const int * ) gguf_get_arr_data(ctx, toktype_idx);
  2020. }
  2021. // determine vocab type
  2022. {
  2023. std::string tokenizer_name;
  2024. GGUF_GET_KEY(ctx, tokenizer_name, gguf_get_val_str, GGUF_TYPE_STRING, true, kv(LLM_KV_TOKENIZER_MODEL));
  2025. if (tokenizer_name == "llama") {
  2026. vocab.type = LLAMA_VOCAB_TYPE_SPM;
  2027. // default special tokens
  2028. vocab.special_bos_id = 1;
  2029. vocab.special_eos_id = 2;
  2030. vocab.special_unk_id = 0;
  2031. vocab.special_sep_id = -1;
  2032. vocab.special_pad_id = -1;
  2033. } else if (tokenizer_name == "gpt2") {
  2034. vocab.type = LLAMA_VOCAB_TYPE_BPE;
  2035. // read bpe merges and populate bpe ranks
  2036. const int merges_keyidx = gguf_find_key(ctx, kv(LLM_KV_TOKENIZER_MERGES).c_str());
  2037. if (merges_keyidx == -1) {
  2038. throw std::runtime_error("cannot find tokenizer merges in model file\n");
  2039. }
  2040. const int n_merges = gguf_get_arr_n(ctx, merges_keyidx);
  2041. for (int i = 0; i < n_merges; i++) {
  2042. const std::string word = gguf_get_arr_str(ctx, merges_keyidx, i);
  2043. GGML_ASSERT(codepoints_from_utf8(word).size() > 0);
  2044. std::string first;
  2045. std::string second;
  2046. const size_t pos = word.find(' ', 1);
  2047. if (pos != std::string::npos) {
  2048. first = word.substr(0, pos);
  2049. second = word.substr(pos + 1);
  2050. }
  2051. vocab.bpe_ranks.emplace(std::make_pair(first, second), i);
  2052. }
  2053. // default special tokens
  2054. vocab.special_bos_id = 11;
  2055. vocab.special_eos_id = 11;
  2056. vocab.special_unk_id = -1;
  2057. vocab.special_sep_id = -1;
  2058. vocab.special_pad_id = -1;
  2059. } else {
  2060. LLAMA_LOG_WARN("%s: unknown tokenizer: '%s'", __func__, tokenizer_name.c_str());
  2061. LLAMA_LOG_WARN("%s: using default tokenizer: 'llama'", __func__);
  2062. vocab.type = LLAMA_VOCAB_TYPE_SPM;
  2063. }
  2064. }
  2065. const uint32_t n_vocab = gguf_get_arr_n(ctx, token_idx);
  2066. vocab.id_to_token.resize(n_vocab);
  2067. for (uint32_t i = 0; i < n_vocab; i++) {
  2068. std::string word = gguf_get_arr_str(ctx, token_idx, i);
  2069. GGML_ASSERT(codepoints_from_utf8(word).size() > 0);
  2070. vocab.token_to_id[word] = i;
  2071. auto & token_data = vocab.id_to_token[i];
  2072. token_data.text = std::move(word);
  2073. token_data.score = scores ? scores[i] : 0.0f;
  2074. token_data.type = toktypes ? (llama_token_type) toktypes[i] : LLAMA_TOKEN_TYPE_NORMAL;
  2075. }
  2076. GGML_ASSERT(vocab.id_to_token.size() == vocab.token_to_id.size());
  2077. // determine the newline token: LLaMA "<0x0A>" == 10 == '\n', Falcon 193 == '\n'
  2078. if (vocab.type == LLAMA_VOCAB_TYPE_SPM) {
  2079. vocab.linefeed_id = llama_byte_to_token(vocab, '\n');
  2080. } else {
  2081. const std::vector<int> ids = llama_tokenize_internal(vocab, "\u010A", false);
  2082. GGML_ASSERT(!ids.empty() && "model vocab missing newline token");
  2083. vocab.linefeed_id = ids[0];
  2084. }
  2085. // special tokens
  2086. {
  2087. const std::vector<std::pair<enum llm_kv, int32_t &>> special_token_types = {
  2088. { LLM_KV_TOKENIZER_BOS_ID, vocab.special_bos_id },
  2089. { LLM_KV_TOKENIZER_EOS_ID, vocab.special_eos_id },
  2090. { LLM_KV_TOKENIZER_UNK_ID, vocab.special_unk_id },
  2091. { LLM_KV_TOKENIZER_SEP_ID, vocab.special_sep_id },
  2092. { LLM_KV_TOKENIZER_PAD_ID, vocab.special_pad_id },
  2093. };
  2094. for (const auto & it : special_token_types) {
  2095. const std::string & key = kv(std::get<0>(it));
  2096. int32_t & id = std::get<1>(it), old_id = id;
  2097. GGUF_GET_KEY(ctx, id, gguf_get_val_u32, GGUF_TYPE_UINT32, false, key);
  2098. // Must be >= -1 and < vocab size. Since the key is unsigned, -1
  2099. // can only come from the default value, so there's no point in
  2100. // validating that.
  2101. if (size_t(id + 1) > vocab.id_to_token.size()) {
  2102. LLAMA_LOG_WARN("%s: bad special token: '%s' = %d, using default id %d\n",
  2103. __func__, key.c_str(), id, old_id);
  2104. id = old_id;
  2105. }
  2106. }
  2107. // Handle add_bos_token and add_eos_token
  2108. std::string key = kv(LLM_KV_TOKENIZER_ADD_BOS);
  2109. int kid = gguf_find_key(ctx, key.c_str());
  2110. enum gguf_type ktype = kid < 0 ? GGUF_TYPE_COUNT : gguf_get_kv_type(ctx, kid);
  2111. vocab.special_add_bos = ktype == GGUF_TYPE_BOOL ? gguf_get_val_bool(ctx, kid) : -1;
  2112. if (ktype != GGUF_TYPE_BOOL && ktype != GGUF_TYPE_COUNT) {
  2113. LLAMA_LOG_WARN("%s: bad field type %d for '%s' - ignoring\n", __func__, ktype, key.c_str());
  2114. }
  2115. key = kv(LLM_KV_TOKENIZER_ADD_EOS);
  2116. kid = gguf_find_key(ctx, key.c_str());
  2117. ktype = kid < 0 ? GGUF_TYPE_COUNT : gguf_get_kv_type(ctx, kid);
  2118. vocab.special_add_eos = ktype == GGUF_TYPE_BOOL ? gguf_get_val_bool(ctx, kid) : -1;
  2119. if (ktype != GGUF_TYPE_BOOL && ktype != GGUF_TYPE_COUNT) {
  2120. LLAMA_LOG_WARN("%s: bad field type %d for '%s' - ignoring\n", __func__, ktype, key.c_str());
  2121. }
  2122. }
  2123. // build special tokens cache
  2124. {
  2125. // TODO: It is unclear (to me) at this point, whether special tokes are guaranteed to be of a deterministic type,
  2126. // and will always be correctly labeled in 'added_tokens.json' etc.
  2127. // The assumption is, since special tokens aren't meant to be exposed to end user, they are designed
  2128. // to be unmatchable by the tokenizer, therefore tokens from the vocab, which are unmatchable by the tokenizer
  2129. // are special tokens.
  2130. // From testing, this appears to corelate 1:1 with special tokens.
  2131. //
  2132. // Counting special tokens and verifying in only one direction
  2133. // is sufficient to detect difference in those two sets.
  2134. //
  2135. uint32_t special_tokens_count_by_type = 0;
  2136. uint32_t special_tokens_count_from_verification = 0;
  2137. bool special_tokens_definition_mismatch = false;
  2138. for (const auto & t : vocab.token_to_id) {
  2139. const auto & token = t.first;
  2140. const auto & id = t.second;
  2141. // Count all non-normal tokens in the vocab while iterating
  2142. if (vocab.id_to_token[id].type != LLAMA_TOKEN_TYPE_NORMAL) {
  2143. special_tokens_count_by_type++;
  2144. }
  2145. // Skip single character tokens
  2146. if (token.length() > 1) {
  2147. bool is_tokenizable = false;
  2148. // Split token string representation in two, in all possible ways
  2149. // and check if both halves can be matched to a valid token
  2150. for (unsigned i = 1; i < token.length();) {
  2151. const auto left = token.substr(0, i);
  2152. const auto right = token.substr(i);
  2153. // check if we didnt partition in the middle of a utf sequence
  2154. auto utf = utf8_len(left.at(left.length() - 1));
  2155. if (utf == 1) {
  2156. if (vocab.token_to_id.find(left) != vocab.token_to_id.end() &&
  2157. vocab.token_to_id.find(right) != vocab.token_to_id.end() ) {
  2158. is_tokenizable = true;
  2159. break;
  2160. }
  2161. i++;
  2162. } else {
  2163. // skip over the rest of multibyte utf sequence
  2164. i += utf - 1;
  2165. }
  2166. }
  2167. if (!is_tokenizable) {
  2168. // Some tokens are multibyte, but they are utf sequences with equivalent text length of 1
  2169. // it's faster to re-filter them here, since there are way less candidates now
  2170. // Calculate a total "utf" length of a token string representation
  2171. size_t utf8_str_len = 0;
  2172. for (unsigned i = 0; i < token.length();) {
  2173. utf8_str_len++;
  2174. i += utf8_len(token.at(i));
  2175. }
  2176. // And skip the ones which are one character
  2177. if (utf8_str_len > 1) {
  2178. // At this point what we have left are special tokens only
  2179. vocab.special_tokens_cache[token] = id;
  2180. // Count manually found special tokens
  2181. special_tokens_count_from_verification++;
  2182. // If this manually found special token is not marked as such, flag a mismatch
  2183. if (vocab.id_to_token[id].type == LLAMA_TOKEN_TYPE_NORMAL) {
  2184. special_tokens_definition_mismatch = true;
  2185. }
  2186. }
  2187. }
  2188. }
  2189. }
  2190. if (special_tokens_definition_mismatch || special_tokens_count_from_verification != special_tokens_count_by_type) {
  2191. LLAMA_LOG_WARN("%s: mismatch in special tokens definition ( %u/%zu vs %u/%zu ).\n",
  2192. __func__,
  2193. special_tokens_count_from_verification, vocab.id_to_token.size(),
  2194. special_tokens_count_by_type, vocab.id_to_token.size()
  2195. );
  2196. } else {
  2197. LLAMA_LOG_INFO("%s: special tokens definition check successful ( %u/%zu ).\n",
  2198. __func__,
  2199. special_tokens_count_from_verification, vocab.id_to_token.size()
  2200. );
  2201. }
  2202. }
  2203. }
  2204. static void llm_load_print_meta(llama_model_loader & ml, llama_model & model) {
  2205. const auto & hparams = model.hparams;
  2206. const auto & vocab = model.vocab;
  2207. const auto rope_scaling_type = LLAMA_ROPE_SCALING_TYPES.at(hparams.rope_scaling_type_train);
  2208. // hparams
  2209. LLAMA_LOG_INFO("%s: format = %s\n", __func__, llama_file_version_name(ml.fver));
  2210. LLAMA_LOG_INFO("%s: arch = %s\n", __func__, LLM_ARCH_NAMES.at(model.arch).c_str());
  2211. LLAMA_LOG_INFO("%s: vocab type = %s\n", __func__, vocab.type == LLAMA_VOCAB_TYPE_SPM ? "SPM" : "BPE"); // TODO: fix
  2212. LLAMA_LOG_INFO("%s: n_vocab = %u\n", __func__, hparams.n_vocab);
  2213. LLAMA_LOG_INFO("%s: n_merges = %u\n", __func__, (int) vocab.bpe_ranks.size());
  2214. LLAMA_LOG_INFO("%s: n_ctx_train = %u\n", __func__, hparams.n_ctx_train);
  2215. LLAMA_LOG_INFO("%s: n_embd = %u\n", __func__, hparams.n_embd);
  2216. LLAMA_LOG_INFO("%s: n_head = %u\n", __func__, hparams.n_head);
  2217. LLAMA_LOG_INFO("%s: n_head_kv = %u\n", __func__, hparams.n_head_kv);
  2218. LLAMA_LOG_INFO("%s: n_layer = %u\n", __func__, hparams.n_layer);
  2219. LLAMA_LOG_INFO("%s: n_rot = %u\n", __func__, hparams.n_rot); // a.k.a. n_embd_head, n_head_dim
  2220. LLAMA_LOG_INFO("%s: n_gqa = %u\n", __func__, hparams.n_gqa());
  2221. LLAMA_LOG_INFO("%s: f_norm_eps = %.1e\n", __func__, hparams.f_norm_eps);
  2222. LLAMA_LOG_INFO("%s: f_norm_rms_eps = %.1e\n", __func__, hparams.f_norm_rms_eps);
  2223. LLAMA_LOG_INFO("%s: f_clamp_kqv = %.1e\n", __func__, hparams.f_clamp_kqv);
  2224. LLAMA_LOG_INFO("%s: f_max_alibi_bias = %.1e\n", __func__, hparams.f_max_alibi_bias);
  2225. LLAMA_LOG_INFO("%s: n_ff = %u\n", __func__, hparams.n_ff);
  2226. LLAMA_LOG_INFO("%s: rope scaling = %s\n", __func__, rope_scaling_type.c_str());
  2227. LLAMA_LOG_INFO("%s: freq_base_train = %.1f\n", __func__, hparams.rope_freq_base_train);
  2228. LLAMA_LOG_INFO("%s: freq_scale_train = %g\n", __func__, hparams.rope_freq_scale_train);
  2229. LLAMA_LOG_INFO("%s: n_yarn_orig_ctx = %u\n", __func__, hparams.n_yarn_orig_ctx);
  2230. LLAMA_LOG_INFO("%s: rope_finetuned = %s\n", __func__, hparams.rope_finetuned ? "yes" : "unknown");
  2231. LLAMA_LOG_INFO("%s: model type = %s\n", __func__, llama_model_type_name(model.type));
  2232. LLAMA_LOG_INFO("%s: model ftype = %s\n", __func__, llama_model_ftype_name(model.ftype).c_str());
  2233. LLAMA_LOG_INFO("%s: model params = %.2f B\n", __func__, ml.n_elements*1e-9);
  2234. if (ml.n_bytes < GiB) {
  2235. LLAMA_LOG_INFO("%s: model size = %.2f MiB (%.2f BPW) \n", __func__, ml.n_bytes/1024.0/1024.0, ml.n_bytes*8.0/ml.n_elements);
  2236. } else {
  2237. LLAMA_LOG_INFO("%s: model size = %.2f GiB (%.2f BPW) \n", __func__, ml.n_bytes/1024.0/1024.0/1024.0, ml.n_bytes*8.0/ml.n_elements);
  2238. }
  2239. // general kv
  2240. LLAMA_LOG_INFO("%s: general.name = %s\n", __func__, model.name.c_str());
  2241. // special tokens
  2242. if (vocab.special_bos_id != -1) { LLAMA_LOG_INFO( "%s: BOS token = %d '%s'\n", __func__, vocab.special_bos_id, vocab.id_to_token[vocab.special_bos_id].text.c_str() ); }
  2243. if (vocab.special_eos_id != -1) { LLAMA_LOG_INFO( "%s: EOS token = %d '%s'\n", __func__, vocab.special_eos_id, vocab.id_to_token[vocab.special_eos_id].text.c_str() ); }
  2244. if (vocab.special_unk_id != -1) { LLAMA_LOG_INFO( "%s: UNK token = %d '%s'\n", __func__, vocab.special_unk_id, vocab.id_to_token[vocab.special_unk_id].text.c_str() ); }
  2245. if (vocab.special_sep_id != -1) { LLAMA_LOG_INFO( "%s: SEP token = %d '%s'\n", __func__, vocab.special_sep_id, vocab.id_to_token[vocab.special_sep_id].text.c_str() ); }
  2246. if (vocab.special_pad_id != -1) { LLAMA_LOG_INFO( "%s: PAD token = %d '%s'\n", __func__, vocab.special_pad_id, vocab.id_to_token[vocab.special_pad_id].text.c_str() ); }
  2247. if (vocab.linefeed_id != -1) { LLAMA_LOG_INFO( "%s: LF token = %d '%s'\n", __func__, vocab.linefeed_id, vocab.id_to_token[vocab.linefeed_id].text.c_str() ); }
  2248. }
  2249. static void llm_load_tensors(
  2250. llama_model_loader & ml,
  2251. llama_model & model,
  2252. int n_gpu_layers,
  2253. int main_gpu,
  2254. const float * tensor_split,
  2255. bool use_mlock,
  2256. llama_progress_callback progress_callback,
  2257. void * progress_callback_user_data) {
  2258. model.t_start_us = ggml_time_us();
  2259. auto & ctx = model.ctx;
  2260. auto & hparams = model.hparams;
  2261. model.n_gpu_layers = n_gpu_layers;
  2262. size_t ctx_size;
  2263. size_t mmapped_size;
  2264. ml.calc_sizes(ctx_size, mmapped_size);
  2265. LLAMA_LOG_INFO("%s: ggml ctx size = %7.2f MiB\n", __func__, ctx_size/1024.0/1024.0);
  2266. // create the ggml context
  2267. {
  2268. model.buf.resize(ctx_size);
  2269. if (use_mlock) {
  2270. model.mlock_buf.init (model.buf.data);
  2271. model.mlock_buf.grow_to(model.buf.size);
  2272. }
  2273. struct ggml_init_params params = {
  2274. /*.mem_size =*/ model.buf.size,
  2275. /*.mem_buffer =*/ model.buf.data,
  2276. /*.no_alloc =*/ ml.use_mmap,
  2277. };
  2278. model.ctx = ggml_init(params);
  2279. if (!model.ctx) {
  2280. throw std::runtime_error(format("ggml_init() failed"));
  2281. }
  2282. }
  2283. (void) main_gpu;
  2284. enum ggml_backend_type llama_backend_offload = GGML_BACKEND_CPU;
  2285. enum ggml_backend_type llama_backend_offload_split = GGML_BACKEND_CPU;
  2286. #ifdef GGML_USE_CUBLAS
  2287. if (ggml_cublas_loaded()) {
  2288. LLAMA_LOG_INFO("%s: using " GGML_CUDA_NAME " for GPU acceleration\n", __func__);
  2289. ggml_cuda_set_main_device(main_gpu);
  2290. llama_backend_offload = GGML_BACKEND_GPU;
  2291. llama_backend_offload_split = GGML_BACKEND_GPU_SPLIT;
  2292. }
  2293. #elif defined(GGML_USE_CLBLAST)
  2294. LLAMA_LOG_INFO("%s: using OpenCL for GPU acceleration\n", __func__);
  2295. llama_backend_offload = GGML_BACKEND_GPU;
  2296. llama_backend_offload_split = GGML_BACKEND_GPU;
  2297. #endif
  2298. // prepare memory for the weights
  2299. size_t vram_weights = 0;
  2300. {
  2301. const int64_t n_embd = hparams.n_embd;
  2302. const int64_t n_embd_gqa = hparams.n_embd_gqa();
  2303. const int64_t n_layer = hparams.n_layer;
  2304. const int64_t n_vocab = hparams.n_vocab;
  2305. const auto tn = LLM_TN(model.arch);
  2306. switch (model.arch) {
  2307. case LLM_ARCH_LLAMA:
  2308. case LLM_ARCH_REFACT:
  2309. {
  2310. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2311. // output
  2312. {
  2313. ggml_backend_type backend_norm;
  2314. ggml_backend_type backend_output;
  2315. if (n_gpu_layers > int(n_layer)) {
  2316. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2317. // on Windows however this is detrimental unless everything is on the GPU
  2318. #ifndef _WIN32
  2319. backend_norm = llama_backend_offload;
  2320. #else
  2321. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2322. #endif // _WIN32
  2323. backend_output = llama_backend_offload_split;
  2324. } else {
  2325. backend_norm = GGML_BACKEND_CPU;
  2326. backend_output = GGML_BACKEND_CPU;
  2327. }
  2328. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2329. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2330. if (backend_norm == GGML_BACKEND_GPU) {
  2331. vram_weights += ggml_nbytes(model.output_norm);
  2332. }
  2333. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2334. vram_weights += ggml_nbytes(model.output);
  2335. }
  2336. }
  2337. const uint32_t n_ff = hparams.n_ff;
  2338. const int i_gpu_start = n_layer - n_gpu_layers;
  2339. model.layers.resize(n_layer);
  2340. for (uint32_t i = 0; i < n_layer; ++i) {
  2341. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2342. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2343. auto & layer = model.layers[i];
  2344. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2345. layer.wq = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_Q, "weight", i), {n_embd, n_embd}, backend_split);
  2346. layer.wk = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_K, "weight", i), {n_embd, n_embd_gqa}, backend_split);
  2347. layer.wv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_V, "weight", i), {n_embd, n_embd_gqa}, backend_split);
  2348. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2349. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2350. layer.ffn_gate = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_GATE, "weight", i), {n_embd, n_ff}, backend_split);
  2351. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), { n_ff, n_embd}, backend_split);
  2352. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2353. if (backend == GGML_BACKEND_GPU) {
  2354. vram_weights +=
  2355. ggml_nbytes(layer.attn_norm) + ggml_nbytes(layer.wq) + ggml_nbytes(layer.wk) +
  2356. ggml_nbytes(layer.wv) + ggml_nbytes(layer.wo) + ggml_nbytes(layer.ffn_norm) +
  2357. ggml_nbytes(layer.ffn_gate) + ggml_nbytes(layer.ffn_down) + ggml_nbytes(layer.ffn_up);
  2358. }
  2359. }
  2360. } break;
  2361. case LLM_ARCH_BAICHUAN:
  2362. {
  2363. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2364. {
  2365. ggml_backend_type backend_norm;
  2366. ggml_backend_type backend_output;
  2367. if (n_gpu_layers > int(n_layer)) {
  2368. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2369. // on Windows however this is detrimental unless everything is on the GPU
  2370. #ifndef _WIN32
  2371. backend_norm = llama_backend_offload;
  2372. #else
  2373. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2374. #endif // _WIN32
  2375. backend_output = llama_backend_offload_split;
  2376. } else {
  2377. backend_norm = GGML_BACKEND_CPU;
  2378. backend_output = GGML_BACKEND_CPU;
  2379. }
  2380. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2381. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2382. if (backend_norm == GGML_BACKEND_GPU) {
  2383. vram_weights += ggml_nbytes(model.output_norm);
  2384. }
  2385. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2386. vram_weights += ggml_nbytes(model.output);
  2387. }
  2388. }
  2389. const uint32_t n_ff = hparams.n_ff;
  2390. const int i_gpu_start = n_layer - n_gpu_layers;
  2391. model.layers.resize(n_layer);
  2392. for (uint32_t i = 0; i < n_layer; ++i) {
  2393. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2394. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2395. auto & layer = model.layers[i];
  2396. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2397. layer.wq = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_Q, "weight", i), {n_embd, n_embd}, backend_split);
  2398. layer.wk = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_K, "weight", i), {n_embd, n_embd_gqa}, backend_split);
  2399. layer.wv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_V, "weight", i), {n_embd, n_embd_gqa}, backend_split);
  2400. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2401. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2402. layer.ffn_gate = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_GATE, "weight", i), {n_embd, n_ff}, backend_split);
  2403. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), { n_ff, n_embd}, backend_split);
  2404. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2405. if (backend == GGML_BACKEND_GPU) {
  2406. vram_weights +=
  2407. ggml_nbytes(layer.attn_norm) + ggml_nbytes(layer.wq) + ggml_nbytes(layer.wk) +
  2408. ggml_nbytes(layer.wv) + ggml_nbytes(layer.wo) + ggml_nbytes(layer.ffn_norm) +
  2409. ggml_nbytes(layer.ffn_gate) + ggml_nbytes(layer.ffn_down) + ggml_nbytes(layer.ffn_up);
  2410. }
  2411. }
  2412. } break;
  2413. case LLM_ARCH_FALCON:
  2414. {
  2415. // TODO: CPU-only for now
  2416. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2417. // output
  2418. {
  2419. ggml_backend_type backend_norm;
  2420. ggml_backend_type backend_output;
  2421. if (n_gpu_layers > int(n_layer)) {
  2422. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2423. // on Windows however this is detrimental unless everything is on the GPU
  2424. #ifndef _WIN32
  2425. backend_norm = llama_backend_offload;
  2426. #else
  2427. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2428. #endif // _WIN32
  2429. backend_output = llama_backend_offload_split;
  2430. } else {
  2431. backend_norm = GGML_BACKEND_CPU;
  2432. backend_output = GGML_BACKEND_CPU;
  2433. }
  2434. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2435. model.output_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "bias"), {n_embd}, backend_norm);
  2436. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2437. if (backend_norm == GGML_BACKEND_GPU) {
  2438. vram_weights += ggml_nbytes(model.output_norm);
  2439. vram_weights += ggml_nbytes(model.output_norm_b);
  2440. }
  2441. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2442. vram_weights += ggml_nbytes(model.output);
  2443. }
  2444. }
  2445. const uint32_t n_ff = hparams.n_ff;
  2446. const int i_gpu_start = n_layer - n_gpu_layers;
  2447. model.layers.resize(n_layer);
  2448. for (uint32_t i = 0; i < n_layer; ++i) {
  2449. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2450. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2451. auto & layer = model.layers[i];
  2452. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2453. layer.attn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "bias", i), {n_embd}, backend);
  2454. if (gguf_find_tensor(ml.ctx_gguf, tn(LLM_TENSOR_ATTN_NORM_2, "weight", i).c_str()) >= 0) {
  2455. layer.attn_norm_2 = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM_2, "weight", i), {n_embd}, backend);
  2456. layer.attn_norm_2_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM_2, "bias", i), {n_embd}, backend);
  2457. if (backend == GGML_BACKEND_GPU) {
  2458. vram_weights += ggml_nbytes(layer.attn_norm_2);
  2459. vram_weights += ggml_nbytes(layer.attn_norm_2_b);
  2460. }
  2461. }
  2462. layer.wqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "weight", i), {n_embd, n_embd + 2*n_embd_gqa}, backend_split);
  2463. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2464. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), { n_ff, n_embd}, backend_split);
  2465. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2466. if (backend == GGML_BACKEND_GPU) {
  2467. vram_weights +=
  2468. ggml_nbytes(layer.attn_norm) + ggml_nbytes(layer.attn_norm_b) +
  2469. ggml_nbytes(layer.wqkv) + ggml_nbytes(layer.wo) +
  2470. ggml_nbytes(layer.ffn_down) + ggml_nbytes(layer.ffn_up);
  2471. }
  2472. }
  2473. } break;
  2474. case LLM_ARCH_STARCODER:
  2475. {
  2476. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2477. model.pos_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_POS_EMBD, "weight"), {n_embd, hparams.n_ctx_train}, GGML_BACKEND_CPU);
  2478. // output
  2479. {
  2480. ggml_backend_type backend_norm;
  2481. ggml_backend_type backend_output;
  2482. if (n_gpu_layers > int(n_layer)) {
  2483. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2484. // on Windows however this is detrimental unless everything is on the GPU
  2485. #ifndef _WIN32
  2486. backend_norm = llama_backend_offload;
  2487. #else
  2488. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2489. #endif // _WIN32
  2490. backend_output = llama_backend_offload_split;
  2491. } else {
  2492. backend_norm = GGML_BACKEND_CPU;
  2493. backend_output = GGML_BACKEND_CPU;
  2494. }
  2495. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2496. model.output_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "bias"), {n_embd}, backend_norm);
  2497. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2498. if (backend_norm == GGML_BACKEND_GPU) {
  2499. vram_weights += ggml_nbytes(model.output_norm);
  2500. vram_weights += ggml_nbytes(model.output_norm_b);
  2501. }
  2502. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2503. vram_weights += ggml_nbytes(model.output);
  2504. }
  2505. }
  2506. const uint32_t n_ff = hparams.n_ff;
  2507. const int i_gpu_start = n_layer - n_gpu_layers;
  2508. model.layers.resize(n_layer);
  2509. for (uint32_t i = 0; i < n_layer; ++i) {
  2510. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2511. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2512. auto & layer = model.layers[i];
  2513. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2514. layer.attn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "bias", i), {n_embd}, backend);
  2515. layer.wqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "weight", i), {n_embd, n_embd + 2*n_embd_gqa}, backend_split);
  2516. layer.bqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "bias", i), {n_embd + 2*n_embd_gqa}, backend);
  2517. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2518. layer.bo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "bias", i), {n_embd}, backend);
  2519. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2520. layer.ffn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "bias", i), {n_embd}, backend);
  2521. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), {n_ff, n_embd}, backend_split);
  2522. layer.ffn_down_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "bias", i), {n_embd}, backend);
  2523. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2524. layer.ffn_up_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "bias", i), {n_ff}, backend);
  2525. if (backend == GGML_BACKEND_GPU) {
  2526. vram_weights +=
  2527. ggml_nbytes(layer.attn_norm) + ggml_nbytes(layer.attn_norm_b) +
  2528. ggml_nbytes(layer.wqkv) + ggml_nbytes(layer.bqkv) +
  2529. ggml_nbytes(layer.wo) + ggml_nbytes(layer.bo) +
  2530. ggml_nbytes(layer.ffn_norm) + ggml_nbytes(layer.ffn_norm_b) +
  2531. ggml_nbytes(layer.ffn_down) + ggml_nbytes(layer.ffn_down_b) +
  2532. ggml_nbytes(layer.ffn_up) + ggml_nbytes(layer.ffn_up_b);
  2533. }
  2534. }
  2535. } break;
  2536. case LLM_ARCH_PERSIMMON:
  2537. {
  2538. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2539. {
  2540. ggml_backend_type backend_norm;
  2541. ggml_backend_type backend_output;
  2542. if (n_gpu_layers > int(n_layer)) {
  2543. #ifdef GGML_USE_CUBLAS
  2544. if (n_gpu_layers > int(n_layer + 1)) {
  2545. LLAMA_LOG_ERROR("%s: CUDA backend missing Persimmon CUDA ops, can offload at most %ld layers. See: https://github.com/ggerganov/llama.cpp/issues/4038\n",
  2546. __func__, n_layer + 1);
  2547. throw std::runtime_error("Persimmon CUDA offload failed");
  2548. }
  2549. #endif
  2550. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2551. // on Windows however this is detrimental unless everything is on the GPU
  2552. #ifndef _WIN32
  2553. backend_norm = llama_backend_offload;
  2554. #else
  2555. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2556. #endif // _WIN32
  2557. backend_output = llama_backend_offload_split;
  2558. } else {
  2559. backend_norm = GGML_BACKEND_CPU;
  2560. backend_output = GGML_BACKEND_CPU;
  2561. }
  2562. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2563. model.output_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "bias"), {n_embd}, backend_norm);
  2564. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2565. if (backend_norm == GGML_BACKEND_GPU) {
  2566. vram_weights += ggml_nbytes(model.output_norm);
  2567. vram_weights += ggml_nbytes(model.output_norm_b);
  2568. }
  2569. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2570. vram_weights += ggml_nbytes(model.output);
  2571. }
  2572. }
  2573. const uint32_t n_ff = hparams.n_ff;
  2574. const int i_gpu_start = n_layer - n_gpu_layers;
  2575. model.layers.resize(n_layer);
  2576. for (uint32_t i = 0; i < n_layer; ++i) {
  2577. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload;
  2578. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split;
  2579. auto & layer = model.layers[i];
  2580. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2581. layer.attn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "bias", i), {n_embd}, backend);
  2582. layer.wqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "weight", i), {n_embd, n_embd + 2*n_embd_gqa}, backend_split);
  2583. layer.bqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "bias", i), {n_embd + 2*n_embd_gqa}, backend);
  2584. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2585. layer.bo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "bias", i), {n_embd}, backend);
  2586. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), {n_ff, n_embd}, backend_split);
  2587. layer.ffn_down_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "bias", i), {n_embd}, backend);
  2588. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2589. layer.ffn_up_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "bias", i), {n_ff}, backend);
  2590. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2591. layer.ffn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "bias", i), {n_embd}, backend);
  2592. layer.attn_q_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_Q_NORM, "weight", i), {64}, backend);
  2593. layer.attn_q_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_Q_NORM, "bias", i), {64}, backend);
  2594. layer.attn_k_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_K_NORM, "weight", i), {64}, backend);
  2595. layer.attn_k_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_K_NORM, "bias", i), {64}, backend);
  2596. }
  2597. } break;
  2598. case LLM_ARCH_BLOOM:
  2599. {
  2600. // TODO: CPU-only for now
  2601. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2602. model.tok_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD_NORM, "weight"), {n_embd}, GGML_BACKEND_CPU);
  2603. model.tok_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD_NORM, "bias"), {n_embd}, GGML_BACKEND_CPU);
  2604. // output
  2605. {
  2606. ggml_backend_type backend_norm;
  2607. ggml_backend_type backend_output;
  2608. if (n_gpu_layers > int(n_layer)) {
  2609. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2610. // on Windows however this is detrimental unless everything is on the GPU
  2611. #ifndef _WIN32
  2612. backend_norm = llama_backend_offload;
  2613. #else
  2614. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2615. #endif // _WIN32
  2616. backend_output = llama_backend_offload_split;
  2617. } else {
  2618. backend_norm = GGML_BACKEND_CPU;
  2619. backend_output = GGML_BACKEND_CPU;
  2620. }
  2621. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2622. model.output_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "bias"), {n_embd}, backend_norm);
  2623. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2624. if (backend_norm == GGML_BACKEND_GPU) {
  2625. vram_weights += ggml_nbytes(model.output_norm);
  2626. vram_weights += ggml_nbytes(model.output_norm_b);
  2627. }
  2628. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2629. vram_weights += ggml_nbytes(model.output);
  2630. }
  2631. }
  2632. const uint32_t n_ff = hparams.n_ff;
  2633. const int i_gpu_start = n_layer - n_gpu_layers;
  2634. model.layers.resize(n_layer);
  2635. for (uint32_t i = 0; i < n_layer; ++i) {
  2636. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2637. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2638. auto & layer = model.layers[i];
  2639. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2640. layer.attn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "bias", i), {n_embd}, backend);
  2641. layer.wqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "weight", i), {n_embd, n_embd + 2*n_embd_gqa}, backend_split);
  2642. layer.bqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "bias", i), {n_embd + 2*n_embd_gqa}, backend);
  2643. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2644. layer.bo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "bias", i), {n_embd}, backend);
  2645. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2646. layer.ffn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "bias", i), {n_embd}, backend);
  2647. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), {n_ff, n_embd}, backend_split);
  2648. layer.ffn_down_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "bias", i), {n_embd}, backend);
  2649. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2650. layer.ffn_up_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "bias", i), {n_ff}, backend);
  2651. if (backend == GGML_BACKEND_GPU) {
  2652. vram_weights +=
  2653. ggml_nbytes(layer.attn_norm) + ggml_nbytes(layer.attn_norm_b) +
  2654. ggml_nbytes(layer.wqkv) + ggml_nbytes(layer.bqkv) +
  2655. ggml_nbytes(layer.wo) + ggml_nbytes(layer.bo) +
  2656. ggml_nbytes(layer.ffn_norm) + ggml_nbytes(layer.ffn_norm_b) +
  2657. ggml_nbytes(layer.ffn_up) + ggml_nbytes(layer.ffn_up_b) +
  2658. ggml_nbytes(layer.ffn_down) + ggml_nbytes(layer.ffn_down_b);
  2659. }
  2660. }
  2661. } break;
  2662. case LLM_ARCH_MPT:
  2663. {
  2664. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2665. // output
  2666. {
  2667. ggml_backend_type backend_norm;
  2668. ggml_backend_type backend_output;
  2669. if (n_gpu_layers > int(n_layer)) {
  2670. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2671. // on Windows however this is detrimental unless everything is on the GPU
  2672. #ifndef _WIN32
  2673. backend_norm = llama_backend_offload;
  2674. #else
  2675. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2676. #endif // _WIN32
  2677. backend_output = llama_backend_offload_split;
  2678. } else {
  2679. backend_norm = GGML_BACKEND_CPU;
  2680. backend_output = GGML_BACKEND_CPU;
  2681. }
  2682. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2683. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2684. if (backend_norm == GGML_BACKEND_GPU) {
  2685. vram_weights += ggml_nbytes(model.output_norm);
  2686. }
  2687. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2688. vram_weights += ggml_nbytes(model.output);
  2689. }
  2690. }
  2691. const uint32_t n_ff = hparams.n_ff;
  2692. const int i_gpu_start = n_layer - n_gpu_layers;
  2693. model.layers.resize(n_layer);
  2694. for (uint32_t i = 0; i < n_layer; ++i) {
  2695. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2696. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2697. auto & layer = model.layers[i];
  2698. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2699. layer.wqkv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_QKV, "weight", i), {n_embd, n_embd + 2*n_embd_gqa}, backend_split);
  2700. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2701. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2702. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), { n_ff, n_embd}, backend_split);
  2703. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2704. if (backend == GGML_BACKEND_GPU) {
  2705. vram_weights +=
  2706. ggml_nbytes(layer.attn_norm) +
  2707. ggml_nbytes(layer.wqkv) +
  2708. ggml_nbytes(layer.wo) +
  2709. ggml_nbytes(layer.ffn_norm) +
  2710. ggml_nbytes(layer.ffn_down) +
  2711. ggml_nbytes(layer.ffn_up);
  2712. }
  2713. }
  2714. } break;
  2715. case LLM_ARCH_STABLELM:
  2716. {
  2717. model.tok_embd = ml.create_tensor(ctx, tn(LLM_TENSOR_TOKEN_EMBD, "weight"), {n_embd, n_vocab}, GGML_BACKEND_CPU);
  2718. // output
  2719. {
  2720. ggml_backend_type backend_norm;
  2721. ggml_backend_type backend_output;
  2722. if (n_gpu_layers > int(n_layer)) {
  2723. // norm is not performance relevant on its own but keeping it in VRAM reduces data copying
  2724. // on Windows however this is detrimental unless everything is on the GPU
  2725. #ifndef _WIN32
  2726. backend_norm = llama_backend_offload;
  2727. #else
  2728. backend_norm = n_gpu_layers <= (int) n_layer + 2 ? GGML_BACKEND_CPU : llama_backend_offload;
  2729. #endif // _WIN32
  2730. backend_output = llama_backend_offload_split;
  2731. } else {
  2732. backend_norm = GGML_BACKEND_CPU;
  2733. backend_output = GGML_BACKEND_CPU;
  2734. }
  2735. model.output_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "bias"), {n_embd}, backend_norm);
  2736. model.output_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT_NORM, "weight"), {n_embd}, backend_norm);
  2737. model.output = ml.create_tensor(ctx, tn(LLM_TENSOR_OUTPUT, "weight"), {n_embd, n_vocab}, backend_output);
  2738. if (backend_norm == GGML_BACKEND_GPU) {
  2739. vram_weights += ggml_nbytes(model.output_norm);
  2740. }
  2741. if (backend_output == GGML_BACKEND_GPU_SPLIT) {
  2742. vram_weights += ggml_nbytes(model.output);
  2743. }
  2744. }
  2745. const uint32_t n_ff = hparams.n_ff;
  2746. const int i_gpu_start = n_layer - n_gpu_layers;
  2747. model.layers.resize(n_layer);
  2748. for (uint32_t i = 0; i < n_layer; ++i) {
  2749. /*
  2750. llama_model_loader: - tensor 4: blk.0.attn_output.weight f16 [ 2560, 2560, 1, 1 ]
  2751. */
  2752. const ggml_backend_type backend = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload; // NOLINT
  2753. const ggml_backend_type backend_split = int(i) < i_gpu_start ? GGML_BACKEND_CPU : llama_backend_offload_split; // NOLINT
  2754. auto & layer = model.layers[i];
  2755. layer.attn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "weight", i), {n_embd}, backend);
  2756. layer.attn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_NORM, "bias", i), {n_embd}, backend);
  2757. layer.wq = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_Q, "weight", i), {n_embd, n_embd}, backend_split);
  2758. layer.wk = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_K, "weight", i), {n_embd, n_embd_gqa}, backend_split);
  2759. layer.wv = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_V, "weight", i), {n_embd, n_embd_gqa}, backend_split);
  2760. layer.wo = ml.create_tensor(ctx, tn(LLM_TENSOR_ATTN_OUT, "weight", i), {n_embd, n_embd}, backend_split);
  2761. layer.ffn_norm = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "weight", i), {n_embd}, backend);
  2762. layer.ffn_norm_b = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_NORM, "bias", i), {n_embd}, backend);
  2763. layer.ffn_gate = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_GATE, "weight", i), {n_embd, n_ff}, backend_split);
  2764. layer.ffn_down = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_DOWN, "weight", i), { n_ff, n_embd}, backend_split);
  2765. layer.ffn_up = ml.create_tensor(ctx, tn(LLM_TENSOR_FFN_UP, "weight", i), {n_embd, n_ff}, backend_split);
  2766. if (backend == GGML_BACKEND_GPU) {
  2767. vram_weights +=
  2768. ggml_nbytes(layer.attn_norm) + ggml_nbytes(layer.wq) + ggml_nbytes(layer.wk) +
  2769. ggml_nbytes(layer.wv) + ggml_nbytes(layer.wo) + ggml_nbytes(layer.ffn_norm) +
  2770. ggml_nbytes(layer.ffn_gate) + ggml_nbytes(layer.ffn_down) + ggml_nbytes(layer.ffn_up);
  2771. }
  2772. }
  2773. } break;
  2774. default:
  2775. throw std::runtime_error("unknown architecture");
  2776. }
  2777. }
  2778. ml.done_getting_tensors();
  2779. // print memory requirements
  2780. {
  2781. // this is the total memory required to run the inference
  2782. size_t mem_required =
  2783. ctx_size +
  2784. mmapped_size - vram_weights; // weights in VRAM not in memory
  2785. LLAMA_LOG_INFO("%s: mem required = %7.2f MiB\n", __func__, mem_required / 1024.0 / 1024.0);
  2786. #if defined(GGML_USE_CUBLAS) || defined(GGML_USE_CLBLAST)
  2787. const int n_gpu = std::min(n_gpu_layers, int(hparams.n_layer));
  2788. LLAMA_LOG_INFO("%s: offloading %d repeating layers to GPU\n", __func__, n_gpu);
  2789. if (n_gpu_layers > (int) hparams.n_layer) {
  2790. LLAMA_LOG_INFO("%s: offloading non-repeating layers to GPU\n", __func__);
  2791. }
  2792. #ifdef GGML_USE_CUBLAS
  2793. const int max_backend_supported_layers = hparams.n_layer + 3;
  2794. const int max_offloadable_layers = hparams.n_layer + 3;
  2795. #elif GGML_USE_CLBLAST
  2796. const int max_backend_supported_layers = hparams.n_layer + 1;
  2797. const int max_offloadable_layers = hparams.n_layer + 1;
  2798. #endif // GGML_USE_CUBLAS
  2799. LLAMA_LOG_INFO("%s: offloaded %d/%d layers to GPU\n", __func__, std::min(n_gpu_layers, max_offloadable_layers), max_backend_supported_layers);
  2800. LLAMA_LOG_INFO("%s: VRAM used: %.2f MiB\n", __func__, vram_weights / 1024.0 / 1024.0);
  2801. #else
  2802. (void) n_gpu_layers;
  2803. #endif // defined(GGML_USE_CUBLAS) || defined(GGML_USE_CLBLAST)
  2804. }
  2805. // populate `tensors_by_name`
  2806. for (int i = 0; i < ml.n_tensors; ++i) {
  2807. struct ggml_tensor * cur = ggml_get_tensor(ctx, ml.get_tensor_name(i));
  2808. model.tensors_by_name.emplace_back(ggml_get_name(cur), cur);
  2809. }
  2810. (void) tensor_split;
  2811. #ifdef GGML_USE_CUBLAS
  2812. {
  2813. ggml_cuda_set_tensor_split(tensor_split);
  2814. }
  2815. #endif
  2816. ml.load_all_data(ctx, progress_callback, progress_callback_user_data, use_mlock ? &model.mlock_mmap : NULL);
  2817. if (progress_callback) {
  2818. progress_callback(1.0f, progress_callback_user_data);
  2819. }
  2820. model.mapping = std::move(ml.mapping);
  2821. // loading time will be recalculate after the first eval, so
  2822. // we take page faults deferred by mmap() into consideration
  2823. model.t_load_us = ggml_time_us() - model.t_start_us;
  2824. }
  2825. static bool llama_model_load(const std::string & fname, llama_model & model, const llama_model_params & params) {
  2826. try {
  2827. llama_model_loader ml(fname, params.use_mmap);
  2828. model.hparams.vocab_only = params.vocab_only;
  2829. llm_load_arch (ml, model);
  2830. llm_load_hparams(ml, model);
  2831. llm_load_vocab (ml, model);
  2832. llm_load_print_meta(ml, model);
  2833. if (model.hparams.n_vocab != model.vocab.id_to_token.size()) {
  2834. throw std::runtime_error("vocab size mismatch");
  2835. }
  2836. if (params.vocab_only) {
  2837. LLAMA_LOG_INFO("%s: vocab only - skipping tensors\n", __func__);
  2838. return true;
  2839. }
  2840. llm_load_tensors(
  2841. ml, model, params.n_gpu_layers, params.main_gpu, params.tensor_split, params.use_mlock,
  2842. params.progress_callback, params.progress_callback_user_data
  2843. );
  2844. } catch (const std::exception & err) {
  2845. LLAMA_LOG_ERROR("error loading model: %s\n", err.what());
  2846. return false;
  2847. }
  2848. return true;
  2849. }
  2850. //
  2851. // llm_build
  2852. //
  2853. using llm_build_cb = std::function<void(struct ggml_tensor * cur, const char * name, int nl)>;
  2854. enum llm_rope_type {
  2855. LLM_ROPE,
  2856. LLM_ROPE_NEOX,
  2857. LLM_ROPE_GLM,
  2858. };
  2859. enum llm_ffn_op_type {
  2860. LLM_FFN_SILU,
  2861. LLM_FFN_GELU,
  2862. LLM_FFN_RELU,
  2863. LLM_FFN_RELU_SQR,
  2864. };
  2865. enum llm_ffn_gate_type {
  2866. LLM_FFN_SEQ,
  2867. LLM_FFN_PAR, // ffn_gate is parallel to ffn_up
  2868. };
  2869. enum llm_norm_type {
  2870. LLM_NORM,
  2871. LLM_NORM_RMS,
  2872. };
  2873. static struct ggml_tensor * llm_build_inp_embd(
  2874. struct ggml_context * ctx,
  2875. const llama_hparams & hparams,
  2876. const llama_batch & batch,
  2877. struct ggml_tensor * tok_embd,
  2878. const llm_build_cb & cb) {
  2879. const int64_t n_embd = hparams.n_embd;
  2880. struct ggml_tensor * inpL;
  2881. if (batch.token) {
  2882. struct ggml_tensor * inp_tokens = ggml_new_tensor_1d(ctx, GGML_TYPE_I32, batch.n_tokens);
  2883. cb(inp_tokens, "inp_tokens", -1);
  2884. inpL = ggml_get_rows(ctx, tok_embd, inp_tokens);
  2885. } else {
  2886. #ifdef GGML_USE_MPI
  2887. GGML_ASSERT(false && "not implemented");
  2888. #endif
  2889. inpL = ggml_new_tensor_2d(ctx, GGML_TYPE_F32, n_embd, batch.n_tokens);
  2890. }
  2891. return inpL;
  2892. }
  2893. // Persimmon: n_rot = n_embd_head/2
  2894. // Other: n_rot = n_embd_head
  2895. static void llm_build_k_shift(
  2896. struct ggml_context * ctx,
  2897. const llama_hparams & hparams,
  2898. const llama_cparams & cparams,
  2899. const llama_kv_cache & kv,
  2900. struct ggml_cgraph * graph,
  2901. llm_rope_type type,
  2902. int64_t n_ctx,
  2903. int n_rot,
  2904. float freq_base,
  2905. float freq_scale,
  2906. const llm_build_cb & cb) {
  2907. const int64_t n_layer = hparams.n_layer;
  2908. const int64_t n_head_kv = hparams.n_head_kv;
  2909. const int64_t n_embd_gqa = hparams.n_embd_gqa();
  2910. const int64_t n_embd_head = hparams.n_embd_head();
  2911. const int32_t n_orig_ctx = cparams.n_yarn_orig_ctx;
  2912. const float ext_factor = cparams.yarn_ext_factor;
  2913. const float attn_factor = cparams.yarn_attn_factor;
  2914. const float beta_fast = cparams.yarn_beta_fast;
  2915. const float beta_slow = cparams.yarn_beta_slow;
  2916. GGML_ASSERT(n_embd_head % n_rot == 0);
  2917. struct ggml_tensor * K_shift = ggml_new_tensor_1d(ctx, GGML_TYPE_I32, n_ctx);
  2918. cb(K_shift, "K_shift", -1);
  2919. int rope_type = 0;
  2920. switch (type) {
  2921. case LLM_ROPE: rope_type = 0; break;
  2922. case LLM_ROPE_NEOX: rope_type = 2; break;
  2923. case LLM_ROPE_GLM: rope_type = 4; break;
  2924. }
  2925. for (int il = 0; il < n_layer; ++il) {
  2926. struct ggml_tensor * tmp =
  2927. // we rotate only the first n_rot dimensions
  2928. ggml_rope_custom_inplace(ctx,
  2929. ggml_view_3d(ctx, kv.k,
  2930. n_embd_head, n_head_kv, n_ctx,
  2931. ggml_element_size(kv.k)*n_embd_head,
  2932. ggml_element_size(kv.k)*n_embd_gqa,
  2933. ggml_element_size(kv.k)*n_embd_gqa*n_ctx*il),
  2934. K_shift, n_rot, rope_type, 0, n_orig_ctx, freq_base, freq_scale,
  2935. ext_factor, attn_factor, beta_fast, beta_slow);
  2936. cb(tmp, "K_shifted", il);
  2937. ggml_build_forward_expand(graph, tmp);
  2938. }
  2939. }
  2940. static void llm_build_kv_store(
  2941. struct ggml_context * ctx,
  2942. const llama_hparams & hparams,
  2943. const llama_kv_cache & kv,
  2944. struct ggml_cgraph * graph,
  2945. struct ggml_tensor * k_cur,
  2946. struct ggml_tensor * v_cur,
  2947. int64_t n_ctx,
  2948. int32_t n_tokens,
  2949. int32_t kv_head,
  2950. const llm_build_cb & cb,
  2951. int64_t il) {
  2952. const int64_t n_embd_gqa = hparams.n_embd_gqa();
  2953. // compute the transposed [n_tokens, n_embd] V matrix
  2954. struct ggml_tensor * v_cur_t = ggml_transpose(ctx, ggml_reshape_2d(ctx, v_cur, n_embd_gqa, n_tokens));
  2955. //struct ggml_tensor * v_cur_t = ggml_transpose(ctx, v_cur); // TODO: reshape above is likely not needed
  2956. cb(v_cur_t, "v_cur_t", il);
  2957. struct ggml_tensor * k_cache_view = ggml_view_1d(ctx, kv.k, n_tokens*n_embd_gqa,
  2958. (ggml_element_size(kv.k)*n_embd_gqa)*(il*n_ctx + kv_head));
  2959. cb(k_cache_view, "k_cache_view", il);
  2960. struct ggml_tensor * v_cache_view = ggml_view_2d(ctx, kv.v, n_tokens, n_embd_gqa,
  2961. ( n_ctx)*ggml_element_size(kv.v),
  2962. (il*n_ctx)*ggml_element_size(kv.v)*n_embd_gqa + kv_head*ggml_element_size(kv.v));
  2963. cb(v_cache_view, "v_cache_view", il);
  2964. // important: storing RoPE-ed version of K in the KV cache!
  2965. ggml_build_forward_expand(graph, ggml_cpy(ctx, k_cur, k_cache_view));
  2966. ggml_build_forward_expand(graph, ggml_cpy(ctx, v_cur_t, v_cache_view));
  2967. }
  2968. static struct ggml_tensor * llm_build_norm(
  2969. struct ggml_context * ctx,
  2970. struct ggml_tensor * cur,
  2971. const llama_hparams & hparams,
  2972. struct ggml_tensor * mw,
  2973. struct ggml_tensor * mb,
  2974. llm_norm_type type,
  2975. const llm_build_cb & cb,
  2976. int il) {
  2977. switch (type) {
  2978. case LLM_NORM: cur = ggml_norm (ctx, cur, hparams.f_norm_eps); break;
  2979. case LLM_NORM_RMS: cur = ggml_rms_norm(ctx, cur, hparams.f_norm_rms_eps); break;
  2980. }
  2981. if (mw || mb) {
  2982. cb(cur, "norm", il);
  2983. }
  2984. if (mw) {
  2985. cur = ggml_mul(ctx, cur, mw);
  2986. if (mb) {
  2987. cb(cur, "norm_w", il);
  2988. }
  2989. }
  2990. if (mb) {
  2991. cur = ggml_add(ctx, cur, mb);
  2992. }
  2993. return cur;
  2994. }
  2995. static struct ggml_tensor * llm_build_ffn(
  2996. struct ggml_context * ctx,
  2997. struct ggml_tensor * cur,
  2998. struct ggml_tensor * up,
  2999. struct ggml_tensor * up_b,
  3000. struct ggml_tensor * gate,
  3001. struct ggml_tensor * gate_b,
  3002. struct ggml_tensor * down,
  3003. struct ggml_tensor * down_b,
  3004. llm_ffn_op_type type_op,
  3005. llm_ffn_gate_type type_gate,
  3006. const llm_build_cb & cb,
  3007. int il) {
  3008. struct ggml_tensor * tmp = ggml_mul_mat(ctx, up, cur);
  3009. cb(tmp, "ffn_up", il);
  3010. if (up_b) {
  3011. tmp = ggml_add(ctx, tmp, up_b);
  3012. cb(tmp, "ffn_up_b", il);
  3013. }
  3014. if (gate) {
  3015. switch (type_gate) {
  3016. case LLM_FFN_SEQ:
  3017. {
  3018. cur = ggml_mul_mat(ctx, gate, tmp);
  3019. cb(cur, "ffn_gate", il);
  3020. } break;
  3021. case LLM_FFN_PAR:
  3022. {
  3023. cur = ggml_mul_mat(ctx, gate, cur);
  3024. cb(cur, "ffn_gate", il);
  3025. } break;
  3026. }
  3027. if (gate_b) {
  3028. cur = ggml_add(ctx, cur, gate_b);
  3029. cb(cur, "ffn_gate_b", il);
  3030. }
  3031. } else {
  3032. cur = tmp;
  3033. }
  3034. switch (type_op) {
  3035. case LLM_FFN_SILU:
  3036. {
  3037. cur = ggml_silu(ctx, cur);
  3038. cb(cur, "ffn_silu", il);
  3039. } break;
  3040. case LLM_FFN_GELU:
  3041. {
  3042. cur = ggml_gelu(ctx, cur);
  3043. cb(cur, "ffn_gelu", il);
  3044. } break;
  3045. case LLM_FFN_RELU:
  3046. {
  3047. cur = ggml_relu(ctx, cur);
  3048. cb(cur, "ffn_relu", il);
  3049. } break;
  3050. case LLM_FFN_RELU_SQR:
  3051. {
  3052. cur = ggml_relu(ctx, cur);
  3053. cb(cur, "ffn_relu", il);
  3054. cur = ggml_sqr(ctx, cur);
  3055. cb(cur, "ffn_sqr(relu)", il);
  3056. } break;
  3057. }
  3058. if (type_gate == LLM_FFN_PAR) {
  3059. cur = ggml_mul(ctx, cur, tmp);
  3060. cb(cur, "ffn_gate_par", il);
  3061. }
  3062. cur = ggml_mul_mat(ctx, down, cur);
  3063. if (down_b) {
  3064. cb(cur, "ffn_down", il);
  3065. }
  3066. if (down_b) {
  3067. cur = ggml_add(ctx, cur, down_b);
  3068. }
  3069. return cur;
  3070. }
  3071. // if max_alibi_bias > 0 then apply ALiBi
  3072. static struct ggml_tensor * llm_build_kqv(
  3073. struct ggml_context * ctx,
  3074. const llama_hparams & hparams,
  3075. const llama_kv_cache & kv,
  3076. struct ggml_tensor * wo,
  3077. struct ggml_tensor * wo_b,
  3078. struct ggml_tensor * q_cur,
  3079. struct ggml_tensor * kq_scale,
  3080. struct ggml_tensor * kq_mask,
  3081. int64_t n_ctx,
  3082. int32_t n_tokens,
  3083. int32_t n_kv,
  3084. float max_alibi_bias,
  3085. const llm_build_cb & cb,
  3086. int il) {
  3087. const int64_t n_embd = hparams.n_embd;
  3088. const int64_t n_head = hparams.n_head;
  3089. const int64_t n_head_kv = hparams.n_head_kv;
  3090. const int64_t n_embd_head = hparams.n_embd_head();
  3091. const int64_t n_embd_gqa = hparams.n_embd_gqa();
  3092. struct ggml_tensor * q = ggml_permute(ctx, q_cur, 0, 2, 1, 3);
  3093. cb(q, "q", il);
  3094. struct ggml_tensor * k =
  3095. ggml_view_3d(ctx, kv.k,
  3096. n_embd_head, n_kv, n_head_kv,
  3097. ggml_element_size(kv.k)*n_embd_gqa,
  3098. ggml_element_size(kv.k)*n_embd_head,
  3099. ggml_element_size(kv.k)*n_embd_gqa*n_ctx*il);
  3100. cb(k, "k", il);
  3101. struct ggml_tensor * kq = ggml_mul_mat(ctx, k, q);
  3102. cb(kq, "kq", il);
  3103. kq = ggml_scale(ctx, kq, kq_scale);
  3104. cb(kq, "kq_scaled", il);
  3105. if (max_alibi_bias > 0.0f) {
  3106. // TODO: n_head or n_head_kv
  3107. // TODO: K-shift is likely not working
  3108. // TODO: change to ggml_add
  3109. kq = ggml_alibi(ctx, kq, /*n_past*/ 0, n_head, max_alibi_bias);
  3110. cb(kq, "kq_scaled_alibi", il);
  3111. }
  3112. kq = ggml_add(ctx, kq, kq_mask);
  3113. cb(kq, "kq_masked", il);
  3114. kq = ggml_soft_max(ctx, kq);
  3115. cb(kq, "kq_soft_max", il);
  3116. // split cached v into n_head heads
  3117. struct ggml_tensor * v =
  3118. ggml_view_3d(ctx, kv.v,
  3119. n_kv, n_embd_head, n_head_kv,
  3120. ggml_element_size(kv.v)*n_ctx,
  3121. ggml_element_size(kv.v)*n_ctx*n_embd_head,
  3122. ggml_element_size(kv.v)*n_ctx*n_embd_gqa*il);
  3123. cb(v, "v", il);
  3124. struct ggml_tensor * kqv = ggml_mul_mat(ctx, v, kq);
  3125. cb(kqv, "kqv", il);
  3126. struct ggml_tensor * kqv_merged = ggml_permute(ctx, kqv, 0, 2, 1, 3);
  3127. cb(kqv_merged, "kqv_merged", il);
  3128. struct ggml_tensor * cur = ggml_cont_2d(ctx, kqv_merged, n_embd, n_tokens);
  3129. cb(cur, "kqv_merged_cont", il);
  3130. cur = ggml_mul_mat(ctx, wo, cur);
  3131. if (wo_b) {
  3132. cb(cur, "kqv_wo", il);
  3133. }
  3134. if (wo_b) {
  3135. cur = ggml_add(ctx, cur, wo_b);
  3136. }
  3137. return cur;
  3138. }
  3139. struct llm_build_context {
  3140. const llama_model & model;
  3141. const llama_hparams & hparams;
  3142. const llama_cparams & cparams;
  3143. const llama_batch & batch;
  3144. const llama_kv_cache & kv_self;
  3145. const int64_t n_embd;
  3146. const int64_t n_layer;
  3147. const int64_t n_ctx; // user-specified context size (can be different from n_ctx_train)
  3148. const int64_t n_head;
  3149. const int64_t n_head_kv;
  3150. const int64_t n_embd_head;
  3151. const int64_t n_embd_gqa;
  3152. const float freq_base;
  3153. const float freq_scale;
  3154. const float ext_factor;
  3155. const float attn_factor;
  3156. const float beta_fast;
  3157. const float beta_slow;
  3158. const float norm_eps;
  3159. const float norm_rms_eps;
  3160. const int32_t n_tokens;
  3161. const int32_t n_kv; // size of KV cache to consider (n_kv <= n_ctx)
  3162. const int32_t kv_head; // index of where we store new KV data in the cache
  3163. const int32_t n_orig_ctx;
  3164. const bool do_rope_shift;
  3165. const llm_build_cb & cb;
  3166. llama_buffer & buf_compute;
  3167. struct ggml_context * ctx0 = nullptr;
  3168. // TODO: consider making the entire interface noexcept
  3169. llm_build_context(
  3170. llama_context & lctx,
  3171. const llama_batch & batch,
  3172. const llm_build_cb & cb,
  3173. bool worst_case) :
  3174. model (lctx.model),
  3175. hparams (model.hparams),
  3176. cparams (lctx.cparams),
  3177. batch (batch),
  3178. kv_self (lctx.kv_self),
  3179. n_embd (hparams.n_embd),
  3180. n_layer (hparams.n_layer),
  3181. n_ctx (cparams.n_ctx),
  3182. n_head (hparams.n_head),
  3183. n_head_kv (hparams.n_head_kv),
  3184. n_embd_head (hparams.n_embd_head()),
  3185. n_embd_gqa (hparams.n_embd_gqa()),
  3186. freq_base (cparams.rope_freq_base),
  3187. freq_scale (cparams.rope_freq_scale),
  3188. ext_factor (cparams.yarn_ext_factor),
  3189. attn_factor (cparams.yarn_attn_factor),
  3190. beta_fast (cparams.yarn_beta_fast),
  3191. beta_slow (cparams.yarn_beta_slow),
  3192. norm_eps (hparams.f_norm_eps),
  3193. norm_rms_eps (hparams.f_norm_rms_eps),
  3194. n_tokens (batch.n_tokens),
  3195. n_kv (worst_case ? n_ctx : kv_self.n),
  3196. kv_head (worst_case ? n_ctx - n_tokens : kv_self.head),
  3197. n_orig_ctx (cparams.n_yarn_orig_ctx),
  3198. do_rope_shift (worst_case || kv_self.has_shift),
  3199. cb (cb),
  3200. buf_compute (lctx.buf_compute) {
  3201. GGML_ASSERT(!!kv_self.ctx);
  3202. // all initializations should be done in init()
  3203. }
  3204. void init() {
  3205. struct ggml_init_params params = {
  3206. /*.mem_size =*/ buf_compute.size,
  3207. /*.mem_buffer =*/ buf_compute.data,
  3208. /*.no_alloc =*/ true,
  3209. };
  3210. ctx0 = ggml_init(params);
  3211. }
  3212. void free() {
  3213. if (ctx0) {
  3214. ggml_free(ctx0);
  3215. ctx0 = nullptr;
  3216. }
  3217. }
  3218. struct ggml_cgraph * build_llama() {
  3219. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3220. GGML_ASSERT(n_embd_head == hparams.n_rot);
  3221. struct ggml_tensor * cur;
  3222. struct ggml_tensor * inpL;
  3223. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3224. cb(inpL, "inp_embd", -1);
  3225. // inp_pos - contains the positions
  3226. struct ggml_tensor * inp_pos = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_tokens);
  3227. cb(inp_pos, "inp_pos", -1);
  3228. // KQ_scale
  3229. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3230. cb(KQ_scale, "KQ_scale", -1);
  3231. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3232. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3233. cb(KQ_mask, "KQ_mask", -1);
  3234. // shift the entire K-cache if needed
  3235. if (do_rope_shift) {
  3236. llm_build_k_shift(ctx0, hparams, cparams, kv_self, gf, LLM_ROPE, n_ctx, n_embd_head, freq_base, freq_scale, cb);
  3237. }
  3238. for (int il = 0; il < n_layer; ++il) {
  3239. struct ggml_tensor * inpSA = inpL;
  3240. // norm
  3241. cur = llm_build_norm(ctx0, inpL, hparams,
  3242. model.layers[il].attn_norm, NULL,
  3243. LLM_NORM_RMS, cb, il);
  3244. cb(cur, "attn_norm", il);
  3245. // self-attention
  3246. {
  3247. // compute Q and K and RoPE them
  3248. struct ggml_tensor * Qcur = ggml_mul_mat(ctx0, model.layers[il].wq, cur);
  3249. cb(Qcur, "Qcur", il);
  3250. struct ggml_tensor * Kcur = ggml_mul_mat(ctx0, model.layers[il].wk, cur);
  3251. cb(Kcur, "Kcur", il);
  3252. struct ggml_tensor * Vcur = ggml_mul_mat(ctx0, model.layers[il].wv, cur);
  3253. cb(Vcur, "Vcur", il);
  3254. Qcur = ggml_rope_custom(
  3255. ctx0, ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens), inp_pos,
  3256. n_embd_head, 0, 0, n_orig_ctx, freq_base, freq_scale,
  3257. ext_factor, attn_factor, beta_fast, beta_slow
  3258. );
  3259. cb(Qcur, "Qcur", il);
  3260. Kcur = ggml_rope_custom(
  3261. ctx0, ggml_reshape_3d(ctx0, Kcur, n_embd_head, n_head_kv, n_tokens), inp_pos,
  3262. n_embd_head, 0, 0, n_orig_ctx, freq_base, freq_scale,
  3263. ext_factor, attn_factor, beta_fast, beta_slow
  3264. );
  3265. cb(Kcur, "Kcur", il);
  3266. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3267. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3268. model.layers[il].wo, NULL,
  3269. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, -1.0f, cb, il);
  3270. cb(cur, "kqv_out", il);
  3271. }
  3272. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpSA);
  3273. cb(ffn_inp, "ffn_inp", il);
  3274. // feed-forward network
  3275. {
  3276. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3277. model.layers[il].ffn_norm, NULL,
  3278. LLM_NORM_RMS, cb, il);
  3279. cb(cur, "ffn_norm", il);
  3280. cur = llm_build_ffn(ctx0, cur,
  3281. model.layers[il].ffn_up, NULL,
  3282. model.layers[il].ffn_gate, NULL,
  3283. model.layers[il].ffn_down, NULL,
  3284. LLM_FFN_SILU, LLM_FFN_PAR, cb, il);
  3285. cb(cur, "ffn_out", il);
  3286. }
  3287. cur = ggml_add(ctx0, cur, ffn_inp);
  3288. cb(cur, "l_out", il);
  3289. // input for next layer
  3290. inpL = cur;
  3291. }
  3292. cur = inpL;
  3293. cur = llm_build_norm(ctx0, cur, hparams,
  3294. model.output_norm, NULL,
  3295. LLM_NORM_RMS, cb, -1);
  3296. cb(cur, "result_norm", -1);
  3297. // lm_head
  3298. cur = ggml_mul_mat(ctx0, model.output, cur);
  3299. cb(cur, "result_output", -1);
  3300. ggml_build_forward_expand(gf, cur);
  3301. return gf;
  3302. }
  3303. struct ggml_cgraph * build_baichuan() {
  3304. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3305. struct ggml_tensor * cur;
  3306. struct ggml_tensor * inpL;
  3307. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3308. cb(inpL, "inp_embd", -1);
  3309. // inp_pos - contains the positions
  3310. struct ggml_tensor * inp_pos = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_tokens);
  3311. cb(inp_pos, "inp_pos", -1);
  3312. // KQ_scale
  3313. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3314. cb(KQ_scale, "KQ_scale", -1);
  3315. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3316. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3317. cb(KQ_mask, "KQ_mask", -1);
  3318. // shift the entire K-cache if needed
  3319. if (do_rope_shift) {
  3320. llm_build_k_shift(ctx0, hparams, cparams, kv_self, gf, LLM_ROPE, n_ctx, n_embd_head, freq_base, freq_scale, cb);
  3321. }
  3322. for (int il = 0; il < n_layer; ++il) {
  3323. struct ggml_tensor * inpSA = inpL;
  3324. cur = llm_build_norm(ctx0, inpL, hparams,
  3325. model.layers[il].attn_norm, NULL,
  3326. LLM_NORM_RMS, cb, il);
  3327. cb(cur, "attn_norm", il);
  3328. // self-attention
  3329. {
  3330. struct ggml_tensor * Qcur = ggml_mul_mat(ctx0, model.layers[il].wq, cur);
  3331. cb(Qcur, "Qcur", il);
  3332. struct ggml_tensor * Kcur = ggml_mul_mat(ctx0, model.layers[il].wk, cur);
  3333. cb(Kcur, "Kcur", il);
  3334. struct ggml_tensor * Vcur = ggml_mul_mat(ctx0, model.layers[il].wv, cur);
  3335. cb(Vcur, "Vcur", il);
  3336. switch (model.type) {
  3337. case MODEL_7B:
  3338. Qcur = ggml_rope_custom(
  3339. ctx0, ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens), inp_pos,
  3340. n_embd_head, 0, 0, n_orig_ctx, freq_base, freq_scale,
  3341. ext_factor, attn_factor, beta_fast, beta_slow
  3342. );
  3343. Kcur = ggml_rope_custom(
  3344. ctx0, ggml_reshape_3d(ctx0, Kcur, n_embd_head, n_head_kv, n_tokens), inp_pos,
  3345. n_embd_head, 0, 0, n_orig_ctx, freq_base, freq_scale,
  3346. ext_factor, attn_factor, beta_fast, beta_slow
  3347. );
  3348. break;
  3349. case MODEL_13B:
  3350. Qcur = ggml_reshape_3d(ctx0, Qcur, n_embd/n_head, n_head, n_tokens);
  3351. Kcur = ggml_reshape_3d(ctx0, Kcur, n_embd/n_head, n_head, n_tokens);
  3352. break;
  3353. default:
  3354. GGML_ASSERT(false);
  3355. }
  3356. cb(Qcur, "Qcur", il);
  3357. cb(Kcur, "Kcur", il);
  3358. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3359. // apply ALiBi for 13B model
  3360. const float max_alibi_bias = model.type == MODEL_13B ? 8.0f : -1.0f;
  3361. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3362. model.layers[il].wo, NULL,
  3363. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, max_alibi_bias, cb, il);
  3364. cb(cur, "kqv_out", il);
  3365. }
  3366. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpSA);
  3367. cb(ffn_inp, "ffn_inp", il);
  3368. // feed-forward network
  3369. {
  3370. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3371. model.layers[il].ffn_norm, NULL,
  3372. LLM_NORM_RMS, cb, il);
  3373. cb(cur, "ffn_norm", il);
  3374. cur = llm_build_ffn(ctx0, cur,
  3375. model.layers[il].ffn_up, NULL,
  3376. model.layers[il].ffn_gate, NULL,
  3377. model.layers[il].ffn_down, NULL,
  3378. LLM_FFN_SILU, LLM_FFN_PAR, cb, il);
  3379. cb(cur, "ffn_out", il);
  3380. }
  3381. cur = ggml_add(ctx0, cur, ffn_inp);
  3382. cb(cur, "l_out", il);
  3383. // input for next layer
  3384. inpL = cur;
  3385. }
  3386. cur = inpL;
  3387. cur = llm_build_norm(ctx0, cur, hparams,
  3388. model.output_norm, NULL,
  3389. LLM_NORM_RMS, cb, -1);
  3390. cb(cur, "result_norm", -1);
  3391. // lm_head
  3392. cur = ggml_mul_mat(ctx0, model.output, cur);
  3393. cb(cur, "result_output", -1);
  3394. ggml_build_forward_expand(gf, cur);
  3395. return gf;
  3396. }
  3397. struct ggml_cgraph * build_falcon() {
  3398. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3399. struct ggml_tensor * cur;
  3400. struct ggml_tensor * inpL;
  3401. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3402. cb(inpL, "inp_embd", -1);
  3403. // inp_pos - contains the positions
  3404. struct ggml_tensor * inp_pos = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_tokens);
  3405. cb(inp_pos, "inp_pos", -1);
  3406. // KQ_scale
  3407. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3408. cb(KQ_scale, "KQ_scale", -1);
  3409. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3410. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3411. cb(KQ_mask, "KQ_mask", -1);
  3412. // shift the entire K-cache if needed
  3413. if (do_rope_shift) {
  3414. llm_build_k_shift(ctx0, hparams, cparams, kv_self, gf, LLM_ROPE_NEOX, n_ctx, n_embd_head, freq_base, freq_scale, cb);
  3415. }
  3416. for (int il = 0; il < n_layer; ++il) {
  3417. struct ggml_tensor * attn_norm;
  3418. attn_norm = llm_build_norm(ctx0, inpL, hparams,
  3419. model.layers[il].attn_norm,
  3420. model.layers[il].attn_norm_b,
  3421. LLM_NORM, cb, il);
  3422. cb(attn_norm, "attn_norm", il);
  3423. // self-attention
  3424. {
  3425. if (model.layers[il].attn_norm_2) {
  3426. // Falcon-40B
  3427. cur = llm_build_norm(ctx0, inpL, hparams,
  3428. model.layers[il].attn_norm_2,
  3429. model.layers[il].attn_norm_2_b,
  3430. LLM_NORM, cb, il);
  3431. cb(cur, "attn_norm_2", il);
  3432. } else {
  3433. cur = attn_norm;
  3434. }
  3435. cur = ggml_mul_mat(ctx0, model.layers[il].wqkv, cur);
  3436. cb(cur, "wqkv", il);
  3437. struct ggml_tensor * Qcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd, n_tokens, cur->nb[1], 0*sizeof(float)*(n_embd)));
  3438. struct ggml_tensor * Kcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd)));
  3439. struct ggml_tensor * Vcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd + n_embd_gqa)));
  3440. cb(Qcur, "Qcur", il);
  3441. cb(Kcur, "Kcur", il);
  3442. cb(Vcur, "Vcur", il);
  3443. Qcur = ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens);
  3444. Kcur = ggml_reshape_3d(ctx0, Kcur, n_embd_head, n_head_kv, n_tokens);
  3445. // using mode = 2 for neox mode
  3446. Qcur = ggml_rope_custom(
  3447. ctx0, Qcur, inp_pos, n_embd_head, 2, 0, n_orig_ctx,
  3448. freq_base, freq_scale, ext_factor, attn_factor, beta_fast, beta_slow
  3449. );
  3450. cb(Qcur, "Qcur", il);
  3451. Kcur = ggml_rope_custom(
  3452. ctx0, Kcur, inp_pos, n_embd_head, 2, 0, n_orig_ctx,
  3453. freq_base, freq_scale, ext_factor, attn_factor, beta_fast, beta_slow
  3454. );
  3455. cb(Kcur, "Kcur", il);
  3456. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3457. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3458. model.layers[il].wo, NULL,
  3459. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, -1.0f, cb, il);
  3460. cb(cur, "kqv_out", il);
  3461. }
  3462. struct ggml_tensor * ffn_inp = cur;
  3463. // feed forward
  3464. {
  3465. cur = llm_build_ffn(ctx0, attn_norm, // !! use the attn norm, not the result
  3466. model.layers[il].ffn_up, NULL,
  3467. NULL, NULL,
  3468. model.layers[il].ffn_down, NULL,
  3469. LLM_FFN_GELU, LLM_FFN_SEQ, cb, il);
  3470. cb(cur, "ffn_out", il);
  3471. }
  3472. cur = ggml_add(ctx0, cur, ffn_inp);
  3473. cb(cur, "l_out", il);
  3474. cur = ggml_add(ctx0, cur, inpL);
  3475. cb(cur, "l_out", il);
  3476. // input for next layer
  3477. inpL = cur;
  3478. }
  3479. cur = inpL;
  3480. // norm
  3481. cur = llm_build_norm(ctx0, cur, hparams,
  3482. model.output_norm,
  3483. model.output_norm_b,
  3484. LLM_NORM, cb, -1);
  3485. cb(cur, "result_norm", -1);
  3486. cur = ggml_mul_mat(ctx0, model.output, cur);
  3487. cb(cur, "result_output", -1);
  3488. ggml_build_forward_expand(gf, cur);
  3489. return gf;
  3490. }
  3491. struct ggml_cgraph * build_starcoder() {
  3492. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3493. struct ggml_tensor * cur;
  3494. struct ggml_tensor * pos;
  3495. struct ggml_tensor * inpL;
  3496. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3497. cb(inpL, "inp_embd", -1);
  3498. // inp_pos - contains the positions
  3499. struct ggml_tensor * inp_pos = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_tokens);
  3500. cb(inp_pos, "inp_pos", -1);
  3501. // KQ_scale
  3502. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3503. cb(KQ_scale, "KQ_scale", -1);
  3504. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3505. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3506. cb(KQ_mask, "KQ_mask", -1);
  3507. pos = ggml_get_rows(ctx0, model.pos_embd, inp_pos);
  3508. cb(pos, "pos_embd", -1);
  3509. inpL = ggml_add(ctx0, inpL, pos);
  3510. cb(inpL, "inpL", -1);
  3511. for (int il = 0; il < n_layer; ++il) {
  3512. cur = llm_build_norm(ctx0, inpL, hparams,
  3513. model.layers[il].attn_norm,
  3514. model.layers[il].attn_norm_b,
  3515. LLM_NORM, cb, il);
  3516. cb(cur, "attn_norm", il);
  3517. // self-attention
  3518. {
  3519. cur = ggml_mul_mat(ctx0, model.layers[il].wqkv, cur);
  3520. cb(cur, "wqkv", il);
  3521. cur = ggml_add(ctx0, cur, model.layers[il].bqkv);
  3522. cb(cur, "bqkv", il);
  3523. struct ggml_tensor * Qcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd, n_tokens, cur->nb[1], 0*sizeof(float)*(n_embd)));
  3524. struct ggml_tensor * Kcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd)));
  3525. struct ggml_tensor * Vcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd + n_embd_gqa)));
  3526. cb(Qcur, "Qcur", il);
  3527. cb(Kcur, "Kcur", il);
  3528. cb(Vcur, "Vcur", il);
  3529. Qcur = ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens);
  3530. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3531. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3532. model.layers[il].wo, model.layers[il].bo,
  3533. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, -1.0f, cb, il);
  3534. cb(cur, "kqv_out", il);
  3535. }
  3536. // add the input
  3537. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpL);
  3538. cb(ffn_inp, "ffn_inp", il);
  3539. // FF
  3540. {
  3541. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3542. model.layers[il].ffn_norm,
  3543. model.layers[il].ffn_norm_b,
  3544. LLM_NORM, cb, il);
  3545. cb(cur, "ffn_norm", il);
  3546. cur = llm_build_ffn(ctx0, cur,
  3547. model.layers[il].ffn_up, model.layers[il].ffn_up_b,
  3548. NULL, NULL,
  3549. model.layers[il].ffn_down, model.layers[il].ffn_down_b,
  3550. LLM_FFN_GELU, LLM_FFN_SEQ, cb, il);
  3551. cb(cur, "ffn_out", il);
  3552. }
  3553. inpL = ggml_add(ctx0, cur, ffn_inp);
  3554. cb(inpL, "l_out", il);
  3555. }
  3556. cur = llm_build_norm(ctx0, inpL, hparams,
  3557. model.output_norm,
  3558. model.output_norm_b,
  3559. LLM_NORM, cb, -1);
  3560. cb(cur, "result_norm", -1);
  3561. cur = ggml_mul_mat(ctx0, model.output, cur);
  3562. cb(cur, "result_output", -1);
  3563. ggml_build_forward_expand(gf, cur);
  3564. return gf;
  3565. }
  3566. struct ggml_cgraph * build_persimmon() {
  3567. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3568. const int64_t n_rot = n_embd_head / 2;
  3569. struct ggml_tensor * cur;
  3570. struct ggml_tensor * inpL;
  3571. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3572. cb(inpL, "imp_embd", -1);
  3573. struct ggml_tensor * inp_pos = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_tokens);
  3574. cb(inp_pos, "inp_pos", -1);
  3575. // KQ_scale
  3576. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3577. cb(KQ_scale, "KQ_scale", -1);
  3578. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3579. cb(KQ_mask, "KQ_mask", -1);
  3580. if (do_rope_shift) {
  3581. llm_build_k_shift(ctx0, hparams, cparams, kv_self, gf, LLM_ROPE_NEOX, n_ctx, n_embd_head, freq_base, freq_scale, cb);
  3582. }
  3583. for (int il = 0; il < n_layer; ++il) {
  3584. struct ggml_tensor * residual = inpL;
  3585. cur = llm_build_norm(ctx0, inpL, hparams,
  3586. model.layers[il].attn_norm,
  3587. model.layers[il].attn_norm_b,
  3588. LLM_NORM, cb, il);
  3589. cb(cur, "attn_norm", il);
  3590. // self attention
  3591. {
  3592. cur = ggml_mul_mat(ctx0, model.layers[il].wqkv, cur);
  3593. cb(cur, "wqkv", il);
  3594. cur = ggml_add(ctx0, cur, model.layers[il].bqkv);
  3595. cb(cur, "bqkv", il);
  3596. // split qkv
  3597. GGML_ASSERT(n_head_kv == n_head);
  3598. struct ggml_tensor * tmpqkv = ggml_reshape_4d(ctx0, cur, n_embd_head, 3, n_head, n_tokens);
  3599. cb(tmpqkv, "tmpqkv", il);
  3600. struct ggml_tensor * tmpqkv_perm = ggml_cont(ctx0, ggml_permute(ctx0, tmpqkv, 0, 3, 1, 2));
  3601. cb(tmpqkv_perm, "tmpqkv", il);
  3602. struct ggml_tensor * tmpq = ggml_view_3d(
  3603. ctx0, tmpqkv_perm, n_embd_head, n_head, n_tokens,
  3604. ggml_element_size(tmpqkv_perm) * n_embd_head,
  3605. ggml_element_size(tmpqkv_perm) * n_embd_head * n_head,
  3606. 0
  3607. );
  3608. cb(tmpq, "tmpq", il);
  3609. struct ggml_tensor * tmpk = ggml_view_3d(
  3610. ctx0, tmpqkv_perm, n_embd_head, n_head, n_tokens,
  3611. ggml_element_size(tmpqkv_perm) * n_embd_head,
  3612. ggml_element_size(tmpqkv_perm) * n_embd_head * n_head,
  3613. ggml_element_size(tmpqkv_perm) * n_embd_head * n_head * n_tokens
  3614. );
  3615. cb(tmpk, "tmpk", il);
  3616. // Q/K Layernorm
  3617. tmpq = llm_build_norm(ctx0, tmpq, hparams,
  3618. model.layers[il].attn_q_norm,
  3619. model.layers[il].attn_q_norm_b,
  3620. LLM_NORM, cb, il);
  3621. cb(tmpq, "tmpq", il);
  3622. tmpk = llm_build_norm(ctx0, tmpk, hparams,
  3623. model.layers[il].attn_k_norm,
  3624. model.layers[il].attn_k_norm_b,
  3625. LLM_NORM, cb, il);
  3626. cb(tmpk, "tmpk", il);
  3627. // RoPE the first n_rot of q/k, pass the other half, and concat.
  3628. struct ggml_tensor * qrot = ggml_view_3d(
  3629. ctx0, tmpq, n_rot, n_head, n_tokens,
  3630. ggml_element_size(tmpq) * n_embd_head,
  3631. ggml_element_size(tmpq) * n_embd_head * n_head,
  3632. 0
  3633. );
  3634. cb(qrot, "qrot", il);
  3635. struct ggml_tensor * krot = ggml_view_3d(
  3636. ctx0, tmpk, n_rot, n_head, n_tokens,
  3637. ggml_element_size(tmpk) * n_embd_head,
  3638. ggml_element_size(tmpk) * n_embd_head * n_head,
  3639. 0
  3640. );
  3641. cb(krot, "krot", il);
  3642. // get the second half of tmpq, e.g tmpq[n_rot:, :, :]
  3643. struct ggml_tensor * qpass = ggml_view_3d(
  3644. ctx0, tmpq, n_rot, n_head, n_tokens,
  3645. ggml_element_size(tmpq) * n_embd_head,
  3646. ggml_element_size(tmpq) * n_embd_head * n_head,
  3647. ggml_element_size(tmpq) * n_rot
  3648. );
  3649. cb(qpass, "qpass", il);
  3650. struct ggml_tensor * kpass = ggml_view_3d(
  3651. ctx0, tmpk, n_rot, n_head, n_tokens,
  3652. ggml_element_size(tmpk) * n_embd_head,
  3653. ggml_element_size(tmpk) * n_embd_head * n_head,
  3654. ggml_element_size(tmpk) * n_rot
  3655. );
  3656. cb(kpass, "kpass", il);
  3657. struct ggml_tensor * qrotated = ggml_rope_custom(
  3658. ctx0, qrot, inp_pos, n_rot, 2, 0, n_orig_ctx,
  3659. freq_base, freq_scale, ext_factor, attn_factor, beta_fast, beta_slow
  3660. );
  3661. cb(qrotated, "qrotated", il);
  3662. struct ggml_tensor * krotated = ggml_rope_custom(
  3663. ctx0, krot, inp_pos, n_rot, 2, 0, n_orig_ctx,
  3664. freq_base, freq_scale, ext_factor, attn_factor, beta_fast, beta_slow
  3665. );
  3666. cb(krotated, "krotated", il);
  3667. // ggml currently only supports concatenation on dim=2
  3668. // so we need to permute qrot, qpass, concat, then permute back.
  3669. qrotated = ggml_cont(ctx0, ggml_permute(ctx0, qrotated, 2, 1, 0, 3));
  3670. cb(qrotated, "qrotated", il);
  3671. krotated = ggml_cont(ctx0, ggml_permute(ctx0, krotated, 2, 1, 0, 3));
  3672. cb(krotated, "krotated", il);
  3673. qpass = ggml_cont(ctx0, ggml_permute(ctx0, qpass, 2, 1, 0, 3));
  3674. cb(qpass, "qpass", il);
  3675. kpass = ggml_cont(ctx0, ggml_permute(ctx0, kpass, 2, 1, 0, 3));
  3676. cb(kpass, "kpass", il);
  3677. struct ggml_tensor * Qcur = ggml_concat(ctx0, qrotated, qpass);
  3678. cb(Qcur, "Qcur", il);
  3679. struct ggml_tensor * Kcur = ggml_concat(ctx0, krotated, kpass);
  3680. cb(Kcur, "Kcur", il);
  3681. struct ggml_tensor * Q = ggml_cont(ctx0, ggml_permute(ctx0, Qcur, 2, 1, 0, 3));
  3682. cb(Q, "Q", il);
  3683. Kcur = ggml_cont(ctx0, ggml_permute(ctx0, Kcur, 2, 1, 0, 3));
  3684. cb(Kcur, "Kcur", il);
  3685. struct ggml_tensor * Vcur = ggml_view_3d(
  3686. ctx0, tmpqkv_perm, n_embd_head, n_head, n_tokens,
  3687. ggml_element_size(tmpqkv_perm) * n_embd_head,
  3688. ggml_element_size(tmpqkv_perm) * n_embd_head * n_head,
  3689. ggml_element_size(tmpqkv_perm) * n_embd_head * n_head * n_tokens * 2
  3690. );
  3691. cb(Vcur, "Vcur", il);
  3692. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3693. // TODO: not tested, could be broken
  3694. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3695. model.layers[il].wo, model.layers[il].bo,
  3696. Q, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, -1.0f, cb, il);
  3697. cb(cur, "kqv_out", il);
  3698. }
  3699. struct ggml_tensor * ffn_inp = ggml_add(ctx0, residual, cur);
  3700. cb(ffn_inp, "ffn_inp", il);
  3701. // feed-forward network
  3702. {
  3703. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3704. model.layers[il].ffn_norm,
  3705. model.layers[il].ffn_norm_b,
  3706. LLM_NORM, cb, il);
  3707. cb(cur, "ffn_norm", il);
  3708. cur = llm_build_ffn(ctx0, cur,
  3709. model.layers[il].ffn_up, model.layers[il].ffn_up_b,
  3710. NULL, NULL,
  3711. model.layers[il].ffn_down, model.layers[il].ffn_down_b,
  3712. LLM_FFN_RELU_SQR, LLM_FFN_SEQ, cb, il);
  3713. cb(cur, "ffn_out", il);
  3714. }
  3715. cur = ggml_add(ctx0, cur, ffn_inp);
  3716. cb(cur, "l_out", il);
  3717. inpL = cur;
  3718. }
  3719. cur = inpL;
  3720. cur = llm_build_norm(ctx0, cur, hparams,
  3721. model.output_norm,
  3722. model.output_norm_b,
  3723. LLM_NORM, cb, -1);
  3724. cb(cur, "result_norm", -1);
  3725. cur = ggml_mul_mat(ctx0, model.output, cur);
  3726. cb(cur, "result_output", -1);
  3727. ggml_build_forward_expand(gf, cur);
  3728. return gf;
  3729. }
  3730. struct ggml_cgraph * build_refact() {
  3731. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3732. struct ggml_tensor * cur;
  3733. struct ggml_tensor * inpL;
  3734. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3735. cb(inpL, "inp_embd", -1);
  3736. // KQ_scale
  3737. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3738. cb(KQ_scale, "KQ_scale", -1);
  3739. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3740. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3741. cb(KQ_mask, "KQ_mask", -1);
  3742. for (int il = 0; il < n_layer; ++il) {
  3743. struct ggml_tensor * inpSA = inpL;
  3744. cur = llm_build_norm(ctx0, inpL, hparams,
  3745. model.layers[il].attn_norm, NULL,
  3746. LLM_NORM_RMS, cb, il);
  3747. cb(cur, "attn_norm", il);
  3748. // self-attention
  3749. {
  3750. struct ggml_tensor * Qcur = ggml_mul_mat(ctx0, model.layers[il].wq, cur);
  3751. cb(Qcur, "Qcur", il);
  3752. struct ggml_tensor * Kcur = ggml_mul_mat(ctx0, model.layers[il].wk, cur);
  3753. cb(Kcur, "Kcur", il);
  3754. struct ggml_tensor * Vcur = ggml_mul_mat(ctx0, model.layers[il].wv, cur);
  3755. cb(Vcur, "Vcur", il);
  3756. Kcur = ggml_reshape_3d(ctx0, Kcur, n_embd_head, n_head_kv, n_tokens);
  3757. cb(Kcur, "Kcur", il);
  3758. Qcur = ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens);
  3759. cb(Qcur, "Qcur", il);
  3760. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3761. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3762. model.layers[il].wo, NULL,
  3763. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, 8.0f, cb, il);
  3764. cb(cur, "kqv_out", il);
  3765. }
  3766. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpSA);
  3767. cb(ffn_inp, "ffn_inp", il);
  3768. // feed-forward network
  3769. {
  3770. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3771. model.layers[il].ffn_norm, NULL,
  3772. LLM_NORM_RMS, cb, il);
  3773. cb(cur, "ffn_norm", il);
  3774. cur = llm_build_ffn(ctx0, cur,
  3775. model.layers[il].ffn_up, NULL,
  3776. model.layers[il].ffn_gate, NULL,
  3777. model.layers[il].ffn_down, NULL,
  3778. LLM_FFN_SILU, LLM_FFN_PAR, cb, il);
  3779. cb(cur, "ffn_out", il);
  3780. }
  3781. cur = ggml_add(ctx0, cur, ffn_inp);
  3782. cb(cur, "l_out", il);
  3783. // input for next layer
  3784. inpL = cur;
  3785. }
  3786. cur = inpL;
  3787. cur = llm_build_norm(ctx0, cur, hparams,
  3788. model.output_norm, NULL,
  3789. LLM_NORM_RMS, cb, -1);
  3790. cb(cur, "result_norm", -1);
  3791. // lm_head
  3792. cur = ggml_mul_mat(ctx0, model.output, cur);
  3793. cb(cur, "result_output", -1);
  3794. ggml_build_forward_expand(gf, cur);
  3795. return gf;
  3796. }
  3797. struct ggml_cgraph * build_bloom() {
  3798. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3799. struct ggml_tensor * cur;
  3800. struct ggml_tensor * inpL;
  3801. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3802. cb(inpL, "inp_embd", -1);
  3803. // KQ_scale
  3804. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3805. cb(KQ_scale, "KQ_scale", -1);
  3806. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3807. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3808. cb(KQ_mask, "KQ_mask", -1);
  3809. inpL = llm_build_norm(ctx0, inpL, hparams,
  3810. model.tok_norm,
  3811. model.tok_norm_b,
  3812. LLM_NORM, cb, -1);
  3813. cb(inpL, "inp_norm", -1);
  3814. for (int il = 0; il < n_layer; ++il) {
  3815. cur = llm_build_norm(ctx0, inpL, hparams,
  3816. model.layers[il].attn_norm,
  3817. model.layers[il].attn_norm_b,
  3818. LLM_NORM, cb, il);
  3819. cb(cur, "attn_norm", il);
  3820. // self-attention
  3821. {
  3822. cur = ggml_mul_mat(ctx0, model.layers[il].wqkv, cur);
  3823. cb(cur, "wqkv", il);
  3824. cur = ggml_add(ctx0, cur, model.layers[il].bqkv);
  3825. cb(cur, "bqkv", il);
  3826. struct ggml_tensor * Qcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd, n_tokens, cur->nb[1], 0*sizeof(float)*(n_embd)));
  3827. struct ggml_tensor * Kcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd)));
  3828. struct ggml_tensor * Vcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd + n_embd_gqa)));
  3829. cb(Qcur, "Qcur", il);
  3830. cb(Kcur, "Kcur", il);
  3831. cb(Vcur, "Vcur", il);
  3832. Qcur = ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens);
  3833. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3834. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3835. model.layers[il].wo, model.layers[il].bo,
  3836. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, 8.0f, cb, il);
  3837. cb(cur, "kqv_out", il);
  3838. }
  3839. // Add the input
  3840. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpL);
  3841. cb(ffn_inp, "ffn_inp", il);
  3842. // FF
  3843. {
  3844. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3845. model.layers[il].ffn_norm,
  3846. model.layers[il].ffn_norm_b,
  3847. LLM_NORM, cb, il);
  3848. cb(cur, "ffn_norm", il);
  3849. cur = llm_build_ffn(ctx0, cur,
  3850. model.layers[il].ffn_up, model.layers[il].ffn_up_b,
  3851. NULL, NULL,
  3852. model.layers[il].ffn_down, model.layers[il].ffn_down_b,
  3853. LLM_FFN_GELU, LLM_FFN_SEQ, cb, il);
  3854. cb(cur, "ffn_out", il);
  3855. }
  3856. inpL = ggml_add(ctx0, cur, ffn_inp);
  3857. cb(inpL, "l_out", il);
  3858. }
  3859. cur = llm_build_norm(ctx0, inpL, hparams,
  3860. model.output_norm,
  3861. model.output_norm_b,
  3862. LLM_NORM, cb, -1);
  3863. cb(cur, "result_norm", -1);
  3864. cur = ggml_mul_mat(ctx0, model.output, cur);
  3865. cb(cur, "result_output", -1);
  3866. ggml_build_forward_expand(gf, cur);
  3867. return gf;
  3868. }
  3869. struct ggml_cgraph * build_mpt() {
  3870. struct ggml_cgraph * gf = ggml_new_graph_custom(ctx0, LLAMA_MAX_NODES, false);
  3871. struct ggml_tensor * cur;
  3872. struct ggml_tensor * inpL;
  3873. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3874. cb(inpL, "inp_embd", -1);
  3875. // KQ_scale
  3876. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3877. cb(KQ_scale, "KQ_scale", -1);
  3878. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3879. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3880. cb(KQ_mask, "KQ_mask", -1);
  3881. for (int il = 0; il < n_layer; ++il) {
  3882. struct ggml_tensor * attn_norm;
  3883. attn_norm = llm_build_norm(ctx0, inpL, hparams,
  3884. model.layers[il].attn_norm,
  3885. NULL,
  3886. LLM_NORM, cb, il);
  3887. cb(attn_norm, "attn_norm", il);
  3888. // self-attention
  3889. {
  3890. cur = attn_norm;
  3891. cur = ggml_mul_mat(ctx0, model.layers[il].wqkv, cur);
  3892. cb(cur, "wqkv", il);
  3893. if (hparams.f_clamp_kqv > 0.0f) {
  3894. cur = ggml_clamp(ctx0, cur, -hparams.f_clamp_kqv, hparams.f_clamp_kqv);
  3895. cb(cur, "wqkv_clamped", il);
  3896. }
  3897. struct ggml_tensor * Qcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd, n_tokens, cur->nb[1], 0*sizeof(float)*(n_embd)));
  3898. struct ggml_tensor * Kcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd)));
  3899. struct ggml_tensor * Vcur = ggml_cont(ctx0, ggml_view_2d(ctx0, cur, n_embd_gqa, n_tokens, cur->nb[1], 1*sizeof(float)*(n_embd + n_embd_gqa)));
  3900. cb(Qcur, "Qcur", il);
  3901. cb(Kcur, "Kcur", il);
  3902. cb(Vcur, "Vcur", il);
  3903. Qcur = ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens);
  3904. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3905. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3906. model.layers[il].wo, NULL,
  3907. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, hparams.f_max_alibi_bias, cb, il);
  3908. cb(cur, "kqv_out", il);
  3909. }
  3910. // Add the input
  3911. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpL);
  3912. cb(ffn_inp, "ffn_inp", il);
  3913. // feed forward
  3914. {
  3915. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  3916. model.layers[il].ffn_norm,
  3917. NULL,
  3918. LLM_NORM, cb, il);
  3919. cb(cur, "ffn_norm", il);
  3920. cur = llm_build_ffn(ctx0, cur,
  3921. model.layers[il].ffn_up, NULL,
  3922. NULL, NULL,
  3923. model.layers[il].ffn_down, NULL,
  3924. LLM_FFN_GELU, LLM_FFN_SEQ, cb, il);
  3925. cb(cur, "ffn_out", il);
  3926. }
  3927. cur = ggml_add(ctx0, cur, ffn_inp);
  3928. cb(cur, "l_out", il);
  3929. // input for next layer
  3930. inpL = cur;
  3931. }
  3932. cur = inpL;
  3933. cur = llm_build_norm(ctx0, cur, hparams,
  3934. model.output_norm,
  3935. NULL,
  3936. LLM_NORM, cb, -1);
  3937. cb(cur, "result_norm", -1);
  3938. cur = ggml_mul_mat(ctx0, model.output, cur);
  3939. cb(cur, "result_output", -1);
  3940. ggml_build_forward_expand(gf, cur);
  3941. return gf;
  3942. }
  3943. struct ggml_cgraph * build_stablelm() {
  3944. struct ggml_cgraph * gf = ggml_new_graph(ctx0);
  3945. struct ggml_tensor * cur;
  3946. struct ggml_tensor * inpL;
  3947. inpL = llm_build_inp_embd(ctx0, hparams, batch, model.tok_embd, cb);
  3948. cb(inpL, "inp_embd", -1);
  3949. // inp_pos - contains the positions
  3950. struct ggml_tensor * inp_pos = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_tokens);
  3951. cb(inp_pos, "inp_pos", -1);
  3952. // KQ_scale
  3953. struct ggml_tensor * KQ_scale = ggml_new_tensor_1d(ctx0, GGML_TYPE_F32, 1);
  3954. cb(KQ_scale, "KQ_scale", -1);
  3955. // KQ_mask (mask for 1 head, it will be broadcasted to all heads)
  3956. struct ggml_tensor * KQ_mask = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_kv, n_tokens, 1);
  3957. cb(KQ_mask, "KQ_mask", -1);
  3958. // shift the entire K-cache if needed
  3959. if (do_rope_shift) {
  3960. llm_build_k_shift(ctx0, hparams, cparams, kv_self, gf, LLM_ROPE_NEOX, n_ctx, hparams.n_rot, freq_base, freq_scale, cb);
  3961. }
  3962. for (int il = 0; il < n_layer; ++il) {
  3963. struct ggml_tensor * inpSA = inpL;
  3964. // norm
  3965. cur = llm_build_norm(ctx0, inpL, hparams,
  3966. model.layers[il].attn_norm,
  3967. model.layers[il].attn_norm_b,
  3968. LLM_NORM, cb, il);
  3969. cb(cur, "attn_norm", il);
  3970. // self-attention
  3971. {
  3972. // compute Q and K and RoPE them
  3973. struct ggml_tensor * Qcur = ggml_mul_mat(ctx0, model.layers[il].wq, cur);
  3974. cb(Qcur, "Qcur", il);
  3975. struct ggml_tensor * Kcur = ggml_mul_mat(ctx0, model.layers[il].wk, cur);
  3976. cb(Kcur, "Kcur", il);
  3977. struct ggml_tensor * Vcur = ggml_mul_mat(ctx0, model.layers[il].wv, cur);
  3978. cb(Vcur, "Vcur", il);
  3979. Qcur = ggml_rope_custom(
  3980. ctx0, ggml_reshape_3d(ctx0, Qcur, n_embd_head, n_head, n_tokens), inp_pos,
  3981. hparams.n_rot, 2, 0, n_orig_ctx, freq_base, freq_scale,
  3982. ext_factor, attn_factor, beta_fast, beta_slow
  3983. );
  3984. cb(Qcur, "Qcur", il);
  3985. Kcur = ggml_rope_custom(
  3986. ctx0, ggml_reshape_3d(ctx0, Kcur, n_embd_head, n_head_kv, n_tokens), inp_pos,
  3987. hparams.n_rot, 2, 0, n_orig_ctx, freq_base, freq_scale,
  3988. ext_factor, attn_factor, beta_fast, beta_slow
  3989. );
  3990. cb(Kcur, "Kcur", il);
  3991. llm_build_kv_store(ctx0, hparams, kv_self, gf, Kcur, Vcur, n_ctx, n_tokens, kv_head, cb, il);
  3992. cur = llm_build_kqv(ctx0, hparams, kv_self,
  3993. model.layers[il].wo, NULL,
  3994. Qcur, KQ_scale, KQ_mask, n_ctx, n_tokens, n_kv, -1.0f, cb, il);
  3995. cb(cur, "kqv_out", il);
  3996. }
  3997. struct ggml_tensor * ffn_inp = ggml_add(ctx0, cur, inpSA);
  3998. cb(ffn_inp, "ffn_inp", il);
  3999. // feed-forward network
  4000. {
  4001. cur = llm_build_norm(ctx0, ffn_inp, hparams,
  4002. model.layers[il].ffn_norm,
  4003. model.layers[il].ffn_norm_b,
  4004. LLM_NORM, cb, il);
  4005. cb(cur, "ffn_norm", il);
  4006. cur = llm_build_ffn(ctx0, cur,
  4007. model.layers[il].ffn_up, NULL,
  4008. model.layers[il].ffn_gate, NULL,
  4009. model.layers[il].ffn_down, NULL,
  4010. LLM_FFN_SILU, LLM_FFN_PAR, cb, il);
  4011. cb(cur, "ffn_out", il);
  4012. }
  4013. cur = ggml_add(ctx0, cur, ffn_inp);
  4014. cb(cur, "l_out", il);
  4015. // input for next layer
  4016. inpL = cur;
  4017. }
  4018. cur = inpL;
  4019. cur = llm_build_norm(ctx0, cur, hparams,
  4020. model.output_norm,
  4021. model.output_norm_b,
  4022. LLM_NORM, cb, -1);
  4023. cb(cur, "result_norm", -1);
  4024. // lm_head
  4025. cur = ggml_mul_mat(ctx0, model.output, cur);
  4026. cb(cur, "result_output", -1);
  4027. ggml_build_forward_expand(gf, cur);
  4028. return gf;
  4029. }
  4030. };
  4031. //
  4032. // tensor offloading helpers
  4033. //
  4034. // TODO: will be removed with backend v2
  4035. enum llm_offload_func_e {
  4036. OFFLOAD_FUNC_NOP,
  4037. OFFLOAD_FUNC,
  4038. OFFLOAD_FUNC_KQ,
  4039. OFFLOAD_FUNC_V,
  4040. OFFLOAD_FUNC_NR,
  4041. OFFLOAD_FUNC_EMB,
  4042. OFFLOAD_FUNC_OUT,
  4043. };
  4044. // TODO: will be removed with backend v2
  4045. struct llm_offload_trie {
  4046. struct node {
  4047. ~node() {
  4048. for (int i = 0; i < 256; ++i) {
  4049. if (children[i]) {
  4050. delete children[i];
  4051. }
  4052. }
  4053. }
  4054. node * children[256] = { nullptr };
  4055. llm_offload_func_e func = OFFLOAD_FUNC_NOP;
  4056. };
  4057. llm_offload_trie() {
  4058. root = new node;
  4059. }
  4060. llm_offload_trie(const std::unordered_map<const char *, llm_offload_func_e> & map) {
  4061. root = new node;
  4062. for (const auto & kv : map) {
  4063. add(kv.first, kv.second);
  4064. }
  4065. }
  4066. ~llm_offload_trie() {
  4067. delete root;
  4068. }
  4069. void add(const char * name, llm_offload_func_e func) {
  4070. node * cur = root;
  4071. for (int i = 0; ; ++i) {
  4072. const uint8_t c = name[i];
  4073. if (!c) {
  4074. break;
  4075. }
  4076. if (!cur->children[c]) {
  4077. cur->children[c] = new node;
  4078. }
  4079. cur = cur->children[c];
  4080. }
  4081. cur->func = func;
  4082. }
  4083. llm_offload_func_e find(const char * name) const {
  4084. const node * cur = root;
  4085. for (int i = 0; ; ++i) {
  4086. const uint8_t c = name[i];
  4087. if (!c) {
  4088. break;
  4089. }
  4090. if (!cur->children[c]) {
  4091. return OFFLOAD_FUNC_NOP;
  4092. }
  4093. cur = cur->children[c];
  4094. }
  4095. return cur->func;
  4096. }
  4097. node * root = nullptr;
  4098. };
  4099. // TODO: will be removed with backend v2
  4100. static const std::unordered_map<const char *, llm_offload_func_e> k_offload_map = {
  4101. //{ "inp_tokens", OFFLOAD_FUNC_NR }, // TODO: missing K-quants get_rows kernel
  4102. //{ "inp_embd", OFFLOAD_FUNC_NR }, // TODO: missing K-quants get_rows kernel
  4103. { "pos_embd", OFFLOAD_FUNC_NR },
  4104. { "inp_pos", OFFLOAD_FUNC_KQ }, // this is often used for KQ ops (e.g. rope)
  4105. { "KQ_scale", OFFLOAD_FUNC_KQ },
  4106. { "KQ_mask", OFFLOAD_FUNC_KQ },
  4107. { "K_shift", OFFLOAD_FUNC_KQ },
  4108. { "K_shifted", OFFLOAD_FUNC_KQ },
  4109. { "inp_norm", OFFLOAD_FUNC_NR },
  4110. { "inp_norm_w", OFFLOAD_FUNC_NR },
  4111. { "inp_norm_wb", OFFLOAD_FUNC_NR },
  4112. { "norm", OFFLOAD_FUNC },
  4113. { "norm_w", OFFLOAD_FUNC },
  4114. { "norm_wb", OFFLOAD_FUNC },
  4115. { "attn_norm", OFFLOAD_FUNC },
  4116. { "attn_norm_2", OFFLOAD_FUNC },
  4117. { "wqkv", OFFLOAD_FUNC_KQ },
  4118. { "bqkv", OFFLOAD_FUNC_KQ },
  4119. { "wqkv_clamped", OFFLOAD_FUNC_KQ },
  4120. { "tmpk", OFFLOAD_FUNC_KQ },
  4121. { "tmpq", OFFLOAD_FUNC_KQ },
  4122. { "tmpv", OFFLOAD_FUNC_V },
  4123. { "Kcur", OFFLOAD_FUNC_KQ },
  4124. { "Qcur", OFFLOAD_FUNC_KQ },
  4125. { "Vcur", OFFLOAD_FUNC_V },
  4126. { "krot", OFFLOAD_FUNC_KQ },
  4127. { "qrot", OFFLOAD_FUNC_KQ },
  4128. { "kpass", OFFLOAD_FUNC_KQ },
  4129. { "qpass", OFFLOAD_FUNC_KQ },
  4130. { "krotated", OFFLOAD_FUNC_KQ },
  4131. { "qrotated", OFFLOAD_FUNC_KQ },
  4132. { "q", OFFLOAD_FUNC_KQ },
  4133. { "k", OFFLOAD_FUNC_KQ },
  4134. { "kq", OFFLOAD_FUNC_KQ },
  4135. { "kq_scaled", OFFLOAD_FUNC_KQ },
  4136. { "kq_scaled_alibi", OFFLOAD_FUNC_KQ },
  4137. { "kq_masked", OFFLOAD_FUNC_KQ },
  4138. { "kq_soft_max", OFFLOAD_FUNC_V },
  4139. { "v", OFFLOAD_FUNC_V },
  4140. { "kqv", OFFLOAD_FUNC_V },
  4141. { "kqv_merged", OFFLOAD_FUNC_V },
  4142. { "kqv_merged_cont", OFFLOAD_FUNC_V },
  4143. { "kqv_wo", OFFLOAD_FUNC_V },
  4144. { "kqv_out", OFFLOAD_FUNC_V },
  4145. { "ffn_inp", OFFLOAD_FUNC },
  4146. { "ffn_norm", OFFLOAD_FUNC },
  4147. { "ffn_up", OFFLOAD_FUNC },
  4148. { "ffn_up_b", OFFLOAD_FUNC },
  4149. { "ffn_gate", OFFLOAD_FUNC },
  4150. { "ffn_gate_b", OFFLOAD_FUNC },
  4151. { "ffn_gate_par", OFFLOAD_FUNC },
  4152. { "ffn_down", OFFLOAD_FUNC },
  4153. { "ffn_down_b", OFFLOAD_FUNC },
  4154. { "ffn_out", OFFLOAD_FUNC },
  4155. { "ffn_silu", OFFLOAD_FUNC },
  4156. { "ffn_gelu", OFFLOAD_FUNC },
  4157. { "ffn_relu", OFFLOAD_FUNC },
  4158. { "ffn_sqr(relu)", OFFLOAD_FUNC },
  4159. { "l_out", OFFLOAD_FUNC },
  4160. { "result_norm", OFFLOAD_FUNC_EMB },
  4161. { "result_output", OFFLOAD_FUNC_OUT },
  4162. };
  4163. static llm_offload_trie k_offload_func_trie(k_offload_map);
  4164. static struct ggml_cgraph * llama_build_graph(
  4165. llama_context & lctx,
  4166. const llama_batch & batch) {
  4167. const auto & model = lctx.model;
  4168. // check if we should build the worst-case graph (for memory measurement)
  4169. const bool worst_case = ggml_allocr_is_measure(lctx.alloc);
  4170. // keep track of the input that has already been allocated
  4171. bool alloc_inp_tokens = false;
  4172. bool alloc_inp_embd = false;
  4173. bool alloc_inp_pos = false;
  4174. bool alloc_inp_KQ_scale = false;
  4175. bool alloc_inp_KQ_mask = false;
  4176. bool alloc_inp_K_shift = false;
  4177. #ifdef GGML_USE_CUBLAS
  4178. const bool do_offload = true;
  4179. #else
  4180. const bool do_offload = true; // TODO: set to false after finishing refactoring
  4181. #endif
  4182. int n_non_view = 0; // number of non-view tensors that have been processed by the callback
  4183. // this callback allows us to apply custom logic to each tensor (e.g. ggml-alloc, offloading, etc.)
  4184. // TODO: will be removed with backend v2
  4185. llm_build_cb cb = [&](struct ggml_tensor * cur, const char * name, int il) {
  4186. if (il >= 0) {
  4187. ggml_format_name(cur, "%s-%d", name, il);
  4188. } else {
  4189. ggml_set_name(cur, name);
  4190. }
  4191. //
  4192. // allocate input tensors and set input data
  4193. //
  4194. // TODO: will be removed with backend v2
  4195. if (!alloc_inp_tokens && strcmp(name, "inp_tokens") == 0) {
  4196. ggml_allocr_alloc(lctx.alloc, cur);
  4197. if (!ggml_allocr_is_measure(lctx.alloc) && batch.token) {
  4198. const int64_t n_tokens = cur->ne[0];
  4199. memcpy(cur->data, batch.token, n_tokens*ggml_element_size(cur));
  4200. }
  4201. alloc_inp_tokens = true;
  4202. }
  4203. if (!alloc_inp_embd && strcmp(name, "inp_embd") == 0) {
  4204. ggml_allocr_alloc(lctx.alloc, cur);
  4205. if (!ggml_allocr_is_measure(lctx.alloc) && batch.embd) {
  4206. const int64_t n_embd = cur->ne[0];
  4207. const int64_t n_tokens = cur->ne[1];
  4208. memcpy(cur->data, batch.embd, n_tokens*n_embd*ggml_element_size(cur));
  4209. }
  4210. alloc_inp_embd = true;
  4211. }
  4212. if (!alloc_inp_pos && strcmp(name, "inp_pos") == 0) {
  4213. ggml_allocr_alloc(lctx.alloc, cur);
  4214. if (!ggml_allocr_is_measure(lctx.alloc) && batch.pos) {
  4215. const int64_t n_tokens = cur->ne[0];
  4216. int32_t * data = (int32_t *) cur->data;
  4217. for (int i = 0; i < n_tokens; ++i) {
  4218. data[i] = batch.pos[i];
  4219. }
  4220. }
  4221. alloc_inp_pos = true;
  4222. }
  4223. if (!alloc_inp_KQ_scale && strcmp(name, "KQ_scale") == 0) {
  4224. ggml_allocr_alloc(lctx.alloc, cur);
  4225. if (!ggml_allocr_is_measure(lctx.alloc)) {
  4226. const int64_t n_embd_head = model.hparams.n_embd_head();
  4227. ggml_set_f32(cur, 1.0f/sqrtf(float(n_embd_head)));
  4228. }
  4229. alloc_inp_KQ_scale = true;
  4230. }
  4231. if (!alloc_inp_KQ_mask && strcmp(name, "KQ_mask") == 0) {
  4232. ggml_allocr_alloc(lctx.alloc, cur);
  4233. if (!ggml_allocr_is_measure(lctx.alloc)) {
  4234. const int64_t n_kv = cur->ne[0];
  4235. const int64_t n_tokens = cur->ne[1];
  4236. float * data = (float *) cur->data;
  4237. memset(data, 0, ggml_nbytes(cur));
  4238. for (int h = 0; h < 1; ++h) {
  4239. for (int j = 0; j < n_tokens; ++j) {
  4240. const llama_pos pos = batch.pos[j];
  4241. const llama_seq_id seq_id = batch.seq_id[j][0];
  4242. for (int i = 0; i < n_kv; ++i) {
  4243. if (!lctx.kv_self.cells[i].has_seq_id(seq_id) || lctx.kv_self.cells[i].pos > pos) {
  4244. data[h*(n_kv*n_tokens) + j*n_kv + i] = -INFINITY;
  4245. }
  4246. }
  4247. }
  4248. }
  4249. }
  4250. alloc_inp_KQ_mask = true;
  4251. }
  4252. if (!alloc_inp_K_shift && strcmp(name, "K_shift") == 0) {
  4253. ggml_allocr_alloc(lctx.alloc, cur);
  4254. if (!ggml_allocr_is_measure(lctx.alloc)) {
  4255. const int64_t n_ctx = cur->ne[0];
  4256. int32_t * data = (int32_t *) cur->data;
  4257. for (int i = 0; i < n_ctx; ++i) {
  4258. data[i] = lctx.kv_self.cells[i].delta;
  4259. }
  4260. }
  4261. alloc_inp_K_shift = true;
  4262. }
  4263. // view tensors are not processed further
  4264. if (cur->view_src != nullptr) {
  4265. return;
  4266. }
  4267. if (cur->op != GGML_OP_NONE) {
  4268. n_non_view++;
  4269. }
  4270. //
  4271. // offload layers
  4272. //
  4273. // TODO: will be removed with backend v2
  4274. //#define LLAMA_OFFLOAD_DEBUG
  4275. if (!do_offload) {
  4276. return;
  4277. }
  4278. const int n_layer = model.hparams.n_layer;
  4279. const int n_gpu_layers = model.n_gpu_layers;
  4280. const int i_gpu_start = n_layer - n_gpu_layers;
  4281. // should we offload the final norm? yes if we are not computing embeddings
  4282. const bool offload_emb = lctx.embedding.empty();
  4283. static const std::unordered_map<llm_offload_func_e, std::string, std::hash<int>> k_offload_func_name = {
  4284. { OFFLOAD_FUNC_NOP, "CPU" },
  4285. { OFFLOAD_FUNC_OUT, "CPU" },
  4286. #ifdef GGML_USE_CUBLAS
  4287. { OFFLOAD_FUNC, "GPU (CUDA)" },
  4288. { OFFLOAD_FUNC_KQ, "GPU (CUDA) KQ" },
  4289. { OFFLOAD_FUNC_V, "GPU (CUDA) V" },
  4290. { OFFLOAD_FUNC_NR, "GPU (CUDA) NR" },
  4291. { OFFLOAD_FUNC_EMB, "GPU (CUDA) EMB" },
  4292. #else
  4293. { OFFLOAD_FUNC, "CPU" },
  4294. { OFFLOAD_FUNC_KQ, "CPU" },
  4295. { OFFLOAD_FUNC_V, "CPU" },
  4296. { OFFLOAD_FUNC_NR, "CPU" },
  4297. { OFFLOAD_FUNC_EMB, "CPU" },
  4298. #endif // GGML_USE_CUBLAS
  4299. };
  4300. // check the global map for what offload function to use for this tensor
  4301. llm_offload_func_e func_e = k_offload_func_trie.find(name);
  4302. if (func_e == OFFLOAD_FUNC_NOP) {
  4303. #ifdef LLAMA_OFFLOAD_DEBUG
  4304. // if a tensor hasn't been offloaded, we warn the user
  4305. if (worst_case) {
  4306. LLAMA_LOG_WARN("%s: %32s: not offloaded (ref: %s)\n", __func__,
  4307. cur->name, "https://github.com/ggerganov/llama.cpp/pull/3837");
  4308. }
  4309. #endif
  4310. return;
  4311. }
  4312. // count the number of layers and respect the provided n_gpu_layers
  4313. switch (func_e) {
  4314. case OFFLOAD_FUNC_NOP:
  4315. case OFFLOAD_FUNC_OUT:
  4316. break;
  4317. case OFFLOAD_FUNC:
  4318. if (n_gpu_layers < n_layer) {
  4319. if (il < i_gpu_start) {
  4320. func_e = OFFLOAD_FUNC_NOP;
  4321. }
  4322. }
  4323. break;
  4324. case OFFLOAD_FUNC_NR:
  4325. if (n_gpu_layers <= n_layer + 0) {
  4326. func_e = OFFLOAD_FUNC_NOP;
  4327. }
  4328. break;
  4329. case OFFLOAD_FUNC_V:
  4330. if (n_gpu_layers <= n_layer + 1) {
  4331. func_e = OFFLOAD_FUNC_NOP;
  4332. }
  4333. break;
  4334. case OFFLOAD_FUNC_KQ:
  4335. if (n_gpu_layers <= n_layer + 2) {
  4336. func_e = OFFLOAD_FUNC_NOP;
  4337. }
  4338. break;
  4339. case OFFLOAD_FUNC_EMB:
  4340. if (!offload_emb || n_gpu_layers < n_layer) {
  4341. func_e = OFFLOAD_FUNC_NOP;
  4342. }
  4343. break;
  4344. default: GGML_ASSERT(false);
  4345. }
  4346. offload_func_t func = ggml_offload_nop;
  4347. // this is needed for compatibility with Metal for example
  4348. #ifdef GGML_USE_CUBLAS
  4349. static offload_func_t ggml_offload_gpu = ggml_cuda_assign_buffers_no_alloc;
  4350. #else
  4351. static offload_func_t ggml_offload_gpu = ggml_offload_nop;
  4352. #endif
  4353. switch (func_e) {
  4354. case OFFLOAD_FUNC_NOP:
  4355. case OFFLOAD_FUNC_OUT: func = ggml_offload_nop; break;
  4356. case OFFLOAD_FUNC:
  4357. case OFFLOAD_FUNC_KQ:
  4358. case OFFLOAD_FUNC_V:
  4359. case OFFLOAD_FUNC_NR:
  4360. case OFFLOAD_FUNC_EMB: func = ggml_offload_gpu; break;
  4361. default: GGML_ASSERT(false);
  4362. }
  4363. // apply offload function to the tensor
  4364. func(cur);
  4365. #ifdef LLAMA_OFFLOAD_DEBUG
  4366. if (worst_case) {
  4367. LLAMA_LOG_INFO("%s: %32s: %s\n", __func__, cur->name, k_offload_func_name.at(func_e).c_str());
  4368. }
  4369. #endif
  4370. };
  4371. struct ggml_cgraph * result = NULL;
  4372. struct llm_build_context llm(lctx, batch, cb, worst_case);
  4373. llm.init();
  4374. switch (model.arch) {
  4375. case LLM_ARCH_LLAMA:
  4376. {
  4377. result = llm.build_llama();
  4378. } break;
  4379. case LLM_ARCH_BAICHUAN:
  4380. {
  4381. result = llm.build_baichuan();
  4382. } break;
  4383. case LLM_ARCH_FALCON:
  4384. {
  4385. result = llm.build_falcon();
  4386. } break;
  4387. case LLM_ARCH_STARCODER:
  4388. {
  4389. result = llm.build_starcoder();
  4390. } break;
  4391. case LLM_ARCH_PERSIMMON:
  4392. {
  4393. result = llm.build_persimmon();
  4394. } break;
  4395. case LLM_ARCH_REFACT:
  4396. {
  4397. result = llm.build_refact();
  4398. } break;
  4399. case LLM_ARCH_BLOOM:
  4400. {
  4401. result = llm.build_bloom();
  4402. } break;
  4403. case LLM_ARCH_MPT:
  4404. {
  4405. result = llm.build_mpt();
  4406. } break;
  4407. case LLM_ARCH_STABLELM:
  4408. {
  4409. result = llm.build_stablelm();
  4410. } break;
  4411. default:
  4412. GGML_ASSERT(false);
  4413. }
  4414. llm.free();
  4415. if (worst_case) {
  4416. int n_non_view_total = 0;
  4417. for (int i = 0; i < result->n_nodes; ++i) {
  4418. if (result->nodes[i]->view_src == nullptr) {
  4419. n_non_view_total++;
  4420. }
  4421. }
  4422. LLAMA_LOG_INFO("%s: non-view tensors processed: %d/%d\n", __func__, n_non_view, n_non_view_total);
  4423. if (n_non_view != n_non_view_total) {
  4424. LLAMA_LOG_WARN("%s: ****************************************************************\n", __func__);
  4425. LLAMA_LOG_WARN("%s: not all non-view tensors have been processed with a callback\n", __func__);
  4426. LLAMA_LOG_WARN("%s: this can indicate an inefficiency in the graph implementation\n", __func__);
  4427. LLAMA_LOG_WARN("%s: build with LLAMA_OFFLOAD_DEBUG for more info\n", __func__);
  4428. LLAMA_LOG_WARN("%s: ref: https://github.com/ggerganov/llama.cpp/pull/3837\n", __func__);
  4429. LLAMA_LOG_WARN("%s: ****************************************************************\n", __func__);
  4430. }
  4431. }
  4432. return result;
  4433. }
  4434. // decode a batch of tokens by evaluating the transformer
  4435. //
  4436. // - lctx: llama context
  4437. // - batch: batch to evaluate
  4438. //
  4439. // return 0 on success
  4440. // return positive int on warning
  4441. // return negative int on error
  4442. //
  4443. static int llama_decode_internal(
  4444. llama_context & lctx,
  4445. llama_batch batch) {
  4446. const uint32_t n_tokens = batch.n_tokens;
  4447. if (n_tokens == 0) {
  4448. LLAMA_LOG_ERROR("%s: n_tokens == 0", __func__);
  4449. return -1;
  4450. }
  4451. const auto & model = lctx.model;
  4452. const auto & hparams = model.hparams;
  4453. const auto & cparams = lctx.cparams;
  4454. const auto n_batch = cparams.n_batch;
  4455. GGML_ASSERT(n_tokens <= n_batch);
  4456. int n_threads = n_tokens == 1 ? cparams.n_threads : cparams.n_threads_batch;
  4457. GGML_ASSERT((!batch.token && batch.embd) || (batch.token && !batch.embd)); // NOLINT
  4458. const int64_t t_start_us = ggml_time_us();
  4459. #ifdef GGML_USE_MPI
  4460. // TODO: needs fix after #3228
  4461. GGML_ASSERT(false && "not implemented");
  4462. //ggml_mpi_eval_init(lctx.ctx_mpi, &n_tokens, &n_past, &n_threads);
  4463. #endif
  4464. GGML_ASSERT(n_threads > 0);
  4465. auto & kv_self = lctx.kv_self;
  4466. GGML_ASSERT(!!kv_self.ctx);
  4467. const int64_t n_embd = hparams.n_embd;
  4468. const int64_t n_vocab = hparams.n_vocab;
  4469. // helpers for smoother batch API transistion
  4470. // after deprecating the llama_eval calls, these will be removed
  4471. std::vector<llama_pos> pos;
  4472. std::vector<int32_t> n_seq_id;
  4473. std::vector<llama_seq_id *> seq_id_arr;
  4474. std::vector<std::vector<llama_seq_id>> seq_id;
  4475. if (batch.pos == nullptr) {
  4476. pos.resize(n_tokens);
  4477. for (uint32_t i = 0; i < n_tokens; i++) {
  4478. pos[i] = batch.all_pos_0 + i*batch.all_pos_1;
  4479. }
  4480. batch.pos = pos.data();
  4481. }
  4482. if (batch.seq_id == nullptr) {
  4483. n_seq_id.resize(n_tokens);
  4484. seq_id.resize(n_tokens);
  4485. seq_id_arr.resize(n_tokens);
  4486. for (uint32_t i = 0; i < n_tokens; i++) {
  4487. n_seq_id[i] = 1;
  4488. seq_id[i].resize(1);
  4489. seq_id[i][0] = batch.all_seq_id;
  4490. seq_id_arr[i] = seq_id[i].data();
  4491. }
  4492. batch.n_seq_id = n_seq_id.data();
  4493. batch.seq_id = seq_id_arr.data();
  4494. }
  4495. // if we have enough unused cells before the current head ->
  4496. // better to start searching from the beginning of the cache, hoping to fill it
  4497. if (kv_self.head > kv_self.used + 2*n_tokens) {
  4498. kv_self.head = 0;
  4499. }
  4500. if (!llama_kv_cache_find_slot(kv_self, batch)) {
  4501. return 1;
  4502. }
  4503. // a heuristic, to avoid attending the full cache if it is not yet utilized
  4504. // after enough generations, the benefit from this heuristic disappears
  4505. // if we start defragmenting the cache, the benefit from this will be more important
  4506. //kv_self.n = std::max(32, GGML_PAD(llama_kv_cache_cell_max(kv_self), 32)); // TODO: this might be better for CUDA?
  4507. kv_self.n = std::min((int32_t) cparams.n_ctx, std::max(32, llama_kv_cache_cell_max(kv_self)));
  4508. //printf("kv_self.n = %5d, kv_self.used = %5d, kv_self.head = %5d\n", kv_self.n, kv_self.used, kv_self.head);
  4509. ggml_allocr_reset(lctx.alloc);
  4510. ggml_cgraph * gf = llama_build_graph(lctx, batch);
  4511. ggml_allocr_alloc_graph(lctx.alloc, gf);
  4512. struct ggml_tensor * res = gf->nodes[gf->n_nodes - 1];
  4513. struct ggml_tensor * embeddings = gf->nodes[gf->n_nodes - 2];
  4514. GGML_ASSERT(strcmp(res->name, "result_output") == 0);
  4515. GGML_ASSERT(strcmp(embeddings->name, "result_norm") == 0);
  4516. #ifdef GGML_USE_CUBLAS
  4517. for (int i = 0; i < gf->n_leafs; i++) {
  4518. ggml_tensor * node = gf->leafs[i];
  4519. if (node->backend == GGML_BACKEND_GPU && node->extra == NULL) {
  4520. ggml_cuda_assign_scratch_offset(node, (char*)node->data - (char *) lctx.buf_alloc.data);
  4521. ggml_cuda_copy_to_device(node);
  4522. }
  4523. }
  4524. for (int i = 0; i < gf->n_nodes; i++) {
  4525. ggml_tensor * node = gf->nodes[i];
  4526. if (node->backend == GGML_BACKEND_GPU && node->extra == NULL) {
  4527. ggml_cuda_assign_scratch_offset(node, (char*)node->data - (char *) lctx.buf_alloc.data);
  4528. }
  4529. }
  4530. // HACK: ggml-alloc may change the tensor backend when reusing a parent, so force output to be on the CPU here if needed
  4531. if (!lctx.embedding.empty()) {
  4532. embeddings->backend = GGML_BACKEND_CPU;
  4533. }
  4534. res->backend = GGML_BACKEND_CPU;
  4535. #endif
  4536. // LLAMA_LOG_INFO("graph build time: %.3f ms (%d nodes, %d leafs)\n", (ggml_time_us() - t_start_us)/1000.0, gf->n_nodes, gf->n_leafs);
  4537. // for big prompts, if BLAS is enabled, it is better to use only one thread
  4538. // otherwise, the threads are spin-lock waiting for the BLAS calls and are degrading the performance
  4539. // TODO: this is mostly important for Apple Silicon where CBLAS is still performing very well
  4540. // we still need some threads to process all non-mul_mat ops, but not too much to avoid interfering
  4541. // with the BLAS calls. need a better solution
  4542. if (n_tokens >= 32 && ggml_cpu_has_blas() && !ggml_cpu_has_gpublas()) {
  4543. n_threads = std::min(4, n_threads);
  4544. }
  4545. const bool fully_offloaded = model.n_gpu_layers >= (int) hparams.n_layer + 3;
  4546. if (ggml_cpu_has_cublas() && fully_offloaded) {
  4547. n_threads = 1;
  4548. }
  4549. #if GGML_USE_MPI
  4550. const int64_t n_layer = hparams.n_layer;
  4551. ggml_mpi_graph_compute_pre(lctx.ctx_mpi, gf, n_layer);
  4552. #endif
  4553. #ifdef GGML_USE_METAL
  4554. if (lctx.ctx_metal) {
  4555. ggml_metal_set_n_cb (lctx.ctx_metal, n_threads);
  4556. ggml_metal_graph_compute(lctx.ctx_metal, gf);
  4557. } else {
  4558. ggml_graph_compute_helper(lctx.work_buffer, gf, n_threads);
  4559. }
  4560. #else
  4561. ggml_graph_compute_helper(lctx.work_buffer, gf, n_threads);
  4562. #endif
  4563. #if GGML_USE_MPI
  4564. ggml_mpi_graph_compute_post(lctx.ctx_mpi, gf, n_layer);
  4565. #endif
  4566. // update the kv ring buffer
  4567. {
  4568. if (kv_self.has_shift) {
  4569. kv_self.has_shift = false;
  4570. for (uint32_t i = 0; i < kv_self.size; ++i) {
  4571. kv_self.cells[i].delta = 0;
  4572. }
  4573. }
  4574. kv_self.head += n_tokens;
  4575. // Ensure kv cache head points to a valid index.
  4576. if (kv_self.head >= kv_self.size) {
  4577. kv_self.head = 0;
  4578. }
  4579. }
  4580. #ifdef GGML_PERF
  4581. // print timing information per ggml operation (for debugging purposes)
  4582. // requires GGML_PERF to be defined
  4583. ggml_graph_print(gf);
  4584. #endif
  4585. // plot the computation graph in dot format (for debugging purposes)
  4586. //if (n_past%100 == 0) {
  4587. // ggml_graph_dump_dot(gf, NULL, "llama.dot");
  4588. //}
  4589. // extract logits
  4590. // TODO: do not compute and extract logits if only embeddings are needed
  4591. // need to update the graphs to skip "result_output"
  4592. {
  4593. auto & logits_out = lctx.logits;
  4594. if (batch.logits) {
  4595. logits_out.resize(n_vocab * n_tokens);
  4596. for (uint32_t i = 0; i < n_tokens; i++) {
  4597. if (batch.logits[i] == 0) {
  4598. continue;
  4599. }
  4600. memcpy(logits_out.data() + (n_vocab*i), (float *) ggml_get_data(res) + (n_vocab*i), sizeof(float)*n_vocab);
  4601. }
  4602. } else if (lctx.logits_all) {
  4603. logits_out.resize(n_vocab * n_tokens);
  4604. memcpy(logits_out.data(), (float *) ggml_get_data(res), sizeof(float)*n_vocab*n_tokens);
  4605. } else {
  4606. logits_out.resize(n_vocab);
  4607. memcpy(logits_out.data(), (float *) ggml_get_data(res) + (n_vocab*(n_tokens - 1)), sizeof(float)*n_vocab);
  4608. }
  4609. }
  4610. // extract embeddings
  4611. if (!lctx.embedding.empty()) {
  4612. auto & embedding_out = lctx.embedding;
  4613. embedding_out.resize(n_embd);
  4614. memcpy(embedding_out.data(), (float *) ggml_get_data(embeddings) + (n_embd*(n_tokens - 1)), sizeof(float)*n_embd);
  4615. }
  4616. // measure the performance only for the single-token evals
  4617. if (n_tokens == 1) {
  4618. lctx.t_eval_us += ggml_time_us() - t_start_us;
  4619. lctx.n_eval++;
  4620. }
  4621. else if (n_tokens > 1) {
  4622. lctx.t_p_eval_us += ggml_time_us() - t_start_us;
  4623. lctx.n_p_eval += n_tokens;
  4624. }
  4625. // get a more accurate load time, upon first eval
  4626. // TODO: fix this
  4627. if (!lctx.has_evaluated_once) {
  4628. lctx.t_load_us = ggml_time_us() - lctx.t_start_us;
  4629. lctx.has_evaluated_once = true;
  4630. }
  4631. return 0;
  4632. }
  4633. //
  4634. // tokenizer
  4635. //
  4636. static enum llama_vocab_type llama_vocab_get_type(const llama_vocab & vocab) {
  4637. return vocab.type;
  4638. }
  4639. static bool llama_is_normal_token(const llama_vocab & vocab, llama_token id) {
  4640. return vocab.id_to_token[id].type == LLAMA_TOKEN_TYPE_NORMAL;
  4641. }
  4642. static bool llama_is_unknown_token(const llama_vocab & vocab, llama_token id) {
  4643. return vocab.id_to_token[id].type == LLAMA_TOKEN_TYPE_UNKNOWN;
  4644. }
  4645. static bool llama_is_control_token(const llama_vocab & vocab, llama_token id) {
  4646. return vocab.id_to_token[id].type == LLAMA_TOKEN_TYPE_CONTROL;
  4647. }
  4648. static bool llama_is_byte_token(const llama_vocab & vocab, llama_token id) {
  4649. return vocab.id_to_token[id].type == LLAMA_TOKEN_TYPE_BYTE;
  4650. }
  4651. static bool llama_is_user_defined_token(const llama_vocab& vocab, llama_token id) {
  4652. return vocab.id_to_token[id].type == LLAMA_TOKEN_TYPE_USER_DEFINED;
  4653. }
  4654. static uint8_t llama_token_to_byte(const llama_vocab& vocab, llama_token id) {
  4655. GGML_ASSERT(llama_is_byte_token(vocab, id));
  4656. const auto& token_data = vocab.id_to_token.at(id);
  4657. switch (llama_vocab_get_type(vocab)) {
  4658. case LLAMA_VOCAB_TYPE_SPM: {
  4659. auto buf = token_data.text.substr(3, 2);
  4660. return strtol(buf.c_str(), NULL, 16);
  4661. }
  4662. case LLAMA_VOCAB_TYPE_BPE: {
  4663. GGML_ASSERT(false);
  4664. return unicode_to_bytes_bpe(token_data.text);
  4665. }
  4666. default:
  4667. GGML_ASSERT(false);
  4668. }
  4669. }
  4670. static llama_token llama_byte_to_token(const llama_vocab & vocab, uint8_t ch) {
  4671. static const char * hex = "0123456789ABCDEF";
  4672. switch (llama_vocab_get_type(vocab)) {
  4673. case LLAMA_VOCAB_TYPE_SPM: {
  4674. const char buf[7] = { '<', '0', 'x', hex[ch >> 4], hex[ch & 15], '>', 0 };
  4675. return vocab.token_to_id.at(buf);
  4676. }
  4677. case LLAMA_VOCAB_TYPE_BPE: {
  4678. return vocab.token_to_id.at(bytes_to_unicode_bpe(ch));
  4679. }
  4680. default:
  4681. GGML_ASSERT(false);
  4682. }
  4683. }
  4684. static void llama_escape_whitespace(std::string & text) {
  4685. replace_all(text, " ", "\xe2\x96\x81");
  4686. }
  4687. static void llama_unescape_whitespace(std::string & word) {
  4688. replace_all(word, "\xe2\x96\x81", " ");
  4689. }
  4690. struct llm_symbol {
  4691. using index = int;
  4692. index prev;
  4693. index next;
  4694. const char * text;
  4695. size_t n;
  4696. };
  4697. static_assert(std::is_trivially_copyable<llm_symbol>::value, "llm_symbol is not trivially copyable");
  4698. // SPM tokenizer
  4699. // original implementation:
  4700. // https://github.com/ggerganov/llama.cpp/commit/074bea2eb1f1349a0118239c4152914aecaa1be4
  4701. struct llm_bigram_spm {
  4702. struct comparator {
  4703. bool operator()(llm_bigram_spm & l, llm_bigram_spm & r) {
  4704. return (l.score < r.score) || (l.score == r.score && l.left > r.left);
  4705. }
  4706. };
  4707. using queue_storage = std::vector<llm_bigram_spm>;
  4708. using queue = std::priority_queue<llm_bigram_spm, queue_storage, comparator>;
  4709. llm_symbol::index left;
  4710. llm_symbol::index right;
  4711. float score;
  4712. size_t size;
  4713. };
  4714. struct llm_tokenizer_spm {
  4715. llm_tokenizer_spm(const llama_vocab & vocab): vocab(vocab) {}
  4716. void tokenize(const std::string & text, std::vector<llama_vocab::id> & output) {
  4717. // split string into utf8 chars
  4718. int index = 0;
  4719. size_t offs = 0;
  4720. while (offs < text.size()) {
  4721. llm_symbol sym;
  4722. size_t len = utf8_len(text[offs]);
  4723. sym.text = text.c_str() + offs;
  4724. sym.n = std::min(len, text.size() - offs);
  4725. offs += sym.n;
  4726. sym.prev = index - 1;
  4727. sym.next = offs == text.size() ? -1 : index + 1;
  4728. index++;
  4729. symbols.emplace_back(sym);
  4730. }
  4731. // seed the work queue with all possible 2-character tokens.
  4732. for (size_t i = 1; i < symbols.size(); ++i) {
  4733. try_add_bigram(i - 1, i);
  4734. }
  4735. // keep substituting the highest frequency pairs for as long as we can.
  4736. while (!work_queue.empty()) {
  4737. auto bigram = work_queue.top();
  4738. work_queue.pop();
  4739. auto & left_sym = symbols[bigram.left];
  4740. auto & right_sym = symbols[bigram.right];
  4741. // if one of the symbols already got merged, skip it.
  4742. if (left_sym.n == 0 || right_sym.n == 0 ||
  4743. left_sym.n + right_sym.n != bigram.size) {
  4744. continue;
  4745. }
  4746. // merge the right sym into the left one
  4747. left_sym.n += right_sym.n;
  4748. right_sym.n = 0;
  4749. //LLAMA_LOG_INFO("left = '%*s' size = %zu\n", (int) left_sym.n, left_sym.text, bigram.size);
  4750. // remove the right sym from the chain
  4751. left_sym.next = right_sym.next;
  4752. if (right_sym.next >= 0) {
  4753. symbols[right_sym.next].prev = bigram.left;
  4754. }
  4755. // find more substitutions
  4756. try_add_bigram(left_sym.prev, bigram.left);
  4757. try_add_bigram(bigram.left, left_sym.next);
  4758. }
  4759. for (int i = 0; i != -1; i = symbols[i].next) {
  4760. auto & symbol = symbols[i];
  4761. resegment(symbol, output);
  4762. }
  4763. }
  4764. private:
  4765. void resegment(llm_symbol & symbol, std::vector<llama_vocab::id> & output) {
  4766. auto text = std::string(symbol.text, symbol.n);
  4767. auto token = vocab.token_to_id.find(text);
  4768. // Do we need to support is_unused?
  4769. if (token != vocab.token_to_id.end()) {
  4770. output.push_back((*token).second);
  4771. return;
  4772. }
  4773. const auto p = rev_merge.find(text);
  4774. if (p == rev_merge.end()) {
  4775. // output any symbols that did not form tokens as bytes.
  4776. for (int j = 0; j < (int)symbol.n; ++j) {
  4777. llama_vocab::id token_id = llama_byte_to_token(vocab, symbol.text[j]);
  4778. output.push_back(token_id);
  4779. }
  4780. return;
  4781. }
  4782. resegment(symbols[p->second.first], output);
  4783. resegment(symbols[p->second.second], output);
  4784. }
  4785. void try_add_bigram(int left, int right) {
  4786. if (left == -1 || right == -1) {
  4787. return;
  4788. }
  4789. const std::string text = std::string(symbols[left].text, symbols[left].n + symbols[right].n);
  4790. auto token = vocab.token_to_id.find(text);
  4791. if (token == vocab.token_to_id.end()) {
  4792. return;
  4793. }
  4794. if (static_cast<size_t>((*token).second) >= vocab.id_to_token.size()) {
  4795. return;
  4796. }
  4797. const auto & tok_data = vocab.id_to_token[(*token).second];
  4798. llm_bigram_spm bigram;
  4799. bigram.left = left;
  4800. bigram.right = right;
  4801. bigram.score = tok_data.score;
  4802. bigram.size = text.size();
  4803. work_queue.push(bigram);
  4804. // Do we need to support is_unused?
  4805. rev_merge[text] = std::make_pair(left, right);
  4806. }
  4807. const llama_vocab & vocab;
  4808. std::vector<llm_symbol> symbols;
  4809. llm_bigram_spm::queue work_queue;
  4810. std::map<std::string, std::pair<int, int>> rev_merge;
  4811. };
  4812. // BPE tokenizer
  4813. // adapted from https://github.com/cmp-nct/ggllm.cpp [MIT License]
  4814. // tried to simplify unicode stuff, so most likely does not work 100% correctly!
  4815. // TODO: there are a lot of common parts between spm and bpe tokenizers, should be refactored and reused
  4816. struct llm_bigram_bpe {
  4817. struct comparator {
  4818. bool operator()(const llm_bigram_bpe & l, const llm_bigram_bpe & r) const {
  4819. return l.rank > r.rank || (l.rank == r.rank && l.left > r.left);
  4820. }
  4821. };
  4822. using queue_storage = std::vector<llm_bigram_bpe>;
  4823. using queue = std::priority_queue<llm_bigram_bpe, queue_storage, comparator>;
  4824. llm_symbol::index left;
  4825. llm_symbol::index right;
  4826. std::string text;
  4827. int rank;
  4828. size_t size;
  4829. };
  4830. struct llm_tokenizer_bpe {
  4831. llm_tokenizer_bpe(const llama_vocab & vocab): vocab(vocab) {}
  4832. void tokenize(const std::string & text, std::vector<llama_vocab::id> & output) {
  4833. int final_prev_index = -1;
  4834. auto word_collection = bpe_gpt2_preprocess(text);
  4835. symbols_final.clear();
  4836. for (auto & word : word_collection) {
  4837. work_queue = llm_bigram_bpe::queue();
  4838. symbols.clear();
  4839. int index = 0;
  4840. size_t offset = 0;
  4841. while (offset < word.size()) {
  4842. llm_symbol sym;
  4843. size_t char_len = std::min(word.size() - offset, (size_t) ::utf8_len(word[offset]));
  4844. sym.text = word.c_str() + offset;
  4845. sym.n = char_len;
  4846. offset += sym.n;
  4847. sym.prev = index - 1;
  4848. sym.next = offset == word.size() ? -1 : index + 1;
  4849. index++;
  4850. symbols.emplace_back(sym);
  4851. }
  4852. for (size_t i = 1; i < symbols.size(); ++i) {
  4853. add_new_bigram(i - 1, i);
  4854. }
  4855. // build token(s)
  4856. while (!work_queue.empty()) {
  4857. auto bigram = work_queue.top();
  4858. work_queue.pop();
  4859. auto & left_symbol = symbols[bigram.left];
  4860. auto & right_symbol = symbols[bigram.right];
  4861. if (left_symbol.n == 0 || right_symbol.n == 0) {
  4862. continue;
  4863. }
  4864. std::string left_token = std::string(left_symbol.text, left_symbol.n);
  4865. std::string right_token = std::string(right_symbol.text, right_symbol.n);
  4866. if (left_token + right_token != bigram.text) {
  4867. continue; // Skip this bigram if it's outdated
  4868. }
  4869. // merge the right sym into the left one
  4870. left_symbol.n += right_symbol.n;
  4871. right_symbol.n = 0;
  4872. // remove the right sym from the chain
  4873. left_symbol.next = right_symbol.next;
  4874. if (right_symbol.next >= 0) {
  4875. symbols[right_symbol.next].prev = bigram.left;
  4876. }
  4877. add_new_bigram(left_symbol.prev, bigram.left); // left side of current symbol
  4878. add_new_bigram(bigram.left, left_symbol.next); // right side of current symbol
  4879. }
  4880. // add the fnished tokens to the final list keeping correct order for next and prev
  4881. for (auto & sym : symbols) {
  4882. if (sym.n > 0) {
  4883. sym.prev = final_prev_index;
  4884. sym.next = -1;
  4885. if (final_prev_index != -1) {
  4886. symbols_final[final_prev_index].next = symbols_final.size();
  4887. }
  4888. symbols_final.emplace_back(sym);
  4889. final_prev_index = symbols_final.size() - 1;
  4890. }
  4891. }
  4892. }
  4893. symbols = symbols_final;
  4894. if (!symbols.empty()) {
  4895. for (int i = 0; i != -1; i = symbols[i].next) {
  4896. auto & symbol = symbols[i];
  4897. if (symbol.n == 0) {
  4898. continue;
  4899. }
  4900. const std::string str = std::string(symbol.text, symbol.n);
  4901. const auto token = vocab.token_to_id.find(str);
  4902. if (token == vocab.token_to_id.end()) {
  4903. for (auto j = str.begin(); j != str.end(); ++j) {
  4904. std::string byte_str(1, *j);
  4905. auto token_multibyte = vocab.token_to_id.find(byte_str);
  4906. if (token_multibyte == vocab.token_to_id.end()) {
  4907. throw std::runtime_error("ERROR: byte not found in vocab");
  4908. }
  4909. output.push_back((*token_multibyte).second);
  4910. }
  4911. } else {
  4912. output.push_back((*token).second);
  4913. }
  4914. }
  4915. }
  4916. }
  4917. private:
  4918. void add_new_bigram(int left, int right) {
  4919. if (left == -1 || right == -1) {
  4920. return;
  4921. }
  4922. std::string left_token = std::string(symbols[left].text, symbols[left].n);
  4923. std::string right_token = std::string(symbols[right].text, symbols[right].n);
  4924. int rank_found = -1;
  4925. rank_found = vocab.find_bpe_rank(left_token, right_token);
  4926. if (rank_found < 0) {
  4927. return;
  4928. }
  4929. llm_bigram_bpe bigram;
  4930. bigram.left = left;
  4931. bigram.right = right;
  4932. bigram.text = left_token + right_token;
  4933. bigram.size = left_token.size() + right_token.size();
  4934. bigram.rank = rank_found;
  4935. work_queue.push(bigram);
  4936. }
  4937. std::vector<std::string> bpe_gpt2_preprocess(const std::string & text) {
  4938. std::vector<std::string> bpe_words;
  4939. std::vector<std::string> bpe_encoded_words;
  4940. std::string token = "";
  4941. // GPT2 system regex: 's|'t|'re|'ve|'m|'ll|'d| ?\p{L}+| ?\p{N}+| ?[^\s\p{L}\p{N}]+|\s+(?!\S)|\s+
  4942. bool collecting_numeric = false;
  4943. bool collecting_letter = false;
  4944. bool collecting_special = false;
  4945. bool collecting_whitespace_lookahead = false;
  4946. bool collecting = false;
  4947. std::vector<std::string> text_utf;
  4948. text_utf.reserve(text.size());
  4949. bpe_words.reserve(text.size());
  4950. bpe_encoded_words.reserve(text.size());
  4951. auto cps = codepoints_from_utf8(text);
  4952. for (size_t i = 0; i < cps.size(); ++i)
  4953. text_utf.emplace_back(codepoint_to_utf8(cps[i]));
  4954. for (int i = 0; i < (int)text_utf.size(); i++) {
  4955. const std::string & utf_char = text_utf[i];
  4956. bool split_condition = false;
  4957. int bytes_remain = text_utf.size() - i;
  4958. // forward backward lookups
  4959. const std::string & utf_char_next = (i + 1 < (int)text_utf.size()) ? text_utf[i + 1] : "";
  4960. const std::string & utf_char_next_next = (i + 2 < (int)text_utf.size()) ? text_utf[i + 2] : "";
  4961. // handling contractions
  4962. if (!split_condition && bytes_remain >= 2) {
  4963. // 's|'t|'m|'d
  4964. if (utf_char == "\'" && (utf_char_next == "s" || utf_char_next == "t" || utf_char_next == "m" || utf_char_next == "d")) {
  4965. split_condition = true;
  4966. }
  4967. if (split_condition) {
  4968. if (token.size()) {
  4969. bpe_words.emplace_back(token); // push previous content as token
  4970. }
  4971. token = utf_char + utf_char_next;
  4972. bpe_words.emplace_back(token);
  4973. token = "";
  4974. i++;
  4975. continue;
  4976. }
  4977. }
  4978. if (!split_condition && bytes_remain >= 3) {
  4979. // 're|'ve|'ll
  4980. if (utf_char == "\'" && (
  4981. (utf_char_next == "r" && utf_char_next_next == "e") ||
  4982. (utf_char_next == "v" && utf_char_next_next == "e") ||
  4983. (utf_char_next == "l" && utf_char_next_next == "l"))
  4984. ) {
  4985. split_condition = true;
  4986. }
  4987. if (split_condition) {
  4988. // current token + next token can be defined
  4989. if (token.size()) {
  4990. bpe_words.emplace_back(token); // push previous content as token
  4991. }
  4992. token = utf_char + utf_char_next + utf_char_next_next;
  4993. bpe_words.emplace_back(token); // the contraction
  4994. token = "";
  4995. i += 2;
  4996. continue;
  4997. }
  4998. }
  4999. if (!split_condition && !collecting) {
  5000. if (codepoint_type(utf_char) == CODEPOINT_TYPE_LETTER || (!token.size() && utf_char == " " && codepoint_type(utf_char_next) == CODEPOINT_TYPE_LETTER)) {
  5001. collecting_letter = true;
  5002. collecting = true;
  5003. }
  5004. else if (codepoint_type(utf_char) == CODEPOINT_TYPE_DIGIT || (!token.size() && utf_char == " " && codepoint_type(utf_char_next) == CODEPOINT_TYPE_DIGIT)) {
  5005. collecting_numeric = true;
  5006. collecting = true;
  5007. }
  5008. else if (
  5009. ((codepoint_type(utf_char) != CODEPOINT_TYPE_LETTER && codepoint_type(utf_char) != CODEPOINT_TYPE_DIGIT) && (codepoint_type(utf_char) != CODEPOINT_TYPE_WHITESPACE)) ||
  5010. (!token.size() && utf_char == " " && codepoint_type(utf_char_next) != CODEPOINT_TYPE_LETTER && codepoint_type(utf_char_next) != CODEPOINT_TYPE_DIGIT && codepoint_type(utf_char_next) != CODEPOINT_TYPE_WHITESPACE)
  5011. ) {
  5012. collecting_special = true;
  5013. collecting = true;
  5014. }
  5015. else if (codepoint_type(utf_char) == CODEPOINT_TYPE_WHITESPACE && codepoint_type(utf_char_next) == CODEPOINT_TYPE_WHITESPACE) {
  5016. collecting_whitespace_lookahead = true;
  5017. collecting = true;
  5018. }
  5019. else if (codepoint_type(utf_char) == CODEPOINT_TYPE_WHITESPACE) {
  5020. split_condition = true;
  5021. }
  5022. }
  5023. else if (!split_condition && collecting) {
  5024. if (collecting_letter && codepoint_type(utf_char) != CODEPOINT_TYPE_LETTER) {
  5025. split_condition = true;
  5026. }
  5027. else if (collecting_numeric && codepoint_type(utf_char) != CODEPOINT_TYPE_DIGIT) {
  5028. split_condition = true;
  5029. }
  5030. else if (collecting_special && (codepoint_type(utf_char) == CODEPOINT_TYPE_LETTER || codepoint_type(utf_char) == CODEPOINT_TYPE_DIGIT || codepoint_type(utf_char) == CODEPOINT_TYPE_WHITESPACE)) {
  5031. split_condition = true;
  5032. }
  5033. else if (collecting_whitespace_lookahead && (codepoint_type(utf_char_next) == CODEPOINT_TYPE_LETTER || codepoint_type(utf_char_next) == CODEPOINT_TYPE_DIGIT)) {
  5034. split_condition = true;
  5035. }
  5036. }
  5037. if (utf_char_next == "") {
  5038. split_condition = true; // final
  5039. token += utf_char;
  5040. }
  5041. if (split_condition) {
  5042. if (token.size()) {
  5043. bpe_words.emplace_back(token);
  5044. }
  5045. token = utf_char;
  5046. collecting = false;
  5047. collecting_letter = false;
  5048. collecting_numeric = false;
  5049. collecting_special = false;
  5050. collecting_whitespace_lookahead = false;
  5051. }
  5052. else {
  5053. token += utf_char;
  5054. }
  5055. }
  5056. for (std::string & word : bpe_words) {
  5057. std::string encoded_token = "";
  5058. for (char & c : word) {
  5059. encoded_token += bytes_to_unicode_bpe(c);
  5060. }
  5061. bpe_encoded_words.emplace_back(encoded_token);
  5062. }
  5063. return bpe_encoded_words;
  5064. }
  5065. const llama_vocab & vocab;
  5066. std::vector<llm_symbol> symbols;
  5067. std::vector<llm_symbol> symbols_final;
  5068. llm_bigram_bpe::queue work_queue;
  5069. };
  5070. typedef enum FRAGMENT_BUFFER_VARIANT_TYPE{
  5071. FRAGMENT_BUFFER_VARIANT_TYPE_TOKEN,
  5072. FRAGMENT_BUFFER_VARIANT_TYPE_RAW_TEXT
  5073. } FRAGMENT_BUFFER_VARIANT_TYPE;
  5074. struct fragment_buffer_variant{
  5075. fragment_buffer_variant(llama_vocab::id _token)
  5076. :
  5077. type(FRAGMENT_BUFFER_VARIANT_TYPE_TOKEN),
  5078. token(_token),
  5079. raw_text(_dummy),
  5080. offset(0),
  5081. length(0){}
  5082. fragment_buffer_variant(const std::string & _raw_text, int64_t _offset, int64_t _length)
  5083. :
  5084. type(FRAGMENT_BUFFER_VARIANT_TYPE_RAW_TEXT),
  5085. token((llama_vocab::id)-1),
  5086. raw_text(_raw_text),
  5087. offset(_offset),
  5088. length(_length){
  5089. GGML_ASSERT( _offset >= 0 );
  5090. GGML_ASSERT( _length >= 1 );
  5091. GGML_ASSERT( offset + length <= raw_text.length() );
  5092. }
  5093. const FRAGMENT_BUFFER_VARIANT_TYPE type;
  5094. const llama_vocab::id token;
  5095. const std::string _dummy;
  5096. const std::string & raw_text;
  5097. const uint64_t offset;
  5098. const uint64_t length;
  5099. };
  5100. // #define PRETOKENIZERDEBUG
  5101. static void tokenizer_st_partition(const llama_vocab & vocab, std::forward_list<fragment_buffer_variant> & buffer)
  5102. {
  5103. // for each special token
  5104. for (const auto & st: vocab.special_tokens_cache) {
  5105. const auto & special_token = st.first;
  5106. const auto & special_id = st.second;
  5107. // for each text fragment
  5108. std::forward_list<fragment_buffer_variant>::iterator it = buffer.begin();
  5109. while (it != buffer.end()) {
  5110. auto & fragment = (*it);
  5111. // if a fragment is text ( not yet processed )
  5112. if (fragment.type == FRAGMENT_BUFFER_VARIANT_TYPE_RAW_TEXT) {
  5113. auto * raw_text = &(fragment.raw_text);
  5114. auto raw_text_base_offset = fragment.offset;
  5115. auto raw_text_base_length = fragment.length;
  5116. // loop over the text
  5117. while (true) {
  5118. // find the first occurence of a given special token in this fragment
  5119. // passing offset argument only limit the "search area" but match coordinates
  5120. // are still relative to the source full raw_text
  5121. auto match = raw_text->find(special_token, raw_text_base_offset);
  5122. // no occurences found, stop processing this fragment for a given special token
  5123. if (match == std::string::npos) break;
  5124. // check if match is within bounds of offset <-> length
  5125. if (match + special_token.length() > raw_text_base_offset + raw_text_base_length) break;
  5126. #ifdef PRETOKENIZERDEBUG
  5127. fprintf(stderr, "FF: (%ld %ld %ld) '%s'\n", raw_text->length(), raw_text_base_offset, raw_text_base_length, raw_text->substr(raw_text_base_offset, raw_text_base_length).c_str());
  5128. #endif
  5129. auto source = std::distance(buffer.begin(), it);
  5130. // if match is further than base offset
  5131. // then we have some text to the left of it
  5132. if (match > raw_text_base_offset) {
  5133. // left
  5134. const int64_t left_reminder_offset = raw_text_base_offset + 0;
  5135. const int64_t left_reminder_length = match - raw_text_base_offset;
  5136. buffer.emplace_after(it, (*raw_text), left_reminder_offset, left_reminder_length);
  5137. #ifdef PRETOKENIZERDEBUG
  5138. fprintf(stderr, "FL: (%ld %ld) '%s'\n", left_reminder_offset, left_reminder_length, raw_text->substr(left_reminder_offset, left_reminder_length).c_str());
  5139. #endif
  5140. it++;
  5141. }
  5142. // special token
  5143. buffer.emplace_after(it, special_id);
  5144. it++;
  5145. // right
  5146. if (match + special_token.length() < raw_text_base_offset + raw_text_base_length) {
  5147. const int64_t right_reminder_offset = match + special_token.length();
  5148. const int64_t right_reminder_length = raw_text_base_length - ((match - raw_text_base_offset) + special_token.length());
  5149. buffer.emplace_after(it, (*raw_text), right_reminder_offset, right_reminder_length);
  5150. #ifdef PRETOKENIZERDEBUG
  5151. fprintf(stderr, "FR: (%ld %ld) '%s'\n", right_reminder_offset, right_reminder_length, raw_text->substr(right_reminder_offset, right_reminder_length).c_str());
  5152. #endif
  5153. it++;
  5154. if (source == 0) {
  5155. buffer.erase_after(buffer.before_begin());
  5156. } else {
  5157. buffer.erase_after(std::next(buffer.begin(), (source-1)));
  5158. }
  5159. // repeat for the right side
  5160. raw_text_base_offset = right_reminder_offset;
  5161. raw_text_base_length = right_reminder_length;
  5162. #ifdef PRETOKENIZERDEBUG
  5163. fprintf(stderr, "RR: (%ld %ld) '%s'\n", raw_text_base_offset, raw_text_base_length, raw_text->substr(raw_text_base_offset, raw_text_base_length).c_str());
  5164. #endif
  5165. } else {
  5166. if (source == 0) {
  5167. buffer.erase_after(buffer.before_begin());
  5168. } else {
  5169. buffer.erase_after(std::next(buffer.begin(), (source-1)));
  5170. }
  5171. break;
  5172. }
  5173. }
  5174. }
  5175. it++;
  5176. }
  5177. }
  5178. }
  5179. static std::vector<llama_vocab::id> llama_tokenize_internal(const llama_vocab & vocab, std::string raw_text, bool bos, bool special) {
  5180. std::vector<llama_vocab::id> output;
  5181. // OG tokenizer behavior:
  5182. //
  5183. // tokenizer.encode('', add_bos=True) returns [1]
  5184. // tokenizer.encode('', add_bos=False) returns []
  5185. if (bos && vocab.special_bos_id != -1) {
  5186. output.push_back(vocab.special_bos_id);
  5187. }
  5188. if (raw_text.empty()) {
  5189. return output;
  5190. }
  5191. std::forward_list<fragment_buffer_variant> fragment_buffer;
  5192. fragment_buffer.emplace_front( raw_text, 0, raw_text.length() );
  5193. if (special) tokenizer_st_partition( vocab, fragment_buffer );
  5194. switch (vocab.type) {
  5195. case LLAMA_VOCAB_TYPE_SPM:
  5196. {
  5197. for (const auto & fragment: fragment_buffer)
  5198. {
  5199. if (fragment.type == FRAGMENT_BUFFER_VARIANT_TYPE_RAW_TEXT)
  5200. {
  5201. // without adding this leading whitespace, we do not get the same results as the original tokenizer
  5202. // TODO: It's likely possible to get rid of this string copy entirely
  5203. // by modifying llm_tokenizer_x to operate with string offsets like pre-tokenizer
  5204. // and passing 'add space prefix' as bool argument
  5205. //
  5206. auto raw_text = fragment.raw_text.substr(fragment.offset, fragment.length);
  5207. if (&fragment == &fragment_buffer.front()) {
  5208. raw_text = " " + raw_text; // prefix with space if the first token is not special
  5209. }
  5210. #ifdef PRETOKENIZERDEBUG
  5211. fprintf(stderr,"TT: (%ld %ld %ld) '%s'\n", raw_text.length(), fragment.offset, fragment.length, raw_text.c_str());
  5212. #endif
  5213. llm_tokenizer_spm tokenizer(vocab);
  5214. llama_escape_whitespace(raw_text);
  5215. tokenizer.tokenize(raw_text, output);
  5216. }
  5217. else // if (fragment.type == FRAGMENT_BUFFER_VARIANT_TYPE_TOKEN)
  5218. {
  5219. output.push_back(fragment.token);
  5220. }
  5221. }
  5222. } break;
  5223. case LLAMA_VOCAB_TYPE_BPE:
  5224. {
  5225. for (const auto & fragment: fragment_buffer)
  5226. {
  5227. if (fragment.type == FRAGMENT_BUFFER_VARIANT_TYPE_RAW_TEXT)
  5228. {
  5229. auto raw_text = fragment.raw_text.substr(fragment.offset, fragment.length);
  5230. #ifdef PRETOKENIZERDEBUG
  5231. fprintf(stderr,"TT: (%ld %ld %ld) '%s'\n", raw_text.length(), fragment.offset, fragment.length, raw_text.c_str());
  5232. #endif
  5233. llm_tokenizer_bpe tokenizer(vocab);
  5234. tokenizer.tokenize(raw_text, output);
  5235. }
  5236. else // if (fragment.type == FRAGMENT_BUFFER_VARIANT_TYPE_TOKEN)
  5237. {
  5238. output.push_back(fragment.token);
  5239. }
  5240. }
  5241. } break;
  5242. }
  5243. return output;
  5244. }
  5245. //
  5246. // grammar - internal
  5247. //
  5248. struct llama_partial_utf8 {
  5249. uint32_t value; // bit value so far (unshifted)
  5250. int n_remain; // num bytes remaining; -1 indicates invalid sequence
  5251. };
  5252. struct llama_grammar {
  5253. const std::vector<std::vector<llama_grammar_element>> rules;
  5254. std::vector<std::vector<const llama_grammar_element *>> stacks;
  5255. // buffer for partially generated UTF-8 sequence from accepted tokens
  5256. llama_partial_utf8 partial_utf8;
  5257. };
  5258. struct llama_grammar_candidate {
  5259. size_t index;
  5260. const uint32_t * code_points;
  5261. llama_partial_utf8 partial_utf8;
  5262. };
  5263. // Decodes a UTF-8 string which may end in an incomplete sequence. Adds a terminating 0 for use as
  5264. // pointer. If an invalid sequence is encountered, returns `llama_partial_utf8.n_remain == -1`.
  5265. static std::pair<std::vector<uint32_t>, llama_partial_utf8> decode_utf8(
  5266. const char * src,
  5267. size_t n_src,
  5268. llama_partial_utf8 partial_start) {
  5269. static const int lookup[] = { 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 2, 2, 3, 4 };
  5270. const char * pos = src;
  5271. std::vector<uint32_t> code_points;
  5272. // common english strings have the same number of codepoints and bytes. `+ 1` for the terminating 0.
  5273. code_points.reserve(n_src + 1);
  5274. uint32_t value = partial_start.value;
  5275. int n_remain = partial_start.n_remain;
  5276. // continue previous decode, if applicable
  5277. while (*pos != 0 && n_remain > 0) {
  5278. uint8_t next_byte = static_cast<uint8_t>(*pos);
  5279. if ((next_byte >> 6) != 2) {
  5280. // invalid sequence, abort
  5281. code_points.push_back(0);
  5282. return std::make_pair(std::move(code_points), llama_partial_utf8{ 0, -1 });
  5283. }
  5284. value = (value << 6) + (next_byte & 0x3F);
  5285. ++pos;
  5286. --n_remain;
  5287. }
  5288. if (partial_start.n_remain > 0 && n_remain == 0) {
  5289. code_points.push_back(value);
  5290. }
  5291. // decode any subsequent utf-8 sequences, which may end in an incomplete one
  5292. while (*pos != 0) {
  5293. uint8_t first_byte = static_cast<uint8_t>(*pos);
  5294. uint8_t highbits = first_byte >> 4;
  5295. n_remain = lookup[highbits] - 1;
  5296. if (n_remain < 0) {
  5297. // invalid sequence, abort
  5298. code_points.clear();
  5299. code_points.push_back(0);
  5300. return std::make_pair(std::move(code_points), llama_partial_utf8{ 0, n_remain });
  5301. }
  5302. uint8_t mask = (1 << (7 - n_remain)) - 1;
  5303. value = first_byte & mask;
  5304. ++pos;
  5305. while (*pos != 0 && n_remain > 0) {
  5306. value = (value << 6) + (static_cast<uint8_t>(*pos) & 0x3F);
  5307. ++pos;
  5308. --n_remain;
  5309. }
  5310. if (n_remain == 0) {
  5311. code_points.push_back(value);
  5312. }
  5313. }
  5314. code_points.push_back(0);
  5315. return std::make_pair(std::move(code_points), llama_partial_utf8{ value, n_remain });
  5316. }
  5317. static std::pair<std::vector<uint32_t>, llama_partial_utf8> decode_utf8(
  5318. std::string src,
  5319. llama_partial_utf8 partial_start
  5320. ) {
  5321. return decode_utf8(src.c_str(), src.size(), partial_start);
  5322. }
  5323. // returns true iff pos points to the end of one of the definitions of a rule
  5324. static bool llama_grammar_is_end_of_sequence(const llama_grammar_element * pos) {
  5325. switch (pos->type) {
  5326. case LLAMA_GRETYPE_END: return true; // NOLINT
  5327. case LLAMA_GRETYPE_ALT: return true; // NOLINT
  5328. default: return false;
  5329. }
  5330. }
  5331. // returns true iff chr satisfies the char range at pos (regular or inverse range)
  5332. // asserts that pos is pointing to a char range element
  5333. static std::pair<bool, const llama_grammar_element *> llama_grammar_match_char(
  5334. const llama_grammar_element * pos,
  5335. const uint32_t chr) {
  5336. bool found = false;
  5337. bool is_positive_char = pos->type == LLAMA_GRETYPE_CHAR;
  5338. GGML_ASSERT(is_positive_char || pos->type == LLAMA_GRETYPE_CHAR_NOT); // NOLINT
  5339. do {
  5340. if (pos[1].type == LLAMA_GRETYPE_CHAR_RNG_UPPER) {
  5341. // inclusive range, e.g. [a-z]
  5342. found = found || (pos->value <= chr && chr <= pos[1].value);
  5343. pos += 2;
  5344. } else {
  5345. // exact char match, e.g. [a] or "a"
  5346. found = found || pos->value == chr;
  5347. pos += 1;
  5348. }
  5349. } while (pos->type == LLAMA_GRETYPE_CHAR_ALT);
  5350. return std::make_pair(found == is_positive_char, pos);
  5351. }
  5352. // returns true iff some continuation of the given partial UTF-8 sequence could satisfy the char
  5353. // range at pos (regular or inverse range)
  5354. // asserts that pos is pointing to a char range element
  5355. static bool llama_grammar_match_partial_char(
  5356. const llama_grammar_element * pos,
  5357. const llama_partial_utf8 partial_utf8) {
  5358. bool is_positive_char = pos->type == LLAMA_GRETYPE_CHAR;
  5359. GGML_ASSERT(is_positive_char || pos->type == LLAMA_GRETYPE_CHAR_NOT);
  5360. uint32_t partial_value = partial_utf8.value;
  5361. int n_remain = partial_utf8.n_remain;
  5362. // invalid sequence or 7-bit char split across 2 bytes (overlong)
  5363. if (n_remain < 0 || (n_remain == 1 && partial_value < 2)) {
  5364. return false;
  5365. }
  5366. // range of possible code points this partial UTF-8 sequence could complete to
  5367. uint32_t low = partial_value << (n_remain * 6);
  5368. uint32_t high = low | ((1 << (n_remain * 6)) - 1);
  5369. if (low == 0) {
  5370. if (n_remain == 2) {
  5371. low = 1 << 11;
  5372. } else if (n_remain == 3) {
  5373. low = 1 << 16;
  5374. }
  5375. }
  5376. do {
  5377. if (pos[1].type == LLAMA_GRETYPE_CHAR_RNG_UPPER) {
  5378. // inclusive range, e.g. [a-z]
  5379. if (pos->value <= high && low <= pos[1].value) {
  5380. return is_positive_char;
  5381. }
  5382. pos += 2;
  5383. } else {
  5384. // exact char match, e.g. [a] or "a"
  5385. if (low <= pos->value && pos->value <= high) {
  5386. return is_positive_char;
  5387. }
  5388. pos += 1;
  5389. }
  5390. } while (pos->type == LLAMA_GRETYPE_CHAR_ALT);
  5391. return !is_positive_char;
  5392. }
  5393. // transforms a grammar pushdown stack into N possible stacks, all ending
  5394. // at a character range (terminal element)
  5395. static void llama_grammar_advance_stack(
  5396. const std::vector<std::vector<llama_grammar_element>> & rules,
  5397. const std::vector<const llama_grammar_element *> & stack,
  5398. std::vector<std::vector<const llama_grammar_element *>> & new_stacks) {
  5399. if (stack.empty()) {
  5400. new_stacks.emplace_back(stack);
  5401. return;
  5402. }
  5403. const llama_grammar_element * pos = stack.back();
  5404. switch (pos->type) {
  5405. case LLAMA_GRETYPE_RULE_REF: {
  5406. const size_t rule_id = static_cast<size_t>(pos->value);
  5407. const llama_grammar_element * subpos = rules[rule_id].data();
  5408. do {
  5409. // init new stack without the top (pos)
  5410. std::vector<const llama_grammar_element *> new_stack(stack.begin(), stack.end() - 1);
  5411. if (!llama_grammar_is_end_of_sequence(pos + 1)) {
  5412. // if this rule ref is followed by another element, add that to stack
  5413. new_stack.push_back(pos + 1);
  5414. }
  5415. if (!llama_grammar_is_end_of_sequence(subpos)) {
  5416. // if alternate is nonempty, add to stack
  5417. new_stack.push_back(subpos);
  5418. }
  5419. llama_grammar_advance_stack(rules, new_stack, new_stacks);
  5420. while (!llama_grammar_is_end_of_sequence(subpos)) {
  5421. // scan to end of alternate def
  5422. subpos++;
  5423. }
  5424. if (subpos->type == LLAMA_GRETYPE_ALT) {
  5425. // there's another alternate def of this rule to process
  5426. subpos++;
  5427. } else {
  5428. break;
  5429. }
  5430. } while (true);
  5431. break;
  5432. }
  5433. case LLAMA_GRETYPE_CHAR:
  5434. case LLAMA_GRETYPE_CHAR_NOT:
  5435. new_stacks.emplace_back(stack);
  5436. break;
  5437. default:
  5438. // end of alternate (LLAMA_GRETYPE_END, LLAMA_GRETYPE_ALT) or middle of char range
  5439. // (LLAMA_GRETYPE_CHAR_ALT, LLAMA_GRETYPE_CHAR_RNG_UPPER); stack should never be left on
  5440. // those
  5441. GGML_ASSERT(false);
  5442. }
  5443. }
  5444. // takes a set of possible pushdown stacks on a grammar, which are required to
  5445. // be positioned at a character range (see `llama_grammar_advance_stack`), and
  5446. // produces the N possible stacks if the given char is accepted at those
  5447. // positions
  5448. static std::vector<std::vector<const llama_grammar_element *>> llama_grammar_accept(
  5449. const std::vector<std::vector<llama_grammar_element>> & rules,
  5450. const std::vector<std::vector<const llama_grammar_element *>> & stacks,
  5451. const uint32_t chr) {
  5452. std::vector<std::vector<const llama_grammar_element *>> new_stacks;
  5453. for (const auto & stack : stacks) {
  5454. if (stack.empty()) {
  5455. continue;
  5456. }
  5457. auto match = llama_grammar_match_char(stack.back(), chr);
  5458. if (match.first) {
  5459. const llama_grammar_element * pos = match.second;
  5460. // update top of stack to next element, if any
  5461. std::vector<const llama_grammar_element *> new_stack(stack.begin(), stack.end() - 1);
  5462. if (!llama_grammar_is_end_of_sequence(pos)) {
  5463. new_stack.push_back(pos);
  5464. }
  5465. llama_grammar_advance_stack(rules, new_stack, new_stacks);
  5466. }
  5467. }
  5468. return new_stacks;
  5469. }
  5470. static std::vector<llama_grammar_candidate> llama_grammar_reject_candidates(
  5471. const std::vector<std::vector<llama_grammar_element>> & rules,
  5472. const std::vector<std::vector<const llama_grammar_element *>> & stacks,
  5473. const std::vector<llama_grammar_candidate> & candidates);
  5474. static std::vector<llama_grammar_candidate> llama_grammar_reject_candidates_for_stack(
  5475. const std::vector<std::vector<llama_grammar_element>> & rules,
  5476. const std::vector<const llama_grammar_element *> & stack,
  5477. const std::vector<llama_grammar_candidate> & candidates) {
  5478. std::vector<llama_grammar_candidate> rejects;
  5479. if (stack.empty()) {
  5480. for (const auto & tok : candidates) {
  5481. if (*tok.code_points != 0 || tok.partial_utf8.n_remain != 0) {
  5482. rejects.push_back(tok);
  5483. }
  5484. }
  5485. return rejects;
  5486. }
  5487. const llama_grammar_element * stack_pos = stack.back();
  5488. std::vector<llama_grammar_candidate> next_candidates;
  5489. for (const auto & tok : candidates) {
  5490. if (*tok.code_points == 0) {
  5491. // reached end of full codepoints in token, reject iff it ended in a partial sequence
  5492. // that cannot satisfy this position in grammar
  5493. if (tok.partial_utf8.n_remain != 0 &&
  5494. !llama_grammar_match_partial_char(stack_pos, tok.partial_utf8)) {
  5495. rejects.push_back(tok);
  5496. }
  5497. } else if (llama_grammar_match_char(stack_pos, *tok.code_points).first) {
  5498. next_candidates.push_back({ tok.index, tok.code_points + 1, tok.partial_utf8 });
  5499. } else {
  5500. rejects.push_back(tok);
  5501. }
  5502. }
  5503. const auto * stack_pos_after = llama_grammar_match_char(stack_pos, 0).second;
  5504. // update top of stack to next element, if any
  5505. std::vector<const llama_grammar_element *> stack_after(stack.begin(), stack.end() - 1);
  5506. if (!llama_grammar_is_end_of_sequence(stack_pos_after)) {
  5507. stack_after.push_back(stack_pos_after);
  5508. }
  5509. std::vector<std::vector<const llama_grammar_element *>> next_stacks;
  5510. llama_grammar_advance_stack(rules, stack_after, next_stacks);
  5511. auto next_rejects = llama_grammar_reject_candidates(rules, next_stacks, next_candidates);
  5512. for (const auto & tok : next_rejects) {
  5513. rejects.push_back({ tok.index, tok.code_points - 1, tok.partial_utf8 });
  5514. }
  5515. return rejects;
  5516. }
  5517. static std::vector<llama_grammar_candidate> llama_grammar_reject_candidates(
  5518. const std::vector<std::vector<llama_grammar_element>> & rules,
  5519. const std::vector<std::vector<const llama_grammar_element *>> & stacks,
  5520. const std::vector<llama_grammar_candidate> & candidates) {
  5521. GGML_ASSERT(!stacks.empty()); // REVIEW
  5522. if (candidates.empty()) {
  5523. return std::vector<llama_grammar_candidate>();
  5524. }
  5525. auto rejects = llama_grammar_reject_candidates_for_stack(rules, stacks.front(), candidates);
  5526. for (size_t i = 1, size = stacks.size(); i < size; ++i) {
  5527. rejects = llama_grammar_reject_candidates_for_stack(rules, stacks[i], rejects);
  5528. }
  5529. return rejects;
  5530. }
  5531. //
  5532. // grammar - external
  5533. //
  5534. struct llama_grammar * llama_grammar_init(
  5535. const llama_grammar_element ** rules,
  5536. size_t n_rules,
  5537. size_t start_rule_index) {
  5538. const llama_grammar_element * pos;
  5539. // copy rule definitions into vectors
  5540. std::vector<std::vector<llama_grammar_element>> vec_rules(n_rules);
  5541. for (size_t i = 0; i < n_rules; i++) {
  5542. for (pos = rules[i]; pos->type != LLAMA_GRETYPE_END; pos++) {
  5543. vec_rules[i].push_back(*pos);
  5544. }
  5545. vec_rules[i].push_back({LLAMA_GRETYPE_END, 0});
  5546. }
  5547. // loop over alternates of start rule to build initial stacks
  5548. std::vector<std::vector<const llama_grammar_element *>> stacks;
  5549. pos = rules[start_rule_index];
  5550. do {
  5551. std::vector<const llama_grammar_element *> stack;
  5552. if (!llama_grammar_is_end_of_sequence(pos)) {
  5553. // if alternate is nonempty, add to stack
  5554. stack.push_back(pos);
  5555. }
  5556. llama_grammar_advance_stack(vec_rules, stack, stacks);
  5557. while (!llama_grammar_is_end_of_sequence(pos)) {
  5558. // scan to end of alternate def
  5559. pos++;
  5560. }
  5561. if (pos->type == LLAMA_GRETYPE_ALT) {
  5562. // there's another alternate def of this rule to process
  5563. pos++;
  5564. } else {
  5565. break;
  5566. }
  5567. } while (true);
  5568. return new llama_grammar{ std::move(vec_rules), std::move(stacks), {} };
  5569. }
  5570. void llama_grammar_free(struct llama_grammar * grammar) {
  5571. delete grammar;
  5572. }
  5573. struct llama_grammar * llama_grammar_copy(const struct llama_grammar * grammar) {
  5574. llama_grammar * result = new llama_grammar{ grammar->rules, grammar->stacks, grammar->partial_utf8 };
  5575. // redirect elements in stacks to point to new rules
  5576. for (size_t is = 0; is < result->stacks.size(); is++) {
  5577. for (size_t ie = 0; ie < result->stacks[is].size(); ie++) {
  5578. for (size_t ir0 = 0; ir0 < grammar->rules.size(); ir0++) {
  5579. for (size_t ir1 = 0; ir1 < grammar->rules[ir0].size(); ir1++) {
  5580. if (grammar->stacks[is][ie] == &grammar->rules[ir0][ir1]) {
  5581. result->stacks[is][ie] = &result->rules[ir0][ir1];
  5582. }
  5583. }
  5584. }
  5585. }
  5586. }
  5587. return result;
  5588. }
  5589. //
  5590. // sampling
  5591. //
  5592. void llama_set_rng_seed(struct llama_context * ctx, uint32_t seed) {
  5593. if (seed == LLAMA_DEFAULT_SEED) {
  5594. seed = time(NULL);
  5595. }
  5596. ctx->rng.seed(seed);
  5597. }
  5598. void llama_sample_softmax(struct llama_context * ctx, llama_token_data_array * candidates) {
  5599. GGML_ASSERT(candidates->size > 0);
  5600. const int64_t t_start_sample_us = ggml_time_us();
  5601. // Sort the logits in descending order
  5602. if (!candidates->sorted) {
  5603. std::sort(candidates->data, candidates->data + candidates->size, [](const llama_token_data & a, const llama_token_data & b) {
  5604. return a.logit > b.logit;
  5605. });
  5606. candidates->sorted = true;
  5607. }
  5608. float max_l = candidates->data[0].logit;
  5609. float cum_sum = 0.0f;
  5610. for (size_t i = 0; i < candidates->size; ++i) {
  5611. float p = expf(candidates->data[i].logit - max_l);
  5612. candidates->data[i].p = p;
  5613. cum_sum += p;
  5614. }
  5615. for (size_t i = 0; i < candidates->size; ++i) {
  5616. candidates->data[i].p /= cum_sum;
  5617. }
  5618. if (ctx) {
  5619. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5620. }
  5621. }
  5622. void llama_sample_top_k(struct llama_context * ctx, llama_token_data_array * candidates, int k, size_t min_keep) {
  5623. const int64_t t_start_sample_us = ggml_time_us();
  5624. k = std::max(k, (int) min_keep);
  5625. k = std::min(k, (int) candidates->size);
  5626. // Sort scores in descending order
  5627. if (!candidates->sorted) {
  5628. auto comp = [](const llama_token_data & a, const llama_token_data & b) {
  5629. return a.logit > b.logit;
  5630. };
  5631. if (k == (int) candidates->size) {
  5632. std::sort(candidates->data, candidates->data + candidates->size, comp);
  5633. } else {
  5634. std::partial_sort(candidates->data, candidates->data + k, candidates->data + candidates->size, comp);
  5635. }
  5636. candidates->sorted = true;
  5637. }
  5638. candidates->size = k;
  5639. if (ctx) {
  5640. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5641. }
  5642. }
  5643. void llama_sample_top_p(struct llama_context * ctx, llama_token_data_array * candidates, float p, size_t min_keep) {
  5644. if (p >= 1.0f) {
  5645. return;
  5646. }
  5647. llama_sample_softmax(ctx, candidates);
  5648. const int64_t t_start_sample_us = ggml_time_us();
  5649. // Compute the cumulative probabilities
  5650. float cum_sum = 0.0f;
  5651. size_t last_idx = candidates->size;
  5652. for (size_t i = 0; i < candidates->size; ++i) {
  5653. cum_sum += candidates->data[i].p;
  5654. // Check if the running sum is at least p or if we have kept at least min_keep tokens
  5655. // we set the last index to i+1 to indicate that the current iterate should be included in the set
  5656. if (cum_sum >= p && i + 1 >= min_keep) {
  5657. last_idx = i + 1;
  5658. break;
  5659. }
  5660. }
  5661. // Resize the output vector to keep only the top-p tokens
  5662. candidates->size = last_idx;
  5663. if (ctx) {
  5664. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5665. }
  5666. }
  5667. void llama_sample_min_p(struct llama_context * ctx, llama_token_data_array * candidates, float p, size_t min_keep) {
  5668. if (p <= 0.0f || !candidates->size) {
  5669. return;
  5670. }
  5671. llama_sample_softmax(ctx, candidates);
  5672. const int64_t t_start_sample_us = ggml_time_us();
  5673. float scale = candidates->data[0].p; // scale by max prob
  5674. size_t i = 1; // first token always matches
  5675. for (; i < candidates->size; ++i) {
  5676. if (candidates->data[i].p < p * scale && i >= min_keep) {
  5677. break; // prob too small
  5678. }
  5679. }
  5680. // Resize the output vector to keep only the matching tokens
  5681. candidates->size = i;
  5682. if (ctx) {
  5683. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5684. }
  5685. }
  5686. void llama_sample_tail_free(struct llama_context * ctx, llama_token_data_array * candidates, float z, size_t min_keep) {
  5687. if (z >= 1.0f || candidates->size <= 2) {
  5688. return;
  5689. }
  5690. llama_sample_softmax(nullptr, candidates);
  5691. const int64_t t_start_sample_us = ggml_time_us();
  5692. // Compute the first and second derivatives
  5693. std::vector<float> first_derivatives(candidates->size - 1);
  5694. std::vector<float> second_derivatives(candidates->size - 2);
  5695. for (size_t i = 0; i < first_derivatives.size(); ++i) {
  5696. first_derivatives[i] = candidates->data[i].p - candidates->data[i + 1].p;
  5697. }
  5698. for (size_t i = 0; i < second_derivatives.size(); ++i) {
  5699. second_derivatives[i] = first_derivatives[i] - first_derivatives[i + 1];
  5700. }
  5701. // Calculate absolute value of second derivatives
  5702. for (size_t i = 0; i < second_derivatives.size(); ++i) {
  5703. second_derivatives[i] = std::abs(second_derivatives[i]);
  5704. }
  5705. // Normalize the second derivatives
  5706. {
  5707. const float second_derivatives_sum = std::accumulate(second_derivatives.begin(), second_derivatives.end(), 0.0f);
  5708. if (second_derivatives_sum > 1e-6f) {
  5709. for (float & value : second_derivatives) {
  5710. value /= second_derivatives_sum;
  5711. }
  5712. } else {
  5713. for (float & value : second_derivatives) {
  5714. value = 1.0f / second_derivatives.size();
  5715. }
  5716. }
  5717. }
  5718. float cum_sum = 0.0f;
  5719. size_t last_idx = candidates->size;
  5720. for (size_t i = 0; i < second_derivatives.size(); ++i) {
  5721. cum_sum += second_derivatives[i];
  5722. // Check if the running sum is greater than z or if we have kept at least min_keep tokens
  5723. if (cum_sum > z && i >= min_keep) {
  5724. last_idx = i;
  5725. break;
  5726. }
  5727. }
  5728. // Resize the output vector to keep only the tokens above the tail location
  5729. candidates->size = last_idx;
  5730. if (ctx) {
  5731. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5732. }
  5733. }
  5734. void llama_sample_typical(struct llama_context * ctx, llama_token_data_array * candidates, float p, size_t min_keep) {
  5735. // Reference implementation:
  5736. // https://github.com/huggingface/transformers/compare/main...cimeister:typical-sampling:typical-pr
  5737. if (p >= 1.0f) {
  5738. return;
  5739. }
  5740. // Compute the softmax of logits and calculate entropy
  5741. llama_sample_softmax(nullptr, candidates);
  5742. const int64_t t_start_sample_us = ggml_time_us();
  5743. float entropy = 0.0f;
  5744. for (size_t i = 0; i < candidates->size; ++i) {
  5745. entropy += -candidates->data[i].p * logf(candidates->data[i].p);
  5746. }
  5747. // Compute the absolute difference between negative log probability and entropy for each candidate
  5748. std::vector<float> shifted_scores;
  5749. for (size_t i = 0; i < candidates->size; ++i) {
  5750. float shifted_score = fabsf(-logf(candidates->data[i].p) - entropy);
  5751. shifted_scores.push_back(shifted_score);
  5752. }
  5753. // Sort tokens based on the shifted_scores and their corresponding indices
  5754. std::vector<size_t> indices(candidates->size);
  5755. std::iota(indices.begin(), indices.end(), 0);
  5756. std::sort(indices.begin(), indices.end(), [&](size_t a, size_t b) {
  5757. return shifted_scores[a] < shifted_scores[b];
  5758. });
  5759. // Compute the cumulative probabilities
  5760. float cum_sum = 0.0f;
  5761. size_t last_idx = indices.size();
  5762. for (size_t i = 0; i < indices.size(); ++i) {
  5763. size_t idx = indices[i];
  5764. cum_sum += candidates->data[idx].p;
  5765. // Check if the running sum is greater than typical or if we have kept at least min_keep tokens
  5766. if (cum_sum > p && i >= min_keep - 1) {
  5767. last_idx = i + 1;
  5768. break;
  5769. }
  5770. }
  5771. // Resize the output vector to keep only the locally typical tokens
  5772. std::vector<llama_token_data> new_candidates;
  5773. for (size_t i = 0; i < last_idx; ++i) {
  5774. size_t idx = indices[i];
  5775. new_candidates.push_back(candidates->data[idx]);
  5776. }
  5777. // Replace the data in candidates with the new_candidates data
  5778. std::copy(new_candidates.begin(), new_candidates.end(), candidates->data);
  5779. candidates->size = new_candidates.size();
  5780. candidates->sorted = false;
  5781. if (ctx) {
  5782. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5783. }
  5784. }
  5785. void llama_sample_temp(struct llama_context * ctx, llama_token_data_array * candidates_p, float temp) {
  5786. const int64_t t_start_sample_us = ggml_time_us();
  5787. for (size_t i = 0; i < candidates_p->size; ++i) {
  5788. candidates_p->data[i].logit /= temp;
  5789. }
  5790. if (ctx) {
  5791. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5792. }
  5793. }
  5794. void llama_sample_temperature(struct llama_context * ctx, llama_token_data_array * candidates_p, float temp) {
  5795. llama_sample_temp(ctx, candidates_p, temp);
  5796. }
  5797. void llama_sample_repetition_penalties(
  5798. struct llama_context * ctx,
  5799. llama_token_data_array * candidates,
  5800. const llama_token * last_tokens,
  5801. size_t penalty_last_n,
  5802. float penalty_repeat,
  5803. float penalty_freq,
  5804. float penalty_present) {
  5805. if (penalty_last_n == 0 || (penalty_repeat == 1.0f && penalty_freq == 0.0f && penalty_present == 0.0f)) {
  5806. return;
  5807. }
  5808. const int64_t t_start_sample_us = ggml_time_us();
  5809. // Create a frequency map to count occurrences of each token in last_tokens
  5810. std::unordered_map<llama_token, int> token_count;
  5811. for (size_t i = 0; i < penalty_last_n; ++i) {
  5812. token_count[last_tokens[i]]++;
  5813. }
  5814. // Apply frequency and presence penalties to the candidates
  5815. for (size_t i = 0; i < candidates->size; ++i) {
  5816. const auto token_iter = token_count.find(candidates->data[i].id);
  5817. if (token_iter == token_count.end()) {
  5818. continue;
  5819. }
  5820. const int count = token_iter->second;
  5821. // The academic publication that described this technique actually just only divided, but that would cause tokens with negative logits to become more likely, which is obviously wrong.
  5822. // This is common fix for this problem, which is to multiply by the penalty instead of dividing.
  5823. if (candidates->data[i].logit <= 0) {
  5824. candidates->data[i].logit *= penalty_repeat;
  5825. } else {
  5826. candidates->data[i].logit /= penalty_repeat;
  5827. }
  5828. candidates->data[i].logit -= float(count) * penalty_freq + float(count > 0) * penalty_present;
  5829. }
  5830. candidates->sorted = false;
  5831. if (ctx) {
  5832. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5833. }
  5834. }
  5835. void llama_sample_grammar(struct llama_context * ctx, llama_token_data_array * candidates, const struct llama_grammar * grammar) {
  5836. GGML_ASSERT(ctx);
  5837. const int64_t t_start_sample_us = ggml_time_us();
  5838. bool allow_eos = false;
  5839. for (const auto & stack : grammar->stacks) {
  5840. if (stack.empty()) {
  5841. allow_eos = true;
  5842. break;
  5843. }
  5844. }
  5845. const llama_token eos = llama_token_eos(&ctx->model);
  5846. std::vector<std::pair<std::vector<uint32_t>, llama_partial_utf8>> candidates_decoded;
  5847. std::vector<llama_grammar_candidate> candidates_grammar;
  5848. for (size_t i = 0; i < candidates->size; ++i) {
  5849. const llama_token id = candidates->data[i].id;
  5850. const std::string piece = llama_token_to_piece(ctx, id);
  5851. if (id == eos) {
  5852. if (!allow_eos) {
  5853. candidates->data[i].logit = -INFINITY;
  5854. }
  5855. } else if (piece.empty() || piece[0] == 0) {
  5856. candidates->data[i].logit = -INFINITY;
  5857. } else {
  5858. candidates_decoded.push_back(decode_utf8(piece, grammar->partial_utf8));
  5859. candidates_grammar.push_back({ i, candidates_decoded.back().first.data(), candidates_decoded.back().second });
  5860. }
  5861. }
  5862. const auto rejects = llama_grammar_reject_candidates(grammar->rules, grammar->stacks, candidates_grammar);
  5863. for (const auto & reject : rejects) {
  5864. candidates->data[reject.index].logit = -INFINITY;
  5865. }
  5866. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5867. }
  5868. static void llama_log_softmax(float * array, size_t size) {
  5869. float max_l = *std::max_element(array, array + size);
  5870. float sum = 0.f;
  5871. for (size_t i = 0; i < size; ++i) {
  5872. float p = expf(array[i] - max_l);
  5873. sum += p;
  5874. array[i] = p;
  5875. }
  5876. for (size_t i = 0; i < size; ++i) {
  5877. array[i] = logf(array[i] / sum);
  5878. }
  5879. }
  5880. void llama_sample_classifier_free_guidance(
  5881. struct llama_context * ctx,
  5882. llama_token_data_array * candidates,
  5883. struct llama_context * guidance_ctx,
  5884. float scale) {
  5885. int64_t t_start_sample_us = ggml_time_us();
  5886. GGML_ASSERT(ctx);
  5887. auto n_vocab = llama_n_vocab(llama_get_model(ctx));
  5888. GGML_ASSERT(n_vocab == (int)candidates->size);
  5889. GGML_ASSERT(!candidates->sorted);
  5890. std::vector<float> logits_base;
  5891. logits_base.reserve(candidates->size);
  5892. for (size_t i = 0; i < candidates->size; ++i) {
  5893. logits_base.push_back(candidates->data[i].logit);
  5894. }
  5895. llama_log_softmax(logits_base.data(), candidates->size);
  5896. float* logits_guidance = llama_get_logits(guidance_ctx);
  5897. llama_log_softmax(logits_guidance, n_vocab);
  5898. for (int i = 0; i < n_vocab; ++i) {
  5899. float logit_guidance = logits_guidance[i];
  5900. float logit_base = logits_base[i];
  5901. candidates->data[i].logit = scale * (logit_base - logit_guidance) + logit_guidance;
  5902. }
  5903. if (ctx) {
  5904. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5905. }
  5906. }
  5907. llama_token llama_sample_token_mirostat(struct llama_context * ctx, llama_token_data_array * candidates, float tau, float eta, int m, float * mu) {
  5908. GGML_ASSERT(ctx);
  5909. auto N = float(llama_n_vocab(llama_get_model(ctx)));
  5910. int64_t t_start_sample_us;
  5911. t_start_sample_us = ggml_time_us();
  5912. llama_sample_softmax(nullptr, candidates);
  5913. // Estimate s_hat using the most probable m tokens
  5914. float s_hat = 0.0;
  5915. float sum_ti_bi = 0.0;
  5916. float sum_ti_sq = 0.0;
  5917. for (size_t i = 0; i < size_t(m - 1) && i < candidates->size - 1; ++i) {
  5918. float t_i = logf(float(i + 2) / float(i + 1));
  5919. float b_i = logf(candidates->data[i].p / candidates->data[i + 1].p);
  5920. sum_ti_bi += t_i * b_i;
  5921. sum_ti_sq += t_i * t_i;
  5922. }
  5923. s_hat = sum_ti_bi / sum_ti_sq;
  5924. // Compute k from the estimated s_hat and target surprise value
  5925. float epsilon_hat = s_hat - 1;
  5926. float k = powf((epsilon_hat * powf(2, *mu)) / (1 - powf(N, -epsilon_hat)), 1 / s_hat);
  5927. // Sample the next word X using top-k sampling
  5928. llama_sample_top_k(nullptr, candidates, int(k), 1);
  5929. if (ctx) {
  5930. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5931. }
  5932. llama_token X = llama_sample_token(ctx, candidates);
  5933. t_start_sample_us = ggml_time_us();
  5934. // Compute error as the difference between observed surprise and target surprise value
  5935. size_t X_idx = std::distance(candidates->data, std::find_if(candidates->data, candidates->data + candidates->size, [&](const llama_token_data & candidate) {
  5936. return candidate.id == X;
  5937. }));
  5938. float observed_surprise = -log2f(candidates->data[X_idx].p);
  5939. float e = observed_surprise - tau;
  5940. // Update mu using the learning rate and error
  5941. *mu = *mu - eta * e;
  5942. if (ctx) {
  5943. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5944. }
  5945. return X;
  5946. }
  5947. llama_token llama_sample_token_mirostat_v2(struct llama_context * ctx, llama_token_data_array * candidates, float tau, float eta, float * mu) {
  5948. int64_t t_start_sample_us;
  5949. t_start_sample_us = ggml_time_us();
  5950. llama_sample_softmax(ctx, candidates);
  5951. // Truncate the words with surprise values greater than mu
  5952. candidates->size = std::distance(candidates->data, std::find_if(candidates->data, candidates->data + candidates->size, [&](const llama_token_data & candidate) {
  5953. return -log2f(candidate.p) > *mu;
  5954. }));
  5955. if (candidates->size == 0) {
  5956. candidates->size = 1;
  5957. }
  5958. if (ctx) {
  5959. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5960. }
  5961. // Normalize the probabilities of the remaining words
  5962. llama_sample_softmax(ctx, candidates);
  5963. // Sample the next word X from the remaining words
  5964. llama_token X = llama_sample_token(ctx, candidates);
  5965. t_start_sample_us = ggml_time_us();
  5966. // Compute error as the difference between observed surprise and target surprise value
  5967. size_t X_idx = std::distance(candidates->data, std::find_if(candidates->data, candidates->data + candidates->size, [&](const llama_token_data & candidate) {
  5968. return candidate.id == X;
  5969. }));
  5970. float observed_surprise = -log2f(candidates->data[X_idx].p);
  5971. float e = observed_surprise - tau;
  5972. // Update mu using the learning rate and error
  5973. *mu = *mu - eta * e;
  5974. if (ctx) {
  5975. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5976. }
  5977. return X;
  5978. }
  5979. llama_token llama_sample_token_greedy(struct llama_context * ctx, llama_token_data_array * candidates) {
  5980. const int64_t t_start_sample_us = ggml_time_us();
  5981. // Find max element
  5982. auto * max_iter = std::max_element(candidates->data, candidates->data + candidates->size, [](const llama_token_data & a, const llama_token_data & b) {
  5983. return a.logit < b.logit;
  5984. });
  5985. llama_token result = max_iter->id;
  5986. if (ctx) {
  5987. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  5988. ctx->n_sample++;
  5989. }
  5990. return result;
  5991. }
  5992. llama_token llama_sample_token(struct llama_context * ctx, llama_token_data_array * candidates) {
  5993. GGML_ASSERT(ctx);
  5994. const int64_t t_start_sample_us = ggml_time_us();
  5995. llama_sample_softmax(nullptr, candidates);
  5996. std::vector<float> probs;
  5997. probs.reserve(candidates->size);
  5998. for (size_t i = 0; i < candidates->size; ++i) {
  5999. probs.push_back(candidates->data[i].p);
  6000. }
  6001. std::discrete_distribution<> dist(probs.begin(), probs.end());
  6002. auto & rng = ctx->rng;
  6003. int idx = dist(rng);
  6004. llama_token result = candidates->data[idx].id;
  6005. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  6006. ctx->n_sample++;
  6007. return result;
  6008. }
  6009. void llama_grammar_accept_token(struct llama_context * ctx, struct llama_grammar * grammar, llama_token token) {
  6010. const int64_t t_start_sample_us = ggml_time_us();
  6011. if (token == llama_token_eos(&ctx->model)) {
  6012. for (const auto & stack : grammar->stacks) {
  6013. if (stack.empty()) {
  6014. return;
  6015. }
  6016. }
  6017. GGML_ASSERT(false);
  6018. }
  6019. const std::string piece = llama_token_to_piece(ctx, token);
  6020. // Note terminating 0 in decoded string
  6021. const auto decoded = decode_utf8(piece, grammar->partial_utf8);
  6022. const auto & code_points = decoded.first;
  6023. for (auto it = code_points.begin(), end = code_points.end() - 1; it != end; ++it) {
  6024. grammar->stacks = llama_grammar_accept(grammar->rules, grammar->stacks, *it);
  6025. }
  6026. grammar->partial_utf8 = decoded.second;
  6027. GGML_ASSERT(!grammar->stacks.empty());
  6028. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  6029. }
  6030. //
  6031. // Beam search
  6032. //
  6033. struct llama_beam {
  6034. std::vector<llama_token> tokens;
  6035. float p; // Cumulative beam probability (renormalized relative to all beams)
  6036. bool eob; // Initialize end-of-beam to false. Callback sets this to true.
  6037. // Sort beams by probability. In case of ties, prefer beams at eob.
  6038. bool operator<(const llama_beam & rhs) const {
  6039. return std::make_pair(p, eob) < std::make_pair(rhs.p, rhs.eob);
  6040. }
  6041. // Shift off first n tokens and discard them.
  6042. void shift_tokens(const size_t n) {
  6043. if (n) {
  6044. std::copy(tokens.begin() + n, tokens.end(), tokens.begin());
  6045. tokens.resize(tokens.size() - n);
  6046. }
  6047. }
  6048. llama_beam_view view() const { return {tokens.data(), tokens.size(), p, eob}; }
  6049. };
  6050. // A struct for calculating logit-related info.
  6051. struct llama_logit_info {
  6052. const float * const logits;
  6053. const int n_vocab;
  6054. const float max_l;
  6055. const float normalizer;
  6056. struct sum_exp {
  6057. float max_l;
  6058. float operator()(float sum, float l) const { return sum + std::exp(l - max_l); }
  6059. };
  6060. llama_logit_info(llama_context * ctx)
  6061. : logits(llama_get_logits(ctx))
  6062. , n_vocab(llama_n_vocab(llama_get_model(ctx)))
  6063. , max_l(*std::max_element(logits, logits + n_vocab))
  6064. , normalizer(1.0f / std::accumulate(logits, logits + n_vocab, 0.0f, sum_exp{max_l}))
  6065. { }
  6066. llama_token_data get_token_data(const llama_token token_id) const {
  6067. constexpr auto p = std::numeric_limits<float>::quiet_NaN(); // never used
  6068. return {token_id, logits[token_id], p};
  6069. }
  6070. // Return top k token_data by logit.
  6071. std::vector<llama_token_data> top_k(size_t k) {
  6072. std::vector<llama_token_data> min_heap; // min-heap by logit
  6073. const llama_token k_min = std::min(static_cast<llama_token>(k), n_vocab);
  6074. min_heap.reserve(k_min);
  6075. for (llama_token token_id = 0 ; token_id < k_min ; ++token_id) {
  6076. min_heap.push_back(get_token_data(token_id));
  6077. }
  6078. auto comp = [](const llama_token_data & a, const llama_token_data & b) { return a.logit > b.logit; };
  6079. std::make_heap(min_heap.begin(), min_heap.end(), comp);
  6080. for (llama_token token_id = k_min ; token_id < n_vocab ; ++token_id) {
  6081. if (min_heap.front().logit < logits[token_id]) {
  6082. std::pop_heap(min_heap.begin(), min_heap.end(), comp);
  6083. min_heap.back().id = token_id;
  6084. min_heap.back().logit = logits[token_id];
  6085. std::push_heap(min_heap.begin(), min_heap.end(), comp);
  6086. }
  6087. }
  6088. return min_heap;
  6089. }
  6090. float probability_from_logit(float logit) const {
  6091. return normalizer * std::exp(logit - max_l);
  6092. }
  6093. };
  6094. struct llama_beam_search_data {
  6095. llama_context * ctx;
  6096. size_t n_beams;
  6097. int n_past;
  6098. int n_predict;
  6099. std::vector<llama_beam> beams;
  6100. std::vector<llama_beam> next_beams;
  6101. // Re-calculated on each loop iteration
  6102. size_t common_prefix_length;
  6103. // Used to communicate to/from callback on beams state.
  6104. std::vector<llama_beam_view> beam_views;
  6105. llama_beam_search_data(llama_context * ctx, size_t n_beams, int n_past, int n_predict)
  6106. : ctx(ctx)
  6107. , n_beams(n_beams)
  6108. , n_past(n_past)
  6109. , n_predict(n_predict)
  6110. , beam_views(n_beams) {
  6111. beams.reserve(n_beams);
  6112. next_beams.reserve(n_beams);
  6113. }
  6114. // Collapse beams to a single beam given by index.
  6115. void collapse_beams(const size_t beam_idx) {
  6116. if (0u < beam_idx) {
  6117. std::swap(beams[0], beams[beam_idx]);
  6118. }
  6119. beams.resize(1);
  6120. }
  6121. // Min-heaps are used to efficiently collect the top-k elements (k=n_beams).
  6122. // The repetative patterns below reflect the 2 stages of heaps:
  6123. // * Gather elements until the vector is full, then call std::make_heap() on it.
  6124. // * If the heap is full and a new element is found that should be included, pop the
  6125. // least element to the back(), replace it with the new, then push it into the heap.
  6126. void fill_next_beams_by_top_probabilities(llama_beam & beam) {
  6127. // Min-heaps use a greater-than comparator.
  6128. const auto comp = [](const llama_beam & a, const llama_beam & b) { return a.p > b.p; };
  6129. if (beam.eob) {
  6130. // beam is at end-of-sentence, so just copy it to next_beams if its probability is high enough.
  6131. if (next_beams.size() < n_beams) {
  6132. next_beams.push_back(std::move(beam));
  6133. if (next_beams.size() == n_beams) {
  6134. std::make_heap(next_beams.begin(), next_beams.end(), comp);
  6135. }
  6136. } else if (next_beams.front().p < beam.p) {
  6137. std::pop_heap(next_beams.begin(), next_beams.end(), comp);
  6138. next_beams.back() = std::move(beam);
  6139. std::push_heap(next_beams.begin(), next_beams.end(), comp);
  6140. }
  6141. } else {
  6142. // beam is not at end-of-sentence, so branch with next top_k tokens.
  6143. if (!beam.tokens.empty()) {
  6144. llama_decode(ctx, llama_batch_get_one(beam.tokens.data(), beam.tokens.size(), n_past, 0));
  6145. }
  6146. llama_logit_info logit_info(ctx);
  6147. std::vector<llama_token_data> next_tokens = logit_info.top_k(n_beams);
  6148. size_t i=0;
  6149. if (next_beams.size() < n_beams) {
  6150. for (; next_beams.size() < n_beams ; ++i) {
  6151. llama_beam next_beam = beam;
  6152. next_beam.tokens.push_back(next_tokens[i].id);
  6153. next_beam.p *= logit_info.probability_from_logit(next_tokens[i].logit);
  6154. next_beams.push_back(std::move(next_beam));
  6155. }
  6156. std::make_heap(next_beams.begin(), next_beams.end(), comp);
  6157. } else {
  6158. for (; next_beams.front().p == 0.0f ; ++i) {
  6159. std::pop_heap(next_beams.begin(), next_beams.end(), comp);
  6160. next_beams.back() = beam;
  6161. next_beams.back().tokens.push_back(next_tokens[i].id);
  6162. next_beams.back().p *= logit_info.probability_from_logit(next_tokens[i].logit);
  6163. std::push_heap(next_beams.begin(), next_beams.end(), comp);
  6164. }
  6165. }
  6166. for (; i < n_beams ; ++i) {
  6167. const float next_p = beam.p * logit_info.probability_from_logit(next_tokens[i].logit);
  6168. if (next_beams.front().p < next_p) {
  6169. std::pop_heap(next_beams.begin(), next_beams.end(), comp);
  6170. next_beams.back() = beam;
  6171. next_beams.back().tokens.push_back(next_tokens[i].id);
  6172. next_beams.back().p = next_p;
  6173. std::push_heap(next_beams.begin(), next_beams.end(), comp);
  6174. }
  6175. }
  6176. }
  6177. }
  6178. // Find common_prefix_length based on beams.
  6179. // Requires beams is not empty.
  6180. size_t find_common_prefix_length() {
  6181. size_t common_prefix_length = beams[0].tokens.size();
  6182. for (size_t i = 1 ; i < beams.size() ; ++i) {
  6183. common_prefix_length = std::min(common_prefix_length, beams[i].tokens.size());
  6184. for (size_t j = 0 ; j < common_prefix_length ; ++j) {
  6185. if (beams[0].tokens[j] != beams[i].tokens[j]) {
  6186. common_prefix_length = j;
  6187. break;
  6188. }
  6189. }
  6190. }
  6191. return common_prefix_length;
  6192. }
  6193. // Construct beams_state to send back to caller via the callback function.
  6194. // Side effect: set common_prefix_length = find_common_prefix_length();
  6195. llama_beams_state get_beams_state(const bool last_call) {
  6196. for (size_t i = 0 ; i < beams.size() ; ++i) {
  6197. beam_views[i] = beams[i].view();
  6198. }
  6199. common_prefix_length = find_common_prefix_length();
  6200. return {beam_views.data(), beams.size(), common_prefix_length, last_call};
  6201. }
  6202. // Loop:
  6203. // * while i < n_predict, AND
  6204. // * any of the beams have not yet reached end-of-beam (eob), AND
  6205. // * the highest probability beam(s) (plural in case of ties) are not at end-of-sentence
  6206. // (since all other beam probabilities can only decrease)
  6207. void loop(const llama_beam_search_callback_fn_t callback, void * const callback_data) {
  6208. beams.push_back({{}, 1.0f, false}); // Start with one empty beam w/ probability = 1.0 and !eob.
  6209. const auto not_eob = [](const llama_beam & beam) { return !beam.eob; };
  6210. for (int i = 0 ; i < n_predict && std::any_of(beams.begin(),beams.end(),not_eob) &&
  6211. !beams[top_beam_index()].eob ; ++i) {
  6212. callback(callback_data, get_beams_state(false)); // Sets common_prefix_length
  6213. update_beams_from_beam_views(); // Update values (p,eob) that callback may have changed.
  6214. if (common_prefix_length) {
  6215. llama_decode(ctx, llama_batch_get_one(beams[0].tokens.data(), common_prefix_length, n_past, 0));
  6216. n_past += common_prefix_length;
  6217. }
  6218. // Zero-out next_beam probabilities to place them last in following min-heap.
  6219. std::for_each(next_beams.begin(), next_beams.end(), [](llama_beam & beam) { beam.p = 0.0f; });
  6220. for (llama_beam & beam : beams) {
  6221. beam.shift_tokens(common_prefix_length);
  6222. fill_next_beams_by_top_probabilities(beam);
  6223. }
  6224. // next_beams become the beams of next/final iteration. Swap them to re-use memory.
  6225. beams.swap(next_beams);
  6226. renormalize_beam_probabilities(beams);
  6227. }
  6228. collapse_beams(top_beam_index());
  6229. callback(callback_data, get_beams_state(true));
  6230. }
  6231. // As beams grow, the cumulative probabilities decrease.
  6232. // Renormalize them to avoid floating point underflow.
  6233. static void renormalize_beam_probabilities(std::vector<llama_beam> & beams) {
  6234. const auto sum_p = [](float sum, llama_beam & beam) { return sum + beam.p; };
  6235. const float inv_sum = 1.0f / std::accumulate(beams.begin(), beams.end(), 0.0f, sum_p);
  6236. std::for_each(beams.begin(), beams.end(), [=](llama_beam & beam) { beam.p *= inv_sum; });
  6237. }
  6238. // Assumes beams is non-empty. Uses llama_beam::operator<() for ordering.
  6239. size_t top_beam_index() {
  6240. return std::max_element(beams.begin(), beams.end()) - beams.begin();
  6241. }
  6242. // Copy (p,eob) for each beam which may have been changed by the callback.
  6243. void update_beams_from_beam_views() {
  6244. for (size_t i = 0 ; i < beams.size() ; ++i) {
  6245. beams[i].p = beam_views[i].p;
  6246. beams[i].eob = beam_views[i].eob;
  6247. }
  6248. }
  6249. };
  6250. void llama_beam_search(llama_context * ctx,
  6251. llama_beam_search_callback_fn_t callback, void * callback_data,
  6252. size_t n_beams, int n_past, int n_predict) {
  6253. assert(ctx);
  6254. const int64_t t_start_sample_us = ggml_time_us();
  6255. llama_beam_search_data beam_search_data(ctx, n_beams, n_past, n_predict);
  6256. beam_search_data.loop(callback, callback_data);
  6257. ctx->t_sample_us += ggml_time_us() - t_start_sample_us;
  6258. ctx->n_sample++;
  6259. }
  6260. //
  6261. // quantization
  6262. //
  6263. template <typename T>
  6264. struct no_init {
  6265. T value;
  6266. no_init() { /* do nothing */ }
  6267. };
  6268. struct quantize_state_internal {
  6269. const llama_model & model;
  6270. const llama_model_quantize_params * params;
  6271. int n_attention_wv = 0;
  6272. int n_feed_forward_w2 = 0;
  6273. int i_attention_wv = 0;
  6274. int i_feed_forward_w2 = 0;
  6275. int n_k_quantized = 0;
  6276. int n_fallback = 0;
  6277. quantize_state_internal(const llama_model & model, const llama_model_quantize_params * params)
  6278. : model(model)
  6279. , params(params)
  6280. {}
  6281. };
  6282. static void llama_convert_tensor_internal(
  6283. struct ggml_tensor * tensor, std::vector<no_init<float>> & output, std::vector<std::thread> & workers,
  6284. const size_t nelements, const int nthread
  6285. ) {
  6286. if (output.size() < nelements) {
  6287. output.resize(nelements);
  6288. }
  6289. float * f32_output = (float *) output.data();
  6290. ggml_type_traits_t qtype;
  6291. if (ggml_is_quantized(tensor->type)) {
  6292. qtype = ggml_internal_get_type_traits(tensor->type);
  6293. if (qtype.to_float == NULL) {
  6294. throw std::runtime_error(format("type %s unsupported for integer quantization: no dequantization available", ggml_type_name(tensor->type)));
  6295. }
  6296. } else if (tensor->type != GGML_TYPE_F16) {
  6297. throw std::runtime_error(format("cannot dequantize/convert tensor type %s", ggml_type_name(tensor->type)));
  6298. }
  6299. if (nthread < 2) {
  6300. if (tensor->type == GGML_TYPE_F16) {
  6301. ggml_fp16_to_fp32_row((ggml_fp16_t *)tensor->data, f32_output, nelements);
  6302. } else if (ggml_is_quantized(tensor->type)) {
  6303. qtype.to_float(tensor->data, f32_output, nelements);
  6304. } else {
  6305. GGML_ASSERT(false); // unreachable
  6306. }
  6307. return;
  6308. }
  6309. auto block_size = tensor->type == GGML_TYPE_F16 ? 1 : (size_t)ggml_blck_size(tensor->type);
  6310. auto block_size_bytes = ggml_type_size(tensor->type);
  6311. GGML_ASSERT(nelements % block_size == 0);
  6312. auto nblocks = nelements / block_size;
  6313. auto blocks_per_thread = nblocks / nthread;
  6314. auto spare_blocks = nblocks - (blocks_per_thread * nthread); // if blocks aren't divisible by thread count
  6315. for (auto tnum = 0, in_buff_offs = 0, out_buff_offs = 0; tnum < nthread; tnum++) {
  6316. auto thr_blocks = blocks_per_thread + (tnum == nthread - 1 ? spare_blocks : 0); // num blocks for this thread
  6317. auto thr_elems = thr_blocks * block_size; // number of elements for this thread
  6318. auto thr_block_bytes = thr_blocks * block_size_bytes; // number of input bytes for this thread
  6319. auto compute = [qtype] (ggml_type typ, uint8_t * inbuf, float * outbuf, int nels) {
  6320. if (typ == GGML_TYPE_F16) {
  6321. ggml_fp16_to_fp32_row((ggml_fp16_t *)inbuf, outbuf, nels);
  6322. } else {
  6323. qtype.to_float(inbuf, outbuf, nels);
  6324. }
  6325. };
  6326. workers.emplace_back(compute, tensor->type, (uint8_t *) tensor->data + in_buff_offs, f32_output + out_buff_offs, thr_elems);
  6327. in_buff_offs += thr_block_bytes;
  6328. out_buff_offs += thr_elems;
  6329. }
  6330. for (auto & w : workers) { w.join(); }
  6331. workers.clear();
  6332. }
  6333. static ggml_type get_k_quant_type(
  6334. quantize_state_internal & qs,
  6335. ggml_type new_type, const ggml_tensor * tensor, llama_ftype ftype
  6336. ) {
  6337. const std::string name = ggml_get_name(tensor);
  6338. // TODO: avoid hardcoded tensor names - use the TN_* constants
  6339. const llm_arch arch = qs.model.arch;
  6340. const auto tn = LLM_TN(arch);
  6341. auto use_more_bits = [](int i_layer, int num_layers) -> bool {
  6342. return i_layer < num_layers/8 || i_layer >= 7*num_layers/8 || (i_layer - num_layers/8)%3 == 2;
  6343. };
  6344. if (name == tn(LLM_TENSOR_OUTPUT, "weight")) {
  6345. int nx = tensor->ne[0];
  6346. if (arch == LLM_ARCH_FALCON || nx % QK_K != 0) {
  6347. new_type = GGML_TYPE_Q8_0;
  6348. }
  6349. else if (new_type != GGML_TYPE_Q8_0) {
  6350. new_type = GGML_TYPE_Q6_K;
  6351. }
  6352. } else if (name.find("attn_v.weight") != std::string::npos) {
  6353. if (ftype == LLAMA_FTYPE_MOSTLY_Q2_K) new_type = GGML_TYPE_Q3_K;
  6354. else if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_M) {
  6355. new_type = qs.i_attention_wv < 2 ? GGML_TYPE_Q5_K : GGML_TYPE_Q4_K;
  6356. }
  6357. else if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_L) new_type = GGML_TYPE_Q5_K;
  6358. else if ((ftype == LLAMA_FTYPE_MOSTLY_Q4_K_M || ftype == LLAMA_FTYPE_MOSTLY_Q5_K_M) &&
  6359. use_more_bits(qs.i_attention_wv, qs.n_attention_wv)) new_type = GGML_TYPE_Q6_K;
  6360. else if (ftype == LLAMA_FTYPE_MOSTLY_Q4_K_S && qs.i_attention_wv < 4) new_type = GGML_TYPE_Q5_K;
  6361. else if (QK_K == 64 && (ftype == LLAMA_FTYPE_MOSTLY_Q4_K_S || ftype == LLAMA_FTYPE_MOSTLY_Q3_K_S) &&
  6362. (qs.i_attention_wv < qs.n_attention_wv/8 || qs.i_attention_wv >= 7*qs.n_attention_wv/8)) new_type = GGML_TYPE_Q6_K;
  6363. if (qs.model.type == MODEL_70B) {
  6364. // In the 70B model we have 8 heads sharing the same attn_v weights. As a result, the attn_v.weight tensor is
  6365. // 8x smaller compared to attn_q.weight. Hence, we can get a nice boost in quantization accuracy with
  6366. // nearly negligible increase in model size by quantizing this tensor with more bits:
  6367. if (new_type == GGML_TYPE_Q3_K || new_type == GGML_TYPE_Q4_K) new_type = GGML_TYPE_Q5_K;
  6368. }
  6369. ++qs.i_attention_wv;
  6370. } else if (name.find("ffn_down.weight") != std::string::npos) {
  6371. if (ftype == LLAMA_FTYPE_MOSTLY_Q2_K) new_type = GGML_TYPE_Q3_K;
  6372. else if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_M) {
  6373. new_type = qs.i_feed_forward_w2 < 2 ? GGML_TYPE_Q5_K
  6374. : arch != LLM_ARCH_FALCON || use_more_bits(qs.i_feed_forward_w2, qs.n_feed_forward_w2) ? GGML_TYPE_Q4_K
  6375. : GGML_TYPE_Q3_K;
  6376. }
  6377. else if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_L) {
  6378. new_type = arch == LLM_ARCH_FALCON ? GGML_TYPE_Q4_K : GGML_TYPE_Q5_K;
  6379. }
  6380. else if (ftype == LLAMA_FTYPE_MOSTLY_Q4_K_M) {
  6381. if (arch == LLM_ARCH_FALCON) {
  6382. new_type = qs.i_feed_forward_w2 < 2 ? GGML_TYPE_Q6_K :
  6383. use_more_bits(qs.i_feed_forward_w2, qs.n_feed_forward_w2) ? GGML_TYPE_Q5_K : GGML_TYPE_Q4_K;
  6384. } else {
  6385. if (use_more_bits(qs.i_feed_forward_w2, qs.n_feed_forward_w2)) new_type = GGML_TYPE_Q6_K;
  6386. }
  6387. }
  6388. else if (ftype == LLAMA_FTYPE_MOSTLY_Q5_K_M && use_more_bits(qs.i_feed_forward_w2, qs.n_feed_forward_w2)) new_type = GGML_TYPE_Q6_K;
  6389. else if (ftype == LLAMA_FTYPE_MOSTLY_Q4_K_S && arch != LLM_ARCH_FALCON && qs.i_feed_forward_w2 < 4) {
  6390. new_type = GGML_TYPE_Q5_K;
  6391. }
  6392. ++qs.i_feed_forward_w2;
  6393. } else if (name.find("attn_output.weight") != std::string::npos) {
  6394. if (arch != LLM_ARCH_FALCON) {
  6395. if (ftype == LLAMA_FTYPE_MOSTLY_Q2_K ) new_type = GGML_TYPE_Q3_K;
  6396. else if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_M) new_type = GGML_TYPE_Q4_K;
  6397. else if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_L) new_type = GGML_TYPE_Q5_K;
  6398. } else {
  6399. if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_L) new_type = GGML_TYPE_Q4_K;
  6400. }
  6401. }
  6402. else if (name.find("attn_qkv.weight") != std::string::npos) {
  6403. if (ftype == LLAMA_FTYPE_MOSTLY_Q3_K_M || ftype == LLAMA_FTYPE_MOSTLY_Q3_K_L) new_type = GGML_TYPE_Q4_K;
  6404. else if (ftype == LLAMA_FTYPE_MOSTLY_Q4_K_M) new_type = GGML_TYPE_Q5_K;
  6405. else if (ftype == LLAMA_FTYPE_MOSTLY_Q5_K_M) new_type = GGML_TYPE_Q6_K;
  6406. }
  6407. else if (name.find("ffn_gate.weight") != std::string::npos || name.find("ffn_up.weight") != std::string::npos) {
  6408. if (ftype == LLAMA_FTYPE_MOSTLY_Q2_K) new_type = GGML_TYPE_Q3_K;
  6409. }
  6410. // This can be used to reduce the size of the Q5_K_S model.
  6411. // The associated PPL increase is fully in line with the size reduction
  6412. //else {
  6413. // if (ftype == LLAMA_FTYPE_MOSTLY_Q5_K_S) new_type = GGML_TYPE_Q4_K;
  6414. //}
  6415. bool convert_incompatible_tensor = false;
  6416. if (new_type == GGML_TYPE_Q2_K || new_type == GGML_TYPE_Q3_K || new_type == GGML_TYPE_Q4_K ||
  6417. new_type == GGML_TYPE_Q5_K || new_type == GGML_TYPE_Q6_K) {
  6418. int nx = tensor->ne[0];
  6419. int ny = tensor->ne[1];
  6420. if (nx % QK_K != 0) {
  6421. LLAMA_LOG_WARN("\n\n%s : tensor cols %d x %d are not divisible by %d, required for %s", __func__, nx, ny, QK_K, ggml_type_name(new_type));
  6422. convert_incompatible_tensor = true;
  6423. } else {
  6424. ++qs.n_k_quantized;
  6425. }
  6426. }
  6427. if (convert_incompatible_tensor) {
  6428. switch (new_type) {
  6429. case GGML_TYPE_Q2_K: new_type = GGML_TYPE_Q4_0; break;
  6430. case GGML_TYPE_Q3_K: new_type = GGML_TYPE_Q4_1; break;
  6431. case GGML_TYPE_Q4_K: new_type = GGML_TYPE_Q5_0; break;
  6432. case GGML_TYPE_Q5_K: new_type = GGML_TYPE_Q5_1; break;
  6433. case GGML_TYPE_Q6_K: new_type = GGML_TYPE_Q8_0; break;
  6434. default: throw std::runtime_error("\nUnsupported tensor size encountered\n");
  6435. }
  6436. LLAMA_LOG_WARN(" - using fallback quantization %s\n", ggml_type_name(new_type));
  6437. ++qs.n_fallback;
  6438. }
  6439. return new_type;
  6440. }
  6441. static void llama_model_quantize_internal(const std::string & fname_inp, const std::string & fname_out, const llama_model_quantize_params * params) {
  6442. ggml_type quantized_type;
  6443. llama_ftype ftype = params->ftype;
  6444. switch (params->ftype) {
  6445. case LLAMA_FTYPE_MOSTLY_Q4_0: quantized_type = GGML_TYPE_Q4_0; break;
  6446. case LLAMA_FTYPE_MOSTLY_Q4_1: quantized_type = GGML_TYPE_Q4_1; break;
  6447. case LLAMA_FTYPE_MOSTLY_Q5_0: quantized_type = GGML_TYPE_Q5_0; break;
  6448. case LLAMA_FTYPE_MOSTLY_Q5_1: quantized_type = GGML_TYPE_Q5_1; break;
  6449. case LLAMA_FTYPE_MOSTLY_Q8_0: quantized_type = GGML_TYPE_Q8_0; break;
  6450. case LLAMA_FTYPE_MOSTLY_F16: quantized_type = GGML_TYPE_F16; break;
  6451. case LLAMA_FTYPE_ALL_F32: quantized_type = GGML_TYPE_F32; break;
  6452. // K-quants
  6453. case LLAMA_FTYPE_MOSTLY_Q2_K: quantized_type = GGML_TYPE_Q2_K; break;
  6454. case LLAMA_FTYPE_MOSTLY_Q3_K_S:
  6455. case LLAMA_FTYPE_MOSTLY_Q3_K_M:
  6456. case LLAMA_FTYPE_MOSTLY_Q3_K_L: quantized_type = GGML_TYPE_Q3_K; break;
  6457. case LLAMA_FTYPE_MOSTLY_Q4_K_S:
  6458. case LLAMA_FTYPE_MOSTLY_Q4_K_M: quantized_type = GGML_TYPE_Q4_K; break;
  6459. case LLAMA_FTYPE_MOSTLY_Q5_K_S:
  6460. case LLAMA_FTYPE_MOSTLY_Q5_K_M: quantized_type = GGML_TYPE_Q5_K; break;
  6461. case LLAMA_FTYPE_MOSTLY_Q6_K: quantized_type = GGML_TYPE_Q6_K; break;
  6462. default: throw std::runtime_error(format("invalid output file type %d\n", ftype));
  6463. }
  6464. int nthread = params->nthread;
  6465. if (nthread <= 0) {
  6466. nthread = std::thread::hardware_concurrency();
  6467. }
  6468. // mmap consistently increases speed Linux, and also increases speed on Windows with
  6469. // hot cache. It may cause a slowdown on macOS, possibly related to free memory.
  6470. #if defined(__linux__) || defined(_WIN32)
  6471. constexpr bool use_mmap = true;
  6472. #else
  6473. constexpr bool use_mmap = false;
  6474. #endif
  6475. llama_model_loader ml(fname_inp, use_mmap);
  6476. if (ml.use_mmap) {
  6477. ml.mapping.reset(new llama_mmap(&ml.file, /* prefetch */ 0, ggml_is_numa()));
  6478. }
  6479. llama_model model;
  6480. llm_load_arch(ml, model);
  6481. llm_load_hparams(ml, model);
  6482. struct quantize_state_internal qs(model, params);
  6483. if (params->only_copy) {
  6484. ftype = model.ftype;
  6485. }
  6486. const size_t align = GGUF_DEFAULT_ALIGNMENT;
  6487. struct gguf_context * ctx_out = gguf_init_empty();
  6488. // copy the KV pairs from the input file
  6489. gguf_set_kv (ctx_out, ml.ctx_gguf);
  6490. gguf_set_val_u32(ctx_out, "general.quantization_version", GGML_QNT_VERSION);
  6491. gguf_set_val_u32(ctx_out, "general.file_type", ftype);
  6492. for (int i = 0; i < ml.n_tensors; ++i) {
  6493. struct ggml_tensor * meta = ml.get_tensor_meta(i);
  6494. const std::string name = ggml_get_name(meta);
  6495. // TODO: avoid hardcoded tensor names - use the TN_* constants
  6496. if (name.find("attn_v.weight") != std::string::npos || name.find("attn_qkv.weight") != std::string::npos) {
  6497. ++qs.n_attention_wv;
  6498. }
  6499. else if (name.find("ffn_down.weight") != std::string::npos) {
  6500. ++qs.n_feed_forward_w2;
  6501. }
  6502. }
  6503. if (qs.n_attention_wv != qs.n_feed_forward_w2 || (uint32_t)qs.n_attention_wv != model.hparams.n_layer) {
  6504. LLAMA_LOG_WARN("%s ============ Strange model: n_attention_wv = %d, n_feed_forward_w2 = %d, hparams.n_layer = %d\n",
  6505. __func__, qs.n_attention_wv, qs.n_feed_forward_w2, model.hparams.n_layer);
  6506. }
  6507. size_t total_size_org = 0;
  6508. size_t total_size_new = 0;
  6509. std::vector<int64_t> hist_all(1 << 4, 0);
  6510. std::vector<std::thread> workers;
  6511. workers.reserve(nthread);
  6512. std::mutex mutex;
  6513. int idx = 0;
  6514. std::vector<no_init<uint8_t>> read_data;
  6515. std::vector<no_init<uint8_t>> work;
  6516. std::vector<no_init<float>> f32_conv_buf;
  6517. // populate the original tensors so we get an initial meta data
  6518. for (int i = 0; i < ml.n_tensors; ++i) {
  6519. struct ggml_tensor * meta = ml.get_tensor_meta(i);
  6520. gguf_add_tensor(ctx_out, meta);
  6521. }
  6522. std::ofstream fout(fname_out, std::ios::binary);
  6523. fout.exceptions(std::ofstream::failbit); // fail fast on write errors
  6524. const size_t meta_size = gguf_get_meta_size(ctx_out);
  6525. LLAMA_LOG_INFO("%s: meta size = %zu bytes\n", __func__, meta_size);
  6526. // placeholder for the meta data
  6527. ::zeros(fout, meta_size);
  6528. for (int i = 0; i < ml.n_tensors; ++i) {
  6529. struct ggml_tensor * tensor = ml.get_tensor_meta(i);
  6530. const std::string name = ggml_get_name(tensor);
  6531. if (!ml.use_mmap) {
  6532. if (read_data.size() < ggml_nbytes(tensor)) {
  6533. read_data.resize(ggml_nbytes(tensor));
  6534. }
  6535. tensor->data = read_data.data();
  6536. }
  6537. ml.load_data_for(tensor);
  6538. LLAMA_LOG_INFO("[%4d/%4d] %36s - [%s], type = %6s, ",
  6539. ++idx, ml.n_tensors,
  6540. ggml_get_name(tensor),
  6541. llama_format_tensor_shape(tensor).c_str(),
  6542. ggml_type_name(tensor->type));
  6543. // This used to be a regex, but <regex> has an extreme cost to compile times.
  6544. bool quantize = name.rfind("weight") == name.size() - 6; // ends with 'weight'?
  6545. // quantize only 2D tensors
  6546. quantize &= (tensor->n_dims == 2);
  6547. quantize &= params->quantize_output_tensor || name != "output.weight";
  6548. quantize &= !params->only_copy;
  6549. enum ggml_type new_type;
  6550. void * new_data;
  6551. size_t new_size;
  6552. if (quantize) {
  6553. new_type = quantized_type;
  6554. if (!params->pure) {
  6555. new_type = get_k_quant_type(qs, new_type, tensor, ftype);
  6556. }
  6557. // If we've decided to quantize to the same type the tensor is already
  6558. // in then there's nothing to do.
  6559. quantize = tensor->type != new_type;
  6560. }
  6561. if (!quantize) {
  6562. new_type = tensor->type;
  6563. new_data = tensor->data;
  6564. new_size = ggml_nbytes(tensor);
  6565. LLAMA_LOG_INFO("size = %8.3f MB\n", ggml_nbytes(tensor)/1024.0/1024.0);
  6566. } else {
  6567. const size_t nelements = ggml_nelements(tensor);
  6568. float * f32_data;
  6569. if (tensor->type == GGML_TYPE_F32) {
  6570. f32_data = (float *) tensor->data;
  6571. } else if (ggml_is_quantized(tensor->type) && !params->allow_requantize) {
  6572. throw std::runtime_error(format("requantizing from type %s is disabled", ggml_type_name(tensor->type)));
  6573. } else {
  6574. llama_convert_tensor_internal(tensor, f32_conv_buf, workers, nelements, nthread);
  6575. f32_data = (float *) f32_conv_buf.data();
  6576. }
  6577. LLAMA_LOG_INFO("quantizing to %s .. ", ggml_type_name(new_type));
  6578. fflush(stdout);
  6579. if (work.size() < nelements * 4) {
  6580. work.resize(nelements * 4); // upper bound on size
  6581. }
  6582. new_data = work.data();
  6583. std::array<int64_t, 1 << 4> hist_cur = {};
  6584. static const int chunk_size = 32 * 512;
  6585. const int nchunk = (nelements + chunk_size - 1)/chunk_size;
  6586. const int nthread_use = nthread > 1 ? std::max(1, std::min(nthread, nchunk)) : 1;
  6587. if (nthread_use < 2) {
  6588. new_size = ggml_quantize_chunk(new_type, f32_data, new_data, 0, nelements, hist_cur.data());
  6589. } else {
  6590. size_t counter = 0;
  6591. new_size = 0;
  6592. auto compute = [&mutex, &counter, &hist_cur, &new_size, new_type, f32_data, new_data, nelements]() {
  6593. std::array<int64_t, 1 << 4> local_hist = {};
  6594. size_t local_size = 0;
  6595. while (true) {
  6596. std::unique_lock<std::mutex> lock(mutex);
  6597. size_t first = counter; counter += chunk_size;
  6598. if (first >= nelements) {
  6599. if (local_size > 0) {
  6600. for (int j=0; j<int(local_hist.size()); ++j) {
  6601. hist_cur[j] += local_hist[j];
  6602. }
  6603. new_size += local_size;
  6604. }
  6605. break;
  6606. }
  6607. lock.unlock();
  6608. size_t last = std::min(nelements, first + chunk_size);
  6609. local_size += ggml_quantize_chunk(new_type, f32_data, new_data, first, last - first, local_hist.data());
  6610. }
  6611. };
  6612. for (int it = 0; it < nthread_use - 1; ++it) {
  6613. workers.emplace_back(compute);
  6614. }
  6615. compute();
  6616. for (auto & w : workers) { w.join(); }
  6617. workers.clear();
  6618. }
  6619. LLAMA_LOG_INFO("size = %8.2f MiB -> %8.2f MiB | hist: ", ggml_nbytes(tensor)/1024.0/1024.0, new_size/1024.0/1024.0);
  6620. int64_t tot_count = 0;
  6621. for (size_t i = 0; i < hist_cur.size(); i++) {
  6622. hist_all[i] += hist_cur[i];
  6623. tot_count += hist_cur[i];
  6624. }
  6625. if (tot_count > 0) {
  6626. for (size_t i = 0; i < hist_cur.size(); i++) {
  6627. LLAMA_LOG_INFO("%5.3f ", hist_cur[i] / float(nelements));
  6628. }
  6629. }
  6630. LLAMA_LOG_INFO("\n");
  6631. }
  6632. total_size_org += ggml_nbytes(tensor);
  6633. total_size_new += new_size;
  6634. // update the gguf meta data as we go
  6635. gguf_set_tensor_type(ctx_out, name.c_str(), new_type);
  6636. gguf_set_tensor_data(ctx_out, name.c_str(), new_data, new_size);
  6637. // write tensor data + padding
  6638. fout.write((const char *) new_data, new_size);
  6639. zeros(fout, GGML_PAD(new_size, align) - new_size);
  6640. }
  6641. // go back to beginning of file and write the updated meta data
  6642. {
  6643. fout.seekp(0);
  6644. std::vector<uint8_t> data(gguf_get_meta_size(ctx_out));
  6645. gguf_get_meta_data(ctx_out, data.data());
  6646. fout.write((const char *) data.data(), data.size());
  6647. }
  6648. fout.close();
  6649. gguf_free(ctx_out);
  6650. LLAMA_LOG_INFO("%s: model size = %8.2f MB\n", __func__, total_size_org/1024.0/1024.0);
  6651. LLAMA_LOG_INFO("%s: quant size = %8.2f MB\n", __func__, total_size_new/1024.0/1024.0);
  6652. // print histogram for all tensors
  6653. {
  6654. int64_t sum_all = 0;
  6655. for (size_t i = 0; i < hist_all.size(); i++) {
  6656. sum_all += hist_all[i];
  6657. }
  6658. if (sum_all > 0) {
  6659. LLAMA_LOG_INFO("%s: hist: ", __func__);
  6660. for (size_t i = 0; i < hist_all.size(); i++) {
  6661. LLAMA_LOG_INFO("%5.3f ", hist_all[i] / float(sum_all));
  6662. }
  6663. LLAMA_LOG_INFO("\n");
  6664. }
  6665. }
  6666. if (qs.n_fallback > 0) {
  6667. LLAMA_LOG_WARN("%s: WARNING: %d of %d tensor(s) incompatible with k-quants and required fallback quantization\n",
  6668. __func__, qs.n_fallback, qs.n_k_quantized + qs.n_fallback);
  6669. }
  6670. }
  6671. static int llama_apply_lora_from_file_internal(
  6672. const struct llama_model & model, const char * path_lora, float scale, const char * path_base_model, int n_threads
  6673. ) {
  6674. LLAMA_LOG_INFO("%s: applying lora adapter from '%s' - please wait ...\n", __func__, path_lora);
  6675. const int64_t t_start_lora_us = ggml_time_us();
  6676. auto fin = std::ifstream(path_lora, std::ios::binary);
  6677. if (!fin) {
  6678. LLAMA_LOG_ERROR("%s: failed to open '%s'\n", __func__, path_lora);
  6679. return 1;
  6680. }
  6681. // verify magic and version
  6682. {
  6683. uint32_t magic;
  6684. fin.read((char *) &magic, sizeof(magic));
  6685. uint32_t format_version;
  6686. fin.read((char *) &format_version, sizeof(format_version));
  6687. if (format_version != 1) {
  6688. LLAMA_LOG_ERROR("%s: unsupported file version\n", __func__ );
  6689. return 1;
  6690. }
  6691. }
  6692. int32_t lora_r;
  6693. int32_t lora_alpha;
  6694. fin.read((char *) &lora_r, sizeof(lora_r));
  6695. fin.read((char *) &lora_alpha, sizeof(lora_alpha));
  6696. float scaling = scale * (float)lora_alpha / (float)lora_r;
  6697. LLAMA_LOG_INFO("%s: r = %d, alpha = %d, scaling = %.2f\n", __func__, lora_r, lora_alpha, scaling);
  6698. // create a temporary ggml context to store the lora tensors
  6699. // todo: calculate size from biggest possible tensor
  6700. std::vector<uint8_t> lora_buf(1024ull * 1024ull * 1024ull);
  6701. struct ggml_init_params params;
  6702. params.mem_size = lora_buf.size();
  6703. params.mem_buffer = lora_buf.data();
  6704. params.no_alloc = false;
  6705. ggml_context * lora_ctx = ggml_init(params);
  6706. std::unordered_map<std::string, struct ggml_tensor *> lora_tensors;
  6707. // create a name -> tensor map of the model to accelerate lookups
  6708. std::unordered_map<std::string, struct ggml_tensor*> model_tensors;
  6709. for (const auto & kv : model.tensors_by_name) {
  6710. model_tensors.insert(kv);
  6711. }
  6712. // load base model
  6713. std::unique_ptr<llama_model_loader> ml;
  6714. ggml_context * base_ctx = NULL;
  6715. std::vector<uint8_t> base_buf;
  6716. if (path_base_model) {
  6717. LLAMA_LOG_INFO("%s: loading base model from '%s'\n", __func__, path_base_model);
  6718. ml.reset(new llama_model_loader(path_base_model, /*use_mmap*/ true));
  6719. size_t ctx_size;
  6720. size_t mmapped_size;
  6721. ml->calc_sizes(ctx_size, mmapped_size);
  6722. base_buf.resize(ctx_size);
  6723. ggml_init_params base_params;
  6724. base_params.mem_size = base_buf.size();
  6725. base_params.mem_buffer = base_buf.data();
  6726. base_params.no_alloc = ml->use_mmap;
  6727. base_ctx = ggml_init(base_params);
  6728. // maybe this should in llama_model_loader
  6729. if (ml->use_mmap) {
  6730. ml->mapping.reset(new llama_mmap(&ml->file, /* prefetch */ 0, ggml_is_numa()));
  6731. }
  6732. }
  6733. // read tensors and apply
  6734. bool warned = false;
  6735. int n_tensors = 0;
  6736. std::vector<uint8_t> work_buffer;
  6737. while (true) {
  6738. int32_t n_dims;
  6739. int32_t length;
  6740. int32_t ftype;
  6741. fin.read(reinterpret_cast<char *>(&n_dims), sizeof(n_dims));
  6742. fin.read(reinterpret_cast<char *>(&length), sizeof(length));
  6743. fin.read(reinterpret_cast<char *>(&ftype), sizeof(ftype));
  6744. if (fin.eof()) {
  6745. break;
  6746. }
  6747. int32_t ne[2] = { 1, 1 };
  6748. for (int i = 0; i < n_dims; ++i) {
  6749. fin.read(reinterpret_cast<char *>(&ne[i]), sizeof(ne[i]));
  6750. }
  6751. std::string name;
  6752. {
  6753. char buf[1024];
  6754. fin.read(buf, length);
  6755. name = std::string(buf, length);
  6756. }
  6757. // check for lora suffix and get the type of tensor
  6758. const std::string lora_suffix = ".lora";
  6759. size_t pos = name.rfind(lora_suffix);
  6760. if (pos == std::string::npos) {
  6761. LLAMA_LOG_ERROR("%s: error: '%s' is not a lora tensor\n", __func__, name.c_str());
  6762. return 1;
  6763. }
  6764. std::string lora_type = name.substr(pos + lora_suffix.length());
  6765. std::string base_name = name;
  6766. base_name.erase(pos);
  6767. // LLAMA_LOG_INFO("%s: %s => %s (lora type %s) \n", __func__, name.c_str(),base_name.c_str(), lora_type.c_str());
  6768. if (model_tensors.find(base_name) == model_tensors.end()) {
  6769. LLAMA_LOG_ERROR("%s: unknown tensor '%s' in lora adapter\n", __func__, name.data());
  6770. return 1;
  6771. }
  6772. // create ggml tensor
  6773. ggml_type wtype;
  6774. switch (ftype) {
  6775. case 0: wtype = GGML_TYPE_F32; break;
  6776. case 1: wtype = GGML_TYPE_F16; break;
  6777. default:
  6778. {
  6779. LLAMA_LOG_ERROR("%s: invalid tensor data type '%d'\n",
  6780. __func__, ftype);
  6781. return false;
  6782. }
  6783. }
  6784. ggml_tensor * lora_tensor;
  6785. if (n_dims == 2) {
  6786. lora_tensor = ggml_new_tensor_2d(lora_ctx, wtype, ne[0], ne[1]);
  6787. }
  6788. else {
  6789. LLAMA_LOG_ERROR("%s: unsupported tensor dimension %d\n", __func__, n_dims);
  6790. return 1;
  6791. }
  6792. ggml_set_name(lora_tensor, "lora_tensor");
  6793. // load tensor data
  6794. size_t offset = fin.tellg();
  6795. size_t tensor_data_size = ggml_nbytes(lora_tensor);
  6796. offset = (offset + 31) & -32;
  6797. fin.seekg(offset);
  6798. fin.read((char*)lora_tensor->data, tensor_data_size);
  6799. lora_tensors[name] = lora_tensor;
  6800. // check if we have both A and B tensors and apply
  6801. if (lora_tensors.find(base_name + ".loraA") != lora_tensors.end() &&
  6802. lora_tensors.find(base_name + ".loraB") != lora_tensors.end()) {
  6803. ggml_tensor * dest_t = model_tensors[base_name];
  6804. offload_func_t offload_func = ggml_offload_nop;
  6805. offload_func_t offload_func_force_inplace = ggml_offload_nop;
  6806. #ifdef GGML_USE_CUBLAS
  6807. if (dest_t->backend == GGML_BACKEND_GPU || dest_t->backend == GGML_BACKEND_GPU_SPLIT) {
  6808. if (dest_t->type != GGML_TYPE_F16) {
  6809. throw std::runtime_error(format(
  6810. "%s: error: the simultaneous use of LoRAs and GPU acceleration is only supported for f16 models. dest_t->type: %d", __func__, dest_t->type));
  6811. }
  6812. offload_func = ggml_cuda_assign_buffers;
  6813. offload_func_force_inplace = ggml_cuda_assign_buffers_force_inplace;
  6814. }
  6815. #endif // GGML_USE_CUBLAS
  6816. ggml_tensor * base_t;
  6817. if (ml) {
  6818. struct gguf_context * ctx_gguf = ml->ctx_gguf;
  6819. // load from base model
  6820. if (gguf_find_tensor(ctx_gguf, base_name.c_str()) < 0) {
  6821. // TODO: throw
  6822. LLAMA_LOG_ERROR("%s: error: tensor '%s' not found in base model\n", __func__, base_name.c_str());
  6823. return 1;
  6824. }
  6825. // TODO: not tested!! maybe not working!
  6826. base_t = ml->create_tensor(base_ctx, base_name, { (uint32_t)dest_t->ne[0], (uint32_t)dest_t->ne[1] }, GGML_BACKEND_CPU);
  6827. ml->load_data_for(base_t);
  6828. } else {
  6829. base_t = dest_t;
  6830. }
  6831. if (ggml_is_quantized(base_t->type)) {
  6832. if (!warned) {
  6833. LLAMA_LOG_WARN("%s: warning: using a lora adapter with a quantized model may result in poor quality, "
  6834. "use a f16 or f32 base model with --lora-base\n", __func__);
  6835. warned = true;
  6836. }
  6837. }
  6838. ggml_tensor * loraA = lora_tensors[base_name + ".loraA"];
  6839. GGML_ASSERT(loraA->type == GGML_TYPE_F32);
  6840. ggml_set_name(loraA, "loraA");
  6841. ggml_tensor * loraB = lora_tensors[base_name + ".loraB"];
  6842. GGML_ASSERT(loraB->type == GGML_TYPE_F32);
  6843. ggml_set_name(loraB, "loraB");
  6844. if (base_t->ne[0] != loraA->ne[1] || base_t->ne[1] != loraB->ne[1]) {
  6845. LLAMA_LOG_ERROR("%s: incompatible tensor dimensions (%" PRId64 " and %" PRId64 ");"
  6846. " are you sure that this adapter is for this model?\n", __func__, base_t->ne[0], loraA->ne[1]);
  6847. return 1;
  6848. }
  6849. // w = w + BA*s
  6850. ggml_tensor * BA = ggml_mul_mat(lora_ctx, loraA, loraB);
  6851. offload_func(BA);
  6852. ggml_set_name(BA, "BA");
  6853. if (scaling != 1.0f) {
  6854. ggml_tensor * scale_tensor = ggml_new_f32(lora_ctx, scaling);
  6855. ggml_set_name(scale_tensor, "scale_tensor");
  6856. BA = ggml_scale_inplace(lora_ctx, BA, scale_tensor);
  6857. offload_func(BA);
  6858. ggml_set_name(BA, "BA_scaled");
  6859. }
  6860. ggml_tensor * r;
  6861. if (base_t == dest_t) {
  6862. r = ggml_add_inplace(lora_ctx, dest_t, BA);
  6863. offload_func_force_inplace(r);
  6864. ggml_set_name(r, "r_add_inplace");
  6865. }
  6866. else {
  6867. r = ggml_add(lora_ctx, base_t, BA);
  6868. offload_func(r);
  6869. ggml_set_name(r, "r_add");
  6870. r = ggml_cpy(lora_ctx, r, dest_t);
  6871. offload_func(r);
  6872. ggml_set_name(r, "r_cpy");
  6873. }
  6874. struct ggml_cgraph * gf = ggml_new_graph(lora_ctx);
  6875. ggml_build_forward_expand(gf, r);
  6876. ggml_graph_compute_helper(work_buffer, gf, n_threads);
  6877. // we won't need these tensors again, reset the context to save memory
  6878. ggml_free(lora_ctx);
  6879. lora_ctx = ggml_init(params);
  6880. lora_tensors.clear();
  6881. n_tensors++;
  6882. if (n_tensors % 4 == 0) {
  6883. LLAMA_LOG_INFO(".");
  6884. }
  6885. }
  6886. }
  6887. // TODO: this should be in a destructor, it will leak on failure
  6888. ggml_free(lora_ctx);
  6889. if (base_ctx) {
  6890. ggml_free(base_ctx);
  6891. }
  6892. const int64_t t_lora_us = ggml_time_us() - t_start_lora_us;
  6893. LLAMA_LOG_INFO(" done (%.2f ms)\n", t_lora_us / 1000.0);
  6894. return 0;
  6895. }
  6896. //
  6897. // interface implementation
  6898. //
  6899. struct llama_model_params llama_model_default_params() {
  6900. struct llama_model_params result = {
  6901. /*.n_gpu_layers =*/ 0,
  6902. /*.main_gpu =*/ 0,
  6903. /*.tensor_split =*/ nullptr,
  6904. /*.progress_callback =*/ nullptr,
  6905. /*.progress_callback_user_data =*/ nullptr,
  6906. /*.vocab_only =*/ false,
  6907. /*.use_mmap =*/ true,
  6908. /*.use_mlock =*/ false,
  6909. };
  6910. #ifdef GGML_USE_METAL
  6911. result.n_gpu_layers = 1;
  6912. #endif
  6913. return result;
  6914. }
  6915. struct llama_context_params llama_context_default_params() {
  6916. struct llama_context_params result = {
  6917. /*.seed =*/ LLAMA_DEFAULT_SEED,
  6918. /*.n_ctx =*/ 512,
  6919. /*.n_batch =*/ 512,
  6920. /*.n_threads =*/ GGML_DEFAULT_N_THREADS, // TODO: better default
  6921. /*.n_threads_batch =*/ GGML_DEFAULT_N_THREADS,
  6922. /*.rope_scaling_type =*/ LLAMA_ROPE_SCALING_UNSPECIFIED,
  6923. /*.rope_freq_base =*/ 0.0f,
  6924. /*.rope_freq_scale =*/ 0.0f,
  6925. /*.yarn_ext_factor =*/ -1.0f,
  6926. /*.yarn_attn_factor =*/ 1.0f,
  6927. /*.yarn_beta_fast =*/ 32.0f,
  6928. /*.yarn_beta_slow =*/ 1.0f,
  6929. /*.yarn_orig_ctx =*/ 0,
  6930. /*.mul_mat_q =*/ true,
  6931. /*.f16_kv =*/ true,
  6932. /*.logits_all =*/ false,
  6933. /*.embedding =*/ false,
  6934. };
  6935. return result;
  6936. }
  6937. struct llama_model_quantize_params llama_model_quantize_default_params() {
  6938. struct llama_model_quantize_params result = {
  6939. /*.nthread =*/ 0,
  6940. /*.ftype =*/ LLAMA_FTYPE_MOSTLY_Q5_1,
  6941. /*.allow_requantize =*/ false,
  6942. /*.quantize_output_tensor =*/ true,
  6943. /*.only_copy =*/ false,
  6944. /*.pure =*/ false,
  6945. };
  6946. return result;
  6947. }
  6948. int llama_max_devices(void) {
  6949. return LLAMA_MAX_DEVICES;
  6950. }
  6951. bool llama_mmap_supported(void) {
  6952. return llama_mmap::SUPPORTED;
  6953. }
  6954. bool llama_mlock_supported(void) {
  6955. return llama_mlock::SUPPORTED;
  6956. }
  6957. void llama_backend_init(bool numa) {
  6958. ggml_time_init();
  6959. // needed to initialize f16 tables
  6960. {
  6961. struct ggml_init_params params = { 0, NULL, false };
  6962. struct ggml_context * ctx = ggml_init(params);
  6963. ggml_free(ctx);
  6964. }
  6965. if (numa) {
  6966. ggml_numa_init();
  6967. }
  6968. #ifdef GGML_USE_MPI
  6969. ggml_mpi_backend_init();
  6970. #endif
  6971. }
  6972. void llama_backend_free(void) {
  6973. #ifdef GGML_USE_MPI
  6974. ggml_mpi_backend_free();
  6975. #endif
  6976. }
  6977. int64_t llama_time_us(void) {
  6978. return ggml_time_us();
  6979. }
  6980. struct llama_model * llama_load_model_from_file(
  6981. const char * path_model,
  6982. struct llama_model_params params) {
  6983. ggml_time_init();
  6984. llama_model * model = new llama_model;
  6985. unsigned cur_percentage = 0;
  6986. if (params.progress_callback == NULL) {
  6987. params.progress_callback_user_data = &cur_percentage;
  6988. params.progress_callback = [](float progress, void * ctx) {
  6989. unsigned * cur_percentage_p = (unsigned *) ctx;
  6990. unsigned percentage = (unsigned) (100 * progress);
  6991. while (percentage > *cur_percentage_p) {
  6992. *cur_percentage_p = percentage;
  6993. LLAMA_LOG_INFO(".");
  6994. if (percentage >= 100) {
  6995. LLAMA_LOG_INFO("\n");
  6996. }
  6997. }
  6998. };
  6999. }
  7000. if (!llama_model_load(path_model, *model, params)) {
  7001. LLAMA_LOG_ERROR("%s: failed to load model\n", __func__);
  7002. delete model;
  7003. return nullptr;
  7004. }
  7005. return model;
  7006. }
  7007. void llama_free_model(struct llama_model * model) {
  7008. delete model;
  7009. }
  7010. struct llama_context * llama_new_context_with_model(
  7011. struct llama_model * model,
  7012. struct llama_context_params params) {
  7013. if (!model) {
  7014. return nullptr;
  7015. }
  7016. llama_context * ctx = new llama_context(*model);
  7017. const auto & hparams = model->hparams;
  7018. auto & cparams = ctx->cparams;
  7019. cparams.n_batch = params.n_batch;
  7020. cparams.n_threads = params.n_threads;
  7021. cparams.n_threads_batch = params.n_threads_batch;
  7022. cparams.yarn_ext_factor = params.yarn_ext_factor;
  7023. cparams.yarn_attn_factor = params.yarn_attn_factor;
  7024. cparams.yarn_beta_fast = params.yarn_beta_fast;
  7025. cparams.yarn_beta_slow = params.yarn_beta_slow;
  7026. cparams.mul_mat_q = params.mul_mat_q;
  7027. cparams.n_ctx = params.n_ctx == 0 ? hparams.n_ctx_train : params.n_ctx;
  7028. cparams.rope_freq_base = params.rope_freq_base == 0.0f ? hparams.rope_freq_base_train : params.rope_freq_base;
  7029. cparams.rope_freq_scale = params.rope_freq_scale == 0.0f ? hparams.rope_freq_scale_train : params.rope_freq_scale;
  7030. cparams.n_yarn_orig_ctx = params.yarn_orig_ctx != 0 ? params.yarn_orig_ctx :
  7031. hparams.n_yarn_orig_ctx != 0 ? hparams.n_yarn_orig_ctx :
  7032. hparams.n_ctx_train;
  7033. auto rope_scaling_type = params.rope_scaling_type;
  7034. if (rope_scaling_type == LLAMA_ROPE_SCALING_UNSPECIFIED) {
  7035. rope_scaling_type = hparams.rope_scaling_type_train;
  7036. }
  7037. if (rope_scaling_type == LLAMA_ROPE_SCALING_NONE) {
  7038. cparams.rope_freq_scale = 1.0f; // never scale if scaling type is none
  7039. }
  7040. if (cparams.yarn_ext_factor < 0.0f) { // negative indicates 'not set'
  7041. cparams.yarn_ext_factor = rope_scaling_type == LLAMA_ROPE_SCALING_YARN ? 1.0f : 0.0f;
  7042. }
  7043. if (params.seed == LLAMA_DEFAULT_SEED) {
  7044. params.seed = time(NULL);
  7045. }
  7046. LLAMA_LOG_INFO("%s: n_ctx = %u\n", __func__, cparams.n_ctx);
  7047. LLAMA_LOG_INFO("%s: freq_base = %.1f\n", __func__, cparams.rope_freq_base);
  7048. LLAMA_LOG_INFO("%s: freq_scale = %g\n", __func__, cparams.rope_freq_scale);
  7049. ctx->rng = std::mt19937(params.seed);
  7050. ctx->logits_all = params.logits_all;
  7051. ggml_type memory_type = params.f16_kv ? GGML_TYPE_F16 : GGML_TYPE_F32;
  7052. // reserve memory for context buffers
  7053. if (!hparams.vocab_only) {
  7054. if (!llama_kv_cache_init(ctx->model.hparams, ctx->kv_self, memory_type, cparams.n_ctx, model->n_gpu_layers)) {
  7055. LLAMA_LOG_ERROR("%s: llama_kv_cache_init() failed for self-attention cache\n", __func__);
  7056. llama_free(ctx);
  7057. return nullptr;
  7058. }
  7059. {
  7060. const size_t memory_size = ggml_nbytes(ctx->kv_self.k) + ggml_nbytes(ctx->kv_self.v);
  7061. LLAMA_LOG_INFO("%s: kv self size = %7.2f MiB\n", __func__, memory_size / 1024.0 / 1024.0);
  7062. }
  7063. // resized during inference
  7064. if (params.logits_all) {
  7065. ctx->logits.reserve(cparams.n_ctx*hparams.n_vocab);
  7066. } else {
  7067. ctx->logits.reserve(hparams.n_vocab);
  7068. }
  7069. if (params.embedding){
  7070. ctx->embedding.resize(hparams.n_embd);
  7071. }
  7072. {
  7073. static const size_t tensor_alignment = 32;
  7074. // the compute buffer is used to store the tensor and graph structs, while the allocator buffer is used for the tensor data
  7075. ctx->buf_compute.resize(ggml_tensor_overhead()*LLAMA_MAX_NODES + ggml_graph_overhead());
  7076. // create measure allocator
  7077. ctx->alloc = ggml_allocr_new_measure(tensor_alignment);
  7078. // build worst-case graph
  7079. int n_tokens = (int)std::min(cparams.n_ctx, cparams.n_batch);
  7080. int n_past = cparams.n_ctx - n_tokens;
  7081. llama_token token = llama_token_bos(&ctx->model); // not actually used by llama_build_graph, but required to choose between token and embedding inputs graph
  7082. ggml_cgraph * gf = llama_build_graph(*ctx, llama_batch_get_one(&token, n_tokens, n_past, 0));
  7083. #ifdef GGML_USE_METAL
  7084. if (model->n_gpu_layers > 0) {
  7085. ctx->ctx_metal = ggml_metal_init(1);
  7086. if (!ctx->ctx_metal) {
  7087. LLAMA_LOG_ERROR("%s: ggml_metal_init() failed\n", __func__);
  7088. llama_free(ctx);
  7089. return NULL;
  7090. }
  7091. //ggml_metal_graph_find_concurrency(ctx->ctx_metal, gf, false);
  7092. //ggml_allocr_set_parse_seq(ctx->alloc, ggml_metal_get_concur_list(ctx->ctx_metal), ggml_metal_if_optimized(ctx->ctx_metal));
  7093. }
  7094. #endif
  7095. // measure memory requirements for the graph
  7096. size_t alloc_size = ggml_allocr_alloc_graph(ctx->alloc, gf) + tensor_alignment;
  7097. LLAMA_LOG_INFO("%s: compute buffer total size = %.2f MiB\n", __func__, (ctx->buf_compute.size + alloc_size) / 1024.0 / 1024.0);
  7098. // recreate allocator with exact memory requirements
  7099. ggml_allocr_free(ctx->alloc);
  7100. ctx->buf_alloc.resize(alloc_size);
  7101. ctx->alloc = ggml_allocr_new(ctx->buf_alloc.data, ctx->buf_alloc.size, tensor_alignment);
  7102. #ifdef GGML_USE_METAL
  7103. if (ctx->ctx_metal) {
  7104. //ggml_allocr_set_parse_seq(ctx->alloc, ggml_metal_get_concur_list(ctx->ctx_metal), ggml_metal_if_optimized(ctx->ctx_metal));
  7105. }
  7106. #endif
  7107. #ifdef GGML_USE_CUBLAS
  7108. ggml_cuda_set_scratch_size(alloc_size);
  7109. LLAMA_LOG_INFO("%s: VRAM scratch buffer: %.2f MiB\n", __func__, alloc_size / 1024.0 / 1024.0);
  7110. // calculate total VRAM usage
  7111. auto add_tensor = [](const ggml_tensor * t, size_t & size) {
  7112. if (t->backend == GGML_BACKEND_GPU || t->backend == GGML_BACKEND_GPU_SPLIT) {
  7113. size += ggml_nbytes(t);
  7114. }
  7115. };
  7116. size_t model_vram_size = 0;
  7117. for (const auto & kv : model->tensors_by_name) {
  7118. add_tensor(kv.second, model_vram_size);
  7119. }
  7120. size_t kv_vram_size = 0;
  7121. add_tensor(ctx->kv_self.k, kv_vram_size);
  7122. add_tensor(ctx->kv_self.v, kv_vram_size);
  7123. size_t ctx_vram_size = alloc_size + kv_vram_size;
  7124. size_t total_vram_size = model_vram_size + ctx_vram_size;
  7125. LLAMA_LOG_INFO("%s: total VRAM used: %.2f MiB (model: %.2f MiB, context: %.2f MiB)\n", __func__,
  7126. total_vram_size / 1024.0 / 1024.0,
  7127. model_vram_size / 1024.0 / 1024.0,
  7128. ctx_vram_size / 1024.0 / 1024.0);
  7129. #endif
  7130. }
  7131. #ifdef GGML_USE_METAL
  7132. if (model->n_gpu_layers > 0) {
  7133. // this allocates all Metal resources and memory buffers
  7134. void * data_ptr = NULL;
  7135. size_t data_size = 0;
  7136. if (ctx->model.mapping) {
  7137. data_ptr = ctx->model.mapping->addr;
  7138. data_size = ctx->model.mapping->size;
  7139. } else {
  7140. data_ptr = ggml_get_mem_buffer(ctx->model.ctx);
  7141. data_size = ggml_get_mem_size (ctx->model.ctx);
  7142. }
  7143. const size_t max_size = ggml_get_max_tensor_size(ctx->model.ctx);
  7144. LLAMA_LOG_INFO("%s: max tensor size = %8.2f MiB\n", __func__, max_size/1024.0/1024.0);
  7145. #define LLAMA_METAL_CHECK_BUF(result) \
  7146. if (!(result)) { \
  7147. LLAMA_LOG_ERROR("%s: failed to add buffer\n", __func__); \
  7148. llama_free(ctx); \
  7149. return NULL; \
  7150. }
  7151. LLAMA_METAL_CHECK_BUF(ggml_metal_add_buffer(ctx->ctx_metal, "data", data_ptr, data_size, max_size));
  7152. LLAMA_METAL_CHECK_BUF(ggml_metal_add_buffer(ctx->ctx_metal, "kv", ctx->kv_self.buf.data, ctx->kv_self.buf.size, 0));
  7153. LLAMA_METAL_CHECK_BUF(ggml_metal_add_buffer(ctx->ctx_metal, "alloc", ctx->buf_alloc.data, ctx->buf_alloc.size, 0));
  7154. #undef LLAMA_METAL_CHECK_BUF
  7155. }
  7156. #endif
  7157. }
  7158. #ifdef GGML_USE_MPI
  7159. ctx->ctx_mpi = ggml_mpi_init();
  7160. if (ggml_mpi_rank(ctx->ctx_mpi) > 0) {
  7161. // Enter a blocking eval loop with dummy input, letting rank=0 drive the process
  7162. // TODO: needs fix after #3228
  7163. GGML_ASSERT(false && "not implemented");
  7164. //const std::vector<llama_token> tmp(ctx->model.hparams.n_ctx, llama_token_bos(ctx));
  7165. //while (!llama_eval(ctx, tmp.data(), tmp.size(), 0, 0)) {};
  7166. llama_backend_free();
  7167. exit(1);
  7168. }
  7169. #endif
  7170. return ctx;
  7171. }
  7172. void llama_free(struct llama_context * ctx) {
  7173. delete ctx;
  7174. }
  7175. const llama_model * llama_get_model(const struct llama_context * ctx) {
  7176. return &ctx->model;
  7177. }
  7178. int llama_n_ctx(const struct llama_context * ctx) {
  7179. return ctx->cparams.n_ctx;
  7180. }
  7181. enum llama_vocab_type llama_vocab_type(const struct llama_model * model) {
  7182. return model->vocab.type;
  7183. }
  7184. int llama_n_vocab(const struct llama_model * model) {
  7185. return model->vocab.id_to_token.size();
  7186. }
  7187. int llama_n_ctx_train(const struct llama_model * model) {
  7188. return model->hparams.n_ctx_train;
  7189. }
  7190. int llama_n_embd(const struct llama_model * model) {
  7191. return model->hparams.n_embd;
  7192. }
  7193. float llama_rope_freq_scale_train(const struct llama_model * model) {
  7194. return model->hparams.rope_freq_scale_train;
  7195. }
  7196. int llama_model_meta_val_str(const struct llama_model * model, const char * key, char * buf, size_t buf_size) {
  7197. const auto & it = model->gguf_kv.find(key);
  7198. if (it == model->gguf_kv.end()) {
  7199. if (buf_size > 0) {
  7200. buf[0] = '\0';
  7201. }
  7202. return -1;
  7203. }
  7204. return snprintf(buf, buf_size, "%s", it->second.c_str());
  7205. }
  7206. int llama_model_meta_count(const struct llama_model * model) {
  7207. return (int)model->gguf_kv.size();
  7208. }
  7209. int llama_model_meta_key_by_index(const struct llama_model * model, int i, char * buf, size_t buf_size) {
  7210. if (i < 0 || i >= (int)model->gguf_kv.size()) {
  7211. if (buf_size > 0) {
  7212. buf[0] = '\0';
  7213. }
  7214. return -1;
  7215. }
  7216. auto it = model->gguf_kv.begin();
  7217. std::advance(it, i);
  7218. return snprintf(buf, buf_size, "%s", it->first.c_str());
  7219. }
  7220. int llama_model_meta_val_str_by_index(const struct llama_model * model, int i, char * buf, size_t buf_size) {
  7221. if (i < 0 || i >= (int)model->gguf_kv.size()) {
  7222. if (buf_size > 0) {
  7223. buf[0] = '\0';
  7224. }
  7225. return -1;
  7226. }
  7227. auto it = model->gguf_kv.begin();
  7228. std::advance(it, i);
  7229. return snprintf(buf, buf_size, "%s", it->second.c_str());
  7230. }
  7231. int llama_model_desc(const struct llama_model * model, char * buf, size_t buf_size) {
  7232. return snprintf(buf, buf_size, "%s %s %s",
  7233. llama_model_arch_name(model->arch).c_str(),
  7234. llama_model_type_name(model->type),
  7235. llama_model_ftype_name(model->ftype).c_str());
  7236. }
  7237. uint64_t llama_model_size(const struct llama_model * model) {
  7238. uint64_t size = 0;
  7239. for (const auto & it : model->tensors_by_name) {
  7240. size += ggml_nbytes(it.second);
  7241. }
  7242. return size;
  7243. }
  7244. uint64_t llama_model_n_params(const struct llama_model * model) {
  7245. uint64_t nparams = 0;
  7246. for (const auto & it : model->tensors_by_name) {
  7247. nparams += ggml_nelements(it.second);
  7248. }
  7249. return nparams;
  7250. }
  7251. struct ggml_tensor * llama_get_model_tensor(struct llama_model * model, const char * name) {
  7252. return ggml_get_tensor(model->ctx, name);
  7253. }
  7254. int llama_model_quantize(
  7255. const char * fname_inp,
  7256. const char * fname_out,
  7257. const llama_model_quantize_params * params) {
  7258. try {
  7259. llama_model_quantize_internal(fname_inp, fname_out, params);
  7260. return 0;
  7261. } catch (const std::exception & err) {
  7262. LLAMA_LOG_ERROR("%s: failed to quantize: %s\n", __func__, err.what());
  7263. return 1;
  7264. }
  7265. }
  7266. int llama_apply_lora_from_file(struct llama_context * ctx, const char * path_lora, float scale, const char * path_base_model, int n_threads) {
  7267. try {
  7268. return llama_apply_lora_from_file_internal(ctx->model, path_lora, scale, path_base_model, n_threads);
  7269. } catch (const std::exception & err) {
  7270. LLAMA_LOG_ERROR("%s: failed to apply lora adapter: %s\n", __func__, err.what());
  7271. return 1;
  7272. }
  7273. }
  7274. int llama_model_apply_lora_from_file(const struct llama_model * model, const char * path_lora, float scale, const char * path_base_model, int n_threads) {
  7275. try {
  7276. return llama_apply_lora_from_file_internal(*model, path_lora, scale, path_base_model, n_threads);
  7277. } catch (const std::exception & err) {
  7278. LLAMA_LOG_ERROR("%s: failed to apply lora adapter: %s\n", __func__, err.what());
  7279. return 1;
  7280. }
  7281. }
  7282. struct llama_kv_cache_view llama_kv_cache_view_init(const struct llama_context * ctx, int32_t n_max_seq) {
  7283. struct llama_kv_cache_view result = {
  7284. /*.n_cells = */ 0,
  7285. /*.n_max_seq = */ n_max_seq,
  7286. /*.token_count = */ 0,
  7287. /*.used_cells = */ llama_get_kv_cache_used_cells(ctx),
  7288. /*.max_contiguous = */ 0,
  7289. /*.max_contiguous_idx = */ -1,
  7290. /*.cells = */ nullptr,
  7291. /*.cells_sequences = */ nullptr,
  7292. };
  7293. return result;
  7294. }
  7295. void llama_kv_cache_view_free(struct llama_kv_cache_view * view) {
  7296. if (view->cells != nullptr) {
  7297. free(view->cells);
  7298. view->cells = nullptr;
  7299. }
  7300. if (view->cells_sequences != nullptr) {
  7301. free(view->cells_sequences);
  7302. view->cells_sequences = nullptr;
  7303. }
  7304. }
  7305. void llama_kv_cache_view_update(const struct llama_context * ctx, struct llama_kv_cache_view * view) {
  7306. if (uint32_t(view->n_cells) < ctx->kv_self.size || view->cells == nullptr) {
  7307. view->n_cells = int32_t(ctx->kv_self.size);
  7308. void * p = realloc(view->cells, sizeof(struct llama_kv_cache_view_cell) * view->n_cells);
  7309. GGML_ASSERT(p != nullptr && "Failed to alloc kv_cache_view cells");
  7310. view->cells = (struct llama_kv_cache_view_cell *)p;
  7311. p = realloc(view->cells_sequences, sizeof(llama_seq_id) * view->n_max_seq * view->n_cells);
  7312. GGML_ASSERT(p != nullptr && "Failed to alloc kv_cache_view cells sequences");
  7313. view->cells_sequences = (llama_seq_id *)p;
  7314. }
  7315. const std::vector<llama_kv_cell> & kv_cells = ctx->kv_self.cells;
  7316. llama_kv_cache_view_cell * c_curr = view->cells;
  7317. llama_seq_id * cs_curr = view->cells_sequences;
  7318. int32_t used_cells = 0;
  7319. int32_t token_count = 0;
  7320. int32_t curr_contig_idx = -1;
  7321. uint32_t max_contig = 0;
  7322. int32_t max_contig_idx = -1;
  7323. for (int32_t i = 0; i < int32_t(ctx->kv_self.size); i++, c_curr++, cs_curr += view->n_max_seq) {
  7324. const size_t curr_size = kv_cells[i].seq_id.size();
  7325. token_count += curr_size;
  7326. c_curr->pos = kv_cells[i].pos + kv_cells[i].delta;
  7327. if (curr_size > 0) {
  7328. if (curr_contig_idx >= 0 && uint32_t(i - curr_contig_idx) > max_contig) {
  7329. max_contig = i - curr_contig_idx;
  7330. max_contig_idx = curr_contig_idx;
  7331. }
  7332. curr_contig_idx = -1;
  7333. } else if (curr_contig_idx < 0) {
  7334. curr_contig_idx = i;
  7335. }
  7336. int seq_idx = 0;
  7337. for (const llama_seq_id it : kv_cells[i].seq_id) {
  7338. if (seq_idx >= view->n_max_seq) {
  7339. break;
  7340. }
  7341. cs_curr[seq_idx] = it;
  7342. seq_idx++;
  7343. }
  7344. if (seq_idx != 0) {
  7345. used_cells++;
  7346. }
  7347. for (; seq_idx < view->n_max_seq; seq_idx++) {
  7348. cs_curr[seq_idx] = -1;
  7349. }
  7350. }
  7351. if (curr_contig_idx >= 0 && kv_cells.size() - curr_contig_idx > max_contig) {
  7352. max_contig_idx = curr_contig_idx;
  7353. max_contig = kv_cells.size() - curr_contig_idx;
  7354. }
  7355. view->max_contiguous = max_contig;
  7356. view->max_contiguous_idx = max_contig_idx;
  7357. view->token_count = token_count;
  7358. view->used_cells = used_cells;
  7359. if (uint32_t(used_cells) != ctx->kv_self.used) {
  7360. LLAMA_LOG_ERROR("%s: used cells mismatch. kv_cache says %d but we calculated %d\n",
  7361. __func__, ctx->kv_self.used, used_cells);
  7362. }
  7363. }
  7364. int llama_get_kv_cache_token_count(const struct llama_context * ctx) {
  7365. int result = 0;
  7366. for (uint32_t i = 0; i < ctx->kv_self.size; i++) {
  7367. result += ctx->kv_self.cells[i].seq_id.size();
  7368. }
  7369. return result;
  7370. }
  7371. int llama_get_kv_cache_used_cells(const struct llama_context * ctx) {
  7372. return ctx->kv_self.used;
  7373. }
  7374. void llama_kv_cache_clear(struct llama_context * ctx) {
  7375. llama_kv_cache_clear(ctx->kv_self);
  7376. }
  7377. void llama_kv_cache_seq_rm(struct llama_context * ctx, llama_seq_id seq_id, llama_pos p0, llama_pos p1) {
  7378. llama_kv_cache_seq_rm(ctx->kv_self, seq_id, p0, p1);
  7379. }
  7380. void llama_kv_cache_seq_cp(struct llama_context * ctx, llama_seq_id seq_id_src, llama_seq_id seq_id_dst, llama_pos p0, llama_pos p1) {
  7381. if (seq_id_src == seq_id_dst) {
  7382. return;
  7383. }
  7384. llama_kv_cache_seq_cp(ctx->kv_self, seq_id_src, seq_id_dst, p0, p1);
  7385. }
  7386. void llama_kv_cache_seq_keep(struct llama_context * ctx, llama_seq_id seq_id) {
  7387. llama_kv_cache_seq_keep(ctx->kv_self, seq_id);
  7388. }
  7389. void llama_kv_cache_seq_shift(struct llama_context * ctx, llama_seq_id seq_id, llama_pos p0, llama_pos p1, llama_pos delta) {
  7390. llama_kv_cache_seq_shift(ctx->kv_self, seq_id, p0, p1, delta);
  7391. }
  7392. // Returns the *maximum* size of the state
  7393. size_t llama_get_state_size(const struct llama_context * ctx) {
  7394. // we don't know size of rng until we actually serialize it. so reserve more than enough memory for its serialized state.
  7395. // for reference, std::mt19937(1337) serializes to 6701 bytes.
  7396. const size_t s_rng_size = sizeof(size_t);
  7397. const size_t s_rng = LLAMA_MAX_RNG_STATE;
  7398. const size_t s_logits_capacity = sizeof(size_t);
  7399. const size_t s_logits_size = sizeof(size_t);
  7400. const size_t s_logits = ctx->logits.capacity() * sizeof(float);
  7401. const size_t s_embedding_size = sizeof(size_t);
  7402. const size_t s_embedding = ctx->embedding.size() * sizeof(float);
  7403. const size_t s_kv_size = sizeof(size_t);
  7404. const size_t s_kv_ntok = sizeof(int);
  7405. const size_t s_kv = ctx->kv_self.buf.size;
  7406. const size_t s_total = (
  7407. + s_rng_size
  7408. + s_rng
  7409. + s_logits_capacity
  7410. + s_logits_size
  7411. + s_logits
  7412. + s_embedding_size
  7413. + s_embedding
  7414. + s_kv_size
  7415. + s_kv_ntok
  7416. + s_kv
  7417. );
  7418. return s_total;
  7419. }
  7420. // llama_context_data
  7421. struct llama_data_context {
  7422. virtual void write(const void * src, size_t size) = 0;
  7423. virtual size_t get_size_written() = 0;
  7424. virtual ~llama_data_context() = default;
  7425. };
  7426. struct llama_data_buffer_context : llama_data_context {
  7427. uint8_t * ptr;
  7428. size_t size_written = 0;
  7429. llama_data_buffer_context(uint8_t * p) : ptr(p) {}
  7430. void write(const void * src, size_t size) override {
  7431. memcpy(ptr, src, size);
  7432. ptr += size;
  7433. size_written += size;
  7434. }
  7435. size_t get_size_written() override {
  7436. return size_written;
  7437. }
  7438. };
  7439. struct llama_data_file_context : llama_data_context {
  7440. llama_file * file;
  7441. size_t size_written = 0;
  7442. llama_data_file_context(llama_file * f) : file(f) {}
  7443. void write(const void * src, size_t size) override {
  7444. file->write_raw(src, size);
  7445. size_written += size;
  7446. }
  7447. size_t get_size_written() override {
  7448. return size_written;
  7449. }
  7450. };
  7451. /** copy state data into either a buffer or file depending on the passed in context
  7452. *
  7453. * file context:
  7454. * llama_file file("/path", "wb");
  7455. * llama_data_file_context data_ctx(&file);
  7456. * llama_copy_state_data(ctx, &data_ctx);
  7457. *
  7458. * buffer context:
  7459. * std::vector<uint8_t> buf(max_size, 0);
  7460. * llama_data_buffer_context data_ctx(&buf.data());
  7461. * llama_copy_state_data(ctx, &data_ctx);
  7462. *
  7463. */
  7464. static void llama_copy_state_data_internal(struct llama_context * ctx, llama_data_context * data_ctx) {
  7465. // copy rng
  7466. {
  7467. std::stringstream rng_ss;
  7468. rng_ss << ctx->rng;
  7469. const size_t rng_size = rng_ss.str().size();
  7470. char rng_buf[LLAMA_MAX_RNG_STATE];
  7471. memset(&rng_buf[0], 0, LLAMA_MAX_RNG_STATE);
  7472. memcpy(&rng_buf[0], rng_ss.str().data(), rng_ss.str().size());
  7473. data_ctx->write(&rng_size, sizeof(rng_size));
  7474. data_ctx->write(&rng_buf[0], LLAMA_MAX_RNG_STATE);
  7475. }
  7476. // copy logits
  7477. {
  7478. const size_t logits_cap = ctx->logits.capacity();
  7479. const size_t logits_size = ctx->logits.size();
  7480. data_ctx->write(&logits_cap, sizeof(logits_cap));
  7481. data_ctx->write(&logits_size, sizeof(logits_size));
  7482. if (logits_size) {
  7483. data_ctx->write(ctx->logits.data(), logits_size * sizeof(float));
  7484. }
  7485. // If there is a gap between the size and the capacity, write padding
  7486. size_t padding_size = (logits_cap - logits_size) * sizeof(float);
  7487. if (padding_size > 0) {
  7488. std::vector<uint8_t> padding(padding_size, 0); // Create a buffer filled with zeros
  7489. data_ctx->write(padding.data(), padding_size);
  7490. }
  7491. }
  7492. // copy embeddings
  7493. {
  7494. const size_t embedding_size = ctx->embedding.size();
  7495. data_ctx->write(&embedding_size, sizeof(embedding_size));
  7496. if (embedding_size) {
  7497. data_ctx->write(ctx->embedding.data(), embedding_size * sizeof(float));
  7498. }
  7499. }
  7500. // copy kv cache
  7501. {
  7502. const auto & kv_self = ctx->kv_self;
  7503. const auto & hparams = ctx->model.hparams;
  7504. const auto & cparams = ctx->cparams;
  7505. const auto n_layer = hparams.n_layer;
  7506. const auto n_embd = hparams.n_embd_gqa();
  7507. const auto n_ctx = cparams.n_ctx;
  7508. const size_t kv_buf_size = kv_self.buf.size;
  7509. const uint32_t kv_head = kv_self.head;
  7510. const uint32_t kv_size = kv_self.size;
  7511. const uint32_t kv_used = kv_self.used;
  7512. data_ctx->write(&kv_buf_size, sizeof(kv_buf_size));
  7513. data_ctx->write(&kv_head, sizeof(kv_head));
  7514. data_ctx->write(&kv_size, sizeof(kv_size));
  7515. data_ctx->write(&kv_used, sizeof(kv_used));
  7516. if (kv_buf_size) {
  7517. const size_t elt_size = ggml_element_size(kv_self.k);
  7518. ggml_context * cpy_ctx = ggml_init({ 6*ggml_tensor_overhead() + ggml_graph_overhead(), NULL, /* no_alloc */ true });
  7519. ggml_cgraph * gf = ggml_new_graph(cpy_ctx);
  7520. ggml_tensor * kout3d = ggml_new_tensor_3d(cpy_ctx, kv_self.k->type, n_embd, kv_head, n_layer);
  7521. std::vector<uint8_t> kout3d_data(ggml_nbytes(kout3d), 0);
  7522. kout3d->data = kout3d_data.data();
  7523. ggml_tensor * vout3d = ggml_new_tensor_3d(cpy_ctx, kv_self.v->type, kv_head, n_embd, n_layer);
  7524. std::vector<uint8_t> vout3d_data(ggml_nbytes(vout3d), 0);
  7525. vout3d->data = vout3d_data.data();
  7526. ggml_tensor * k3d = ggml_view_3d(cpy_ctx, kv_self.k,
  7527. n_embd, kv_head, n_layer,
  7528. elt_size*n_embd, elt_size*n_embd*n_ctx, 0);
  7529. ggml_tensor * v3d = ggml_view_3d(cpy_ctx, kv_self.v,
  7530. kv_head, n_embd, n_layer,
  7531. elt_size*n_ctx, elt_size*n_ctx*n_embd, 0);
  7532. ggml_build_forward_expand(gf, ggml_cpy(cpy_ctx, k3d, kout3d));
  7533. ggml_build_forward_expand(gf, ggml_cpy(cpy_ctx, v3d, vout3d));
  7534. ggml_graph_compute_helper(ctx->work_buffer, gf, /*n_threads*/ 1);
  7535. ggml_free(cpy_ctx);
  7536. // our data is now in the kout3d_data and vout3d_data buffers
  7537. // write them to file
  7538. data_ctx->write(kout3d_data.data(), kout3d_data.size());
  7539. data_ctx->write(vout3d_data.data(), vout3d_data.size());
  7540. }
  7541. for (uint32_t i = 0; i < kv_size; ++i) {
  7542. const auto & cell = kv_self.cells[i];
  7543. const llama_pos pos = cell.pos;
  7544. const size_t seq_id_size = cell.seq_id.size();
  7545. data_ctx->write(&pos, sizeof(pos));
  7546. data_ctx->write(&seq_id_size, sizeof(seq_id_size));
  7547. for (auto seq_id : cell.seq_id) {
  7548. data_ctx->write(&seq_id, sizeof(seq_id));
  7549. }
  7550. }
  7551. }
  7552. }
  7553. size_t llama_copy_state_data(struct llama_context * ctx, uint8_t * dst) {
  7554. llama_data_buffer_context data_ctx(dst);
  7555. llama_copy_state_data_internal(ctx, &data_ctx);
  7556. return data_ctx.get_size_written();
  7557. }
  7558. // Sets the state reading from the specified source address
  7559. size_t llama_set_state_data(struct llama_context * ctx, uint8_t * src) {
  7560. uint8_t * inp = src;
  7561. // set rng
  7562. {
  7563. size_t rng_size;
  7564. char rng_buf[LLAMA_MAX_RNG_STATE];
  7565. memcpy(&rng_size, inp, sizeof(rng_size)); inp += sizeof(rng_size);
  7566. memcpy(&rng_buf[0], inp, LLAMA_MAX_RNG_STATE); inp += LLAMA_MAX_RNG_STATE;
  7567. std::stringstream rng_ss;
  7568. rng_ss.str(std::string(&rng_buf[0], rng_size));
  7569. rng_ss >> ctx->rng;
  7570. GGML_ASSERT(!rng_ss.fail());
  7571. }
  7572. // set logits
  7573. {
  7574. size_t logits_cap;
  7575. size_t logits_size;
  7576. memcpy(&logits_cap, inp, sizeof(logits_cap)); inp += sizeof(logits_cap);
  7577. memcpy(&logits_size, inp, sizeof(logits_size)); inp += sizeof(logits_size);
  7578. GGML_ASSERT(ctx->logits.capacity() == logits_cap);
  7579. if (logits_size) {
  7580. ctx->logits.resize(logits_size);
  7581. memcpy(ctx->logits.data(), inp, logits_size * sizeof(float));
  7582. }
  7583. inp += logits_cap * sizeof(float);
  7584. }
  7585. // set embeddings
  7586. {
  7587. size_t embedding_size;
  7588. memcpy(&embedding_size, inp, sizeof(embedding_size)); inp += sizeof(embedding_size);
  7589. GGML_ASSERT(ctx->embedding.capacity() == embedding_size);
  7590. if (embedding_size) {
  7591. memcpy(ctx->embedding.data(), inp, embedding_size * sizeof(float));
  7592. inp += embedding_size * sizeof(float);
  7593. }
  7594. }
  7595. // set kv cache
  7596. {
  7597. const auto & kv_self = ctx->kv_self;
  7598. const auto & hparams = ctx->model.hparams;
  7599. const auto & cparams = ctx->cparams;
  7600. const int n_layer = hparams.n_layer;
  7601. const int n_embd = hparams.n_embd_gqa();
  7602. const int n_ctx = cparams.n_ctx;
  7603. size_t kv_buf_size;
  7604. uint32_t kv_head;
  7605. uint32_t kv_size;
  7606. uint32_t kv_used;
  7607. memcpy(&kv_buf_size, inp, sizeof(kv_buf_size)); inp += sizeof(kv_buf_size);
  7608. memcpy(&kv_head, inp, sizeof(kv_head)); inp += sizeof(kv_head);
  7609. memcpy(&kv_size, inp, sizeof(kv_size)); inp += sizeof(kv_size);
  7610. memcpy(&kv_used, inp, sizeof(kv_used)); inp += sizeof(kv_used);
  7611. if (kv_buf_size) {
  7612. GGML_ASSERT(kv_self.buf.size == kv_buf_size);
  7613. const size_t elt_size = ggml_element_size(kv_self.k);
  7614. ggml_context * cpy_ctx = ggml_init({ 6*ggml_tensor_overhead() + ggml_graph_overhead(), NULL, /* no_alloc */ true });
  7615. ggml_cgraph * gf = ggml_new_graph(cpy_ctx);
  7616. ggml_tensor * kin3d = ggml_new_tensor_3d(cpy_ctx, kv_self.k->type, n_embd, kv_head, n_layer);
  7617. kin3d->data = (void *) inp;
  7618. inp += ggml_nbytes(kin3d);
  7619. ggml_tensor * vin3d = ggml_new_tensor_3d(cpy_ctx, kv_self.v->type, kv_head, n_embd, n_layer);
  7620. vin3d->data = (void *) inp;
  7621. inp += ggml_nbytes(vin3d);
  7622. ggml_tensor * k3d = ggml_view_3d(cpy_ctx, kv_self.k,
  7623. n_embd, kv_head, n_layer,
  7624. elt_size*n_embd, elt_size*n_embd*n_ctx, 0);
  7625. ggml_tensor * v3d = ggml_view_3d(cpy_ctx, kv_self.v,
  7626. kv_head, n_embd, n_layer,
  7627. elt_size*n_ctx, elt_size*n_ctx*n_embd, 0);
  7628. ggml_build_forward_expand(gf, ggml_cpy(cpy_ctx, kin3d, k3d));
  7629. ggml_build_forward_expand(gf, ggml_cpy(cpy_ctx, vin3d, v3d));
  7630. ggml_graph_compute_helper(ctx->work_buffer, gf, /*n_threads*/ 1);
  7631. ggml_free(cpy_ctx);
  7632. }
  7633. ctx->kv_self.head = kv_head;
  7634. ctx->kv_self.size = kv_size;
  7635. ctx->kv_self.used = kv_used;
  7636. ctx->kv_self.cells.resize(kv_size);
  7637. for (uint32_t i = 0; i < kv_size; ++i) {
  7638. llama_pos pos;
  7639. size_t seq_id_size;
  7640. memcpy(&pos, inp, sizeof(pos)); inp += sizeof(pos);
  7641. memcpy(&seq_id_size, inp, sizeof(seq_id_size)); inp += sizeof(seq_id_size);
  7642. ctx->kv_self.cells[i].pos = pos;
  7643. llama_seq_id seq_id;
  7644. for (size_t j = 0; j < seq_id_size; ++j) {
  7645. memcpy(&seq_id, inp, sizeof(seq_id)); inp += sizeof(seq_id);
  7646. ctx->kv_self.cells[i].seq_id.insert(seq_id);
  7647. }
  7648. }
  7649. }
  7650. const size_t nread = inp - src;
  7651. const size_t max_size = llama_get_state_size(ctx);
  7652. GGML_ASSERT(nread <= max_size);
  7653. return nread;
  7654. }
  7655. static bool llama_load_session_file_internal(struct llama_context * ctx, const char * path_session, llama_token * tokens_out, size_t n_token_capacity, size_t * n_token_count_out) {
  7656. llama_file file(path_session, "rb");
  7657. // sanity checks
  7658. {
  7659. const uint32_t magic = file.read_u32();
  7660. const uint32_t version = file.read_u32();
  7661. if (magic != LLAMA_SESSION_MAGIC || version != LLAMA_SESSION_VERSION) {
  7662. LLAMA_LOG_ERROR("%s : unknown (magic, version) for session file: %08x, %08x\n", __func__, magic, version);
  7663. return false;
  7664. }
  7665. llama_hparams session_hparams;
  7666. file.read_raw(&session_hparams, sizeof(llama_hparams));
  7667. if (session_hparams != ctx->model.hparams) {
  7668. LLAMA_LOG_INFO("%s : model hparams didn't match from session file!\n", __func__);
  7669. return false;
  7670. }
  7671. }
  7672. // load the prompt
  7673. {
  7674. const uint32_t n_token_count = file.read_u32();
  7675. if (n_token_count > n_token_capacity) {
  7676. LLAMA_LOG_ERROR("%s : token count in session file exceeded capacity! %u > %zu\n", __func__, n_token_count, n_token_capacity);
  7677. return false;
  7678. }
  7679. file.read_raw(tokens_out, sizeof(llama_token) * n_token_count);
  7680. *n_token_count_out = n_token_count;
  7681. }
  7682. // restore the context state
  7683. {
  7684. const size_t n_state_size_cur = file.size - file.tell();
  7685. const size_t n_state_size_max = llama_get_state_size(ctx);
  7686. if (n_state_size_cur > n_state_size_max) {
  7687. LLAMA_LOG_ERROR("%s : the state size in session file is too big! max %zu, got %zu\n", __func__, n_state_size_max, n_state_size_cur);
  7688. return false;
  7689. }
  7690. std::vector<uint8_t> state_data(n_state_size_max);
  7691. file.read_raw(state_data.data(), n_state_size_cur);
  7692. llama_set_state_data(ctx, state_data.data());
  7693. }
  7694. return true;
  7695. }
  7696. bool llama_load_session_file(struct llama_context * ctx, const char * path_session, llama_token * tokens_out, size_t n_token_capacity, size_t * n_token_count_out) {
  7697. try {
  7698. return llama_load_session_file_internal(ctx, path_session, tokens_out, n_token_capacity, n_token_count_out);
  7699. } catch (const std::exception & err) {
  7700. LLAMA_LOG_ERROR("error loading session file: %s\n", err.what());
  7701. return false;
  7702. }
  7703. }
  7704. bool llama_save_session_file(struct llama_context * ctx, const char * path_session, const llama_token * tokens, size_t n_token_count) {
  7705. llama_file file(path_session, "wb");
  7706. file.write_u32(LLAMA_SESSION_MAGIC);
  7707. file.write_u32(LLAMA_SESSION_VERSION);
  7708. file.write_raw(&ctx->model.hparams, sizeof(llama_hparams));
  7709. // save the prompt
  7710. file.write_u32((uint32_t) n_token_count);
  7711. file.write_raw(tokens, sizeof(llama_token) * n_token_count);
  7712. // save the context state using stream saving
  7713. llama_data_file_context data_ctx(&file);
  7714. llama_copy_state_data_internal(ctx, &data_ctx);
  7715. return true;
  7716. }
  7717. int llama_eval(
  7718. struct llama_context * ctx,
  7719. llama_token * tokens,
  7720. int32_t n_tokens,
  7721. int n_past) {
  7722. llama_kv_cache_seq_rm(ctx->kv_self, -1, n_past, -1);
  7723. const int ret = llama_decode_internal(*ctx, llama_batch_get_one(tokens, n_tokens, n_past, 0));
  7724. if (ret < 0) {
  7725. LLAMA_LOG_ERROR("%s: failed to decode, ret = %d\n", __func__, ret);
  7726. }
  7727. return ret;
  7728. }
  7729. int llama_eval_embd(
  7730. struct llama_context * ctx,
  7731. float * embd,
  7732. int32_t n_tokens,
  7733. int n_past) {
  7734. llama_kv_cache_seq_rm(ctx->kv_self, -1, n_past, -1);
  7735. llama_batch batch = { n_tokens, nullptr, embd, nullptr, nullptr, nullptr, nullptr, n_past, 1, 0, };
  7736. const int ret = llama_decode_internal(*ctx, batch);
  7737. if (ret < 0) {
  7738. LLAMA_LOG_ERROR("%s: failed to decode, ret = %d\n", __func__, ret);
  7739. }
  7740. return ret;
  7741. }
  7742. void llama_set_n_threads(struct llama_context * ctx, uint32_t n_threads, uint32_t n_threads_batch) {
  7743. ctx->cparams.n_threads = n_threads;
  7744. ctx->cparams.n_threads_batch = n_threads_batch;
  7745. }
  7746. struct llama_batch llama_batch_get_one(
  7747. llama_token * tokens,
  7748. int32_t n_tokens,
  7749. llama_pos pos_0,
  7750. llama_seq_id seq_id) {
  7751. return {
  7752. /*n_tokens =*/ n_tokens,
  7753. /*tokens =*/ tokens,
  7754. /*embd =*/ nullptr,
  7755. /*pos =*/ nullptr,
  7756. /*n_seq_id =*/ nullptr,
  7757. /*seq_id =*/ nullptr,
  7758. /*logits =*/ nullptr,
  7759. /*all_pos_0 =*/ pos_0,
  7760. /*all_pos_1 =*/ 1,
  7761. /*all_seq_id =*/ seq_id,
  7762. };
  7763. }
  7764. struct llama_batch llama_batch_init(int32_t n_tokens, int32_t embd, int32_t n_seq_max) {
  7765. llama_batch batch = { 0, nullptr, nullptr, nullptr, nullptr, nullptr, nullptr, 0, 0, 0, };
  7766. if (embd) {
  7767. batch.embd = (float *) malloc(sizeof(float) * n_tokens * embd);
  7768. } else {
  7769. batch.token = (llama_token *) malloc(sizeof(llama_token) * n_tokens);
  7770. }
  7771. batch.pos = (llama_pos *) malloc(sizeof(llama_pos) * n_tokens);
  7772. batch.n_seq_id = (int32_t *) malloc(sizeof(int32_t) * n_tokens);
  7773. batch.seq_id = (llama_seq_id **) malloc(sizeof(llama_seq_id *) * n_tokens);
  7774. for (int i = 0; i < n_tokens; ++i) {
  7775. batch.seq_id[i] = (llama_seq_id *) malloc(sizeof(llama_seq_id) * n_seq_max);
  7776. }
  7777. batch.logits = (int8_t *) malloc(sizeof(int8_t) * n_tokens);
  7778. return batch;
  7779. }
  7780. void llama_batch_free(struct llama_batch batch) {
  7781. if (batch.token) free(batch.token);
  7782. if (batch.embd) free(batch.embd);
  7783. if (batch.pos) free(batch.pos);
  7784. if (batch.n_seq_id) free(batch.n_seq_id);
  7785. if (batch.seq_id) {
  7786. for (int i = 0; i < batch.n_tokens; ++i) {
  7787. free(batch.seq_id[i]);
  7788. }
  7789. free(batch.seq_id);
  7790. }
  7791. if (batch.logits) free(batch.logits);
  7792. }
  7793. int llama_decode(
  7794. struct llama_context * ctx,
  7795. struct llama_batch batch) {
  7796. const int ret = llama_decode_internal(*ctx, batch);
  7797. if (ret < 0) {
  7798. LLAMA_LOG_ERROR("%s: failed to decode, ret = %d\n", __func__, ret);
  7799. }
  7800. return ret;
  7801. }
  7802. float * llama_get_logits(struct llama_context * ctx) {
  7803. return ctx->logits.data();
  7804. }
  7805. float * llama_get_logits_ith(struct llama_context * ctx, int32_t i) {
  7806. return ctx->logits.data() + i*ctx->model.hparams.n_vocab;
  7807. }
  7808. float * llama_get_embeddings(struct llama_context * ctx) {
  7809. return ctx->embedding.data();
  7810. }
  7811. const char * llama_token_get_text(const struct llama_model * model, llama_token token) {
  7812. return model->vocab.id_to_token[token].text.c_str();
  7813. }
  7814. float llama_token_get_score(const struct llama_model * model, llama_token token) {
  7815. return model->vocab.id_to_token[token].score;
  7816. }
  7817. llama_token_type llama_token_get_type(const struct llama_model * model, llama_token token) {
  7818. return model->vocab.id_to_token[token].type;
  7819. }
  7820. llama_token llama_token_bos(const struct llama_model * model) {
  7821. return model->vocab.special_bos_id;
  7822. }
  7823. llama_token llama_token_eos(const struct llama_model * model) {
  7824. return model->vocab.special_eos_id;
  7825. }
  7826. llama_token llama_token_nl(const struct llama_model * model) {
  7827. return model->vocab.linefeed_id;
  7828. }
  7829. int llama_add_bos_token(const struct llama_model * model) {
  7830. return model->vocab.special_add_bos;
  7831. }
  7832. int llama_add_eos_token(const struct llama_model * model) {
  7833. return model->vocab.special_add_eos;
  7834. }
  7835. llama_token llama_token_prefix(const struct llama_model * model) {
  7836. return model->vocab.special_prefix_id;
  7837. }
  7838. llama_token llama_token_middle(const struct llama_model * model) {
  7839. return model->vocab.special_middle_id;
  7840. }
  7841. llama_token llama_token_suffix(const struct llama_model * model) {
  7842. return model->vocab.special_suffix_id;
  7843. }
  7844. llama_token llama_token_eot(const struct llama_model * model) {
  7845. return model->vocab.special_eot_id;
  7846. }
  7847. int llama_tokenize(
  7848. const struct llama_model * model,
  7849. const char * text,
  7850. int text_len,
  7851. llama_token * tokens,
  7852. int n_max_tokens,
  7853. bool add_bos,
  7854. bool special) {
  7855. auto res = llama_tokenize_internal(model->vocab, std::string(text, text_len), add_bos, special);
  7856. if (n_max_tokens < (int) res.size()) {
  7857. // LLAMA_LOG_ERROR("%s: too many tokens\n", __func__);
  7858. return -((int) res.size());
  7859. }
  7860. for (size_t i = 0; i < res.size(); i++) {
  7861. tokens[i] = res[i];
  7862. }
  7863. return res.size();
  7864. }
  7865. static std::string llama_decode_text(const std::string & text) {
  7866. std::string decoded_text;
  7867. auto unicode_sequences = codepoints_from_utf8(text);
  7868. for (auto& unicode_sequence : unicode_sequences) {
  7869. decoded_text += unicode_to_bytes_bpe(codepoint_to_utf8(unicode_sequence));
  7870. }
  7871. return decoded_text;
  7872. }
  7873. // does not write null-terminator to buf
  7874. int llama_token_to_piece(const struct llama_model * model, llama_token token, char * buf, int length) {
  7875. if (0 <= token && token < llama_n_vocab(model)) {
  7876. switch (llama_vocab_get_type(model->vocab)) {
  7877. case LLAMA_VOCAB_TYPE_SPM: {
  7878. if (llama_is_normal_token(model->vocab, token)) {
  7879. std::string result = model->vocab.id_to_token[token].text;
  7880. llama_unescape_whitespace(result);
  7881. if (length < (int) result.length()) {
  7882. return -result.length();
  7883. }
  7884. memcpy(buf, result.c_str(), result.length());
  7885. return result.length();
  7886. } else if (llama_is_unknown_token(model->vocab, token)) { // NOLINT
  7887. if (length < 3) {
  7888. return -3;
  7889. }
  7890. memcpy(buf, "\xe2\x96\x85", 3);
  7891. return 3;
  7892. } else if (llama_is_control_token(model->vocab, token)) {
  7893. ;
  7894. } else if (llama_is_byte_token(model->vocab, token)) {
  7895. if (length < 1) {
  7896. return -1;
  7897. }
  7898. buf[0] = llama_token_to_byte(model->vocab, token);
  7899. return 1;
  7900. } else {
  7901. // TODO: for now we accept all unsupported token types,
  7902. // suppressing them like CONTROL tokens.
  7903. // GGML_ASSERT(false);
  7904. }
  7905. break;
  7906. }
  7907. case LLAMA_VOCAB_TYPE_BPE: {
  7908. if (llama_is_normal_token(model->vocab, token)) {
  7909. std::string result = model->vocab.id_to_token[token].text;
  7910. result = llama_decode_text(result);
  7911. if (length < (int) result.length()) {
  7912. return -result.length();
  7913. }
  7914. memcpy(buf, result.c_str(), result.length());
  7915. return result.length();
  7916. } else if (llama_is_control_token(model->vocab, token)) {
  7917. ;
  7918. } else {
  7919. // TODO: for now we accept all unsupported token types,
  7920. // suppressing them like CONTROL tokens.
  7921. // GGML_ASSERT(false);
  7922. }
  7923. break;
  7924. }
  7925. default:
  7926. GGML_ASSERT(false);
  7927. }
  7928. }
  7929. return 0;
  7930. }
  7931. struct llama_timings llama_get_timings(struct llama_context * ctx) {
  7932. struct llama_timings result = {
  7933. /*.t_start_ms =*/ 1e-3 * ctx->t_start_us,
  7934. /*.t_end_ms =*/ 1.00 * ggml_time_ms(),
  7935. /*.t_load_ms =*/ 1e-3 * ctx->t_load_us,
  7936. /*.t_sample_ms =*/ 1e-3 * ctx->t_sample_us,
  7937. /*.t_p_eval_ms =*/ 1e-3 * ctx->t_p_eval_us,
  7938. /*.t_eval_ms =*/ 1e-3 * ctx->t_eval_us,
  7939. /*.n_sample =*/ std::max(1, ctx->n_sample),
  7940. /*.n_p_eval =*/ std::max(1, ctx->n_p_eval),
  7941. /*.n_eval =*/ std::max(1, ctx->n_eval),
  7942. };
  7943. return result;
  7944. }
  7945. void llama_print_timings(struct llama_context * ctx) {
  7946. const llama_timings timings = llama_get_timings(ctx);
  7947. LLAMA_LOG_INFO("\n");
  7948. LLAMA_LOG_INFO("%s: load time = %10.2f ms\n", __func__, timings.t_load_ms);
  7949. LLAMA_LOG_INFO("%s: sample time = %10.2f ms / %5d runs (%8.2f ms per token, %8.2f tokens per second)\n",
  7950. __func__, timings.t_sample_ms, timings.n_sample, timings.t_sample_ms / timings.n_sample, 1e3 / timings.t_sample_ms * timings.n_sample);
  7951. LLAMA_LOG_INFO("%s: prompt eval time = %10.2f ms / %5d tokens (%8.2f ms per token, %8.2f tokens per second)\n",
  7952. __func__, timings.t_p_eval_ms, timings.n_p_eval, timings.t_p_eval_ms / timings.n_p_eval, 1e3 / timings.t_p_eval_ms * timings.n_p_eval);
  7953. LLAMA_LOG_INFO("%s: eval time = %10.2f ms / %5d runs (%8.2f ms per token, %8.2f tokens per second)\n",
  7954. __func__, timings.t_eval_ms, timings.n_eval, timings.t_eval_ms / timings.n_eval, 1e3 / timings.t_eval_ms * timings.n_eval);
  7955. LLAMA_LOG_INFO("%s: total time = %10.2f ms\n", __func__, (timings.t_end_ms - timings.t_start_ms));
  7956. }
  7957. void llama_reset_timings(struct llama_context * ctx) {
  7958. ctx->t_start_us = ggml_time_us();
  7959. ctx->t_sample_us = ctx->n_sample = 0;
  7960. ctx->t_eval_us = ctx->n_eval = 0;
  7961. ctx->t_p_eval_us = ctx->n_p_eval = 0;
  7962. }
  7963. const char * llama_print_system_info(void) {
  7964. static std::string s;
  7965. s = "";
  7966. s += "AVX = " + std::to_string(ggml_cpu_has_avx()) + " | ";
  7967. s += "AVX2 = " + std::to_string(ggml_cpu_has_avx2()) + " | ";
  7968. s += "AVX512 = " + std::to_string(ggml_cpu_has_avx512()) + " | ";
  7969. s += "AVX512_VBMI = " + std::to_string(ggml_cpu_has_avx512_vbmi()) + " | ";
  7970. s += "AVX512_VNNI = " + std::to_string(ggml_cpu_has_avx512_vnni()) + " | ";
  7971. s += "FMA = " + std::to_string(ggml_cpu_has_fma()) + " | ";
  7972. s += "NEON = " + std::to_string(ggml_cpu_has_neon()) + " | ";
  7973. s += "ARM_FMA = " + std::to_string(ggml_cpu_has_arm_fma()) + " | ";
  7974. s += "F16C = " + std::to_string(ggml_cpu_has_f16c()) + " | ";
  7975. s += "FP16_VA = " + std::to_string(ggml_cpu_has_fp16_va()) + " | ";
  7976. s += "WASM_SIMD = " + std::to_string(ggml_cpu_has_wasm_simd()) + " | ";
  7977. s += "BLAS = " + std::to_string(ggml_cpu_has_blas()) + " | ";
  7978. s += "SSE3 = " + std::to_string(ggml_cpu_has_sse3()) + " | ";
  7979. s += "SSSE3 = " + std::to_string(ggml_cpu_has_ssse3()) + " | ";
  7980. s += "VSX = " + std::to_string(ggml_cpu_has_vsx()) + " | ";
  7981. return s.c_str();
  7982. }
  7983. void llama_dump_timing_info_yaml(FILE * stream, const llama_context * ctx) {
  7984. fprintf(stream, "\n");
  7985. fprintf(stream, "###########\n");
  7986. fprintf(stream, "# Timings #\n");
  7987. fprintf(stream, "###########\n");
  7988. fprintf(stream, "\n");
  7989. fprintf(stream, "mst_eval: %.2f # ms / token during generation\n",
  7990. 1.0e-3 * ctx->t_eval_us / ctx->n_eval);
  7991. fprintf(stream, "mst_p_eval: %.2f # ms / token during prompt processing\n",
  7992. 1.0e-3 * ctx->t_p_eval_us / ctx->n_p_eval);
  7993. fprintf(stream, "mst_sample: %.2f # ms / token during sampling\n",
  7994. 1.0e-3 * ctx->t_sample_us / ctx->n_sample);
  7995. fprintf(stream, "n_eval: %d # number of tokens generated (excluding the first one)\n", ctx->n_eval);
  7996. fprintf(stream, "n_p_eval: %d # number of tokens processed in batches at the beginning\n", ctx->n_p_eval);
  7997. fprintf(stream, "n_sample: %d # number of sampled tokens\n", ctx->n_sample);
  7998. fprintf(stream, "t_eval_us: %" PRId64 " # total microseconds spent generating tokens\n", ctx->t_eval_us);
  7999. fprintf(stream, "t_load_us: %" PRId64 " # total microseconds spent loading the model\n", ctx->t_load_us);
  8000. fprintf(stream, "t_p_eval_us: %" PRId64 " # total microseconds spent prompt processing\n", ctx->t_p_eval_us);
  8001. fprintf(stream, "t_sample_us: %" PRId64 " # total microseconds spent sampling\n", ctx->t_sample_us);
  8002. fprintf(stream, "ts_eval: %.2f # tokens / second during generation\n",
  8003. 1.0e6 * ctx->n_eval / ctx->t_eval_us);
  8004. fprintf(stream, "ts_p_eval: %.2f # tokens / second during prompt processing\n",
  8005. 1.0e6 * ctx->n_p_eval / ctx->t_p_eval_us);
  8006. fprintf(stream, "ts_sample: %.2f # tokens / second during sampling\n",
  8007. 1.0e6 * ctx->n_sample / ctx->t_sample_us);
  8008. }
  8009. // For internal test use
  8010. const std::vector<std::pair<std::string, struct ggml_tensor *>> & llama_internal_get_tensor_map(
  8011. struct llama_context * ctx
  8012. ) {
  8013. return ctx->model.tensors_by_name;
  8014. }
  8015. void llama_log_set(ggml_log_callback log_callback, void * user_data) {
  8016. g_state.log_callback = log_callback ? log_callback : llama_log_callback_default;
  8017. g_state.log_callback_user_data = user_data;
  8018. #ifdef GGML_USE_METAL
  8019. ggml_metal_log_set_callback(g_state.log_callback, g_state.log_callback_user_data);
  8020. #endif
  8021. }
  8022. static void llama_log_internal_v(ggml_log_level level, const char * format, va_list args) {
  8023. va_list args_copy;
  8024. va_copy(args_copy, args);
  8025. char buffer[128];
  8026. int len = vsnprintf(buffer, 128, format, args);
  8027. if (len < 128) {
  8028. g_state.log_callback(level, buffer, g_state.log_callback_user_data);
  8029. } else {
  8030. char* buffer2 = new char[len+1];
  8031. vsnprintf(buffer2, len+1, format, args_copy);
  8032. buffer2[len] = 0;
  8033. g_state.log_callback(level, buffer2, g_state.log_callback_user_data);
  8034. delete[] buffer2;
  8035. }
  8036. va_end(args_copy);
  8037. }
  8038. static void llama_log_internal(ggml_log_level level, const char * format, ...) {
  8039. va_list args;
  8040. va_start(args, format);
  8041. llama_log_internal_v(level, format, args);
  8042. va_end(args);
  8043. }
  8044. static void llama_log_callback_default(ggml_log_level level, const char * text, void * user_data) {
  8045. (void) level;
  8046. (void) user_data;
  8047. fputs(text, stderr);
  8048. fflush(stderr);
  8049. }