clip.cpp 151 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654
  1. // NOTE: This is modified from clip.cpp only for LLaVA,
  2. // so there might be still unnecessary artifacts hanging around
  3. // I'll gradually clean and extend it
  4. // Note: Even when using identical normalized image inputs (see normalize_image_u8_to_f32()) we have a significant difference in resulting embeddings compared to pytorch
  5. #include "clip.h"
  6. #include "clip-impl.h"
  7. #include "ggml.h"
  8. #include "ggml-cpp.h"
  9. #include "ggml-cpu.h"
  10. #include "ggml-alloc.h"
  11. #include "ggml-backend.h"
  12. #include "gguf.h"
  13. #define STB_IMAGE_IMPLEMENTATION
  14. #include "stb_image.h"
  15. #include <cassert>
  16. #include <cmath>
  17. #include <cstdlib>
  18. #include <cstring>
  19. #include <fstream>
  20. #include <map>
  21. #include <regex>
  22. #include <stdexcept>
  23. #include <unordered_set>
  24. #include <vector>
  25. #include <sstream>
  26. #include <cinttypes>
  27. #include <limits>
  28. #include <array>
  29. #include <numeric>
  30. #include <functional>
  31. struct clip_logger_state g_logger_state = {GGML_LOG_LEVEL_CONT, clip_log_callback_default, NULL};
  32. enum ffn_op_type {
  33. FFN_GELU,
  34. FFN_SILU,
  35. FFN_GELU_QUICK,
  36. };
  37. enum norm_type {
  38. NORM_TYPE_NORMAL,
  39. NORM_TYPE_RMS,
  40. };
  41. //#define CLIP_DEBUG_FUNCTIONS
  42. #ifdef CLIP_DEBUG_FUNCTIONS
  43. static void clip_image_write_image_to_ppm(const clip_image_u8& img, const std::string& filename) {
  44. std::ofstream file(filename, std::ios::binary);
  45. if (!file.is_open()) {
  46. LOG_ERR("Failed to open file for writing: %s\n", filename.c_str());
  47. return;
  48. }
  49. // PPM header: P6 format, width, height, and max color value
  50. file << "P6\n" << img.nx << " " << img.ny << "\n255\n";
  51. // Write pixel data
  52. for (size_t i = 0; i < img.buf.size(); i += 3) {
  53. // PPM expects binary data in RGB format, which matches our image buffer
  54. file.write(reinterpret_cast<const char*>(&img.buf[i]), 3);
  55. }
  56. file.close();
  57. }
  58. static void clip_image_save_to_bmp(const clip_image_u8& img, const std::string& filename) {
  59. std::ofstream file(filename, std::ios::binary);
  60. if (!file.is_open()) {
  61. LOG_ERR("Failed to open file for writing: %s\n", filename.c_str());
  62. return;
  63. }
  64. int fileSize = 54 + 3 * img.nx * img.ny; // File header + info header + pixel data
  65. int bytesPerPixel = 3;
  66. int widthInBytes = img.nx * bytesPerPixel;
  67. int paddingAmount = (4 - (widthInBytes % 4)) % 4;
  68. int stride = widthInBytes + paddingAmount;
  69. // Bitmap file header
  70. unsigned char fileHeader[14] = {
  71. 'B','M', // Signature
  72. 0,0,0,0, // Image file size in bytes
  73. 0,0,0,0, // Reserved
  74. 54,0,0,0 // Start of pixel array
  75. };
  76. // Total file size
  77. fileSize = 54 + (stride * img.ny);
  78. fileHeader[2] = (unsigned char)(fileSize);
  79. fileHeader[3] = (unsigned char)(fileSize >> 8);
  80. fileHeader[4] = (unsigned char)(fileSize >> 16);
  81. fileHeader[5] = (unsigned char)(fileSize >> 24);
  82. // Bitmap information header (BITMAPINFOHEADER)
  83. unsigned char infoHeader[40] = {
  84. 40,0,0,0, // Size of this header (40 bytes)
  85. 0,0,0,0, // Image width
  86. 0,0,0,0, // Image height
  87. 1,0, // Number of color planes
  88. 24,0, // Bits per pixel
  89. 0,0,0,0, // No compression
  90. 0,0,0,0, // Image size (can be 0 for no compression)
  91. 0,0,0,0, // X pixels per meter (not specified)
  92. 0,0,0,0, // Y pixels per meter (not specified)
  93. 0,0,0,0, // Total colors (color table not used)
  94. 0,0,0,0 // Important colors (all are important)
  95. };
  96. // Width and height in the information header
  97. infoHeader[4] = (unsigned char)(img.nx);
  98. infoHeader[5] = (unsigned char)(img.nx >> 8);
  99. infoHeader[6] = (unsigned char)(img.nx >> 16);
  100. infoHeader[7] = (unsigned char)(img.nx >> 24);
  101. infoHeader[8] = (unsigned char)(img.ny);
  102. infoHeader[9] = (unsigned char)(img.ny >> 8);
  103. infoHeader[10] = (unsigned char)(img.ny >> 16);
  104. infoHeader[11] = (unsigned char)(img.ny >> 24);
  105. // Write file headers
  106. file.write(reinterpret_cast<char*>(fileHeader), sizeof(fileHeader));
  107. file.write(reinterpret_cast<char*>(infoHeader), sizeof(infoHeader));
  108. // Pixel data
  109. std::vector<unsigned char> padding(3, 0); // Max padding size to be added to each row
  110. for (int y = img.ny - 1; y >= 0; --y) { // BMP files are stored bottom-to-top
  111. for (int x = 0; x < img.nx; ++x) {
  112. // Each pixel
  113. size_t pixelIndex = (y * img.nx + x) * 3;
  114. unsigned char pixel[3] = {
  115. img.buf[pixelIndex + 2], // BMP stores pixels in BGR format
  116. img.buf[pixelIndex + 1],
  117. img.buf[pixelIndex]
  118. };
  119. file.write(reinterpret_cast<char*>(pixel), 3);
  120. }
  121. // Write padding for the row
  122. file.write(reinterpret_cast<char*>(padding.data()), paddingAmount);
  123. }
  124. file.close();
  125. }
  126. // debug function to convert f32 to u8
  127. static void clip_image_convert_f32_to_u8(const clip_image_f32& src, clip_image_u8& dst) {
  128. dst.nx = src.nx;
  129. dst.ny = src.ny;
  130. dst.buf.resize(3 * src.nx * src.ny);
  131. for (size_t i = 0; i < src.buf.size(); ++i) {
  132. dst.buf[i] = static_cast<uint8_t>(std::min(std::max(int(src.buf[i] * 255.0f), 0), 255));
  133. }
  134. }
  135. #endif
  136. //
  137. // clip layers
  138. //
  139. enum patch_merge_type {
  140. PATCH_MERGE_FLAT,
  141. PATCH_MERGE_SPATIAL_UNPAD,
  142. };
  143. struct clip_hparams {
  144. int32_t image_size;
  145. int32_t patch_size;
  146. int32_t n_embd;
  147. int32_t n_ff;
  148. int32_t projection_dim;
  149. int32_t n_head;
  150. int32_t n_layer;
  151. int32_t proj_scale_factor = 0; // idefics3
  152. ffn_op_type ffn_op = FFN_GELU;
  153. patch_merge_type mm_patch_merge_type = PATCH_MERGE_FLAT;
  154. float eps = 1e-6;
  155. float rope_theta = 0.0;
  156. std::vector<int32_t> image_grid_pinpoints;
  157. int32_t image_crop_resolution;
  158. std::unordered_set<int32_t> vision_feature_layer;
  159. int32_t attn_window_size = 0;
  160. int32_t n_wa_pattern = 0;
  161. int32_t spatial_merge_size = 0;
  162. };
  163. struct clip_layer {
  164. // attention
  165. ggml_tensor * k_w = nullptr;
  166. ggml_tensor * k_b = nullptr;
  167. ggml_tensor * q_w = nullptr;
  168. ggml_tensor * q_b = nullptr;
  169. ggml_tensor * v_w = nullptr;
  170. ggml_tensor * v_b = nullptr;
  171. ggml_tensor * o_w = nullptr;
  172. ggml_tensor * o_b = nullptr;
  173. // layernorm 1
  174. ggml_tensor * ln_1_w = nullptr;
  175. ggml_tensor * ln_1_b = nullptr;
  176. ggml_tensor * ff_up_w = nullptr;
  177. ggml_tensor * ff_up_b = nullptr;
  178. ggml_tensor * ff_gate_w = nullptr;
  179. ggml_tensor * ff_gate_b = nullptr;
  180. ggml_tensor * ff_down_w = nullptr;
  181. ggml_tensor * ff_down_b = nullptr;
  182. // layernorm 2
  183. ggml_tensor * ln_2_w = nullptr;
  184. ggml_tensor * ln_2_b = nullptr;
  185. };
  186. struct clip_vision_model {
  187. struct clip_hparams hparams;
  188. // embeddings
  189. ggml_tensor * class_embedding = nullptr;
  190. ggml_tensor * patch_embeddings_0 = nullptr;
  191. ggml_tensor * patch_embeddings_1 = nullptr; // second Conv2D kernel when we decouple Conv3D along temproal dimension (Qwen2VL)
  192. ggml_tensor * patch_bias = nullptr;
  193. ggml_tensor * position_embeddings = nullptr;
  194. ggml_tensor * pre_ln_w = nullptr;
  195. ggml_tensor * pre_ln_b = nullptr;
  196. std::vector<clip_layer> layers;
  197. ggml_tensor * post_ln_w;
  198. ggml_tensor * post_ln_b;
  199. ggml_tensor * projection;
  200. // LLaVA projection
  201. ggml_tensor * mm_input_norm_w = nullptr;
  202. ggml_tensor * mm_0_w = nullptr;
  203. ggml_tensor * mm_0_b = nullptr;
  204. ggml_tensor * mm_2_w = nullptr;
  205. ggml_tensor * mm_2_b = nullptr;
  206. ggml_tensor * image_newline = nullptr;
  207. // Yi type models with mlp+normalization projection
  208. ggml_tensor * mm_1_w = nullptr; // Yi type models have 0, 1, 3, 4
  209. ggml_tensor * mm_1_b = nullptr;
  210. ggml_tensor * mm_3_w = nullptr;
  211. ggml_tensor * mm_3_b = nullptr;
  212. ggml_tensor * mm_4_w = nullptr;
  213. ggml_tensor * mm_4_b = nullptr;
  214. // GLMV-Edge projection
  215. ggml_tensor * mm_model_adapter_conv_w = nullptr;
  216. ggml_tensor * mm_model_adapter_conv_b = nullptr;
  217. ggml_tensor * mm_glm_tok_boi = nullptr;
  218. ggml_tensor * mm_glm_tok_eoi = nullptr;
  219. // MobileVLM projection
  220. ggml_tensor * mm_model_mlp_1_w = nullptr;
  221. ggml_tensor * mm_model_mlp_1_b = nullptr;
  222. ggml_tensor * mm_model_mlp_3_w = nullptr;
  223. ggml_tensor * mm_model_mlp_3_b = nullptr;
  224. ggml_tensor * mm_model_block_1_block_0_0_w = nullptr;
  225. ggml_tensor * mm_model_block_1_block_0_1_w = nullptr;
  226. ggml_tensor * mm_model_block_1_block_0_1_b = nullptr;
  227. ggml_tensor * mm_model_block_1_block_1_fc1_w = nullptr;
  228. ggml_tensor * mm_model_block_1_block_1_fc1_b = nullptr;
  229. ggml_tensor * mm_model_block_1_block_1_fc2_w = nullptr;
  230. ggml_tensor * mm_model_block_1_block_1_fc2_b = nullptr;
  231. ggml_tensor * mm_model_block_1_block_2_0_w = nullptr;
  232. ggml_tensor * mm_model_block_1_block_2_1_w = nullptr;
  233. ggml_tensor * mm_model_block_1_block_2_1_b = nullptr;
  234. ggml_tensor * mm_model_block_2_block_0_0_w = nullptr;
  235. ggml_tensor * mm_model_block_2_block_0_1_w = nullptr;
  236. ggml_tensor * mm_model_block_2_block_0_1_b = nullptr;
  237. ggml_tensor * mm_model_block_2_block_1_fc1_w = nullptr;
  238. ggml_tensor * mm_model_block_2_block_1_fc1_b = nullptr;
  239. ggml_tensor * mm_model_block_2_block_1_fc2_w = nullptr;
  240. ggml_tensor * mm_model_block_2_block_1_fc2_b = nullptr;
  241. ggml_tensor * mm_model_block_2_block_2_0_w = nullptr;
  242. ggml_tensor * mm_model_block_2_block_2_1_w = nullptr;
  243. ggml_tensor * mm_model_block_2_block_2_1_b = nullptr;
  244. // MobileVLM_V2 projection
  245. ggml_tensor * mm_model_mlp_0_w = nullptr;
  246. ggml_tensor * mm_model_mlp_0_b = nullptr;
  247. ggml_tensor * mm_model_mlp_2_w = nullptr;
  248. ggml_tensor * mm_model_mlp_2_b = nullptr;
  249. ggml_tensor * mm_model_peg_0_w = nullptr;
  250. ggml_tensor * mm_model_peg_0_b = nullptr;
  251. // MINICPMV projection
  252. ggml_tensor * mm_model_pos_embed_k = nullptr;
  253. ggml_tensor * mm_model_query = nullptr;
  254. ggml_tensor * mm_model_proj = nullptr;
  255. ggml_tensor * mm_model_kv_proj = nullptr;
  256. ggml_tensor * mm_model_attn_q_w = nullptr;
  257. ggml_tensor * mm_model_attn_q_b = nullptr;
  258. ggml_tensor * mm_model_attn_k_w = nullptr;
  259. ggml_tensor * mm_model_attn_k_b = nullptr;
  260. ggml_tensor * mm_model_attn_v_w = nullptr;
  261. ggml_tensor * mm_model_attn_v_b = nullptr;
  262. ggml_tensor * mm_model_attn_o_w = nullptr;
  263. ggml_tensor * mm_model_attn_o_b = nullptr;
  264. ggml_tensor * mm_model_ln_q_w = nullptr;
  265. ggml_tensor * mm_model_ln_q_b = nullptr;
  266. ggml_tensor * mm_model_ln_kv_w = nullptr;
  267. ggml_tensor * mm_model_ln_kv_b = nullptr;
  268. ggml_tensor * mm_model_ln_post_w = nullptr;
  269. ggml_tensor * mm_model_ln_post_b = nullptr;
  270. // gemma3
  271. ggml_tensor * mm_input_proj_w = nullptr;
  272. ggml_tensor * mm_soft_emb_norm_w = nullptr;
  273. // pixtral
  274. ggml_tensor * token_embd_img_break = nullptr;
  275. ggml_tensor * mm_patch_merger_w = nullptr;
  276. };
  277. struct clip_ctx {
  278. bool has_llava_projector = false;
  279. int minicpmv_version = 0;
  280. struct clip_vision_model vision_model;
  281. projector_type proj_type = PROJECTOR_TYPE_MLP;
  282. float image_mean[3];
  283. float image_std[3];
  284. gguf_context_ptr ctx_gguf;
  285. ggml_context_ptr ctx_data;
  286. std::vector<uint8_t> buf_compute_meta;
  287. std::vector<ggml_backend_t> backend_ptrs;
  288. std::vector<ggml_backend_buffer_type_t> backend_buft;
  289. ggml_backend_t backend;
  290. ggml_backend_t backend_cpu;
  291. ggml_backend_buffer_ptr buf;
  292. int max_nodes = 8192;
  293. ggml_backend_sched_ptr sched;
  294. clip_image_size load_image_size;
  295. clip_ctx(clip_context_params & ctx_params) {
  296. backend_cpu = ggml_backend_init_by_type(GGML_BACKEND_DEVICE_TYPE_CPU, nullptr);
  297. if (!backend_cpu) {
  298. throw std::runtime_error("failed to initialize CPU backend");
  299. }
  300. backend = ctx_params.use_gpu
  301. ? ggml_backend_init_by_type(GGML_BACKEND_DEVICE_TYPE_GPU, nullptr)
  302. : nullptr;
  303. if (backend) {
  304. LOG_INF("%s: CLIP using %s backend\n", __func__, ggml_backend_name(backend));
  305. backend_ptrs.push_back(backend);
  306. backend_buft.push_back(ggml_backend_get_default_buffer_type(backend));
  307. } else {
  308. backend = backend_cpu;
  309. LOG_INF("%s: CLIP using CPU backend\n", __func__);
  310. }
  311. backend_ptrs.push_back(backend_cpu);
  312. backend_buft.push_back(ggml_backend_get_default_buffer_type(backend_cpu));
  313. sched.reset(
  314. ggml_backend_sched_new(backend_ptrs.data(), backend_buft.data(), backend_ptrs.size(), 8192, false)
  315. );
  316. }
  317. ~clip_ctx() {
  318. ggml_backend_free(backend);
  319. if (backend != backend_cpu) {
  320. ggml_backend_free(backend_cpu);
  321. }
  322. }
  323. };
  324. struct clip_graph {
  325. clip_ctx * ctx;
  326. const clip_vision_model & model;
  327. const clip_hparams & hparams;
  328. // we only support single image per batch
  329. const clip_image_f32 & img;
  330. const int patch_size;
  331. const int n_patches_x;
  332. const int n_patches_y;
  333. const int n_patches;
  334. const int n_embd;
  335. const int n_head;
  336. const int d_head;
  337. const int n_layer;
  338. const float eps;
  339. const float kq_scale;
  340. ggml_context_ptr ctx0_ptr;
  341. ggml_context * ctx0;
  342. ggml_cgraph * gf;
  343. clip_graph(clip_ctx * ctx, const clip_image_f32 & img) :
  344. ctx(ctx),
  345. model(ctx->vision_model),
  346. hparams(model.hparams),
  347. img(img),
  348. patch_size(hparams.patch_size),
  349. n_patches_x(img.nx / patch_size),
  350. n_patches_y(img.ny / patch_size),
  351. n_patches(n_patches_x * n_patches_y),
  352. n_embd(hparams.n_embd),
  353. n_head(hparams.n_head),
  354. d_head(n_embd / n_head),
  355. n_layer(hparams.n_layer),
  356. eps(hparams.eps),
  357. kq_scale(1.0f / sqrtf((float)d_head)) {
  358. struct ggml_init_params params = {
  359. /*.mem_size =*/ ctx->buf_compute_meta.size(),
  360. /*.mem_buffer =*/ ctx->buf_compute_meta.data(),
  361. /*.no_alloc =*/ true,
  362. };
  363. ctx0_ptr.reset(ggml_init(params));
  364. ctx0 = ctx0_ptr.get();
  365. gf = ggml_new_graph(ctx0);
  366. }
  367. ggml_cgraph * build_siglip() {
  368. ggml_tensor * inp = build_inp();
  369. ggml_tensor * cur = build_vit(
  370. inp, n_patches,
  371. NORM_TYPE_NORMAL,
  372. hparams.ffn_op,
  373. model.position_embeddings,
  374. nullptr);
  375. if (ctx->proj_type == PROJECTOR_TYPE_GEMMA3) {
  376. const int batch_size = 1;
  377. GGML_ASSERT(n_patches_x == n_patches_y);
  378. const int patches_per_image = n_patches_x;
  379. const int kernel_size = hparams.proj_scale_factor;
  380. cur = ggml_cont(ctx0, ggml_transpose(ctx0, cur));
  381. cur = ggml_reshape_4d(ctx0, cur, patches_per_image, patches_per_image, n_embd, batch_size);
  382. // doing a pool2d to reduce the number of output tokens
  383. cur = ggml_pool_2d(ctx0, cur, GGML_OP_POOL_AVG, kernel_size, kernel_size, kernel_size, kernel_size, 0, 0);
  384. cur = ggml_reshape_3d(ctx0, cur, cur->ne[0] * cur->ne[0], n_embd, batch_size);
  385. cur = ggml_cont(ctx0, ggml_transpose(ctx0, cur));
  386. // apply norm before projection
  387. cur = ggml_rms_norm(ctx0, cur, eps);
  388. cur = ggml_mul(ctx0, cur, model.mm_soft_emb_norm_w);
  389. // apply projection
  390. cur = ggml_mul_mat(ctx0,
  391. ggml_cont(ctx0, ggml_transpose(ctx0, model.mm_input_proj_w)),
  392. cur);
  393. } else if (ctx->proj_type == PROJECTOR_TYPE_IDEFICS3) {
  394. // https://github.com/huggingface/transformers/blob/0a950e0bbe1ed58d5401a6b547af19f15f0c195e/src/transformers/models/idefics3/modeling_idefics3.py#L578
  395. const int scale_factor = model.hparams.proj_scale_factor;
  396. const int n_embd = cur->ne[0];
  397. const int seq = cur->ne[1];
  398. const int bsz = 1; // batch size, always 1 for now since we don't support batching
  399. const int height = std::sqrt(seq);
  400. const int width = std::sqrt(seq);
  401. GGML_ASSERT(scale_factor != 0);
  402. cur = ggml_reshape_4d(ctx0, cur, n_embd * scale_factor, width / scale_factor, height, bsz);
  403. cur = ggml_permute(ctx0, cur, 0, 2, 1, 3);
  404. cur = ggml_reshape_4d(ctx0, ggml_cont(ctx0, cur),
  405. n_embd * scale_factor * scale_factor,
  406. height / scale_factor,
  407. width / scale_factor,
  408. bsz);
  409. cur = ggml_permute(ctx0, cur, 0, 2, 1, 3);
  410. cur = ggml_reshape_3d(ctx0, ggml_cont(ctx0, cur),
  411. n_embd * scale_factor * scale_factor,
  412. seq / (scale_factor * scale_factor),
  413. bsz);
  414. cur = ggml_mul_mat(ctx0, model.projection, cur);
  415. } else {
  416. GGML_ABORT("SigLIP: Unsupported projector type");
  417. }
  418. // build the graph
  419. ggml_build_forward_expand(gf, cur);
  420. return gf;
  421. }
  422. ggml_cgraph * build_pixtral() {
  423. const int n_merge = hparams.spatial_merge_size;
  424. // 2D input positions
  425. ggml_tensor * pos_h = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_patches);
  426. ggml_set_name(pos_h, "pos_h");
  427. ggml_set_input(pos_h);
  428. ggml_tensor * pos_w = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_patches);
  429. ggml_set_name(pos_w, "pos_w");
  430. ggml_set_input(pos_w);
  431. auto add_pos = [&](ggml_tensor * cur, const clip_layer &) {
  432. return build_rope_2d(ctx0, cur, pos_h, pos_w, hparams.rope_theta);
  433. };
  434. ggml_tensor * inp = build_inp();
  435. ggml_tensor * cur = build_vit(
  436. inp, n_patches,
  437. NORM_TYPE_RMS,
  438. hparams.ffn_op,
  439. nullptr, // no learned pos embd
  440. add_pos);
  441. // mistral small 3.1 patch merger
  442. // ref: https://github.com/huggingface/transformers/blob/7a3e208892c06a5e278144eaf38c8599a42f53e7/src/transformers/models/mistral3/modeling_mistral3.py#L67
  443. if (model.mm_patch_merger_w) {
  444. GGML_ASSERT(hparams.spatial_merge_size > 0);
  445. cur = ggml_mul(ctx0, ggml_rms_norm(ctx0, cur, eps), model.mm_input_norm_w);
  446. // reshape image tokens to 2D grid
  447. cur = ggml_reshape_3d(ctx0, cur, n_embd, n_patches_x, n_patches_y);
  448. cur = ggml_permute(ctx0, cur, 2, 0, 1, 3); // [x, y, n_embd]
  449. cur = ggml_cont(ctx0, cur);
  450. // torch.nn.functional.unfold is just an im2col under the hood
  451. // we just need a dummy kernel to make it work
  452. ggml_tensor * kernel = ggml_view_3d(ctx0, cur, n_merge, n_merge, cur->ne[2], 0, 0, 0);
  453. cur = ggml_im2col(ctx0, kernel, cur, n_merge, n_merge, 0, 0, 1, 1, true, inp->type);
  454. // project to n_embd
  455. cur = ggml_reshape_2d(ctx0, cur, cur->ne[0], cur->ne[1] * cur->ne[2]);
  456. cur = ggml_mul_mat(ctx0, model.mm_patch_merger_w, cur);
  457. }
  458. // LlavaMultiModalProjector (always using GELU activation)
  459. {
  460. cur = ggml_mul_mat(ctx0, model.mm_1_w, cur);
  461. if (model.mm_1_b) {
  462. cur = ggml_add(ctx0, cur, model.mm_1_b);
  463. }
  464. cur = ggml_gelu(ctx0, cur);
  465. cur = ggml_mul_mat(ctx0, model.mm_2_w, cur);
  466. if (model.mm_2_b) {
  467. cur = ggml_add(ctx0, cur, model.mm_2_b);
  468. }
  469. }
  470. // arrangement of the [IMG_BREAK] token
  471. {
  472. // not efficient, but works
  473. // the trick is to view the embeddings as a 3D tensor with shape [n_embd, n_patches_per_row, n_rows]
  474. // and then concatenate the [IMG_BREAK] token to the end of each row, aka n_patches_per_row dimension
  475. // after the concatenation, we have a tensor with shape [n_embd, n_patches_per_row + 1, n_rows]
  476. const int p_y = n_merge > 0 ? n_patches_y / n_merge : n_patches_y;
  477. const int p_x = n_merge > 0 ? n_patches_x / n_merge : n_patches_x;
  478. const int p_total = p_x * p_y;
  479. const int n_embd_text = cur->ne[0];
  480. const int n_tokens_output = p_total + p_y - 1; // one [IMG_BREAK] per row, except the last row
  481. ggml_tensor * tmp = ggml_reshape_3d(ctx0, cur, n_embd_text, p_x, p_y);
  482. ggml_tensor * tok = ggml_new_tensor_3d(ctx0, tmp->type, n_embd_text, 1, p_y);
  483. tok = ggml_scale(ctx0, tok, 0.0); // clear the tensor
  484. tok = ggml_add(ctx0, tok, model.token_embd_img_break);
  485. tmp = ggml_concat(ctx0, tmp, tok, 1);
  486. cur = ggml_view_2d(ctx0, tmp,
  487. n_embd_text, n_tokens_output,
  488. ggml_row_size(tmp->type, n_embd_text), 0);
  489. }
  490. // build the graph
  491. ggml_build_forward_expand(gf, cur);
  492. return gf;
  493. }
  494. // Qwen2VL and Qwen2.5VL use M-RoPE
  495. ggml_cgraph * build_qwen2vl() {
  496. const int batch_size = 1;
  497. const bool use_window_attn = hparams.n_wa_pattern > 0;
  498. const int n_wa_pattern = hparams.n_wa_pattern;
  499. const int n_pos = n_patches;
  500. const int num_position_ids = n_pos * 4; // m-rope requires 4 dim per position
  501. norm_type norm_t = ctx->proj_type == PROJECTOR_TYPE_QWEN25VL
  502. ? NORM_TYPE_RMS // qwen 2.5 vl
  503. : NORM_TYPE_NORMAL; // qwen 2 vl
  504. int mrope_sections[4] = {d_head/4, d_head/4, d_head/4, d_head/4};
  505. ggml_tensor * inp_raw = build_inp_raw();
  506. ggml_tensor * inp = ggml_conv_2d(ctx0, model.patch_embeddings_0, inp_raw, patch_size, patch_size, 0, 0, 1, 1);
  507. GGML_ASSERT(img.nx % (patch_size * 2) == 0);
  508. GGML_ASSERT(img.ny % (patch_size * 2) == 0);
  509. // second conv dimension
  510. {
  511. auto inp_1 = ggml_conv_2d(ctx0, model.patch_embeddings_1, inp_raw, patch_size, patch_size, 0, 0, 1, 1);
  512. inp = ggml_add(ctx0, inp, inp_1);
  513. inp = ggml_cont(ctx0, ggml_permute(ctx0, inp, 1, 2, 0, 3)); // [w, h, c, b] -> [c, w, h, b]
  514. inp = ggml_reshape_4d(
  515. ctx0, inp,
  516. n_embd * 2, n_patches_x / 2, n_patches_y, batch_size);
  517. inp = ggml_reshape_4d(
  518. ctx0, inp,
  519. n_embd * 2, n_patches_x / 2, 2, batch_size * (n_patches_y / 2));
  520. inp = ggml_cont(ctx0, ggml_permute(ctx0, inp, 0, 2, 1, 3));
  521. inp = ggml_reshape_3d(
  522. ctx0, inp,
  523. n_embd, n_patches_x * n_patches_y, batch_size);
  524. }
  525. if (model.patch_bias) {
  526. inp = ggml_add(ctx0, inp, model.patch_bias);
  527. }
  528. ggml_tensor * inpL = inp;
  529. ggml_tensor * window_mask = nullptr;
  530. ggml_tensor * window_idx = nullptr;
  531. ggml_tensor * inv_window_idx = nullptr;
  532. ggml_tensor * positions = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, num_position_ids);
  533. ggml_set_name(positions, "positions");
  534. ggml_set_input(positions);
  535. // pre-layernorm
  536. if (model.pre_ln_w) {
  537. inpL = build_norm(inpL, model.pre_ln_w, model.pre_ln_b, norm_t, eps, -1);
  538. }
  539. if (use_window_attn) {
  540. // handle window attention inputs
  541. inv_window_idx = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_pos / 4);
  542. ggml_set_name(inv_window_idx, "inv_window_idx");
  543. ggml_set_input(inv_window_idx);
  544. // mask for window attention
  545. window_mask = ggml_new_tensor_2d(ctx0, GGML_TYPE_F32, n_pos, n_pos);
  546. ggml_set_name(window_mask, "window_mask");
  547. ggml_set_input(window_mask);
  548. // inpL shape: [n_embd, n_patches_x * n_patches_y, batch_size]
  549. GGML_ASSERT(batch_size == 1);
  550. inpL = ggml_reshape_2d(ctx0, inpL, n_embd * 4, n_patches_x * n_patches_y * batch_size / 4);
  551. inpL = ggml_get_rows(ctx0, inpL, inv_window_idx);
  552. inpL = ggml_reshape_3d(ctx0, inpL, n_embd, n_patches_x * n_patches_y, batch_size);
  553. }
  554. // loop over layers
  555. for (int il = 0; il < n_layer; il++) {
  556. auto & layer = model.layers[il];
  557. const bool full_attn = use_window_attn ? (il + 1) % n_wa_pattern == 0 : true;
  558. ggml_tensor * cur = inpL; // inpL = residual, cur = hidden_states
  559. // layernorm1
  560. cur = build_norm(cur, layer.ln_1_w, layer.ln_1_b, norm_t, eps, il);
  561. cb(cur, "ln1", il);
  562. // self-attention
  563. {
  564. ggml_tensor * Qcur = ggml_add(ctx0,
  565. ggml_mul_mat(ctx0, layer.q_w, cur), layer.q_b);
  566. ggml_tensor * Kcur = ggml_add(ctx0,
  567. ggml_mul_mat(ctx0, layer.k_w, cur), layer.k_b);
  568. ggml_tensor * Vcur = ggml_add(ctx0,
  569. ggml_mul_mat(ctx0, layer.v_w, cur), layer.v_b);
  570. Qcur = ggml_reshape_3d(ctx0, Qcur, d_head, n_head, n_patches);
  571. Kcur = ggml_reshape_3d(ctx0, Kcur, d_head, n_head, n_patches);
  572. Vcur = ggml_reshape_3d(ctx0, Vcur, d_head, n_head, n_patches);
  573. cb(Qcur, "Qcur", il);
  574. cb(Kcur, "Kcur", il);
  575. cb(Vcur, "Vcur", il);
  576. // apply M-RoPE
  577. Qcur = ggml_rope_multi(
  578. ctx0, Qcur, positions, nullptr,
  579. d_head/2, mrope_sections, GGML_ROPE_TYPE_VISION, 32768, 10000, 1, 0, 1, 32, 1);
  580. Kcur = ggml_rope_multi(
  581. ctx0, Kcur, positions, nullptr,
  582. d_head/2, mrope_sections, GGML_ROPE_TYPE_VISION, 32768, 10000, 1, 0, 1, 32, 1);
  583. cb(Qcur, "Qcur_rope", il);
  584. cb(Kcur, "Kcur_rope", il);
  585. ggml_tensor * attn_mask = full_attn ? nullptr : window_mask;
  586. cur = build_attn(layer.o_w, layer.o_b,
  587. Qcur, Kcur, Vcur, attn_mask, kq_scale, il);
  588. cb(cur, "attn_out", il);
  589. }
  590. // re-add the layer input, e.g., residual
  591. cur = ggml_add(ctx0, cur, inpL);
  592. inpL = cur; // inpL = residual, cur = hidden_states
  593. cb(cur, "ffn_inp", il);
  594. // layernorm2
  595. cur = build_norm(cur, layer.ln_2_w, layer.ln_2_b, norm_t, eps, il);
  596. cb(cur, "ffn_inp_normed", il);
  597. // ffn
  598. cur = build_ffn(cur,
  599. layer.ff_up_w, layer.ff_up_b,
  600. layer.ff_gate_w, layer.ff_gate_b,
  601. layer.ff_down_w, layer.ff_down_b,
  602. hparams.ffn_op, il);
  603. cb(cur, "ffn_out", il);
  604. // residual 2
  605. cur = ggml_add(ctx0, inpL, cur);
  606. cb(cur, "layer_out", il);
  607. inpL = cur;
  608. }
  609. // post-layernorm
  610. if (model.post_ln_w) {
  611. inpL = build_norm(inpL, model.post_ln_w, model.post_ln_b, norm_t, eps, n_layer);
  612. }
  613. // multimodal projection
  614. ggml_tensor * embeddings = inpL;
  615. embeddings = ggml_reshape_3d(ctx0, embeddings, n_embd * 4, n_pos / 4, batch_size);
  616. embeddings = ggml_mul_mat(ctx0, model.mm_0_w, embeddings);
  617. embeddings = ggml_add(ctx0, embeddings, model.mm_0_b);
  618. // GELU activation
  619. embeddings = ggml_gelu(ctx0, embeddings);
  620. // Second linear layer
  621. embeddings = ggml_mul_mat(ctx0, model.mm_1_w, embeddings);
  622. embeddings = ggml_add(ctx0, embeddings, model.mm_1_b);
  623. if (use_window_attn) {
  624. window_idx = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_pos / 4);
  625. ggml_set_name(window_idx, "window_idx");
  626. ggml_set_input(window_idx);
  627. // embeddings shape: [n_embd, n_patches_x * n_patches_y, batch_size]
  628. GGML_ASSERT(batch_size == 1);
  629. embeddings = ggml_reshape_2d(ctx0, embeddings, hparams.projection_dim, n_patches_x * n_patches_y / 4);
  630. embeddings = ggml_get_rows(ctx0, embeddings, window_idx);
  631. embeddings = ggml_reshape_3d(ctx0, embeddings, hparams.projection_dim, n_patches_x * n_patches_y / 4, batch_size);
  632. }
  633. // build the graph
  634. ggml_build_forward_expand(gf, embeddings);
  635. return gf;
  636. }
  637. ggml_cgraph * build_minicpmv() {
  638. const int batch_size = 1;
  639. GGML_ASSERT(model.class_embedding == nullptr);
  640. const int n_pos = n_patches;
  641. // position embeddings for the projector (not for ViT)
  642. int n_output_dim = clip_n_mmproj_embd(ctx);
  643. ggml_tensor * pos_embed = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, n_output_dim, n_pos, batch_size);
  644. ggml_set_name(pos_embed, "pos_embed");
  645. ggml_set_input(pos_embed);
  646. // for selecting learned pos embd, used by ViT
  647. struct ggml_tensor * positions = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_pos);
  648. ggml_set_name(positions, "positions");
  649. ggml_set_input(positions);
  650. ggml_tensor * learned_pos_embd = ggml_get_rows(ctx0, model.position_embeddings, positions);
  651. ggml_tensor * inp = build_inp();
  652. ggml_tensor * embeddings = build_vit(
  653. inp, n_patches,
  654. NORM_TYPE_NORMAL,
  655. hparams.ffn_op,
  656. learned_pos_embd,
  657. nullptr);
  658. // resampler projector (it is just another transformer)
  659. ggml_tensor * q = model.mm_model_query;
  660. ggml_tensor * v = ggml_mul_mat(ctx0, model.mm_model_kv_proj, embeddings);
  661. // norm
  662. q = build_norm(q, model.mm_model_ln_q_w, model.mm_model_ln_q_b, NORM_TYPE_NORMAL, eps, -1);
  663. v = build_norm(v, model.mm_model_ln_kv_w, model.mm_model_ln_kv_b, NORM_TYPE_NORMAL, eps, -1);
  664. // k = v + pos_embed
  665. ggml_tensor * k = ggml_add(ctx0, v, pos_embed);
  666. // attention
  667. {
  668. int n_embd = clip_n_mmproj_embd(ctx);
  669. const int d_head = 128;
  670. int n_head = n_embd/d_head;
  671. int num_query = 96;
  672. if (ctx->minicpmv_version == 2) {
  673. num_query = 96;
  674. } else if (ctx->minicpmv_version == 3) {
  675. num_query = 64;
  676. } else if (ctx->minicpmv_version == 4) {
  677. num_query = 64;
  678. }
  679. ggml_tensor * Q = ggml_add(ctx0,
  680. ggml_mul_mat(ctx0, model.mm_model_attn_q_w, q),
  681. model.mm_model_attn_q_b);
  682. ggml_tensor * K = ggml_add(ctx0,
  683. ggml_mul_mat(ctx0, model.mm_model_attn_k_w, k),
  684. model.mm_model_attn_k_b);
  685. ggml_tensor * V = ggml_add(ctx0,
  686. ggml_mul_mat(ctx0, model.mm_model_attn_v_w, v),
  687. model.mm_model_attn_v_b);
  688. Q = ggml_reshape_3d(ctx0, Q, d_head, n_head, num_query);
  689. K = ggml_reshape_3d(ctx0, K, d_head, n_head, n_pos);
  690. V = ggml_reshape_3d(ctx0, V, d_head, n_head, n_pos);
  691. cb(Q, "resampler_Q", -1);
  692. cb(K, "resampler_K", -1);
  693. cb(V, "resampler_V", -1);
  694. embeddings = build_attn(
  695. model.mm_model_attn_o_w,
  696. model.mm_model_attn_o_b,
  697. Q, K, V, nullptr, kq_scale, -1);
  698. cb(embeddings, "resampler_attn_out", -1);
  699. }
  700. // layernorm
  701. embeddings = build_norm(embeddings, model.mm_model_ln_post_w, model.mm_model_ln_post_b, NORM_TYPE_NORMAL, eps, -1);
  702. // projection
  703. embeddings = ggml_mul_mat(ctx0, model.mm_model_proj, embeddings);
  704. // build the graph
  705. ggml_build_forward_expand(gf, embeddings);
  706. return gf;
  707. }
  708. // this graph is used by llava, granite and glm
  709. // due to having embedding_stack (used by granite), we cannot reuse build_vit
  710. ggml_cgraph * build_llava() {
  711. const int batch_size = 1;
  712. const int n_pos = n_patches + (model.class_embedding ? 1 : 0);
  713. GGML_ASSERT(n_patches_x == n_patches_y && "only square images supported");
  714. // Calculate the deepest feature layer based on hparams and projector type
  715. int max_feature_layer = n_layer;
  716. {
  717. // Get the index of the second to last layer; this is the default for models that have a llava projector
  718. int il_last = hparams.n_layer - 1;
  719. int deepest_feature_layer = -1;
  720. if (ctx->proj_type == PROJECTOR_TYPE_MINICPMV || ctx->proj_type == PROJECTOR_TYPE_GLM_EDGE) {
  721. il_last += 1;
  722. }
  723. // If we set explicit vision feature layers, only go up to the deepest one
  724. // NOTE: only used by granite-vision models for now
  725. for (const auto & feature_layer : hparams.vision_feature_layer) {
  726. if (feature_layer > deepest_feature_layer) {
  727. deepest_feature_layer = feature_layer;
  728. }
  729. }
  730. max_feature_layer = deepest_feature_layer < 0 ? il_last : deepest_feature_layer;
  731. }
  732. ggml_tensor * inp = build_inp();
  733. if (model.patch_bias) {
  734. inp = ggml_add(ctx0, inp, model.patch_bias);
  735. }
  736. // concat class_embeddings and patch_embeddings
  737. if (model.class_embedding) {
  738. inp = ggml_concat(ctx0, inp, model.class_embedding, 1);
  739. }
  740. ggml_tensor * positions = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_pos);
  741. ggml_set_name(positions, "positions");
  742. ggml_set_input(positions);
  743. inp = ggml_add(ctx0, inp, ggml_get_rows(ctx0, model.position_embeddings, positions));
  744. ggml_tensor * inpL = inp;
  745. // pre-layernorm
  746. if (model.pre_ln_w) {
  747. inpL = build_norm(inpL, model.pre_ln_w, model.pre_ln_b, NORM_TYPE_NORMAL, eps, -1);
  748. cb(inpL, "pre_ln", -1);
  749. }
  750. std::vector<ggml_tensor *> embedding_stack;
  751. const auto & vision_feature_layer = hparams.vision_feature_layer;
  752. // loop over layers
  753. for (int il = 0; il < max_feature_layer; il++) {
  754. auto & layer = model.layers[il];
  755. ggml_tensor * cur = inpL; // inpL = residual, cur = hidden_states
  756. // If this is an embedding feature layer, save the output.
  757. // NOTE: 0 index here refers to the input to the encoder.
  758. if (vision_feature_layer.find(il) != vision_feature_layer.end()) {
  759. embedding_stack.push_back(cur);
  760. }
  761. // layernorm1
  762. cur = build_norm(cur, layer.ln_1_w, layer.ln_1_b, NORM_TYPE_NORMAL, eps, il);
  763. cb(cur, "layer_inp_normed", il);
  764. // self-attention
  765. {
  766. ggml_tensor * Qcur = ggml_mul_mat(ctx0, layer.q_w, cur);
  767. if (layer.q_b) {
  768. Qcur = ggml_add(ctx0, Qcur, layer.q_b);
  769. }
  770. ggml_tensor * Kcur = ggml_mul_mat(ctx0, layer.k_w, cur);
  771. if (layer.k_b) {
  772. Kcur = ggml_add(ctx0, Kcur, layer.k_b);
  773. }
  774. ggml_tensor * Vcur = ggml_mul_mat(ctx0, layer.v_w, cur);
  775. if (layer.v_b) {
  776. Vcur = ggml_add(ctx0, Vcur, layer.v_b);
  777. }
  778. Qcur = ggml_reshape_3d(ctx0, Qcur, d_head, n_head, n_pos);
  779. Kcur = ggml_reshape_3d(ctx0, Kcur, d_head, n_head, n_pos);
  780. Vcur = ggml_reshape_3d(ctx0, Vcur, d_head, n_head, n_pos);
  781. cb(Qcur, "Qcur", il);
  782. cb(Kcur, "Kcur", il);
  783. cb(Vcur, "Vcur", il);
  784. cur = build_attn(layer.o_w, layer.o_b,
  785. Qcur, Kcur, Vcur, nullptr, kq_scale, il);
  786. cb(cur, "attn_out", il);
  787. }
  788. // re-add the layer input, e.g., residual
  789. cur = ggml_add(ctx0, cur, inpL);
  790. inpL = cur; // inpL = residual, cur = hidden_states
  791. cb(cur, "ffn_inp", il);
  792. // layernorm2
  793. cur = build_norm(cur, layer.ln_2_w, layer.ln_2_b, NORM_TYPE_NORMAL, eps, il);
  794. cb(cur, "ffn_inp_normed", il);
  795. // ffn
  796. cur = build_ffn(cur,
  797. layer.ff_up_w, layer.ff_up_b,
  798. layer.ff_gate_w, layer.ff_gate_b,
  799. layer.ff_down_w, layer.ff_down_b,
  800. hparams.ffn_op, il);
  801. cb(cur, "ffn_out", il);
  802. // residual 2
  803. cur = ggml_add(ctx0, inpL, cur);
  804. cb(cur, "layer_out", il);
  805. inpL = cur;
  806. }
  807. // post-layernorm
  808. if (model.post_ln_w) {
  809. inpL = build_norm(inpL, model.post_ln_w, model.post_ln_b, NORM_TYPE_NORMAL, eps, -1);
  810. }
  811. ggml_tensor * embeddings = inpL;
  812. // process vision feature layers (used by granite)
  813. {
  814. // final layer is a vision feature layer
  815. if (vision_feature_layer.find(max_feature_layer) != vision_feature_layer.end()) {
  816. embedding_stack.push_back(inpL);
  817. }
  818. // If feature layers are explicitly set, stack them (if we have multiple)
  819. if (!embedding_stack.empty()) {
  820. embeddings = embedding_stack[0];
  821. for (size_t i = 1; i < embedding_stack.size(); i++) {
  822. embeddings = ggml_concat(ctx0, embeddings, embedding_stack[i], 0);
  823. }
  824. }
  825. }
  826. // llava projector (also used by granite)
  827. if (ctx->has_llava_projector) {
  828. embeddings = ggml_reshape_2d(ctx0, embeddings, embeddings->ne[0], embeddings->ne[1]);
  829. ggml_tensor * patches = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, n_patches);
  830. ggml_set_name(patches, "patches");
  831. ggml_set_input(patches);
  832. // shape [1, 576, 1024]
  833. // ne is whcn, ne = [1024, 576, 1, 1]
  834. embeddings = ggml_get_rows(ctx0, embeddings, patches);
  835. // print_tensor_info(embeddings, "embeddings");
  836. // llava projector
  837. if (ctx->proj_type == PROJECTOR_TYPE_MLP) {
  838. embeddings = ggml_mul_mat(ctx0, model.mm_0_w, embeddings);
  839. embeddings = ggml_add(ctx0, embeddings, model.mm_0_b);
  840. embeddings = ggml_gelu(ctx0, embeddings);
  841. if (model.mm_2_w) {
  842. embeddings = ggml_mul_mat(ctx0, model.mm_2_w, embeddings);
  843. embeddings = ggml_add(ctx0, embeddings, model.mm_2_b);
  844. }
  845. }
  846. else if (ctx->proj_type == PROJECTOR_TYPE_MLP_NORM) {
  847. embeddings = ggml_mul_mat(ctx0, model.mm_0_w, embeddings);
  848. embeddings = ggml_add(ctx0, embeddings, model.mm_0_b);
  849. // ggml_tensor_printf(embeddings, "mm_0_w",0,true,false);
  850. // First LayerNorm
  851. embeddings = ggml_norm(ctx0, embeddings, eps);
  852. embeddings = ggml_add(ctx0, ggml_mul(ctx0, embeddings, model.mm_1_w),
  853. model.mm_1_b);
  854. // GELU activation
  855. embeddings = ggml_gelu(ctx0, embeddings);
  856. // Second linear layer
  857. embeddings = ggml_mul_mat(ctx0, model.mm_3_w, embeddings);
  858. embeddings = ggml_add(ctx0, embeddings, model.mm_3_b);
  859. // Second LayerNorm
  860. embeddings = ggml_norm(ctx0, embeddings, eps);
  861. embeddings = ggml_add(ctx0, ggml_mul(ctx0, embeddings, model.mm_4_w),
  862. model.mm_4_b);
  863. }
  864. else if (ctx->proj_type == PROJECTOR_TYPE_LDP) {
  865. // MobileVLM projector
  866. int n_patch = 24;
  867. ggml_tensor * mlp_1 = ggml_mul_mat(ctx0, model.mm_model_mlp_1_w, embeddings);
  868. mlp_1 = ggml_add(ctx0, mlp_1, model.mm_model_mlp_1_b);
  869. mlp_1 = ggml_gelu(ctx0, mlp_1);
  870. ggml_tensor * mlp_3 = ggml_mul_mat(ctx0, model.mm_model_mlp_3_w, mlp_1);
  871. mlp_3 = ggml_add(ctx0, mlp_3, model.mm_model_mlp_3_b);
  872. // mlp_3 shape = [1, 576, 2048], ne = [2048, 576, 1, 1]
  873. // block 1
  874. ggml_tensor * block_1 = nullptr;
  875. {
  876. // transpose from [1, 576, 2048] --> [1, 2048, 576] --> [1, 2048, 24, 24]
  877. mlp_3 = ggml_cont(ctx0, ggml_permute(ctx0, mlp_3, 1, 0, 2, 3));
  878. mlp_3 = ggml_reshape_4d(ctx0, mlp_3, n_patch, n_patch, mlp_3->ne[1], mlp_3->ne[2]);
  879. // stride = 1, padding = 1, bias is nullptr
  880. block_1 = ggml_conv_2d_dw(ctx0, model.mm_model_block_1_block_0_0_w, mlp_3, 1, 1, 1, 1, 1, 1);
  881. // layer norm
  882. // // block_1 shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1]
  883. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 2, 0, 3));
  884. // block_1 shape = [1, 24, 24, 2048], ne = [2048, 24, 24, 1]
  885. block_1 = ggml_norm(ctx0, block_1, eps);
  886. block_1 = ggml_add(ctx0, ggml_mul(ctx0, block_1, model.mm_model_block_1_block_0_1_w), model.mm_model_block_1_block_0_1_b);
  887. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 2, 0, 1, 3));
  888. // block_1 shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1]
  889. // hardswish
  890. ggml_tensor * block_1_hw = ggml_hardswish(ctx0, block_1);
  891. block_1 = ggml_pool_2d(ctx0, block_1_hw, GGML_OP_POOL_AVG, block_1_hw->ne[0], block_1_hw->ne[1], block_1_hw->ne[0], block_1_hw->ne[1], 0, 0);
  892. // block_1 shape = [1, 2048, 1, 1], ne = [1, 1, 2048, 1]
  893. // pointwise conv
  894. block_1 = ggml_reshape_2d(ctx0, block_1, block_1->ne[0]*block_1->ne[1]*block_1->ne[2], block_1->ne[3]);
  895. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_1_block_1_fc1_w, block_1);
  896. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_1_block_1_fc1_b);
  897. block_1 = ggml_relu(ctx0, block_1);
  898. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_1_block_1_fc2_w, block_1);
  899. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_1_block_1_fc2_b);
  900. block_1 = ggml_hardsigmoid(ctx0, block_1);
  901. // block_1_hw shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1], block_1 shape = [1, 2048], ne = [2048, 1, 1, 1]
  902. block_1 = ggml_reshape_4d(ctx0, block_1, 1, 1, block_1->ne[0], block_1->ne[1]);
  903. block_1 = ggml_mul(ctx0, block_1_hw, block_1);
  904. int w = block_1->ne[0], h = block_1->ne[1];
  905. block_1 = ggml_reshape_3d(ctx0, block_1, w*h, block_1->ne[2], block_1->ne[3]);
  906. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 0, 2, 3));
  907. // block_1 shape = [1, 24*24, 2048], ne = [24*24, 2048, 1]
  908. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_1_block_2_0_w, block_1);
  909. block_1 = ggml_reshape_4d(ctx0, block_1, block_1->ne[0], w, h, block_1->ne[3]);
  910. // block_1 shape = [1, 24, 24, 2048], ne = [2048, 24, 24, 1]
  911. block_1 = ggml_norm(ctx0, block_1, eps);
  912. block_1 = ggml_add(ctx0, ggml_mul(ctx0, block_1, model.mm_model_block_1_block_2_1_w), model.mm_model_block_1_block_2_1_b);
  913. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 2, 0, 1, 3));
  914. // block1 shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1]
  915. // residual
  916. block_1 = ggml_add(ctx0, mlp_3, block_1);
  917. }
  918. // block_2
  919. {
  920. // stride = 2
  921. block_1 = ggml_conv_2d_dw(ctx0, model.mm_model_block_2_block_0_0_w, block_1, 2, 2, 1, 1, 1, 1);
  922. // block_1 shape = [1, 2048, 12, 12], ne = [12, 12, 2048, 1]
  923. // layer norm
  924. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 2, 0, 3));
  925. // block_1 shape = [1, 12, 12, 2048], ne = [2048, 12, 12, 1]
  926. block_1 = ggml_norm(ctx0, block_1, eps);
  927. block_1 = ggml_add(ctx0, ggml_mul(ctx0, block_1, model.mm_model_block_2_block_0_1_w), model.mm_model_block_2_block_0_1_b);
  928. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 2, 0, 1, 3));
  929. // block_1 shape = [1, 2048, 12, 12], ne = [12, 12, 2048, 1]
  930. // hardswish
  931. ggml_tensor * block_1_hw = ggml_hardswish(ctx0, block_1);
  932. // not sure the parameters is right for globalAvgPooling
  933. block_1 = ggml_pool_2d(ctx0, block_1_hw, GGML_OP_POOL_AVG, block_1_hw->ne[0], block_1_hw->ne[1], block_1_hw->ne[0], block_1_hw->ne[1], 0, 0);
  934. // block_1 shape = [1, 2048, 1, 1], ne = [1, 1, 2048, 1]
  935. // pointwise conv
  936. block_1 = ggml_reshape_2d(ctx0, block_1, block_1->ne[0]*block_1->ne[1]*block_1->ne[2], block_1->ne[3]);
  937. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_2_block_1_fc1_w, block_1);
  938. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_2_block_1_fc1_b);
  939. block_1 = ggml_relu(ctx0, block_1);
  940. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_2_block_1_fc2_w, block_1);
  941. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_2_block_1_fc2_b);
  942. block_1 = ggml_hardsigmoid(ctx0, block_1);
  943. // block_1_hw shape = [1, 2048, 12, 12], ne = [12, 12, 2048, 1], block_1 shape = [1, 2048, 1, 1], ne = [1, 1, 2048, 1]
  944. block_1 = ggml_reshape_4d(ctx0, block_1, 1, 1, block_1->ne[0], block_1->ne[1]);
  945. block_1 = ggml_mul(ctx0, block_1_hw, block_1);
  946. int w = block_1->ne[0], h = block_1->ne[1];
  947. block_1 = ggml_reshape_3d(ctx0, block_1, w*h, block_1->ne[2], block_1->ne[3]);
  948. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 0, 2, 3));
  949. // block_1 shape = [1, 24*24, 2048], ne = [24*24, 2048, 1]
  950. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_2_block_2_0_w, block_1);
  951. block_1 = ggml_reshape_4d(ctx0, block_1, block_1->ne[0], w, h, block_1->ne[3]);
  952. // block_1 shape = [1, 12, 12, 2048], ne = [2048, 12, 12, 1]
  953. block_1 = ggml_norm(ctx0, block_1, eps);
  954. block_1 = ggml_add(ctx0, ggml_mul(ctx0, block_1, model.mm_model_block_2_block_2_1_w), model.mm_model_block_2_block_2_1_b);
  955. block_1 = ggml_reshape_3d(ctx0, block_1, block_1->ne[0], block_1->ne[1] * block_1->ne[2], block_1->ne[3]);
  956. // block_1 shape = [1, 144, 2048], ne = [2048, 144, 1]
  957. }
  958. embeddings = block_1;
  959. }
  960. else if (ctx->proj_type == PROJECTOR_TYPE_LDPV2)
  961. {
  962. int n_patch = 24;
  963. ggml_tensor * mlp_0 = ggml_mul_mat(ctx0, model.mm_model_mlp_0_w, embeddings);
  964. mlp_0 = ggml_add(ctx0, mlp_0, model.mm_model_mlp_0_b);
  965. mlp_0 = ggml_gelu(ctx0, mlp_0);
  966. ggml_tensor * mlp_2 = ggml_mul_mat(ctx0, model.mm_model_mlp_2_w, mlp_0);
  967. mlp_2 = ggml_add(ctx0, mlp_2, model.mm_model_mlp_2_b);
  968. // mlp_2 ne = [2048, 576, 1, 1]
  969. // // AVG Pool Layer 2*2, strides = 2
  970. mlp_2 = ggml_cont(ctx0, ggml_permute(ctx0, mlp_2, 1, 0, 2, 3));
  971. // mlp_2 ne = [576, 2048, 1, 1]
  972. mlp_2 = ggml_reshape_4d(ctx0, mlp_2, n_patch, n_patch, mlp_2->ne[1], mlp_2->ne[2]);
  973. // mlp_2 ne [24, 24, 2048, 1]
  974. mlp_2 = ggml_pool_2d(ctx0, mlp_2, GGML_OP_POOL_AVG, 2, 2, 2, 2, 0, 0);
  975. // weight ne = [3, 3, 2048, 1]
  976. ggml_tensor * peg_0 = ggml_conv_2d_dw(ctx0, model.mm_model_peg_0_w, mlp_2, 1, 1, 1, 1, 1, 1);
  977. peg_0 = ggml_cont(ctx0, ggml_permute(ctx0, peg_0, 1, 2, 0, 3));
  978. peg_0 = ggml_add(ctx0, peg_0, model.mm_model_peg_0_b);
  979. mlp_2 = ggml_cont(ctx0, ggml_permute(ctx0, mlp_2, 1, 2, 0, 3));
  980. peg_0 = ggml_add(ctx0, peg_0, mlp_2);
  981. peg_0 = ggml_reshape_3d(ctx0, peg_0, peg_0->ne[0], peg_0->ne[1] * peg_0->ne[2], peg_0->ne[3]);
  982. embeddings = peg_0;
  983. }
  984. else {
  985. GGML_ABORT("fatal error");
  986. }
  987. }
  988. // glm projector
  989. else if (ctx->proj_type == PROJECTOR_TYPE_GLM_EDGE) {
  990. size_t gridsz = (size_t)sqrt(embeddings->ne[1]);
  991. embeddings = ggml_cont(ctx0, ggml_permute(ctx0,embeddings,1,0,2,3));
  992. embeddings = ggml_reshape_3d(ctx0, embeddings, gridsz, gridsz, embeddings->ne[1]);
  993. embeddings = ggml_conv_2d(ctx0, model.mm_model_adapter_conv_w, embeddings, 2, 2, 0, 0, 1, 1);
  994. embeddings = ggml_reshape_3d(ctx0, embeddings,embeddings->ne[0]*embeddings->ne[1] , embeddings->ne[2], batch_size);
  995. embeddings = ggml_cont(ctx0, ggml_permute(ctx0,embeddings, 1, 0, 2, 3));
  996. embeddings = ggml_add(ctx0, embeddings, model.mm_model_adapter_conv_b);
  997. // GLU
  998. {
  999. embeddings = ggml_mul_mat(ctx0, model.mm_model_mlp_0_w, embeddings);
  1000. embeddings = ggml_norm(ctx0, embeddings, eps);
  1001. embeddings = ggml_add(ctx0, ggml_mul(ctx0, embeddings, model.mm_model_ln_q_w), model.mm_model_ln_q_b);
  1002. embeddings = ggml_gelu_inplace(ctx0, embeddings);
  1003. ggml_tensor * x = embeddings;
  1004. embeddings = ggml_mul_mat(ctx0, model.mm_model_mlp_2_w, embeddings);
  1005. x = ggml_mul_mat(ctx0, model.mm_model_mlp_1_w,x);
  1006. embeddings = ggml_silu_inplace(ctx0, embeddings);
  1007. embeddings = ggml_mul(ctx0, embeddings,x);
  1008. embeddings = ggml_mul_mat(ctx0, model.mm_model_mlp_3_w, embeddings);
  1009. }
  1010. // arrangement of BOI/EOI token embeddings
  1011. // note: these embeddings are not present in text model, hence we cannot process them as text tokens
  1012. // see: https://huggingface.co/THUDM/glm-edge-v-2b/blob/main/siglip.py#L53
  1013. {
  1014. embeddings = ggml_concat(ctx0, model.mm_glm_tok_boi, embeddings, 1); // BOI
  1015. embeddings = ggml_concat(ctx0, embeddings, model.mm_glm_tok_eoi, 1); // EOI
  1016. }
  1017. }
  1018. else {
  1019. GGML_ABORT("llava: unknown projector type");
  1020. }
  1021. // build the graph
  1022. ggml_build_forward_expand(gf, embeddings);
  1023. return gf;
  1024. }
  1025. private:
  1026. //
  1027. // utility functions
  1028. //
  1029. void cb(ggml_tensor * cur, const char * name, int il) const {
  1030. // TODO: implement this
  1031. GGML_UNUSED(cur);
  1032. GGML_UNUSED(name);
  1033. GGML_UNUSED(il);
  1034. }
  1035. // build vision transformer (ViT) cgraph
  1036. // this function should cover most of the models
  1037. // if your model has specific features, you should probably duplicate this function
  1038. ggml_tensor * build_vit(
  1039. ggml_tensor * inp,
  1040. int64_t n_pos,
  1041. norm_type norm_t,
  1042. ffn_op_type ffn_t,
  1043. ggml_tensor * learned_pos_embd,
  1044. std::function<ggml_tensor *(ggml_tensor *, const clip_layer &)> add_pos
  1045. ) {
  1046. if (model.patch_bias) {
  1047. inp = ggml_add(ctx0, inp, model.patch_bias);
  1048. cb(inp, "patch_bias", -1);
  1049. }
  1050. if (learned_pos_embd) {
  1051. inp = ggml_add(ctx0, inp, learned_pos_embd);
  1052. cb(inp, "pos_embed", -1);
  1053. }
  1054. ggml_tensor * inpL = inp;
  1055. // pre-layernorm
  1056. if (model.pre_ln_w) {
  1057. inpL = build_norm(inpL, model.pre_ln_w, model.pre_ln_b, norm_t, eps, -1);
  1058. cb(inpL, "pre_ln", -1);
  1059. }
  1060. // loop over layers
  1061. for (int il = 0; il < n_layer; il++) {
  1062. auto & layer = model.layers[il];
  1063. ggml_tensor * cur = inpL; // inpL = residual, cur = hidden_states
  1064. // layernorm1
  1065. cur = build_norm(cur, layer.ln_1_w, layer.ln_1_b, norm_t, eps, il);
  1066. cb(cur, "layer_inp_normed", il);
  1067. // self-attention
  1068. {
  1069. ggml_tensor * Qcur = ggml_mul_mat(ctx0, layer.q_w, cur);
  1070. if (layer.q_b) {
  1071. Qcur = ggml_add(ctx0, Qcur, layer.q_b);
  1072. }
  1073. ggml_tensor * Kcur = ggml_mul_mat(ctx0, layer.k_w, cur);
  1074. if (layer.k_b) {
  1075. Kcur = ggml_add(ctx0, Kcur, layer.k_b);
  1076. }
  1077. ggml_tensor * Vcur = ggml_mul_mat(ctx0, layer.v_w, cur);
  1078. if (layer.v_b) {
  1079. Vcur = ggml_add(ctx0, Vcur, layer.v_b);
  1080. }
  1081. Qcur = ggml_reshape_3d(ctx0, Qcur, d_head, n_head, n_pos);
  1082. Kcur = ggml_reshape_3d(ctx0, Kcur, d_head, n_head, n_pos);
  1083. Vcur = ggml_reshape_3d(ctx0, Vcur, d_head, n_head, n_pos);
  1084. cb(Qcur, "Qcur", il);
  1085. cb(Kcur, "Kcur", il);
  1086. cb(Vcur, "Vcur", il);
  1087. if (add_pos) {
  1088. Qcur = add_pos(Qcur, layer);
  1089. Kcur = add_pos(Kcur, layer);
  1090. cb(Qcur, "Qcur_pos", il);
  1091. cb(Kcur, "Kcur_pos", il);
  1092. }
  1093. cur = build_attn(layer.o_w, layer.o_b,
  1094. Qcur, Kcur, Vcur, nullptr, kq_scale, il);
  1095. cb(cur, "attn_out", il);
  1096. }
  1097. // re-add the layer input, e.g., residual
  1098. cur = ggml_add(ctx0, cur, inpL);
  1099. inpL = cur; // inpL = residual, cur = hidden_states
  1100. cb(cur, "ffn_inp", il);
  1101. // layernorm2
  1102. cur = build_norm(cur, layer.ln_2_w, layer.ln_2_b, norm_t, eps, il);
  1103. cb(cur, "ffn_inp_normed", il);
  1104. // ffn
  1105. cur = build_ffn(cur,
  1106. layer.ff_up_w, layer.ff_up_b,
  1107. layer.ff_gate_w, layer.ff_gate_b,
  1108. layer.ff_down_w, layer.ff_down_b,
  1109. ffn_t, il);
  1110. cb(cur, "ffn_out", il);
  1111. // residual 2
  1112. cur = ggml_add(ctx0, inpL, cur);
  1113. cb(cur, "layer_out", il);
  1114. inpL = cur;
  1115. }
  1116. // post-layernorm
  1117. if (model.post_ln_w) {
  1118. inpL = build_norm(inpL, model.post_ln_w, model.post_ln_b, norm_t, eps, -1);
  1119. }
  1120. return inpL;
  1121. }
  1122. // build the input after conv2d (inp_raw --> patches)
  1123. // returns tensor with shape [n_embd, n_patches]
  1124. ggml_tensor * build_inp() {
  1125. ggml_tensor * inp_raw = build_inp_raw();
  1126. ggml_tensor * inp = ggml_conv_2d(ctx0, model.patch_embeddings_0, inp_raw, patch_size, patch_size, 0, 0, 1, 1);
  1127. inp = ggml_reshape_2d(ctx0, inp, n_patches, n_embd);
  1128. inp = ggml_cont(ctx0, ggml_transpose(ctx0, inp));
  1129. return inp;
  1130. }
  1131. ggml_tensor * build_inp_raw() {
  1132. ggml_tensor * inp_raw = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, img.nx, img.ny, 3);
  1133. ggml_set_name(inp_raw, "inp_raw");
  1134. ggml_set_input(inp_raw);
  1135. return inp_raw;
  1136. }
  1137. ggml_tensor * build_norm(
  1138. ggml_tensor * cur,
  1139. ggml_tensor * mw,
  1140. ggml_tensor * mb,
  1141. norm_type type,
  1142. float norm_eps,
  1143. int il) const {
  1144. cur = type == NORM_TYPE_RMS
  1145. ? ggml_rms_norm(ctx0, cur, norm_eps)
  1146. : ggml_norm(ctx0, cur, norm_eps);
  1147. if (mw || mb) {
  1148. cb(cur, "norm", il);
  1149. }
  1150. if (mw) {
  1151. cur = ggml_mul(ctx0, cur, mw);
  1152. if (mb) {
  1153. cb(cur, "norm_w", il);
  1154. }
  1155. }
  1156. if (mb) {
  1157. cur = ggml_add(ctx0, cur, mb);
  1158. }
  1159. return cur;
  1160. }
  1161. ggml_tensor * build_ffn(
  1162. ggml_tensor * cur,
  1163. ggml_tensor * up,
  1164. ggml_tensor * up_b,
  1165. ggml_tensor * gate,
  1166. ggml_tensor * gate_b,
  1167. ggml_tensor * down,
  1168. ggml_tensor * down_b,
  1169. ffn_op_type type_op,
  1170. int il) const {
  1171. ggml_tensor * tmp = up ? ggml_mul_mat(ctx0, up, cur) : cur;
  1172. cb(tmp, "ffn_up", il);
  1173. if (up_b) {
  1174. tmp = ggml_add(ctx0, tmp, up_b);
  1175. cb(tmp, "ffn_up_b", il);
  1176. }
  1177. if (gate) {
  1178. cur = ggml_mul_mat(ctx0, gate, cur);
  1179. cb(cur, "ffn_gate", il);
  1180. if (gate_b) {
  1181. cur = ggml_add(ctx0, cur, gate_b);
  1182. cb(cur, "ffn_gate_b", il);
  1183. }
  1184. } else {
  1185. cur = tmp;
  1186. }
  1187. switch (type_op) {
  1188. case FFN_SILU:
  1189. {
  1190. cur = ggml_silu(ctx0, cur);
  1191. cb(cur, "ffn_silu", il);
  1192. } break;
  1193. case FFN_GELU:
  1194. {
  1195. cur = ggml_gelu(ctx0, cur);
  1196. cb(cur, "ffn_gelu", il);
  1197. } break;
  1198. case FFN_GELU_QUICK:
  1199. {
  1200. cur = ggml_gelu_quick(ctx0, cur);
  1201. cb(cur, "ffn_relu", il);
  1202. } break;
  1203. }
  1204. // we only support parallel ffn for now
  1205. if (gate) {
  1206. cur = ggml_mul(ctx0, cur, tmp);
  1207. cb(cur, "ffn_gate_par", il);
  1208. }
  1209. if (down) {
  1210. cur = ggml_mul_mat(ctx0, down, cur);
  1211. }
  1212. if (down_b) {
  1213. cb(cur, "ffn_down", il);
  1214. }
  1215. if (down_b) {
  1216. cur = ggml_add(ctx0, cur, down_b);
  1217. }
  1218. return cur;
  1219. }
  1220. ggml_tensor * build_attn(
  1221. ggml_tensor * wo,
  1222. ggml_tensor * wo_b,
  1223. ggml_tensor * q_cur,
  1224. ggml_tensor * k_cur,
  1225. ggml_tensor * v_cur,
  1226. ggml_tensor * kq_mask,
  1227. float kq_scale,
  1228. int il) const {
  1229. // these nodes are added to the graph together so that they are not reordered
  1230. // by doing so, the number of splits in the graph is reduced
  1231. ggml_build_forward_expand(gf, q_cur);
  1232. ggml_build_forward_expand(gf, k_cur);
  1233. ggml_build_forward_expand(gf, v_cur);
  1234. ggml_tensor * q = ggml_permute(ctx0, q_cur, 0, 2, 1, 3);
  1235. //cb(q, "q", il);
  1236. ggml_tensor * k = ggml_permute(ctx0, k_cur, 0, 2, 1, 3);
  1237. //cb(k, "k", il);
  1238. ggml_tensor * v = ggml_permute(ctx0, v_cur, 1, 2, 0, 3);
  1239. v = ggml_cont(ctx0, v);
  1240. //cb(k, "v", il);
  1241. ggml_tensor * cur;
  1242. // TODO @ngxson : support flash attention
  1243. {
  1244. const auto n_tokens = q->ne[1];
  1245. const auto n_head = q->ne[2];
  1246. // const auto n_kv = k->ne[1]; // for flash attention
  1247. ggml_tensor * kq = ggml_mul_mat(ctx0, k, q);
  1248. // F32 may not needed for vision encoders?
  1249. // ggml_mul_mat_set_prec(kq, GGML_PREC_F32);
  1250. kq = ggml_soft_max_ext(ctx0, kq, kq_mask, kq_scale, 0.0f);
  1251. ggml_tensor * kqv = ggml_mul_mat(ctx0, v, kq);
  1252. cur = ggml_permute(ctx0, kqv, 0, 2, 1, 3);
  1253. cur = ggml_cont_2d(ctx0, cur, cur->ne[0]*n_head, n_tokens);
  1254. }
  1255. cb(cur, "kqv_out", il);
  1256. if (wo) {
  1257. cur = ggml_mul_mat(ctx0, wo, cur);
  1258. }
  1259. if (wo_b) {
  1260. cur = ggml_add(ctx0, cur, wo_b);
  1261. }
  1262. return cur;
  1263. }
  1264. // implementation of the 2D RoPE without adding a new op in ggml
  1265. // this is not efficient (use double the memory), but works on all backends
  1266. // TODO: there was a more efficient which relies on ggml_view and ggml_rope_ext_inplace, but the rope inplace does not work well with non-contiguous tensors ; we should fix that and revert back to the original implementation in https://github.com/ggml-org/llama.cpp/pull/13065
  1267. static ggml_tensor * build_rope_2d(
  1268. ggml_context * ctx0,
  1269. ggml_tensor * cur,
  1270. ggml_tensor * pos_h,
  1271. ggml_tensor * pos_w,
  1272. const float freq_base
  1273. ) {
  1274. const int64_t n_dim = cur->ne[0];
  1275. const int64_t n_head = cur->ne[1];
  1276. const int64_t n_pos = cur->ne[2];
  1277. // for example, if we have cur tensor of shape (n_dim=8, n_head, n_pos)
  1278. // we will have a list of 4 inv_freq: 1e-0, 1e-1, 1e-2, 1e-3
  1279. // first half of cur will use 1e-0, 1e-2 (even)
  1280. // second half of cur will use 1e-1, 1e-3 (odd)
  1281. // the trick here is to rotate just half of n_dim, so inv_freq will automatically be even
  1282. // ^ don't ask me why, it's math! -2(2i) / n_dim == -2i / (n_dim/2)
  1283. // then for the second half, we use freq_scale to shift the inv_freq
  1284. // ^ why? replace (2i) with (2i+1) in the above equation
  1285. const float freq_scale_odd = std::pow(freq_base, (float)-2/n_dim);
  1286. // first half
  1287. ggml_tensor * first;
  1288. {
  1289. first = ggml_view_3d(ctx0, cur,
  1290. n_dim/2, n_head, n_pos,
  1291. ggml_row_size(cur->type, n_dim),
  1292. ggml_row_size(cur->type, n_dim*n_head),
  1293. 0);
  1294. first = ggml_rope_ext(
  1295. ctx0,
  1296. first,
  1297. pos_h, // positions
  1298. nullptr, // freq factors
  1299. n_dim/2, // n_dims
  1300. 0, 0, freq_base,
  1301. 1.0f, 0.0f, 1.0f, 0.0f, 0.0f
  1302. );
  1303. }
  1304. // second half
  1305. ggml_tensor * second;
  1306. {
  1307. second = ggml_view_3d(ctx0, cur,
  1308. n_dim/2, n_head, n_pos,
  1309. ggml_row_size(cur->type, n_dim),
  1310. ggml_row_size(cur->type, n_dim*n_head),
  1311. n_dim/2 * ggml_element_size(cur));
  1312. second = ggml_cont(ctx0, second); // copy, because ggml_rope don't play well with non-contiguous tensors
  1313. second = ggml_rope_ext(
  1314. ctx0,
  1315. second,
  1316. pos_w, // positions
  1317. nullptr, // freq factors
  1318. n_dim/2, // n_dims
  1319. 0, 0, freq_base,
  1320. freq_scale_odd,
  1321. 0.0f, 1.0f, 0.0f, 0.0f
  1322. );
  1323. }
  1324. cur = ggml_concat(ctx0, first, second, 0);
  1325. return cur;
  1326. }
  1327. };
  1328. static ggml_cgraph * clip_image_build_graph(clip_ctx * ctx, const clip_image_f32_batch & imgs) {
  1329. GGML_ASSERT(imgs.entries.size() == 1 && "n_batch > 1 is not supported");
  1330. clip_graph graph(ctx, *imgs.entries[0]);
  1331. ggml_cgraph * res;
  1332. switch (ctx->proj_type) {
  1333. case PROJECTOR_TYPE_GEMMA3:
  1334. case PROJECTOR_TYPE_IDEFICS3:
  1335. {
  1336. res = graph.build_siglip();
  1337. } break;
  1338. case PROJECTOR_TYPE_PIXTRAL:
  1339. {
  1340. res = graph.build_pixtral();
  1341. } break;
  1342. case PROJECTOR_TYPE_QWEN2VL:
  1343. case PROJECTOR_TYPE_QWEN25VL:
  1344. {
  1345. res = graph.build_qwen2vl();
  1346. } break;
  1347. case PROJECTOR_TYPE_MINICPMV:
  1348. {
  1349. res = graph.build_minicpmv();
  1350. } break;
  1351. default:
  1352. {
  1353. res = graph.build_llava();
  1354. } break;
  1355. }
  1356. return res;
  1357. }
  1358. struct clip_model_loader {
  1359. ggml_context_ptr ctx_meta;
  1360. gguf_context_ptr ctx_gguf;
  1361. clip_ctx & ctx_clip;
  1362. std::string fname;
  1363. size_t model_size = 0; // in bytes
  1364. // TODO @ngxson : we should not pass clip_ctx here, it should be clip_vision_model
  1365. clip_model_loader(const char * fname, clip_ctx & ctx_clip) : ctx_clip(ctx_clip), fname(fname) {
  1366. struct ggml_context * meta = nullptr;
  1367. struct gguf_init_params params = {
  1368. /*.no_alloc = */ true,
  1369. /*.ctx = */ &meta,
  1370. };
  1371. ctx_gguf = gguf_context_ptr(gguf_init_from_file(fname, params));
  1372. if (!ctx_gguf.get()) {
  1373. throw std::runtime_error(string_format("%s: failed to load CLIP model from %s. Does this file exist?\n", __func__, fname));
  1374. }
  1375. ctx_meta.reset(meta);
  1376. const int n_tensors = gguf_get_n_tensors(ctx_gguf.get());
  1377. // print gguf info
  1378. {
  1379. std::string name;
  1380. get_string(KEY_NAME, name, false);
  1381. std::string description;
  1382. get_string(KEY_DESCRIPTION, description, false);
  1383. LOG_INF("%s: model name: %s\n", __func__, name.c_str());
  1384. LOG_INF("%s: description: %s\n", __func__, description.c_str());
  1385. LOG_INF("%s: GGUF version: %d\n", __func__, gguf_get_version(ctx_gguf.get()));
  1386. LOG_INF("%s: alignment: %zu\n", __func__, gguf_get_alignment(ctx_gguf.get()));
  1387. LOG_INF("%s: n_tensors: %d\n", __func__, n_tensors);
  1388. LOG_INF("%s: n_kv: %d\n", __func__, (int)gguf_get_n_kv(ctx_gguf.get()));
  1389. LOG_INF("\n");
  1390. }
  1391. // tensors
  1392. {
  1393. for (int i = 0; i < n_tensors; ++i) {
  1394. const char * name = gguf_get_tensor_name(ctx_gguf.get(), i);
  1395. const size_t offset = gguf_get_tensor_offset(ctx_gguf.get(), i);
  1396. enum ggml_type type = gguf_get_tensor_type(ctx_gguf.get(), i);
  1397. ggml_tensor * cur = ggml_get_tensor(meta, name);
  1398. size_t tensor_size = ggml_nbytes(cur);
  1399. model_size += tensor_size;
  1400. LOG_DBG("%s: tensor[%d]: n_dims = %d, name = %s, tensor_size=%zu, offset=%zu, shape:[%" PRIu64 ", %" PRIu64 ", %" PRIu64 ", %" PRIu64 "], type = %s\n",
  1401. __func__, i, ggml_n_dims(cur), cur->name, tensor_size, offset, cur->ne[0], cur->ne[1], cur->ne[2], cur->ne[3], ggml_type_name(type));
  1402. }
  1403. }
  1404. }
  1405. void load_hparams() {
  1406. auto & hparams = ctx_clip.vision_model.hparams;
  1407. std::string log_ffn_op; // for logging
  1408. // projector type
  1409. std::string proj_type;
  1410. {
  1411. get_string(KEY_PROJ_TYPE, proj_type, false);
  1412. if (!proj_type.empty()) {
  1413. ctx_clip.proj_type = clip_projector_type_from_string(proj_type);
  1414. }
  1415. if (ctx_clip.proj_type == PROJECTOR_TYPE_UNKNOWN) {
  1416. throw std::runtime_error(string_format("%s: unknown projector type: %s\n", __func__, proj_type.c_str()));
  1417. }
  1418. }
  1419. // other hparams
  1420. {
  1421. get_i32(KEY_MINICPMV_VERSION, ctx_clip.minicpmv_version, false); // legacy
  1422. get_u32(KEY_N_EMBD, hparams.n_embd);
  1423. get_u32(KEY_N_HEAD, hparams.n_head);
  1424. get_u32(KEY_N_FF, hparams.n_ff);
  1425. get_u32(KEY_N_BLOCK, hparams.n_layer);
  1426. get_u32(KEY_PROJ_DIM, hparams.projection_dim);
  1427. get_f32(KEY_LAYER_NORM_EPS, hparams.eps);
  1428. get_u32(KEY_IMAGE_SIZE, hparams.image_size);
  1429. get_u32(KEY_PATCH_SIZE, hparams.patch_size);
  1430. get_u32(KEY_IMAGE_CROP_RESOLUTION, hparams.image_crop_resolution, false);
  1431. get_arr_int(KEY_IMAGE_GRID_PINPOINTS, hparams.image_grid_pinpoints, false);
  1432. ctx_clip.has_llava_projector = ctx_clip.proj_type == PROJECTOR_TYPE_MLP
  1433. || ctx_clip.proj_type == PROJECTOR_TYPE_MLP_NORM
  1434. || ctx_clip.proj_type == PROJECTOR_TYPE_LDP
  1435. || ctx_clip.proj_type == PROJECTOR_TYPE_LDPV2;
  1436. {
  1437. bool use_gelu = false;
  1438. bool use_silu = false;
  1439. get_bool(KEY_USE_GELU, use_gelu, false);
  1440. get_bool(KEY_USE_SILU, use_silu, false);
  1441. if (use_gelu && use_silu) {
  1442. throw std::runtime_error(string_format("%s: both use_gelu and use_silu are set to true\n", __func__));
  1443. }
  1444. if (use_gelu) {
  1445. hparams.ffn_op = FFN_GELU;
  1446. log_ffn_op = "gelu";
  1447. } else if (use_silu) {
  1448. hparams.ffn_op = FFN_SILU;
  1449. log_ffn_op = "silu";
  1450. } else {
  1451. hparams.ffn_op = FFN_GELU_QUICK;
  1452. log_ffn_op = "gelu_quick";
  1453. }
  1454. }
  1455. {
  1456. std::string mm_patch_merge_type;
  1457. get_string(KEY_MM_PATCH_MERGE_TYPE, mm_patch_merge_type, false);
  1458. if (mm_patch_merge_type == "spatial_unpad") {
  1459. hparams.mm_patch_merge_type = PATCH_MERGE_SPATIAL_UNPAD;
  1460. }
  1461. }
  1462. {
  1463. int idx_mean = gguf_find_key(ctx_gguf.get(), KEY_IMAGE_MEAN);
  1464. int idx_std = gguf_find_key(ctx_gguf.get(), KEY_IMAGE_STD);
  1465. GGML_ASSERT(idx_mean >= 0 && "image_mean not found");
  1466. GGML_ASSERT(idx_std >= 0 && "image_std not found");
  1467. const float * mean_data = (const float *) gguf_get_arr_data(ctx_gguf.get(), idx_mean);
  1468. const float * std_data = (const float *) gguf_get_arr_data(ctx_gguf.get(), idx_std);
  1469. for (int i = 0; i < 3; ++i) {
  1470. ctx_clip.image_mean[i] = mean_data[i];
  1471. ctx_clip.image_std[i] = std_data[i];
  1472. }
  1473. }
  1474. // Load the vision feature layer indices if they are explicitly provided;
  1475. // if multiple vision feature layers are present, the values will be concatenated
  1476. // to form the final visual features.
  1477. // NOTE: gguf conversions should standardize the values of the vision feature layer to
  1478. // be non-negative, since we use -1 to mark values as unset here.
  1479. std::vector<int> vision_feature_layer;
  1480. get_arr_int(KEY_FEATURE_LAYER, vision_feature_layer, false);
  1481. // convert std::vector to std::unordered_set
  1482. for (auto & layer : vision_feature_layer) {
  1483. hparams.vision_feature_layer.insert(layer);
  1484. }
  1485. // model-specific params
  1486. switch (ctx_clip.proj_type) {
  1487. case PROJECTOR_TYPE_MINICPMV:
  1488. {
  1489. if (ctx_clip.minicpmv_version == 0) {
  1490. ctx_clip.minicpmv_version = 2; // default to 2 if not set
  1491. }
  1492. } break;
  1493. case PROJECTOR_TYPE_IDEFICS3:
  1494. {
  1495. get_u32(KEY_PROJ_SCALE_FACTOR, hparams.proj_scale_factor, false);
  1496. } break;
  1497. case PROJECTOR_TYPE_PIXTRAL:
  1498. {
  1499. hparams.rope_theta = 10000.0f;
  1500. get_u32(KEY_SPATIAL_MERGE_SIZE, hparams.spatial_merge_size, false);
  1501. } break;
  1502. case PROJECTOR_TYPE_GEMMA3:
  1503. {
  1504. // default value (used by all model sizes in gemma 3 family)
  1505. // number of patches for each **side** is reduced by a factor of 4
  1506. hparams.proj_scale_factor = 4;
  1507. // test model (tinygemma3) has a different value, we optionally read it
  1508. get_u32(KEY_PROJ_SCALE_FACTOR, hparams.proj_scale_factor, false);
  1509. } break;
  1510. case PROJECTOR_TYPE_QWEN25VL:
  1511. {
  1512. get_u32(KEY_WIN_ATTN_PATTERN, hparams.n_wa_pattern);
  1513. } break;
  1514. default:
  1515. break;
  1516. }
  1517. LOG_INF("%s: projector: %s\n", __func__, proj_type.c_str());
  1518. LOG_INF("%s: n_embd: %d\n", __func__, hparams.n_embd);
  1519. LOG_INF("%s: n_head: %d\n", __func__, hparams.n_head);
  1520. LOG_INF("%s: n_ff: %d\n", __func__, hparams.n_ff);
  1521. LOG_INF("%s: n_layer: %d\n", __func__, hparams.n_layer);
  1522. LOG_INF("%s: projection_dim: %d\n", __func__, hparams.projection_dim);
  1523. LOG_INF("%s: image_size: %d\n", __func__, hparams.image_size);
  1524. LOG_INF("%s: patch_size: %d\n", __func__, hparams.patch_size);
  1525. LOG_INF("\n");
  1526. LOG_INF("%s: has_llava_proj: %d\n", __func__, ctx_clip.has_llava_projector);
  1527. LOG_INF("%s: minicpmv_version: %d\n", __func__, ctx_clip.minicpmv_version);
  1528. LOG_INF("%s: proj_scale_factor: %d\n", __func__, hparams.proj_scale_factor);
  1529. LOG_INF("%s: n_wa_pattern: %d\n", __func__, hparams.n_wa_pattern);
  1530. LOG_INF("%s: ffn_op: %s\n", __func__, log_ffn_op.c_str());
  1531. LOG_INF("%s: model size: %.2f MiB\n", __func__, model_size / 1024.0 / 1024.0);
  1532. LOG_INF("%s: metadata size: %.2f MiB\n", __func__, ggml_get_mem_size(ctx_meta.get()) / 1024.0 / 1024.0);
  1533. }
  1534. }
  1535. void load_tensors() {
  1536. auto & hparams = ctx_clip.vision_model.hparams;
  1537. std::map<std::string, size_t> tensor_offset;
  1538. std::vector<ggml_tensor *> tensors_to_load;
  1539. // get offsets
  1540. for (int64_t i = 0; i < gguf_get_n_tensors(ctx_gguf.get()); ++i) {
  1541. const char * name = gguf_get_tensor_name(ctx_gguf.get(), i);
  1542. tensor_offset[name] = gguf_get_data_offset(ctx_gguf.get()) + gguf_get_tensor_offset(ctx_gguf.get(), i);
  1543. }
  1544. // create data context
  1545. struct ggml_init_params params = {
  1546. /*.mem_size =*/ (gguf_get_n_tensors(ctx_gguf.get()) + 1) * ggml_tensor_overhead(),
  1547. /*.mem_buffer =*/ NULL,
  1548. /*.no_alloc =*/ true,
  1549. };
  1550. ctx_clip.ctx_data.reset(ggml_init(params));
  1551. if (!ctx_clip.ctx_data) {
  1552. throw std::runtime_error(string_format("%s: failed to init ggml context\n", __func__));
  1553. }
  1554. // helper function
  1555. auto get_tensor = [&](const std::string & name, bool required = true) {
  1556. ggml_tensor * cur = ggml_get_tensor(ctx_meta.get(), name.c_str());
  1557. if (!cur && required) {
  1558. throw std::runtime_error(string_format("%s: unable to find tensor %s\n", __func__, name.c_str()));
  1559. }
  1560. if (cur) {
  1561. tensors_to_load.push_back(cur);
  1562. // add tensors to context
  1563. ggml_tensor * data_tensor = ggml_dup_tensor(ctx_clip.ctx_data.get(), cur);
  1564. ggml_set_name(data_tensor, cur->name);
  1565. cur = data_tensor;
  1566. }
  1567. return cur;
  1568. };
  1569. auto & vision_model = ctx_clip.vision_model;
  1570. vision_model.class_embedding = get_tensor(TN_CLASS_EMBD, false);
  1571. vision_model.pre_ln_w = get_tensor(string_format(TN_LN_PRE, "v", "weight"), false);
  1572. vision_model.pre_ln_b = get_tensor(string_format(TN_LN_PRE, "v", "bias"), false);
  1573. vision_model.post_ln_w = get_tensor(string_format(TN_LN_POST, "v", "weight"), false);
  1574. vision_model.post_ln_b = get_tensor(string_format(TN_LN_POST, "v", "bias"), false);
  1575. vision_model.patch_bias = get_tensor(TN_PATCH_BIAS, false);
  1576. vision_model.patch_embeddings_0 = get_tensor(TN_PATCH_EMBD, false);
  1577. vision_model.patch_embeddings_1 = get_tensor(TN_PATCH_EMBD_1, false);
  1578. vision_model.position_embeddings = get_tensor(string_format(TN_POS_EMBD, "v"), false);
  1579. // layers
  1580. vision_model.layers.resize(hparams.n_layer);
  1581. for (int il = 0; il < hparams.n_layer; ++il) {
  1582. auto & layer = vision_model.layers[il];
  1583. layer.k_w = get_tensor(string_format(TN_ATTN_K, "v", il, "weight"));
  1584. layer.q_w = get_tensor(string_format(TN_ATTN_Q, "v", il, "weight"));
  1585. layer.v_w = get_tensor(string_format(TN_ATTN_V, "v", il, "weight"));
  1586. layer.o_w = get_tensor(string_format(TN_ATTN_OUTPUT, "v", il, "weight"));
  1587. layer.ln_1_w = get_tensor(string_format(TN_LN_1, "v", il, "weight"), false);
  1588. layer.ln_2_w = get_tensor(string_format(TN_LN_2, "v", il, "weight"), false);
  1589. layer.k_b = get_tensor(string_format(TN_ATTN_K, "v", il, "bias"), false);
  1590. layer.q_b = get_tensor(string_format(TN_ATTN_Q, "v", il, "bias"), false);
  1591. layer.v_b = get_tensor(string_format(TN_ATTN_V, "v", il, "bias"), false);
  1592. layer.o_b = get_tensor(string_format(TN_ATTN_OUTPUT, "v", il, "bias"), false);
  1593. layer.ln_1_b = get_tensor(string_format(TN_LN_1, "v", il, "bias"), false);
  1594. layer.ln_2_b = get_tensor(string_format(TN_LN_2, "v", il, "bias"), false);
  1595. // new naming
  1596. layer.ff_up_w = get_tensor(string_format(TN_FFN_UP, "v", il, "weight"));
  1597. layer.ff_up_b = get_tensor(string_format(TN_FFN_UP, "v", il, "bias"), false);
  1598. layer.ff_gate_w = get_tensor(string_format(TN_FFN_GATE, "v", il, "weight"), false);
  1599. layer.ff_gate_b = get_tensor(string_format(TN_FFN_GATE, "v", il, "bias"), false);
  1600. layer.ff_down_w = get_tensor(string_format(TN_FFN_DOWN, "v", il, "weight"));
  1601. layer.ff_down_b = get_tensor(string_format(TN_FFN_DOWN, "v", il, "bias"), false);
  1602. // some models already exported with legacy (incorrect) naming which is quite messy, let's fix it here
  1603. // note: Qwen model converted from the old surgery script has n_ff = 0, so we cannot use n_ff to check!
  1604. if (layer.ff_up_w && layer.ff_down_w && layer.ff_down_w->ne[0] == hparams.n_embd) {
  1605. // swap up and down weights
  1606. ggml_tensor * tmp = layer.ff_up_w;
  1607. layer.ff_up_w = layer.ff_down_w;
  1608. layer.ff_down_w = tmp;
  1609. // swap up and down biases
  1610. tmp = layer.ff_up_b;
  1611. layer.ff_up_b = layer.ff_down_b;
  1612. layer.ff_down_b = tmp;
  1613. }
  1614. }
  1615. switch (ctx_clip.proj_type) {
  1616. case PROJECTOR_TYPE_MLP:
  1617. case PROJECTOR_TYPE_MLP_NORM:
  1618. {
  1619. // LLaVA projection
  1620. vision_model.mm_0_w = get_tensor(string_format(TN_LLAVA_PROJ, 0, "weight"), false);
  1621. vision_model.mm_0_b = get_tensor(string_format(TN_LLAVA_PROJ, 0, "bias"), false);
  1622. // Yi-type llava
  1623. vision_model.mm_1_w = get_tensor(string_format(TN_LLAVA_PROJ, 1, "weight"), false);
  1624. vision_model.mm_1_b = get_tensor(string_format(TN_LLAVA_PROJ, 1, "bias"), false);
  1625. // missing in Yi-type llava
  1626. vision_model.mm_2_w = get_tensor(string_format(TN_LLAVA_PROJ, 2, "weight"), false);
  1627. vision_model.mm_2_b = get_tensor(string_format(TN_LLAVA_PROJ, 2, "bias"), false);
  1628. // Yi-type llava
  1629. vision_model.mm_3_w = get_tensor(string_format(TN_LLAVA_PROJ, 3, "weight"), false);
  1630. vision_model.mm_3_b = get_tensor(string_format(TN_LLAVA_PROJ, 3, "bias"), false);
  1631. vision_model.mm_4_w = get_tensor(string_format(TN_LLAVA_PROJ, 4, "weight"), false);
  1632. vision_model.mm_4_b = get_tensor(string_format(TN_LLAVA_PROJ, 4, "bias"), false);
  1633. if (vision_model.mm_3_w) {
  1634. // TODO: this is a hack to support Yi-type llava
  1635. ctx_clip.proj_type = PROJECTOR_TYPE_MLP_NORM;
  1636. }
  1637. vision_model.image_newline = get_tensor(TN_IMAGE_NEWLINE, false);
  1638. } break;
  1639. case PROJECTOR_TYPE_LDP:
  1640. {
  1641. // MobileVLM projection
  1642. vision_model.mm_model_mlp_1_w = get_tensor(string_format(TN_MVLM_PROJ_MLP, 1, "weight"));
  1643. vision_model.mm_model_mlp_1_b = get_tensor(string_format(TN_MVLM_PROJ_MLP, 1, "bias"));
  1644. vision_model.mm_model_mlp_3_w = get_tensor(string_format(TN_MVLM_PROJ_MLP, 3, "weight"));
  1645. vision_model.mm_model_mlp_3_b = get_tensor(string_format(TN_MVLM_PROJ_MLP, 3, "bias"));
  1646. vision_model.mm_model_block_1_block_0_0_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 0, "0.weight"));
  1647. vision_model.mm_model_block_1_block_0_1_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 0, "1.weight"));
  1648. vision_model.mm_model_block_1_block_0_1_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 0, "1.bias"));
  1649. vision_model.mm_model_block_1_block_1_fc1_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc1.weight"));
  1650. vision_model.mm_model_block_1_block_1_fc1_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc1.bias"));
  1651. vision_model.mm_model_block_1_block_1_fc2_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc2.weight"));
  1652. vision_model.mm_model_block_1_block_1_fc2_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc2.bias"));
  1653. vision_model.mm_model_block_1_block_2_0_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 2, "0.weight"));
  1654. vision_model.mm_model_block_1_block_2_1_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 2, "1.weight"));
  1655. vision_model.mm_model_block_1_block_2_1_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 1, 2, "1.bias"));
  1656. vision_model.mm_model_block_2_block_0_0_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 0, "0.weight"));
  1657. vision_model.mm_model_block_2_block_0_1_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 0, "1.weight"));
  1658. vision_model.mm_model_block_2_block_0_1_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 0, "1.bias"));
  1659. vision_model.mm_model_block_2_block_1_fc1_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc1.weight"));
  1660. vision_model.mm_model_block_2_block_1_fc1_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc1.bias"));
  1661. vision_model.mm_model_block_2_block_1_fc2_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc2.weight"));
  1662. vision_model.mm_model_block_2_block_1_fc2_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc2.bias"));
  1663. vision_model.mm_model_block_2_block_2_0_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 2, "0.weight"));
  1664. vision_model.mm_model_block_2_block_2_1_w = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 2, "1.weight"));
  1665. vision_model.mm_model_block_2_block_2_1_b = get_tensor(string_format(TN_MVLM_PROJ_BLOCK, 2, 2, "1.bias"));
  1666. } break;
  1667. case PROJECTOR_TYPE_LDPV2:
  1668. {
  1669. // MobilVLM_V2 projection
  1670. vision_model.mm_model_mlp_0_w = get_tensor(string_format(TN_MVLM_PROJ_MLP, 0, "weight"));
  1671. vision_model.mm_model_mlp_0_b = get_tensor(string_format(TN_MVLM_PROJ_MLP, 0, "bias"));
  1672. vision_model.mm_model_mlp_2_w = get_tensor(string_format(TN_MVLM_PROJ_MLP, 2, "weight"));
  1673. vision_model.mm_model_mlp_2_b = get_tensor(string_format(TN_MVLM_PROJ_MLP, 2, "bias"));
  1674. vision_model.mm_model_peg_0_w = get_tensor(string_format(TN_MVLM_PROJ_PEG, 0, "weight"));
  1675. vision_model.mm_model_peg_0_b = get_tensor(string_format(TN_MVLM_PROJ_PEG, 0, "bias"));
  1676. } break;
  1677. case PROJECTOR_TYPE_MINICPMV:
  1678. {
  1679. // vision_model.mm_model_pos_embed = get_tensor(new_clip->ctx_data, TN_MINICPMV_POS_EMBD);
  1680. vision_model.mm_model_pos_embed_k = get_tensor(TN_MINICPMV_POS_EMBD_K);
  1681. vision_model.mm_model_query = get_tensor(TN_MINICPMV_QUERY);
  1682. vision_model.mm_model_proj = get_tensor(TN_MINICPMV_PROJ);
  1683. vision_model.mm_model_kv_proj = get_tensor(TN_MINICPMV_KV_PROJ);
  1684. vision_model.mm_model_attn_q_w = get_tensor(string_format(TN_MINICPMV_ATTN, "q", "weight"));
  1685. vision_model.mm_model_attn_k_w = get_tensor(string_format(TN_MINICPMV_ATTN, "k", "weight"));
  1686. vision_model.mm_model_attn_v_w = get_tensor(string_format(TN_MINICPMV_ATTN, "v", "weight"));
  1687. vision_model.mm_model_attn_q_b = get_tensor(string_format(TN_MINICPMV_ATTN, "q", "bias"));
  1688. vision_model.mm_model_attn_k_b = get_tensor(string_format(TN_MINICPMV_ATTN, "k", "bias"));
  1689. vision_model.mm_model_attn_v_b = get_tensor(string_format(TN_MINICPMV_ATTN, "v", "bias"));
  1690. vision_model.mm_model_attn_o_w = get_tensor(string_format(TN_MINICPMV_ATTN, "out", "weight"));
  1691. vision_model.mm_model_attn_o_b = get_tensor(string_format(TN_MINICPMV_ATTN, "out", "bias"));
  1692. vision_model.mm_model_ln_q_w = get_tensor(string_format(TN_MINICPMV_LN, "q", "weight"));
  1693. vision_model.mm_model_ln_q_b = get_tensor(string_format(TN_MINICPMV_LN, "q", "bias"));
  1694. vision_model.mm_model_ln_kv_w = get_tensor(string_format(TN_MINICPMV_LN, "kv", "weight"));
  1695. vision_model.mm_model_ln_kv_b = get_tensor(string_format(TN_MINICPMV_LN, "kv", "bias"));
  1696. vision_model.mm_model_ln_post_w = get_tensor(string_format(TN_MINICPMV_LN, "post", "weight"));
  1697. vision_model.mm_model_ln_post_b = get_tensor(string_format(TN_MINICPMV_LN, "post", "bias"));
  1698. } break;
  1699. case PROJECTOR_TYPE_GLM_EDGE:
  1700. {
  1701. vision_model.mm_model_adapter_conv_w = get_tensor(string_format(TN_GLM_ADAPER_CONV, "weight"));
  1702. vision_model.mm_model_adapter_conv_b = get_tensor(string_format(TN_GLM_ADAPER_CONV, "bias"));
  1703. vision_model.mm_model_mlp_0_w = get_tensor(string_format(TN_GLM_ADAPTER_LINEAR, "weight"));
  1704. vision_model.mm_model_ln_q_w = get_tensor(string_format(TN_GLM_ADAPTER_NORM_1, "weight"));
  1705. vision_model.mm_model_ln_q_b = get_tensor(string_format(TN_GLM_ADAPTER_NORM_1, "bias"));
  1706. vision_model.mm_model_mlp_1_w = get_tensor(string_format(TN_GLM_ADAPTER_D_H_2_4H, "weight"));
  1707. vision_model.mm_model_mlp_2_w = get_tensor(string_format(TN_GLM_ADAPTER_GATE, "weight"));
  1708. vision_model.mm_model_mlp_3_w = get_tensor(string_format(TN_GLM_ADAPTER_D_4H_2_H, "weight"));
  1709. vision_model.mm_glm_tok_boi = get_tensor(string_format(TN_TOK_GLM_BOI, "weight"));
  1710. vision_model.mm_glm_tok_eoi = get_tensor(string_format(TN_TOK_GLM_EOI, "weight"));
  1711. } break;
  1712. case PROJECTOR_TYPE_QWEN2VL:
  1713. case PROJECTOR_TYPE_QWEN25VL:
  1714. {
  1715. vision_model.mm_0_w = get_tensor(string_format(TN_LLAVA_PROJ, 0, "weight"));
  1716. vision_model.mm_0_b = get_tensor(string_format(TN_LLAVA_PROJ, 0, "bias"));
  1717. vision_model.mm_1_w = get_tensor(string_format(TN_LLAVA_PROJ, 2, "weight"));
  1718. vision_model.mm_1_b = get_tensor(string_format(TN_LLAVA_PROJ, 2, "bias"));
  1719. } break;
  1720. case PROJECTOR_TYPE_GEMMA3:
  1721. {
  1722. vision_model.mm_input_proj_w = get_tensor(TN_MM_INP_PROJ);
  1723. vision_model.mm_soft_emb_norm_w = get_tensor(TN_MM_SOFT_EMB_N);
  1724. } break;
  1725. case PROJECTOR_TYPE_IDEFICS3:
  1726. {
  1727. vision_model.projection = get_tensor(TN_MM_PROJECTOR);
  1728. } break;
  1729. case PROJECTOR_TYPE_PIXTRAL:
  1730. {
  1731. vision_model.mm_1_w = get_tensor(string_format(TN_LLAVA_PROJ, 1, "weight"));
  1732. vision_model.mm_1_b = get_tensor(string_format(TN_LLAVA_PROJ, 1, "bias"), false);
  1733. vision_model.mm_2_w = get_tensor(string_format(TN_LLAVA_PROJ, 2, "weight"));
  1734. vision_model.mm_2_b = get_tensor(string_format(TN_LLAVA_PROJ, 2, "bias"), false);
  1735. // [IMG_BREAK] token embedding
  1736. vision_model.token_embd_img_break = get_tensor(TN_TOK_IMG_BREAK);
  1737. // for mistral small 3.1
  1738. vision_model.mm_input_norm_w = get_tensor(TN_MM_INP_NORM, false);
  1739. vision_model.mm_patch_merger_w = get_tensor(TN_MM_PATCH_MERGER, false);
  1740. } break;
  1741. default:
  1742. GGML_ASSERT(false && "unknown projector type");
  1743. }
  1744. // load data
  1745. {
  1746. std::vector<uint8_t> read_buf;
  1747. auto fin = std::ifstream(fname, std::ios::binary);
  1748. if (!fin) {
  1749. throw std::runtime_error(string_format("%s: failed to open %s\n", __func__, fname.c_str()));
  1750. }
  1751. // alloc memory and offload data
  1752. ggml_backend_buffer_type_t buft = ggml_backend_get_default_buffer_type(ctx_clip.backend);
  1753. ctx_clip.buf.reset(ggml_backend_alloc_ctx_tensors_from_buft(ctx_clip.ctx_data.get(), buft));
  1754. ggml_backend_buffer_set_usage(ctx_clip.buf.get(), GGML_BACKEND_BUFFER_USAGE_WEIGHTS);
  1755. for (auto & t : tensors_to_load) {
  1756. ggml_tensor * cur = ggml_get_tensor(ctx_clip.ctx_data.get(), t->name);
  1757. const size_t offset = tensor_offset[t->name];
  1758. fin.seekg(offset, std::ios::beg);
  1759. if (!fin) {
  1760. throw std::runtime_error(string_format("%s: failed to seek for tensor %s\n", __func__, t->name));
  1761. }
  1762. size_t num_bytes = ggml_nbytes(cur);
  1763. if (ggml_backend_buft_is_host(buft)) {
  1764. // for the CPU and Metal backend, we can read directly into the tensor
  1765. fin.read(reinterpret_cast<char *>(cur->data), num_bytes);
  1766. } else {
  1767. // read into a temporary buffer first, then copy to device memory
  1768. read_buf.resize(num_bytes);
  1769. fin.read(reinterpret_cast<char *>(read_buf.data()), num_bytes);
  1770. ggml_backend_tensor_set(cur, read_buf.data(), 0, num_bytes);
  1771. }
  1772. }
  1773. fin.close();
  1774. LOG_DBG("%s: loaded %zu tensors from %s\n", __func__, tensors_to_load.size(), fname.c_str());
  1775. }
  1776. }
  1777. void alloc_compute_meta() {
  1778. ctx_clip.buf_compute_meta.resize(ctx_clip.max_nodes * ggml_tensor_overhead() + ggml_graph_overhead());
  1779. // create a fake batch
  1780. clip_image_f32_batch batch;
  1781. clip_image_f32_ptr img(clip_image_f32_init());
  1782. img->nx = ctx_clip.vision_model.hparams.image_size;
  1783. img->ny = ctx_clip.vision_model.hparams.image_size;
  1784. img->buf.resize(img->nx * img->ny * 3);
  1785. batch.entries.push_back(std::move(img));
  1786. ggml_cgraph * gf = clip_image_build_graph(&ctx_clip, batch);
  1787. ggml_backend_sched_reserve(ctx_clip.sched.get(), gf);
  1788. for (size_t i = 0; i < ctx_clip.backend_ptrs.size(); ++i) {
  1789. ggml_backend_t backend = ctx_clip.backend_ptrs[i];
  1790. ggml_backend_buffer_type_t buft = ctx_clip.backend_buft[i];
  1791. size_t size = ggml_backend_sched_get_buffer_size(ctx_clip.sched.get(), backend);
  1792. if (size > 1) {
  1793. LOG_INF("%s: %10s compute buffer size = %8.2f MiB\n", __func__,
  1794. ggml_backend_buft_name(buft),
  1795. size / 1024.0 / 1024.0);
  1796. }
  1797. }
  1798. }
  1799. void get_bool(const std::string & key, bool & output, bool required = true) {
  1800. const int i = gguf_find_key(ctx_gguf.get(), key.c_str());
  1801. if (i < 0) {
  1802. if (required) throw std::runtime_error("Key not found: " + key);
  1803. return;
  1804. }
  1805. output = gguf_get_val_bool(ctx_gguf.get(), i);
  1806. }
  1807. void get_i32(const std::string & key, int & output, bool required = true) {
  1808. const int i = gguf_find_key(ctx_gguf.get(), key.c_str());
  1809. if (i < 0) {
  1810. if (required) throw std::runtime_error("Key not found: " + key);
  1811. return;
  1812. }
  1813. output = gguf_get_val_i32(ctx_gguf.get(), i);
  1814. }
  1815. void get_u32(const std::string & key, int & output, bool required = true) {
  1816. const int i = gguf_find_key(ctx_gguf.get(), key.c_str());
  1817. if (i < 0) {
  1818. if (required) throw std::runtime_error("Key not found: " + key);
  1819. return;
  1820. }
  1821. output = gguf_get_val_u32(ctx_gguf.get(), i);
  1822. }
  1823. void get_f32(const std::string & key, float & output, bool required = true) {
  1824. const int i = gguf_find_key(ctx_gguf.get(), key.c_str());
  1825. if (i < 0) {
  1826. if (required) throw std::runtime_error("Key not found: " + key);
  1827. return;
  1828. }
  1829. output = gguf_get_val_f32(ctx_gguf.get(), i);
  1830. }
  1831. void get_string(const std::string & key, std::string & output, bool required = true) {
  1832. const int i = gguf_find_key(ctx_gguf.get(), key.c_str());
  1833. if (i < 0) {
  1834. if (required) throw std::runtime_error("Key not found: " + key);
  1835. return;
  1836. }
  1837. output = std::string(gguf_get_val_str(ctx_gguf.get(), i));
  1838. }
  1839. void get_arr_int(const std::string & key, std::vector<int> & output, bool required = true) {
  1840. const int i = gguf_find_key(ctx_gguf.get(), key.c_str());
  1841. if (i < 0) {
  1842. if (required) throw std::runtime_error("Key not found: " + key);
  1843. return;
  1844. }
  1845. int n = gguf_get_arr_n(ctx_gguf.get(), i);
  1846. output.resize(n);
  1847. const int32_t * values = (const int32_t *)gguf_get_arr_data(ctx_gguf.get(), i);
  1848. for (int i = 0; i < n; ++i) {
  1849. output[i] = values[i];
  1850. }
  1851. }
  1852. };
  1853. // read and create ggml_context containing the tensors and their data
  1854. struct clip_ctx * clip_model_load(const char * fname, const int verbosity) {
  1855. return clip_init(fname, clip_context_params{
  1856. /* use_gpu */ true,
  1857. /* verbosity */ static_cast<ggml_log_level>(verbosity),
  1858. });
  1859. }
  1860. struct clip_ctx * clip_init(const char * fname, struct clip_context_params ctx_params) {
  1861. g_logger_state.verbosity_thold = ctx_params.verbosity;
  1862. clip_ctx * ctx_clip = nullptr;
  1863. try {
  1864. ctx_clip = new clip_ctx(ctx_params);
  1865. clip_model_loader loader(fname, *ctx_clip);
  1866. loader.load_hparams();
  1867. loader.load_tensors();
  1868. loader.alloc_compute_meta();
  1869. } catch (const std::exception & e) {
  1870. LOG_ERR("%s: failed to load model '%s': %s\n", __func__, fname, e.what());
  1871. delete ctx_clip;
  1872. return nullptr;
  1873. }
  1874. return ctx_clip;
  1875. }
  1876. void clip_add_load_image_size(struct clip_ctx * ctx_clip, struct clip_image_size * load_image_size) {
  1877. ctx_clip->load_image_size = *load_image_size; // copy
  1878. }
  1879. struct clip_image_size * clip_get_load_image_size(struct clip_ctx * ctx_clip) {
  1880. return &ctx_clip->load_image_size;
  1881. }
  1882. struct clip_image_size * clip_image_size_init() {
  1883. struct clip_image_size * load_image_size = new struct clip_image_size();
  1884. load_image_size->width = 448;
  1885. load_image_size->height = 448;
  1886. return load_image_size;
  1887. }
  1888. struct clip_image_u8 * clip_image_u8_init() {
  1889. return new clip_image_u8();
  1890. }
  1891. struct clip_image_f32 * clip_image_f32_init() {
  1892. return new clip_image_f32();
  1893. }
  1894. struct clip_image_f32_batch * clip_image_f32_batch_init() {
  1895. return new clip_image_f32_batch();
  1896. }
  1897. unsigned char * clip_image_u8_get_data(struct clip_image_u8 * img, uint32_t * nx, uint32_t * ny) {
  1898. if (nx) *nx = img->nx;
  1899. if (ny) *ny = img->ny;
  1900. return img->buf.data();
  1901. }
  1902. void clip_image_size_free(struct clip_image_size * load_image_size) {
  1903. if (load_image_size == nullptr) {
  1904. return;
  1905. }
  1906. delete load_image_size;
  1907. }
  1908. void clip_image_u8_free(struct clip_image_u8 * img) { if (img) delete img; }
  1909. void clip_image_f32_free(struct clip_image_f32 * img) { if (img) delete img; }
  1910. void clip_image_u8_batch_free(struct clip_image_u8_batch * batch) { if (batch) delete batch; }
  1911. void clip_image_f32_batch_free(struct clip_image_f32_batch * batch) { if (batch) delete batch; }
  1912. size_t clip_image_f32_batch_n_images(const struct clip_image_f32_batch * batch) {
  1913. return batch->entries.size();
  1914. }
  1915. size_t clip_image_f32_batch_nx(const struct clip_image_f32_batch * batch, int idx) {
  1916. if (idx < 0 || idx >= (int)batch->entries.size()) {
  1917. LOG_ERR("%s: invalid index %d\n", __func__, idx);
  1918. return 0;
  1919. }
  1920. return batch->entries[idx]->nx;
  1921. }
  1922. size_t clip_image_f32_batch_ny(const struct clip_image_f32_batch * batch, int idx) {
  1923. if (idx < 0 || idx >= (int)batch->entries.size()) {
  1924. LOG_ERR("%s: invalid index %d\n", __func__, idx);
  1925. return 0;
  1926. }
  1927. return batch->entries[idx]->ny;
  1928. }
  1929. clip_image_f32 * clip_image_f32_get_img(const struct clip_image_f32_batch * batch, int idx) {
  1930. if (idx < 0 || idx >= (int)batch->entries.size()) {
  1931. LOG_ERR("%s: invalid index %d\n", __func__, idx);
  1932. return nullptr;
  1933. }
  1934. return batch->entries[idx].get();
  1935. }
  1936. void clip_build_img_from_pixels(const unsigned char * rgb_pixels, int nx, int ny, clip_image_u8 * img) {
  1937. img->nx = nx;
  1938. img->ny = ny;
  1939. img->buf.resize(3 * nx * ny);
  1940. memcpy(img->buf.data(), rgb_pixels, img->buf.size());
  1941. }
  1942. bool clip_image_load_from_file(const char * fname, clip_image_u8 * img) {
  1943. int nx, ny, nc;
  1944. auto * data = stbi_load(fname, &nx, &ny, &nc, 3);
  1945. if (!data) {
  1946. LOG_ERR("%s: failed to load image '%s'\n", __func__, fname);
  1947. return false;
  1948. }
  1949. clip_build_img_from_pixels(data, nx, ny, img);
  1950. stbi_image_free(data);
  1951. return true;
  1952. }
  1953. bool clip_image_load_from_bytes(const unsigned char * bytes, size_t bytes_length, struct clip_image_u8 * img) {
  1954. int nx, ny, nc;
  1955. auto * data = stbi_load_from_memory(bytes, bytes_length, &nx, &ny, &nc, 3);
  1956. if (!data) {
  1957. LOG_ERR("%s: failed to decode image bytes\n", __func__);
  1958. return false;
  1959. }
  1960. clip_build_img_from_pixels(data, nx, ny, img);
  1961. stbi_image_free(data);
  1962. return true;
  1963. }
  1964. // Normalize image to float32 - careful with pytorch .to(model.device, dtype=torch.float16) - this sometimes reduces precision (32>16>32), sometimes not
  1965. static void normalize_image_u8_to_f32(const clip_image_u8 & src, clip_image_f32 & dst, const float mean[3], const float std[3]) {
  1966. dst.nx = src.nx;
  1967. dst.ny = src.ny;
  1968. dst.buf.resize(src.buf.size());
  1969. // TODO @ngxson : seems like this could be done more efficiently on cgraph
  1970. for (size_t i = 0; i < src.buf.size(); ++i) {
  1971. int c = i % 3; // rgb
  1972. dst.buf[i] = (static_cast<float>(src.buf[i]) / 255.0f - mean[c]) / std[c];
  1973. }
  1974. }
  1975. // set of tools to manupulate images
  1976. // in the future, we can have HW acceleration by allowing this struct to access 3rd party lib like imagick or opencv
  1977. struct image_manipulation {
  1978. // Bilinear resize function
  1979. static void bilinear_resize(const clip_image_u8& src, clip_image_u8& dst, int target_width, int target_height) {
  1980. dst.nx = target_width;
  1981. dst.ny = target_height;
  1982. dst.buf.resize(3 * target_width * target_height);
  1983. float x_ratio = static_cast<float>(src.nx - 1) / target_width;
  1984. float y_ratio = static_cast<float>(src.ny - 1) / target_height;
  1985. for (int y = 0; y < target_height; y++) {
  1986. for (int x = 0; x < target_width; x++) {
  1987. float px = x_ratio * x;
  1988. float py = y_ratio * y;
  1989. int x_floor = static_cast<int>(px);
  1990. int y_floor = static_cast<int>(py);
  1991. float x_lerp = px - x_floor;
  1992. float y_lerp = py - y_floor;
  1993. for (int c = 0; c < 3; c++) {
  1994. float top = lerp(
  1995. static_cast<float>(src.buf[3 * (y_floor * src.nx + x_floor) + c]),
  1996. static_cast<float>(src.buf[3 * (y_floor * src.nx + (x_floor + 1)) + c]),
  1997. x_lerp
  1998. );
  1999. float bottom = lerp(
  2000. static_cast<float>(src.buf[3 * ((y_floor + 1) * src.nx + x_floor) + c]),
  2001. static_cast<float>(src.buf[3 * ((y_floor + 1) * src.nx + (x_floor + 1)) + c]),
  2002. x_lerp
  2003. );
  2004. dst.buf[3 * (y * target_width + x) + c] = static_cast<uint8_t>(lerp(top, bottom, y_lerp));
  2005. }
  2006. }
  2007. }
  2008. }
  2009. // Bicubic resize function
  2010. // part of image will be cropped if the aspect ratio is different
  2011. static bool bicubic_resize(const clip_image_u8 & img, clip_image_u8 & dst, int target_width, int target_height) {
  2012. const int nx = img.nx;
  2013. const int ny = img.ny;
  2014. dst.nx = target_width;
  2015. dst.ny = target_height;
  2016. dst.buf.resize(3 * target_width * target_height);
  2017. float Cc;
  2018. float C[5];
  2019. float d0, d2, d3, a0, a1, a2, a3;
  2020. int i, j, k, jj;
  2021. int x, y;
  2022. float dx, dy;
  2023. float tx, ty;
  2024. tx = (float)nx / (float)target_width;
  2025. ty = (float)ny / (float)target_height;
  2026. // Bicubic interpolation; adapted from ViT.cpp, inspired from :
  2027. // -> https://github.com/yglukhov/bicubic-interpolation-image-processing/blob/master/libimage.c#L36
  2028. // -> https://en.wikipedia.org/wiki/Bicubic_interpolation
  2029. for (i = 0; i < target_height; i++) {
  2030. for (j = 0; j < target_width; j++) {
  2031. x = (int)(tx * j);
  2032. y = (int)(ty * i);
  2033. dx = tx * j - x;
  2034. dy = ty * i - y;
  2035. for (k = 0; k < 3; k++) {
  2036. for (jj = 0; jj <= 3; jj++) {
  2037. d0 = img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x - 1, 0, nx - 1)) * 3 + k] - img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x, 0, nx - 1)) * 3 + k];
  2038. d2 = img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x + 1, 0, nx - 1)) * 3 + k] - img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x, 0, nx - 1)) * 3 + k];
  2039. d3 = img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x + 2, 0, nx - 1)) * 3 + k] - img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x, 0, nx - 1)) * 3 + k];
  2040. a0 = img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x, 0, nx - 1)) * 3 + k];
  2041. a1 = -1.0 / 3 * d0 + d2 - 1.0 / 6 * d3;
  2042. a2 = 1.0 / 2 * d0 + 1.0 / 2 * d2;
  2043. a3 = -1.0 / 6 * d0 - 1.0 / 2 * d2 + 1.0 / 6 * d3;
  2044. C[jj] = a0 + a1 * dx + a2 * dx * dx + a3 * dx * dx * dx;
  2045. d0 = C[0] - C[1];
  2046. d2 = C[2] - C[1];
  2047. d3 = C[3] - C[1];
  2048. a0 = C[1];
  2049. a1 = -1.0 / 3 * d0 + d2 - 1.0 / 6 * d3;
  2050. a2 = 1.0 / 2 * d0 + 1.0 / 2 * d2;
  2051. a3 = -1.0 / 6 * d0 - 1.0 / 2 * d2 + 1.0 / 6 * d3;
  2052. Cc = a0 + a1 * dy + a2 * dy * dy + a3 * dy * dy * dy;
  2053. const uint8_t Cc2 = std::min(std::max(std::round(Cc), 0.0f), 255.0f);
  2054. dst.buf[(i * target_width + j) * 3 + k] = float(Cc2);
  2055. }
  2056. }
  2057. }
  2058. }
  2059. return true;
  2060. }
  2061. // llava-1.6 type of resize_and_pad
  2062. // if the ratio is not 1:1, padding with pad_color will be applied
  2063. // pad_color is single channel, default is 0 (black)
  2064. static void resize_and_pad_image(const clip_image_u8 & image, clip_image_u8 & dst, const clip_image_size & target_resolution, std::array<uint8_t, 3> pad_color = {0, 0, 0}) {
  2065. int target_width = target_resolution.width;
  2066. int target_height = target_resolution.height;
  2067. float scale_w = static_cast<float>(target_width) / image.nx;
  2068. float scale_h = static_cast<float>(target_height) / image.ny;
  2069. int new_width, new_height;
  2070. if (scale_w < scale_h) {
  2071. new_width = target_width;
  2072. new_height = std::min(static_cast<int>(std::ceil(image.ny * scale_w)), target_height);
  2073. } else {
  2074. new_height = target_height;
  2075. new_width = std::min(static_cast<int>(std::ceil(image.nx * scale_h)), target_width);
  2076. }
  2077. clip_image_u8 resized_image;
  2078. bicubic_resize(image, resized_image, new_width, new_height);
  2079. clip_image_u8 padded_image;
  2080. padded_image.nx = target_width;
  2081. padded_image.ny = target_height;
  2082. padded_image.buf.resize(3 * target_width * target_height);
  2083. // Fill the padded image with the fill color
  2084. for (size_t i = 0; i < padded_image.buf.size(); i += 3) {
  2085. padded_image.buf[i] = pad_color[0];
  2086. padded_image.buf[i + 1] = pad_color[1];
  2087. padded_image.buf[i + 2] = pad_color[2];
  2088. }
  2089. // Calculate padding offsets
  2090. int pad_x = (target_width - new_width) / 2;
  2091. int pad_y = (target_height - new_height) / 2;
  2092. // Copy the resized image into the center of the padded buffer
  2093. for (int y = 0; y < new_height; ++y) {
  2094. for (int x = 0; x < new_width; ++x) {
  2095. for (int c = 0; c < 3; ++c) {
  2096. padded_image.buf[3 * ((y + pad_y) * target_width + (x + pad_x)) + c] = resized_image.buf[3 * (y * new_width + x) + c];
  2097. }
  2098. }
  2099. }
  2100. dst = std::move(padded_image);
  2101. }
  2102. static void crop_image(const clip_image_u8 & image, clip_image_u8 & dst, int x, int y, int w, int h) {
  2103. dst.nx = w;
  2104. dst.ny = h;
  2105. dst.buf.resize(3 * w * h);
  2106. for (int i = 0; i < h; ++i) {
  2107. for (int j = 0; j < w; ++j) {
  2108. int src_idx = 3 * ((y + i)*image.nx + (x + j));
  2109. int dst_idx = 3 * (i*w + j);
  2110. dst.buf[dst_idx] = image.buf[src_idx];
  2111. dst.buf[dst_idx + 1] = image.buf[src_idx + 1];
  2112. dst.buf[dst_idx + 2] = image.buf[src_idx + 2];
  2113. }
  2114. }
  2115. }
  2116. // calculate the size of the **resized** image, while preserving the aspect ratio
  2117. // the calculated size will be aligned to the nearest multiple of align_size
  2118. // if H or W size is larger than max_dimension, it will be resized to max_dimension
  2119. static clip_image_size calc_size_preserved_ratio(const clip_image_size & inp_size, const int align_size, const int max_dimension) {
  2120. if (inp_size.width <= 0 || inp_size.height <= 0 || align_size <= 0 || max_dimension <= 0) {
  2121. return {0, 0};
  2122. }
  2123. float scale = std::min(1.0f, std::min(static_cast<float>(max_dimension) / inp_size.width,
  2124. static_cast<float>(max_dimension) / inp_size.height));
  2125. float target_width_f = static_cast<float>(inp_size.width) * scale;
  2126. float target_height_f = static_cast<float>(inp_size.height) * scale;
  2127. int aligned_width = GGML_PAD((int)target_width_f, align_size);
  2128. int aligned_height = GGML_PAD((int)target_height_f, align_size);
  2129. return {aligned_width, aligned_height};
  2130. }
  2131. private:
  2132. static inline int clip(int x, int lower, int upper) {
  2133. return std::max(lower, std::min(x, upper));
  2134. }
  2135. // Linear interpolation between two points
  2136. static inline float lerp(float s, float e, float t) {
  2137. return s + (e - s) * t;
  2138. }
  2139. };
  2140. /**
  2141. * implementation of LLaVA-UHD:
  2142. * - https://arxiv.org/pdf/2403.11703
  2143. * - https://github.com/thunlp/LLaVA-UHD
  2144. * - https://github.com/thunlp/LLaVA-UHD/blob/302301bc2175f7e717fb8548516188e89f649753/llava_uhd/train/llava-uhd/slice_logic.py#L118
  2145. *
  2146. * overview:
  2147. * - an image always have a single overview (downscaled image)
  2148. * - an image can have 0 or multiple slices, depending on the image size
  2149. * - each slice can then be considered as a separate image
  2150. *
  2151. * for example:
  2152. *
  2153. * [overview] --> [slice 1] --> [slice 2]
  2154. * | |
  2155. * +--> [slice 3] --> [slice 4]
  2156. */
  2157. struct llava_uhd {
  2158. struct slice_coordinates {
  2159. int x;
  2160. int y;
  2161. clip_image_size size;
  2162. };
  2163. struct slice_instructions {
  2164. clip_image_size overview_size; // size of downscaled image
  2165. clip_image_size refined_size; // size of image right before slicing (must be multiple of slice size)
  2166. clip_image_size grid_size; // grid_size.width * grid_size.height = number of slices
  2167. std::vector<slice_coordinates> slices;
  2168. bool padding_refined = false; // if true, refine image will be padded to the grid size (e.g. llava-1.6)
  2169. };
  2170. static int get_max_slices(struct clip_ctx * ctx) {
  2171. if (clip_is_minicpmv(ctx)) {
  2172. return 9;
  2173. }
  2174. return 0;
  2175. }
  2176. static slice_instructions get_slice_instructions(struct clip_ctx * ctx, const clip_image_size & original_size) {
  2177. slice_instructions res;
  2178. const int patch_size = clip_get_patch_size(ctx);
  2179. const int slice_size = clip_get_image_size(ctx);
  2180. const int max_slice_nums = get_max_slices(ctx);
  2181. const int original_width = original_size.width;
  2182. const int original_height = original_size.height;
  2183. const float log_ratio = log((float)original_width / original_height);
  2184. const float ratio = (float)original_width * original_height / (slice_size * slice_size);
  2185. const int multiple = fmin(ceil(ratio), max_slice_nums);
  2186. const bool has_slices = (multiple > 1);
  2187. const bool has_pinpoints = !ctx->vision_model.hparams.image_grid_pinpoints.empty();
  2188. if (has_pinpoints) {
  2189. // has pinpoints, use them to calculate the grid size (e.g. llava-1.6)
  2190. auto refine_size = llava_uhd::select_best_resolution(
  2191. ctx->vision_model.hparams.image_grid_pinpoints,
  2192. original_size);
  2193. res.overview_size = clip_image_size{slice_size, slice_size};
  2194. res.refined_size = refine_size;
  2195. res.grid_size = clip_image_size{0, 0};
  2196. res.padding_refined = true;
  2197. for (int y = 0; y < refine_size.height; y += slice_size) {
  2198. for (int x = 0; x < refine_size.width; x += slice_size) {
  2199. slice_coordinates slice;
  2200. slice.x = x;
  2201. slice.y = y;
  2202. slice.size.width = std::min(slice_size, refine_size.width - x);
  2203. slice.size.height = std::min(slice_size, refine_size.height - y);
  2204. res.slices.push_back(slice);
  2205. if (x == 0) {
  2206. res.grid_size.width++;
  2207. }
  2208. }
  2209. res.grid_size.height++;
  2210. }
  2211. return res;
  2212. }
  2213. // no pinpoints, dynamically calculate the grid size (e.g. minicpmv)
  2214. auto best_size = get_best_resize(original_size, slice_size, patch_size, !has_slices);
  2215. res.overview_size = best_size;
  2216. if (!has_slices) {
  2217. // skip slicing logic
  2218. res.refined_size = clip_image_size{0, 0};
  2219. res.grid_size = clip_image_size{0, 0};
  2220. } else {
  2221. auto best_grid = get_best_grid(max_slice_nums, multiple, log_ratio);
  2222. auto refine_size = get_refine_size(original_size, best_grid, slice_size, patch_size, true);
  2223. res.grid_size = best_grid;
  2224. res.refined_size = refine_size;
  2225. int width = refine_size.width;
  2226. int height = refine_size.height;
  2227. int grid_x = int(width / best_grid.width);
  2228. int grid_y = int(height / best_grid.height);
  2229. for (int patches_y = 0, ic = 0;
  2230. patches_y < refine_size.height && ic < best_grid.height;
  2231. patches_y += grid_y, ic += 1) {
  2232. for (int patches_x = 0, jc = 0;
  2233. patches_x < refine_size.width && jc < best_grid.width;
  2234. patches_x += grid_x, jc += 1) {
  2235. slice_coordinates slice;
  2236. slice.x = patches_x;
  2237. slice.y = patches_y;
  2238. slice.size.width = grid_x;
  2239. slice.size.height = grid_y;
  2240. res.slices.push_back(slice);
  2241. // LOG_INF("slice %d: %d %d %d %d\n", ic, patches_i, patches_j, grid_x, grid_y);
  2242. }
  2243. }
  2244. }
  2245. return res;
  2246. }
  2247. static std::vector<clip_image_u8_ptr> slice_image(const clip_image_u8 * img, const slice_instructions & inst) {
  2248. std::vector<clip_image_u8_ptr> output;
  2249. // resize to overview size
  2250. clip_image_u8_ptr resized_img(clip_image_u8_init());
  2251. image_manipulation::bicubic_resize(*img, *resized_img, inst.overview_size.width, inst.overview_size.height);
  2252. output.push_back(std::move(resized_img));
  2253. if (inst.slices.empty()) {
  2254. // no slices, just return the resized image
  2255. return output;
  2256. }
  2257. // resize to refined size
  2258. clip_image_u8_ptr refined_img(clip_image_u8_init());
  2259. if (inst.padding_refined) {
  2260. image_manipulation::resize_and_pad_image(*img, *refined_img, inst.refined_size);
  2261. } else {
  2262. image_manipulation::bilinear_resize(*img, *refined_img, inst.refined_size.width, inst.refined_size.height);
  2263. }
  2264. // create slices
  2265. for (const auto & slice : inst.slices) {
  2266. int x = slice.x;
  2267. int y = slice.y;
  2268. int w = slice.size.width;
  2269. int h = slice.size.height;
  2270. clip_image_u8_ptr img_slice(clip_image_u8_init());
  2271. image_manipulation::crop_image(*refined_img, *img_slice, x, y, w, h);
  2272. output.push_back(std::move(img_slice));
  2273. }
  2274. return output;
  2275. }
  2276. private:
  2277. static clip_image_size get_best_resize(const clip_image_size & original_size, int scale_resolution, int patch_size, bool allow_upscale = false) {
  2278. int width = original_size.width;
  2279. int height = original_size.height;
  2280. if ((width * height > scale_resolution * scale_resolution) || allow_upscale) {
  2281. float r = static_cast<float>(width) / height;
  2282. height = static_cast<int>(scale_resolution / std::sqrt(r));
  2283. width = static_cast<int>(height * r);
  2284. }
  2285. clip_image_size res;
  2286. res.width = ensure_divide(width, patch_size);
  2287. res.height = ensure_divide(height, patch_size);
  2288. return res;
  2289. }
  2290. /**
  2291. * Selects the best resolution from a list of possible resolutions based on the original size.
  2292. *
  2293. * @param original_size The original size of the image
  2294. * @param possible_resolutions A list of possible resolutions
  2295. * @return The best fit resolution
  2296. */
  2297. static clip_image_size select_best_resolution(const clip_image_size & original_size, const std::vector<clip_image_size> & possible_resolutions) {
  2298. int original_width = original_size.width;
  2299. int original_height = original_size.height;
  2300. clip_image_size best_fit;
  2301. int max_effective_resolution = 0;
  2302. int min_wasted_resolution = std::numeric_limits<int>::max();
  2303. for (const auto & resolution : possible_resolutions) {
  2304. int width = resolution.width;
  2305. int height = resolution.height;
  2306. float scale = std::min(static_cast<float>(width) / original_width, static_cast<float>(height) / original_height);
  2307. int downscaled_width = static_cast<int>(original_width * scale);
  2308. int downscaled_height = static_cast<int>(original_height * scale);
  2309. int effective_resolution = std::min(downscaled_width * downscaled_height, original_width * original_height);
  2310. int wasted_resolution = (width * height) - effective_resolution;
  2311. // LOG_INF("resolution: %d %d, scale: %f, downscaled: %d %d, effective: %d, wasted: %d\n", width, height, scale, downscaled_width, downscaled_height, effective_resolution, wasted_resolution);
  2312. if (effective_resolution > max_effective_resolution || (effective_resolution == max_effective_resolution && wasted_resolution < min_wasted_resolution)) {
  2313. max_effective_resolution = effective_resolution;
  2314. min_wasted_resolution = wasted_resolution;
  2315. best_fit = resolution;
  2316. }
  2317. }
  2318. return best_fit;
  2319. }
  2320. // used by llava 1.6 with custom list of pinpoints
  2321. static clip_image_size select_best_resolution(const std::vector<int32_t> & pinpoints, const clip_image_size & original_size) {
  2322. std::vector<clip_image_size> possible_resolutions;
  2323. for (size_t i = 0; i < pinpoints.size(); i += 2) {
  2324. possible_resolutions.push_back(clip_image_size{pinpoints[i], pinpoints[i+1]});
  2325. }
  2326. return select_best_resolution(original_size, possible_resolutions);
  2327. }
  2328. static int ensure_divide(int length, int patch_size) {
  2329. return std::max(static_cast<int>(std::round(static_cast<float>(length) / patch_size) * patch_size), patch_size);
  2330. }
  2331. static clip_image_size get_refine_size(const clip_image_size & original_size, const clip_image_size & grid, int scale_resolution, int patch_size, bool allow_upscale = false) {
  2332. int width = original_size.width;
  2333. int height = original_size.height;
  2334. int grid_x = grid.width;
  2335. int grid_y = grid.height;
  2336. int refine_width = ensure_divide(width, grid_x);
  2337. int refine_height = ensure_divide(height, grid_y);
  2338. clip_image_size grid_size;
  2339. grid_size.width = refine_width / grid_x;
  2340. grid_size.height = refine_height / grid_y;
  2341. auto best_grid_size = get_best_resize(grid_size, scale_resolution, patch_size, allow_upscale);
  2342. int best_grid_width = best_grid_size.width;
  2343. int best_grid_height = best_grid_size.height;
  2344. clip_image_size refine_size;
  2345. refine_size.width = best_grid_width * grid_x;
  2346. refine_size.height = best_grid_height * grid_y;
  2347. return refine_size;
  2348. }
  2349. static clip_image_size get_best_grid(const int max_slice_nums, const int multiple, const float log_ratio) {
  2350. std::vector<int> candidate_split_grids_nums;
  2351. for (int i : {multiple - 1, multiple, multiple + 1}) {
  2352. if (i == 1 || i > max_slice_nums) {
  2353. continue;
  2354. }
  2355. candidate_split_grids_nums.push_back(i);
  2356. }
  2357. std::vector<clip_image_size> candidate_grids;
  2358. for (int split_grids_nums : candidate_split_grids_nums) {
  2359. int m = 1;
  2360. while (m <= split_grids_nums) {
  2361. if (split_grids_nums % m == 0) {
  2362. candidate_grids.push_back(clip_image_size{m, split_grids_nums / m});
  2363. }
  2364. ++m;
  2365. }
  2366. }
  2367. clip_image_size best_grid{1, 1};
  2368. float min_error = std::numeric_limits<float>::infinity();
  2369. for (const auto& grid : candidate_grids) {
  2370. float error = std::abs(log_ratio - std::log(1.0 * grid.width / grid.height));
  2371. if (error < min_error) {
  2372. best_grid = grid;
  2373. min_error = error;
  2374. }
  2375. }
  2376. return best_grid;
  2377. }
  2378. };
  2379. // TODO @ngxson : decprecate the load_image_size singleton pattern
  2380. int clip_uhd_num_image_embeds_col(struct clip_ctx * ctx_clip) {
  2381. const auto inst = llava_uhd::get_slice_instructions(ctx_clip, ctx_clip->load_image_size);
  2382. return inst.grid_size.width;
  2383. }
  2384. // returns the normalized float tensor for llava-1.5, for spatial_unpad with anyres processing for llava-1.6 it returns the normalized image patch tensors as a vector
  2385. // res_imgs memory is being allocated here, previous allocations will be freed if found
  2386. bool clip_image_preprocess(struct clip_ctx * ctx, const clip_image_u8 * img, struct clip_image_f32_batch * res_imgs) {
  2387. clip_image_size original_size{img->nx, img->ny};
  2388. bool pad_to_square = true;
  2389. auto & params = ctx->vision_model.hparams;
  2390. // The model config actually contains all we need to decide on how to preprocess, here we automatically switch to the new llava-1.6 preprocessing
  2391. if (params.mm_patch_merge_type == PATCH_MERGE_SPATIAL_UNPAD) {
  2392. pad_to_square = false;
  2393. }
  2394. if (clip_is_minicpmv(ctx)) {
  2395. auto const inst = llava_uhd::get_slice_instructions(ctx, original_size);
  2396. std::vector<clip_image_u8_ptr> imgs = llava_uhd::slice_image(img, inst);
  2397. for (size_t i = 0; i < imgs.size(); ++i) {
  2398. // clip_image_save_to_bmp(*imgs[i], "slice_" + std::to_string(i) + ".bmp");
  2399. clip_image_f32_ptr res(clip_image_f32_init());
  2400. normalize_image_u8_to_f32(*imgs[i], *res, ctx->image_mean, ctx->image_std);
  2401. res_imgs->entries.push_back(std::move(res));
  2402. }
  2403. return true;
  2404. }
  2405. else if (ctx->proj_type == PROJECTOR_TYPE_QWEN2VL || ctx->proj_type == PROJECTOR_TYPE_QWEN25VL) {
  2406. clip_image_u8 resized;
  2407. auto patch_size = clip_get_patch_size(ctx) * 2;
  2408. int nx = ceil((float)img->nx / patch_size) * patch_size;
  2409. int ny = ceil((float)img->ny / patch_size) * patch_size;
  2410. image_manipulation::bicubic_resize(*img, resized, nx, ny);
  2411. clip_image_f32_ptr img_f32(clip_image_f32_init());
  2412. // clip_image_f32_ptr res(clip_image_f32_init());
  2413. normalize_image_u8_to_f32(resized, *img_f32, ctx->image_mean, ctx->image_std);
  2414. // res_imgs->data[0] = *res;
  2415. res_imgs->entries.push_back(std::move(img_f32));
  2416. return true;
  2417. }
  2418. else if (ctx->proj_type == PROJECTOR_TYPE_GLM_EDGE
  2419. || ctx->proj_type == PROJECTOR_TYPE_GEMMA3
  2420. || ctx->proj_type == PROJECTOR_TYPE_IDEFICS3) {
  2421. clip_image_u8 resized_image;
  2422. int sz = params.image_size;
  2423. image_manipulation::resize_and_pad_image(*img, resized_image, {sz, sz});
  2424. clip_image_f32_ptr img_f32(clip_image_f32_init());
  2425. //clip_image_save_to_bmp(resized_image, "resized.bmp");
  2426. normalize_image_u8_to_f32(resized_image, *img_f32, ctx->image_mean, ctx->image_std);
  2427. res_imgs->entries.push_back(std::move(img_f32));
  2428. return true;
  2429. }
  2430. else if (ctx->proj_type == PROJECTOR_TYPE_PIXTRAL) {
  2431. clip_image_u8 resized_image;
  2432. auto new_size = image_manipulation::calc_size_preserved_ratio(original_size, params.patch_size, params.image_size);
  2433. image_manipulation::bilinear_resize(*img, resized_image, new_size.width, new_size.height);
  2434. clip_image_f32_ptr img_f32(clip_image_f32_init());
  2435. normalize_image_u8_to_f32(resized_image, *img_f32, ctx->image_mean, ctx->image_std);
  2436. res_imgs->entries.push_back(std::move(img_f32));
  2437. return true;
  2438. }
  2439. // the logic below is to pad the shorter side to the longer side with a background color: rgb(122, 116, 104)
  2440. // see https://github.com/haotian-liu/LLaVA/blob/e854a2bf85118c504f6f16bf5c3c7c92f8fa8c6b/llava/conversation.py#L113-L156
  2441. clip_image_u8_ptr temp(clip_image_u8_init()); // we will keep the input image data here temporarily
  2442. if (pad_to_square) {
  2443. // for llava-1.5, we resize image to a square, and pad the shorter side with a background color
  2444. // see https://github.com/haotian-liu/LLaVA/blob/e854a2bf85118c504f6f16bf5c3c7c92f8fa8c6b/llava/conversation.py#L113-L156
  2445. const int longer_side = std::max(img->nx, img->ny);
  2446. temp->nx = longer_side;
  2447. temp->ny = longer_side;
  2448. temp->buf.resize(3 * longer_side * longer_side);
  2449. // background color in RGB from LLaVA (this is the mean rgb color * 255)
  2450. const std::array<uint8_t, 3> pad_color = {122, 116, 104};
  2451. // resize the image to the target_size
  2452. image_manipulation::resize_and_pad_image(*img, *temp, clip_image_size{params.image_size, params.image_size}, pad_color);
  2453. clip_image_f32_ptr res(clip_image_f32_init());
  2454. normalize_image_u8_to_f32(*temp, *res, ctx->image_mean, ctx->image_std);
  2455. res_imgs->entries.push_back(std::move(res));
  2456. return true;
  2457. } else if (!params.image_grid_pinpoints.empty()) {
  2458. // "spatial_unpad" with "anyres" processing for llava-1.6
  2459. auto const inst = llava_uhd::get_slice_instructions(ctx, original_size);
  2460. std::vector<clip_image_u8_ptr> imgs = llava_uhd::slice_image(img, inst);
  2461. for (size_t i = 0; i < imgs.size(); ++i) {
  2462. // clip_image_save_to_bmp(*imgs[i], "slice_" + std::to_string(i) + ".bmp");
  2463. clip_image_f32_ptr res(clip_image_f32_init());
  2464. normalize_image_u8_to_f32(*imgs[i], *res, ctx->image_mean, ctx->image_std);
  2465. res_imgs->entries.push_back(std::move(res));
  2466. }
  2467. return true;
  2468. }
  2469. GGML_ASSERT(false && "Unknown image preprocessing type");
  2470. }
  2471. ggml_tensor * clip_get_newline_tensor(const struct clip_ctx * ctx) {
  2472. return ctx->vision_model.image_newline;
  2473. }
  2474. void clip_free(clip_ctx * ctx) {
  2475. if (ctx == nullptr) {
  2476. return;
  2477. }
  2478. delete ctx;
  2479. }
  2480. // deprecated
  2481. size_t clip_embd_nbytes(const struct clip_ctx * ctx) {
  2482. const int32_t nx = ctx->vision_model.hparams.image_size;
  2483. const int32_t ny = ctx->vision_model.hparams.image_size;
  2484. return clip_embd_nbytes_by_img(ctx, nx, ny);
  2485. }
  2486. size_t clip_embd_nbytes_by_img(const struct clip_ctx * ctx, int img_w, int img_h) {
  2487. clip_image_f32 img;
  2488. img.nx = img_w;
  2489. img.ny = img_h;
  2490. return clip_n_output_tokens(ctx, &img) * clip_n_mmproj_embd(ctx) * sizeof(float);
  2491. }
  2492. int32_t clip_get_image_size(const struct clip_ctx * ctx) {
  2493. return ctx->vision_model.hparams.image_size;
  2494. }
  2495. int32_t clip_get_patch_size(const struct clip_ctx * ctx) {
  2496. return ctx->vision_model.hparams.patch_size;
  2497. }
  2498. int32_t clip_get_hidden_size(const struct clip_ctx * ctx) {
  2499. return ctx->vision_model.hparams.n_embd;
  2500. }
  2501. const char * clip_patch_merge_type(const struct clip_ctx * ctx) {
  2502. return ctx->vision_model.hparams.mm_patch_merge_type == PATCH_MERGE_SPATIAL_UNPAD ? "spatial_unpad" : "flat";
  2503. }
  2504. const int32_t * clip_image_grid(const struct clip_ctx * ctx) {
  2505. if (ctx->vision_model.hparams.image_grid_pinpoints.size()) {
  2506. return &ctx->vision_model.hparams.image_grid_pinpoints.front();
  2507. }
  2508. return nullptr;
  2509. }
  2510. size_t get_clip_image_grid_size(const struct clip_ctx * ctx) {
  2511. return ctx->vision_model.hparams.image_grid_pinpoints.size();
  2512. }
  2513. // deprecated
  2514. int clip_n_patches(const struct clip_ctx * ctx) {
  2515. clip_image_f32 img;
  2516. img.nx = ctx->vision_model.hparams.image_size;
  2517. img.ny = ctx->vision_model.hparams.image_size;
  2518. return clip_n_output_tokens(ctx, &img);
  2519. }
  2520. // deprecated
  2521. int clip_n_patches_by_img(const struct clip_ctx * ctx, struct clip_image_f32 * img) {
  2522. return clip_n_output_tokens(ctx, img);
  2523. }
  2524. int clip_n_output_tokens_x(const struct clip_ctx * ctx, struct clip_image_f32 * img) {
  2525. const auto & params = ctx->vision_model.hparams;
  2526. const int n_total = clip_n_output_tokens(ctx, img);
  2527. if (ctx->proj_type == PROJECTOR_TYPE_QWEN2VL || ctx->proj_type == PROJECTOR_TYPE_QWEN25VL) {
  2528. return img->nx / (params.patch_size * 2) + (int)(img->nx % params.patch_size > 0);
  2529. }
  2530. return n_total;
  2531. }
  2532. int clip_n_output_tokens_y(const struct clip_ctx * ctx, struct clip_image_f32 * img) {
  2533. const auto & params = ctx->vision_model.hparams;
  2534. if (ctx->proj_type == PROJECTOR_TYPE_QWEN2VL || ctx->proj_type == PROJECTOR_TYPE_QWEN25VL) {
  2535. return img->ny / (params.patch_size * 2) + (int)(img->ny % params.patch_size > 0);
  2536. }
  2537. return 1;
  2538. }
  2539. int clip_n_output_tokens(const struct clip_ctx * ctx, struct clip_image_f32 * img) {
  2540. const auto & params = ctx->vision_model.hparams;
  2541. int n_patches = (params.image_size / params.patch_size) * (params.image_size / params.patch_size);
  2542. if (ctx->proj_type == PROJECTOR_TYPE_LDP || ctx->proj_type == PROJECTOR_TYPE_LDPV2 || ctx->proj_type == PROJECTOR_TYPE_GLM_EDGE) {
  2543. n_patches /= 4;
  2544. n_patches += 2; // for BOI and EOI token embeddings
  2545. } else if (ctx->proj_type == PROJECTOR_TYPE_MINICPMV) {
  2546. if (ctx->minicpmv_version == 2) {
  2547. n_patches = 96;
  2548. }
  2549. else if (ctx->minicpmv_version == 3) {
  2550. n_patches = 64;
  2551. }
  2552. else if (ctx->minicpmv_version == 4) {
  2553. n_patches = 64;
  2554. }
  2555. else {
  2556. GGML_ABORT("Unknown minicpmv version");
  2557. }
  2558. } else if (ctx->proj_type == PROJECTOR_TYPE_QWEN2VL || ctx->proj_type == PROJECTOR_TYPE_QWEN25VL) {
  2559. int patch_size = params.patch_size * 2;
  2560. int x_patch = img->nx / patch_size + (int)(img->nx % patch_size > 0);
  2561. int y_patch = img->ny / patch_size + (int)(img->ny % patch_size > 0);
  2562. n_patches = x_patch * y_patch;
  2563. } else if (ctx->proj_type == PROJECTOR_TYPE_GEMMA3) {
  2564. int n_per_side = params.image_size / params.patch_size;
  2565. int n_per_side_2d_pool = n_per_side / params.proj_scale_factor;
  2566. n_patches = n_per_side_2d_pool * n_per_side_2d_pool;
  2567. } else if (ctx->proj_type == PROJECTOR_TYPE_IDEFICS3) {
  2568. n_patches /= (params.proj_scale_factor * params.proj_scale_factor);
  2569. } else if (ctx->proj_type == PROJECTOR_TYPE_PIXTRAL) {
  2570. int n_merge = params.spatial_merge_size;
  2571. int n_patches_x = img->nx / params.patch_size / (n_merge > 0 ? n_merge : 1);
  2572. int n_patches_y = img->ny / params.patch_size / (n_merge > 0 ? n_merge : 1);
  2573. n_patches = n_patches_y*n_patches_x + n_patches_y - 1; // + one [IMG_BREAK] per row, except the last row
  2574. }
  2575. return n_patches;
  2576. }
  2577. static std::vector<std::vector<std::vector<float>>> get_1d_sincos_pos_embed_from_grid_new(int embed_dim, const std::vector<std::vector<float>> & pos) {
  2578. assert(embed_dim % 2 == 0);
  2579. int H = pos.size();
  2580. int W = pos[0].size();
  2581. std::vector<float> omega(embed_dim / 2);
  2582. for (int i = 0; i < embed_dim / 2; ++i) {
  2583. omega[i] = 1.0 / pow(10000.0, static_cast<float>(i) / (embed_dim / 2));
  2584. }
  2585. std::vector<std::vector<std::vector<float>>> emb(H, std::vector<std::vector<float>>(W, std::vector<float>(embed_dim)));
  2586. for (int h = 0; h < H; ++h) {
  2587. for (int w = 0; w < W; ++w) {
  2588. for (int d = 0; d < embed_dim / 2; ++d) {
  2589. float out_value = pos[h][w] * omega[d];
  2590. emb[h][w][d] = sin(out_value);
  2591. emb[h][w][d + embed_dim / 2] = cos(out_value);
  2592. }
  2593. }
  2594. }
  2595. return emb;
  2596. }
  2597. static std::vector<std::vector<std::vector<float>>> get_2d_sincos_pos_embed_from_grid(int embed_dim, const std::vector<std::vector<std::vector<float>>> & grid) {
  2598. assert(embed_dim % 2 == 0);
  2599. std::vector<std::vector<std::vector<float>>> emb_h = get_1d_sincos_pos_embed_from_grid_new(embed_dim / 2, grid[0]); // (H, W, D/2)
  2600. std::vector<std::vector<std::vector<float>>> emb_w = get_1d_sincos_pos_embed_from_grid_new(embed_dim / 2, grid[1]); // (H, W, D/2)
  2601. int H = emb_h.size();
  2602. int W = emb_h[0].size();
  2603. std::vector<std::vector<std::vector<float>>> emb(H, std::vector<std::vector<float>>(W, std::vector<float>(embed_dim)));
  2604. for (int h = 0; h < H; ++h) {
  2605. for (int w = 0; w < W; ++w) {
  2606. for (int d = 0; d < embed_dim / 2; ++d) {
  2607. emb[h][w][d] = emb_h[h][w][d];
  2608. emb[h][w][d + embed_dim / 2] = emb_w[h][w][d];
  2609. }
  2610. }
  2611. }
  2612. return emb;
  2613. }
  2614. static std::vector<std::vector<float>> get_2d_sincos_pos_embed(int embed_dim, const std::pair<int, int> image_size) {
  2615. int grid_h_size = image_size.first;
  2616. int grid_w_size = image_size.second;
  2617. std::vector<float> grid_h(grid_h_size);
  2618. std::vector<float> grid_w(grid_w_size);
  2619. for (int i = 0; i < grid_h_size; ++i) {
  2620. grid_h[i] = static_cast<float>(i);
  2621. }
  2622. for (int i = 0; i < grid_w_size; ++i) {
  2623. grid_w[i] = static_cast<float>(i);
  2624. }
  2625. std::vector<std::vector<float>> grid(grid_h_size, std::vector<float>(grid_w_size));
  2626. for (int h = 0; h < grid_h_size; ++h) {
  2627. for (int w = 0; w < grid_w_size; ++w) {
  2628. grid[h][w] = grid_w[w];
  2629. }
  2630. }
  2631. std::vector<std::vector<std::vector<float>>> grid_2d = {grid, grid};
  2632. for (int h = 0; h < grid_h_size; ++h) {
  2633. for (int w = 0; w < grid_w_size; ++w) {
  2634. grid_2d[0][h][w] = grid_h[h];
  2635. grid_2d[1][h][w] = grid_w[w];
  2636. }
  2637. }
  2638. std::vector<std::vector<std::vector<float>>> pos_embed_3d = get_2d_sincos_pos_embed_from_grid(embed_dim, grid_2d);
  2639. int H = image_size.first;
  2640. int W = image_size.second;
  2641. std::vector<std::vector<float>> pos_embed_2d(H * W, std::vector<float>(embed_dim));
  2642. for (int h = 0; h < H; ++h) {
  2643. for (int w = 0; w < W; ++w) {
  2644. pos_embed_2d[w * H + h] = pos_embed_3d[h][w];
  2645. }
  2646. }
  2647. return pos_embed_2d;
  2648. }
  2649. bool clip_image_encode(struct clip_ctx * ctx, const int n_threads, clip_image_f32 * img, float * vec) {
  2650. clip_image_f32_batch imgs;
  2651. clip_image_f32_ptr img_copy(clip_image_f32_init());
  2652. *img_copy = *img;
  2653. imgs.entries.push_back(std::move(img_copy));
  2654. return clip_image_batch_encode(ctx, n_threads, &imgs, vec);
  2655. }
  2656. bool clip_image_batch_encode(clip_ctx * ctx, const int n_threads, const clip_image_f32_batch * imgs_c_ptr, float * vec) {
  2657. const clip_image_f32_batch & imgs = *imgs_c_ptr;
  2658. int batch_size = imgs.entries.size();
  2659. // TODO @ngxson : implement batch size > 1 as a loop
  2660. // we don't need true batching support because the cgraph will gonna be big anyway
  2661. if (batch_size != 1) {
  2662. return false; // only support batch size of 1
  2663. }
  2664. // build the inference graph
  2665. ggml_backend_sched_reset(ctx->sched.get());
  2666. ggml_cgraph * gf = clip_image_build_graph(ctx, imgs);
  2667. ggml_backend_sched_alloc_graph(ctx->sched.get(), gf);
  2668. // set inputs
  2669. const auto & model = ctx->vision_model;
  2670. const auto & hparams = model.hparams;
  2671. const int image_size_width = imgs.entries[0]->nx;
  2672. const int image_size_height = imgs.entries[0]->ny;
  2673. const int patch_size = hparams.patch_size;
  2674. const int num_patches = ((image_size_width / patch_size) * (image_size_height / patch_size));
  2675. const int n_pos = num_patches + (model.class_embedding ? 1 : 0);
  2676. const int pos_w = ctx->load_image_size.width / patch_size;
  2677. const int pos_h = ctx->load_image_size.height / patch_size;
  2678. const bool use_window_attn = hparams.n_wa_pattern > 0; // for qwen2.5vl
  2679. auto get_inp_tensor = [&gf](const char * name) {
  2680. ggml_tensor * inp = ggml_graph_get_tensor(gf, name);
  2681. if (inp == nullptr) {
  2682. GGML_ABORT("Failed to get tensor %s", name);
  2683. }
  2684. if (!(inp->flags & GGML_TENSOR_FLAG_INPUT)) {
  2685. GGML_ABORT("Tensor %s is not an input tensor", name);
  2686. }
  2687. return inp;
  2688. };
  2689. auto set_input_f32 = [&get_inp_tensor](const char * name, std::vector<float> & values) {
  2690. ggml_tensor * cur = get_inp_tensor(name);
  2691. GGML_ASSERT(cur->type == GGML_TYPE_F32);
  2692. GGML_ASSERT(ggml_nelements(cur) == (int64_t)values.size());
  2693. ggml_backend_tensor_set(cur, values.data(), 0, ggml_nbytes(cur));
  2694. };
  2695. auto set_input_i32 = [&get_inp_tensor](const char * name, std::vector<int32_t> & values) {
  2696. ggml_tensor * cur = get_inp_tensor(name);
  2697. GGML_ASSERT(cur->type == GGML_TYPE_I32);
  2698. GGML_ASSERT(ggml_nelements(cur) == (int64_t)values.size());
  2699. ggml_backend_tensor_set(cur, values.data(), 0, ggml_nbytes(cur));
  2700. };
  2701. // set input pixel values
  2702. {
  2703. size_t nelem = 0;
  2704. for (const auto & img : imgs.entries) {
  2705. nelem += img->nx * img->ny * 3;
  2706. }
  2707. std::vector<float> inp_raw(nelem);
  2708. // layout of data (note: the channel dim is unrolled to better visualize the layout):
  2709. //
  2710. // ┌──W──┐
  2711. // │ H │ channel = R
  2712. // ├─────┤ │
  2713. // │ H │ channel = G
  2714. // ├─────┤ │
  2715. // │ H │ channel = B
  2716. // └─────┘ │
  2717. // ──────┘ x B
  2718. for (size_t i = 0; i < imgs.entries.size(); i++) {
  2719. const int nx = imgs.entries[i]->nx;
  2720. const int ny = imgs.entries[i]->ny;
  2721. const int n = nx * ny;
  2722. for (int b = 0; b < batch_size; b++) {
  2723. float * batch_entry = inp_raw.data() + b * (3*n);
  2724. for (int y = 0; y < ny; y++) {
  2725. for (int x = 0; x < nx; x++) {
  2726. size_t base_src = 3*(y * nx + x); // idx of the first channel
  2727. size_t base_dst = y * nx + x; // idx of the first channel
  2728. batch_entry[ base_dst] = imgs.entries[b]->buf[base_src ];
  2729. batch_entry[1*n + base_dst] = imgs.entries[b]->buf[base_src + 1];
  2730. batch_entry[2*n + base_dst] = imgs.entries[b]->buf[base_src + 2];
  2731. }
  2732. }
  2733. }
  2734. }
  2735. set_input_f32("inp_raw", inp_raw);
  2736. }
  2737. // set input per projector
  2738. switch (ctx->proj_type) {
  2739. case PROJECTOR_TYPE_MINICPMV:
  2740. {
  2741. // inspired from siglip:
  2742. // -> https://huggingface.co/HuggingFaceM4/siglip-so400m-14-980-flash-attn2-navit
  2743. // -> https://huggingface.co/HuggingFaceM4/siglip-so400m-14-980-flash-attn2-navit/blob/d66538faeba44480d0bfaa42145eef26f9423199/modeling_siglip.py#L316
  2744. std::vector<int32_t> positions(pos_h * pos_w);
  2745. int bucket_coords_h[1024];
  2746. int bucket_coords_w[1024];
  2747. for (int i = 0; i < pos_h; i++){
  2748. bucket_coords_h[i] = std::floor(70.0*i/pos_h);
  2749. }
  2750. for (int i = 0; i < pos_w; i++){
  2751. bucket_coords_w[i] = std::floor(70.0*i/pos_w);
  2752. }
  2753. for (int i = 0, id = 0; i < pos_h; i++){
  2754. for (int j = 0; j < pos_w; j++){
  2755. positions[id++] = bucket_coords_h[i]*70 + bucket_coords_w[j];
  2756. }
  2757. }
  2758. set_input_i32("positions", positions);
  2759. // inspired from resampler of Qwen-VL:
  2760. // -> https://huggingface.co/Qwen/Qwen-VL/tree/main
  2761. // -> https://huggingface.co/Qwen/Qwen-VL/blob/0547ed36a86561e2e42fecec8fd0c4f6953e33c4/visual.py#L23
  2762. int embed_dim = clip_n_mmproj_embd(ctx);
  2763. // TODO @ngxson : this is very inefficient, can we do this using ggml_sin and ggml_cos?
  2764. auto pos_embed_t = get_2d_sincos_pos_embed(embed_dim, std::make_pair(pos_w, pos_h));
  2765. std::vector<float> pos_embed(embed_dim * pos_w * pos_h);
  2766. for(int i = 0; i < pos_w * pos_h; ++i){
  2767. for(int j = 0; j < embed_dim; ++j){
  2768. pos_embed[i * embed_dim + j] = pos_embed_t[i][j];
  2769. }
  2770. }
  2771. set_input_f32("pos_embed", pos_embed);
  2772. } break;
  2773. case PROJECTOR_TYPE_QWEN2VL:
  2774. {
  2775. const int merge_ratio = 2;
  2776. const int pw = image_size_width / patch_size;
  2777. const int ph = image_size_height / patch_size;
  2778. std::vector<int> positions(n_pos * 4);
  2779. int ptr = 0;
  2780. for (int y = 0; y < ph; y += merge_ratio) {
  2781. for (int x = 0; x < pw; x += merge_ratio) {
  2782. for (int dy = 0; dy < 2; dy++) {
  2783. for (int dx = 0; dx < 2; dx++) {
  2784. positions[ ptr] = y + dy;
  2785. positions[ num_patches + ptr] = x + dx;
  2786. positions[2 * num_patches + ptr] = y + dy;
  2787. positions[3 * num_patches + ptr] = x + dx;
  2788. ptr++;
  2789. }
  2790. }
  2791. }
  2792. }
  2793. set_input_i32("positions", positions);
  2794. } break;
  2795. case PROJECTOR_TYPE_QWEN25VL:
  2796. {
  2797. // pw * ph = number of tokens output by ViT after apply patch merger
  2798. // ipw * ipw = number of vision token been processed inside ViT
  2799. const int merge_ratio = 2;
  2800. const int pw = image_size_width / patch_size / merge_ratio;
  2801. const int ph = image_size_height / patch_size / merge_ratio;
  2802. const int ipw = image_size_width / patch_size;
  2803. const int iph = image_size_height / patch_size;
  2804. std::vector<int> idx (ph * pw);
  2805. std::vector<int> inv_idx(ph * pw);
  2806. if (use_window_attn) {
  2807. const int attn_window_size = 112;
  2808. const int grid_window = attn_window_size / patch_size / merge_ratio;
  2809. int dst = 0;
  2810. // [num_vision_tokens, num_vision_tokens] attention mask tensor
  2811. std::vector<float> mask(pow(ipw * iph, 2), std::numeric_limits<float>::lowest());
  2812. int mask_row = 0;
  2813. for (int y = 0; y < ph; y += grid_window) {
  2814. for (int x = 0; x < pw; x += grid_window) {
  2815. const int win_h = std::min(grid_window, ph - y);
  2816. const int win_w = std::min(grid_window, pw - x);
  2817. const int dst_0 = dst;
  2818. // group all tokens belong to the same window togather (to a continue range)
  2819. for (int dy = 0; dy < win_h; dy++) {
  2820. for (int dx = 0; dx < win_w; dx++) {
  2821. const int src = (y + dy) * pw + (x + dx);
  2822. GGML_ASSERT(src < (int)idx.size());
  2823. GGML_ASSERT(dst < (int)inv_idx.size());
  2824. idx [src] = dst;
  2825. inv_idx[dst] = src;
  2826. dst++;
  2827. }
  2828. }
  2829. for (int r=0; r < win_h * win_w * merge_ratio * merge_ratio; r++) {
  2830. int row_offset = mask_row * (ipw * iph);
  2831. std::fill(
  2832. mask.begin() + row_offset + (dst_0 * merge_ratio * merge_ratio),
  2833. mask.begin() + row_offset + (dst * merge_ratio * merge_ratio),
  2834. 0.0);
  2835. mask_row++;
  2836. }
  2837. }
  2838. }
  2839. set_input_i32("window_idx", idx);
  2840. set_input_i32("inv_window_idx", inv_idx);
  2841. set_input_f32("window_mask", mask);
  2842. } else {
  2843. for (int i = 0; i < ph * pw; i++) {
  2844. idx[i] = i;
  2845. }
  2846. }
  2847. const int mpow = merge_ratio * merge_ratio;
  2848. std::vector<int> positions(n_pos * 4);
  2849. int ptr = 0;
  2850. for (int y = 0; y < iph; y += merge_ratio) {
  2851. for (int x = 0; x < ipw; x += merge_ratio) {
  2852. for (int dy = 0; dy < 2; dy++) {
  2853. for (int dx = 0; dx < 2; dx++) {
  2854. auto remap = idx[ptr / mpow];
  2855. remap = (remap * mpow) + (ptr % mpow);
  2856. positions[ remap] = y + dy;
  2857. positions[ num_patches + remap] = x + dx;
  2858. positions[2 * num_patches + remap] = y + dy;
  2859. positions[3 * num_patches + remap] = x + dx;
  2860. ptr++;
  2861. }
  2862. }
  2863. }
  2864. }
  2865. set_input_i32("positions", positions);
  2866. } break;
  2867. case PROJECTOR_TYPE_PIXTRAL:
  2868. {
  2869. // set the 2D positions
  2870. int n_patches_per_col = image_size_width / patch_size;
  2871. std::vector<int> pos_data(n_pos);
  2872. // dimension H
  2873. for (int i = 0; i < n_pos; i++) {
  2874. pos_data[i] = i / n_patches_per_col;
  2875. }
  2876. set_input_i32("pos_h", pos_data);
  2877. // dimension W
  2878. for (int i = 0; i < n_pos; i++) {
  2879. pos_data[i] = i % n_patches_per_col;
  2880. }
  2881. set_input_i32("pos_w", pos_data);
  2882. } break;
  2883. case PROJECTOR_TYPE_GLM_EDGE:
  2884. {
  2885. // llava and other models
  2886. std::vector<int32_t> positions(n_pos);
  2887. for (int i = 0; i < n_pos; i++) {
  2888. positions[i] = i;
  2889. }
  2890. set_input_i32("positions", positions);
  2891. } break;
  2892. case PROJECTOR_TYPE_MLP:
  2893. case PROJECTOR_TYPE_MLP_NORM:
  2894. case PROJECTOR_TYPE_LDP:
  2895. case PROJECTOR_TYPE_LDPV2:
  2896. {
  2897. // llava and other models
  2898. std::vector<int32_t> positions(n_pos);
  2899. for (int i = 0; i < n_pos; i++) {
  2900. positions[i] = i;
  2901. }
  2902. set_input_i32("positions", positions);
  2903. // The patches vector is used to get rows to index into the embeds with;
  2904. // we should skip dim 0 only if we have CLS to avoid going out of bounds
  2905. // when retrieving the rows.
  2906. int patch_offset = model.class_embedding ? 1 : 0;
  2907. std::vector<int32_t> patches(num_patches);
  2908. for (int i = 0; i < num_patches; i++) {
  2909. patches[i] = i + patch_offset;
  2910. }
  2911. set_input_i32("patches", patches);
  2912. } break;
  2913. case PROJECTOR_TYPE_GEMMA3:
  2914. case PROJECTOR_TYPE_IDEFICS3:
  2915. {
  2916. // do nothing
  2917. } break;
  2918. default:
  2919. GGML_ABORT("Unknown projector type");
  2920. }
  2921. // ggml_backend_cpu_set_n_threads(ctx->backend_cpu, n_threads);
  2922. ggml_backend_dev_t dev = ggml_backend_get_device(ctx->backend_cpu);
  2923. ggml_backend_reg_t reg = dev ? ggml_backend_dev_backend_reg(dev) : nullptr;
  2924. if (reg) {
  2925. auto ggml_backend_set_n_threads_fn = (ggml_backend_set_n_threads_t) ggml_backend_reg_get_proc_address(reg, "ggml_backend_set_n_threads");
  2926. if (ggml_backend_set_n_threads_fn) {
  2927. ggml_backend_set_n_threads_fn(ctx->backend_cpu, n_threads);
  2928. }
  2929. }
  2930. auto status = ggml_backend_sched_graph_compute(ctx->sched.get(), gf);
  2931. if (status != GGML_STATUS_SUCCESS) {
  2932. LOG_ERR("%s: ggml_backend_sched_graph_compute failed with error %d\n", __func__, status);
  2933. return false;
  2934. }
  2935. // the last node is the embedding tensor
  2936. ggml_tensor * embeddings = ggml_graph_node(gf, -1);
  2937. // copy the embeddings to the location passed by the user
  2938. ggml_backend_tensor_get(embeddings, vec, 0, ggml_nbytes(embeddings));
  2939. return true;
  2940. }
  2941. bool clip_model_quantize(const char * fname_inp, const char * fname_out, const int itype) {
  2942. assert(itype < GGML_TYPE_COUNT);
  2943. ggml_type type = static_cast<ggml_type>(itype);
  2944. auto * ctx_clip = clip_init(fname_inp, clip_context_params{
  2945. /* use_gpu */ false,
  2946. /* verbosity */ GGML_LOG_LEVEL_ERROR,
  2947. });
  2948. const auto & ctx_src = ctx_clip->ctx_gguf.get();
  2949. const auto & ctx_data = ctx_clip->ctx_data.get();
  2950. auto * ctx_out = gguf_init_empty();
  2951. gguf_set_kv(ctx_out, ctx_src);
  2952. gguf_set_val_u32(ctx_out, "general.quantization_version", GGML_QNT_VERSION);
  2953. gguf_set_val_u32(ctx_out, "general.file_type", itype);
  2954. auto fout = std::ofstream(fname_out, std::ios::binary);
  2955. const int n_tensors = gguf_get_n_tensors(ctx_src);
  2956. for (int i = 0; i < n_tensors; ++i) {
  2957. const char * name = gguf_get_tensor_name(ctx_src, i);
  2958. ggml_tensor * cur = ggml_get_tensor(ctx_data, name);
  2959. gguf_add_tensor(ctx_out, cur);
  2960. }
  2961. const size_t meta_size = gguf_get_meta_size(ctx_out);
  2962. for (size_t i = 0; i < meta_size; ++i) {
  2963. fout.put(0);
  2964. }
  2965. // regexes of tensor names to be quantized
  2966. const std::vector<std::string> k_names = {
  2967. ".*weight",
  2968. };
  2969. std::vector<uint8_t> work(512);
  2970. std::vector<float> conv_buf(512);
  2971. size_t total_size_org = 0;
  2972. size_t total_size_new = 0;
  2973. for (int i = 0; i < n_tensors; ++i) {
  2974. const std::string name = gguf_get_tensor_name(ctx_src, i);
  2975. ggml_tensor * cur = ggml_get_tensor(ctx_data, name.c_str());
  2976. enum ggml_type new_type;
  2977. void * new_data;
  2978. size_t new_size;
  2979. bool quantize = false;
  2980. for (const auto & s : k_names) {
  2981. if (std::regex_match(name, std::regex(s))) {
  2982. quantize = true;
  2983. break;
  2984. }
  2985. }
  2986. // quantize only 2D tensors and bigger than block size
  2987. quantize &= (ggml_n_dims(cur) == 2) && cur->ne[0] > ggml_blck_size(type);
  2988. if (quantize) {
  2989. new_type = type;
  2990. if (new_type >= GGML_TYPE_Q2_K && name.find("embd") != std::string::npos) {
  2991. new_type = GGML_TYPE_Q8_0; // ggml_get_rows needs non K type
  2992. // LOG_ERR("%s: quantizing %s to %s\n", __func__, name.c_str(), ggml_type_name(new_type));
  2993. }
  2994. const size_t n_elms = ggml_nelements(cur);
  2995. float * f32_data;
  2996. switch (cur->type) {
  2997. case GGML_TYPE_F32:
  2998. f32_data = (float *)cur->data;
  2999. break;
  3000. case GGML_TYPE_F16:
  3001. if (conv_buf.size() < n_elms) {
  3002. conv_buf.resize(n_elms);
  3003. }
  3004. for (size_t j = 0; j < n_elms; ++j) {
  3005. conv_buf[j] = ggml_fp16_to_fp32(((ggml_fp16_t *)cur->data)[j]);
  3006. }
  3007. f32_data = (float *)conv_buf.data();
  3008. break;
  3009. default:
  3010. LOG_ERR("%s: Please use an input file in f32 or f16\n", __func__);
  3011. gguf_free(ctx_out);
  3012. return false;
  3013. }
  3014. if (work.size() < n_elms * 4) {
  3015. work.resize(n_elms * 4);
  3016. }
  3017. new_data = work.data();
  3018. new_size = ggml_quantize_chunk(new_type, f32_data, new_data, 0, n_elms/cur->ne[0], cur->ne[0], nullptr);
  3019. } else {
  3020. new_type = cur->type;
  3021. new_data = cur->data;
  3022. new_size = ggml_nbytes(cur);
  3023. }
  3024. const size_t orig_size = ggml_nbytes(cur);
  3025. total_size_org += orig_size;
  3026. total_size_new += new_size;
  3027. gguf_set_tensor_type(ctx_out, name.c_str(), new_type);
  3028. GGML_ASSERT(gguf_get_tensor_size(ctx_out, gguf_find_tensor(ctx_out, name.c_str())) == new_size);
  3029. gguf_set_tensor_data(ctx_out, name.c_str(), new_data);
  3030. fout.write((const char *)new_data, new_size);
  3031. size_t pad = GGML_PAD(new_size, gguf_get_alignment(ctx_out)) - new_size;
  3032. for (size_t j = 0; j < pad; ++j) {
  3033. fout.put(0);
  3034. }
  3035. LOG_INF("%s: n_dims = %d | quantize=%d | size = %f MB -> %f MB\n", name.c_str(), ggml_n_dims(cur), quantize,
  3036. orig_size / 1024.0 / 1024.0, new_size / 1024.0 / 1024.0);
  3037. }
  3038. // go back to beginning of file and write the updated metadata
  3039. fout.seekp(0, std::ios::beg);
  3040. std::vector<uint8_t> meta(meta_size);
  3041. gguf_get_meta_data(ctx_out, meta.data());
  3042. fout.write((const char *)meta.data(), meta_size);
  3043. fout.close();
  3044. clip_free(ctx_clip);
  3045. gguf_free(ctx_out);
  3046. {
  3047. LOG_INF("%s: original size = %8.2f MB\n", __func__, total_size_org / 1024.0 / 1024.0);
  3048. LOG_INF("%s: quantized size = %8.2f MB\n", __func__, total_size_new / 1024.0 / 1024.0);
  3049. }
  3050. return true;
  3051. }
  3052. int clip_n_mmproj_embd(const struct clip_ctx * ctx) {
  3053. switch (ctx->proj_type) {
  3054. case PROJECTOR_TYPE_LDP:
  3055. return ctx->vision_model.mm_model_block_1_block_2_1_b->ne[0];
  3056. case PROJECTOR_TYPE_LDPV2:
  3057. return ctx->vision_model.mm_model_peg_0_b->ne[0];
  3058. case PROJECTOR_TYPE_MLP:
  3059. case PROJECTOR_TYPE_PIXTRAL:
  3060. return ctx->vision_model.mm_2_w->ne[1];
  3061. case PROJECTOR_TYPE_MLP_NORM:
  3062. return ctx->vision_model.mm_3_b->ne[0];
  3063. case PROJECTOR_TYPE_MINICPMV:
  3064. if (ctx->minicpmv_version == 2) {
  3065. return 4096;
  3066. } else if (ctx->minicpmv_version == 3) {
  3067. return 3584;
  3068. } else if (ctx->minicpmv_version == 4) {
  3069. return 3584;
  3070. }
  3071. GGML_ABORT("Unknown minicpmv version");
  3072. case PROJECTOR_TYPE_GLM_EDGE:
  3073. return ctx->vision_model.mm_model_mlp_3_w->ne[1];
  3074. case PROJECTOR_TYPE_QWEN2VL:
  3075. case PROJECTOR_TYPE_QWEN25VL:
  3076. return ctx->vision_model.mm_1_b->ne[0];
  3077. case PROJECTOR_TYPE_GEMMA3:
  3078. return ctx->vision_model.mm_input_proj_w->ne[0];
  3079. case PROJECTOR_TYPE_IDEFICS3:
  3080. return ctx->vision_model.projection->ne[1];
  3081. default:
  3082. GGML_ABORT("Unknown projector type");
  3083. }
  3084. }
  3085. int clip_is_minicpmv(const struct clip_ctx * ctx) {
  3086. if (ctx->proj_type == PROJECTOR_TYPE_MINICPMV) {
  3087. return ctx->minicpmv_version;
  3088. }
  3089. return 0;
  3090. }
  3091. bool clip_is_glm(const struct clip_ctx * ctx) {
  3092. return ctx->proj_type == PROJECTOR_TYPE_GLM_EDGE;
  3093. }
  3094. bool clip_is_qwen2vl(const struct clip_ctx * ctx) {
  3095. return ctx->proj_type == PROJECTOR_TYPE_QWEN2VL || ctx->proj_type == PROJECTOR_TYPE_QWEN25VL;
  3096. }
  3097. bool clip_is_llava(const struct clip_ctx * ctx) {
  3098. return ctx->has_llava_projector;
  3099. }
  3100. bool clip_is_gemma3(const struct clip_ctx * ctx) {
  3101. return ctx->proj_type == PROJECTOR_TYPE_GEMMA3;
  3102. }
  3103. bool clip_encode_float_image (struct clip_ctx * ctx, int n_threads, float * img, int h, int w, float * vec) {
  3104. clip_image_f32 clip_img;
  3105. clip_img.buf.resize(h * w * 3);
  3106. for (int i = 0; i < h*w*3; i++)
  3107. {
  3108. clip_img.buf[i] = img[i];
  3109. }
  3110. clip_img.nx = w;
  3111. clip_img.ny = h;
  3112. clip_image_encode(ctx, n_threads, &clip_img, vec);
  3113. return true;
  3114. }
  3115. //
  3116. // API used internally with mtmd
  3117. //
  3118. projector_type clip_get_projector_type(const struct clip_ctx * ctx) {
  3119. return ctx->proj_type;
  3120. }