clip.cpp 83 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026
  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 "ggml.h"
  7. #include "ggml-alloc.h"
  8. #include "ggml-backend.h"
  9. #ifdef GGML_USE_CUDA
  10. #include "ggml-cuda.h"
  11. #endif
  12. #ifdef GGML_USE_METAL
  13. #include "ggml-metal.h"
  14. #endif
  15. #define STB_IMAGE_IMPLEMENTATION
  16. #include "stb_image.h"
  17. #include <cassert>
  18. #include <cmath>
  19. #include <cstdlib>
  20. #include <cstring>
  21. #include <fstream>
  22. #include <iostream>
  23. #include <map>
  24. #include <regex>
  25. #include <stdexcept>
  26. #include <vector>
  27. #include <sstream>
  28. #include <cinttypes>
  29. #include <limits>
  30. //#define CLIP_DEBUG_FUNCTIONS
  31. // RGB uint8 image
  32. struct clip_image_u8 {
  33. int nx;
  34. int ny;
  35. std::vector<uint8_t> buf;
  36. };
  37. // RGB float32 image (NHWC)
  38. // Memory layout: RGBRGBRGB...
  39. struct clip_image_f32 {
  40. int nx;
  41. int ny;
  42. std::vector<float> buf;
  43. };
  44. static std::string format(const char * fmt, ...) {
  45. va_list ap;
  46. va_list ap2;
  47. va_start(ap, fmt);
  48. va_copy(ap2, ap);
  49. int size = vsnprintf(NULL, 0, fmt, ap);
  50. GGML_ASSERT(size >= 0 && size < INT_MAX); // NOLINT
  51. std::vector<char> buf(size + 1);
  52. int size2 = vsnprintf(buf.data(), size + 1, fmt, ap2);
  53. GGML_ASSERT(size2 == size);
  54. va_end(ap2);
  55. va_end(ap);
  56. return std::string(buf.data(), buf.size());
  57. }
  58. //
  59. // key constants
  60. //
  61. #define KEY_FTYPE "general.file_type"
  62. #define KEY_NAME "general.name"
  63. #define KEY_DESCRIPTION "general.description"
  64. #define KEY_HAS_TEXT_ENC "clip.has_text_encoder"
  65. #define KEY_HAS_VIS_ENC "clip.has_vision_encoder"
  66. #define KEY_HAS_LLAVA_PROJ "clip.has_llava_projector"
  67. #define KEY_USE_GELU "clip.use_gelu"
  68. #define KEY_N_EMBD "clip.%s.embedding_length"
  69. #define KEY_N_FF "clip.%s.feed_forward_length"
  70. #define KEY_N_BLOCK "clip.%s.block_count"
  71. #define KEY_N_HEAD "clip.%s.attention.head_count"
  72. #define KEY_LAYER_NORM_EPS "clip.%s.attention.layer_norm_epsilon"
  73. #define KEY_PROJ_DIM "clip.%s.projection_dim"
  74. #define KEY_TOKENS "tokenizer.ggml.tokens"
  75. #define KEY_N_POSITIONS "clip.text.context_length"
  76. #define KEY_IMAGE_SIZE "clip.vision.image_size"
  77. #define KEY_PATCH_SIZE "clip.vision.patch_size"
  78. #define KEY_IMAGE_MEAN "clip.vision.image_mean"
  79. #define KEY_IMAGE_STD "clip.vision.image_std"
  80. #define KEY_PROJ_TYPE "clip.projector_type"
  81. #define KEY_MM_PATCH_MERGE_TYPE "clip.vision.mm_patch_merge_type"
  82. #define KEY_IMAGE_GRID_PINPOINTS "clip.vision.image_grid_pinpoints"
  83. #define KEY_IMAGE_CROP_RESOLUTION "clip.vision.image_crop_resolution"
  84. //
  85. // tensor name constants
  86. //
  87. #define TN_TOKEN_EMBD "%s.token_embd.weight"
  88. #define TN_POS_EMBD "%s.position_embd.weight"
  89. #define TN_CLASS_EMBD "v.class_embd"
  90. #define TN_PATCH_EMBD "v.patch_embd.weight"
  91. #define TN_ATTN_K "%s.blk.%d.attn_k.%s"
  92. #define TN_ATTN_Q "%s.blk.%d.attn_q.%s"
  93. #define TN_ATTN_V "%s.blk.%d.attn_v.%s"
  94. #define TN_ATTN_OUTPUT "%s.blk.%d.attn_out.%s"
  95. #define TN_FFN_DOWN "%s.blk.%d.ffn_down.%s"
  96. #define TN_FFN_UP "%s.blk.%d.ffn_up.%s"
  97. #define TN_LN_1 "%s.blk.%d.ln1.%s"
  98. #define TN_LN_2 "%s.blk.%d.ln2.%s"
  99. #define TN_LN_PRE "%s.pre_ln.%s"
  100. #define TN_LN_POST "%s.post_ln.%s"
  101. #define TN_TEXT_PROJ "text_projection.weight"
  102. #define TN_VIS_PROJ "visual_projection.weight"
  103. #define TN_LLAVA_PROJ "mm.%d.%s"
  104. #define TN_MVLM_PROJ_MLP "mm.model.mlp.%d.%s"
  105. #define TN_MVLM_PROJ_BLOCK "mm.model.mb_block.%d.block.%d.%s"
  106. #define TN_MVLM_PROJ_PEG "mm.model.peg.%d.%s"
  107. #define TN_IMAGE_NEWLINE "model.image_newline"
  108. enum projector_type {
  109. PROJECTOR_TYPE_MLP,
  110. PROJECTOR_TYPE_MLP_NORM,
  111. PROJECTOR_TYPE_LDP,
  112. PROJECTOR_TYPE_LDPV2,
  113. PROJECTOR_TYPE_UNKNOWN,
  114. };
  115. static std::map<projector_type, std::string> PROJECTOR_TYPE_NAMES = {
  116. { PROJECTOR_TYPE_MLP, "mlp" },
  117. { PROJECTOR_TYPE_LDP, "ldp" },
  118. { PROJECTOR_TYPE_LDPV2, "ldpv2"},
  119. };
  120. //
  121. // utilities to get data from a gguf file
  122. //
  123. static int get_key_idx(const gguf_context * ctx, const char * key) {
  124. int i = gguf_find_key(ctx, key);
  125. if (i == -1) {
  126. fprintf(stderr, "key %s not found in file\n", key);
  127. throw std::runtime_error(format("Missing required key: %s", key));
  128. }
  129. return i;
  130. }
  131. static uint32_t get_u32(const gguf_context * ctx, const std::string & key) {
  132. const int i = get_key_idx(ctx, key.c_str());
  133. return gguf_get_val_u32(ctx, i);
  134. }
  135. static float get_f32(const gguf_context * ctx, const std::string & key) {
  136. const int i = get_key_idx(ctx, key.c_str());
  137. return gguf_get_val_f32(ctx, i);
  138. }
  139. static struct ggml_tensor * get_tensor(struct ggml_context * ctx, const std::string & name) {
  140. struct ggml_tensor * cur = ggml_get_tensor(ctx, name.c_str());
  141. if (!cur) {
  142. throw std::runtime_error(format("%s: unable to find tensor %s\n", __func__, name.c_str()));
  143. }
  144. return cur;
  145. }
  146. static std::string get_ftype(int ftype) {
  147. return ggml_type_name(static_cast<ggml_type>(ftype));
  148. }
  149. static std::string gguf_data_to_str(enum gguf_type type, const void * data, int i) {
  150. switch (type) {
  151. case GGUF_TYPE_UINT8: return std::to_string(((const uint8_t *)data)[i]);
  152. case GGUF_TYPE_INT8: return std::to_string(((const int8_t *)data)[i]);
  153. case GGUF_TYPE_UINT16: return std::to_string(((const uint16_t *)data)[i]);
  154. case GGUF_TYPE_INT16: return std::to_string(((const int16_t *)data)[i]);
  155. case GGUF_TYPE_UINT32: return std::to_string(((const uint32_t *)data)[i]);
  156. case GGUF_TYPE_INT32: return std::to_string(((const int32_t *)data)[i]);
  157. case GGUF_TYPE_UINT64: return std::to_string(((const uint64_t *)data)[i]);
  158. case GGUF_TYPE_INT64: return std::to_string(((const int64_t *)data)[i]);
  159. case GGUF_TYPE_FLOAT32: return std::to_string(((const float *)data)[i]);
  160. case GGUF_TYPE_FLOAT64: return std::to_string(((const double *)data)[i]);
  161. case GGUF_TYPE_BOOL: return ((const bool *)data)[i] ? "true" : "false";
  162. default: return format("unknown type %d", type);
  163. }
  164. }
  165. static void replace_all(std::string & s, const std::string & search, const std::string & replace) {
  166. std::string result;
  167. for (size_t pos = 0; ; pos += search.length()) {
  168. auto new_pos = s.find(search, pos);
  169. if (new_pos == std::string::npos) {
  170. result += s.substr(pos, s.size() - pos);
  171. break;
  172. }
  173. result += s.substr(pos, new_pos - pos) + replace;
  174. pos = new_pos;
  175. }
  176. s = std::move(result);
  177. }
  178. static std::string gguf_kv_to_str(const struct gguf_context * ctx_gguf, int i) {
  179. const enum gguf_type type = gguf_get_kv_type(ctx_gguf, i);
  180. switch (type) {
  181. case GGUF_TYPE_STRING:
  182. return gguf_get_val_str(ctx_gguf, i);
  183. case GGUF_TYPE_ARRAY:
  184. {
  185. const enum gguf_type arr_type = gguf_get_arr_type(ctx_gguf, i);
  186. int arr_n = gguf_get_arr_n(ctx_gguf, i);
  187. const void * data = gguf_get_arr_data(ctx_gguf, i);
  188. std::stringstream ss;
  189. ss << "[";
  190. for (int j = 0; j < arr_n; j++) {
  191. if (arr_type == GGUF_TYPE_STRING) {
  192. std::string val = gguf_get_arr_str(ctx_gguf, i, j);
  193. // escape quotes
  194. replace_all(val, "\\", "\\\\");
  195. replace_all(val, "\"", "\\\"");
  196. ss << '"' << val << '"';
  197. } else if (arr_type == GGUF_TYPE_ARRAY) {
  198. ss << "???";
  199. } else {
  200. ss << gguf_data_to_str(arr_type, data, j);
  201. }
  202. if (j < arr_n - 1) {
  203. ss << ", ";
  204. }
  205. }
  206. ss << "]";
  207. return ss.str();
  208. }
  209. default:
  210. return gguf_data_to_str(type, gguf_get_val_data(ctx_gguf, i), 0);
  211. }
  212. }
  213. static void print_tensor_info(const ggml_tensor * tensor, const char * prefix = "") {
  214. size_t tensor_size = ggml_nbytes(tensor);
  215. printf("%s: n_dims = %d, name = %s, tensor_size=%zu, shape:[%" PRId64 ", %" PRId64 ", %" PRId64 ", %" PRId64 "], type = %s\n",
  216. prefix, ggml_n_dims(tensor), tensor->name, tensor_size,
  217. tensor->ne[0], tensor->ne[1], tensor->ne[2], tensor->ne[3], ggml_type_name(tensor->type));
  218. }
  219. static projector_type clip_projector_type_from_string(const std::string & name) {
  220. for (const auto & kv : PROJECTOR_TYPE_NAMES) { // NOLINT
  221. if (kv.second == name) {
  222. return kv.first;
  223. }
  224. }
  225. return PROJECTOR_TYPE_UNKNOWN;
  226. }
  227. #ifdef CLIP_DEBUG_FUNCTIONS
  228. static void clip_image_write_image_to_ppm(const clip_image_u8& img, const std::string& filename) {
  229. std::ofstream file(filename, std::ios::binary);
  230. if (!file.is_open()) {
  231. std::cerr << "Failed to open file for writing: " << filename << std::endl;
  232. return;
  233. }
  234. // PPM header: P6 format, width, height, and max color value
  235. file << "P6\n" << img.nx << " " << img.ny << "\n255\n";
  236. // Write pixel data
  237. for (size_t i = 0; i < img.buf.size(); i += 3) {
  238. // PPM expects binary data in RGB format, which matches our image buffer
  239. file.write(reinterpret_cast<const char*>(&img.buf[i]), 3);
  240. }
  241. file.close();
  242. }
  243. static void clip_image_save_to_bmp(const clip_image_u8& img, const std::string& filename) {
  244. std::ofstream file(filename, std::ios::binary);
  245. if (!file.is_open()) {
  246. std::cerr << "Failed to open file for writing: " << filename << std::endl;
  247. return;
  248. }
  249. int fileSize = 54 + 3 * img.nx * img.ny; // File header + info header + pixel data
  250. int bytesPerPixel = 3;
  251. int widthInBytes = img.nx * bytesPerPixel;
  252. int paddingAmount = (4 - (widthInBytes % 4)) % 4;
  253. int stride = widthInBytes + paddingAmount;
  254. // Bitmap file header
  255. unsigned char fileHeader[14] = {
  256. 'B','M', // Signature
  257. 0,0,0,0, // Image file size in bytes
  258. 0,0,0,0, // Reserved
  259. 54,0,0,0 // Start of pixel array
  260. };
  261. // Total file size
  262. fileSize = 54 + (stride * img.ny);
  263. fileHeader[2] = (unsigned char)(fileSize);
  264. fileHeader[3] = (unsigned char)(fileSize >> 8);
  265. fileHeader[4] = (unsigned char)(fileSize >> 16);
  266. fileHeader[5] = (unsigned char)(fileSize >> 24);
  267. // Bitmap information header (BITMAPINFOHEADER)
  268. unsigned char infoHeader[40] = {
  269. 40,0,0,0, // Size of this header (40 bytes)
  270. 0,0,0,0, // Image width
  271. 0,0,0,0, // Image height
  272. 1,0, // Number of color planes
  273. 24,0, // Bits per pixel
  274. 0,0,0,0, // No compression
  275. 0,0,0,0, // Image size (can be 0 for no compression)
  276. 0,0,0,0, // X pixels per meter (not specified)
  277. 0,0,0,0, // Y pixels per meter (not specified)
  278. 0,0,0,0, // Total colors (color table not used)
  279. 0,0,0,0 // Important colors (all are important)
  280. };
  281. // Width and height in the information header
  282. infoHeader[4] = (unsigned char)(img.nx);
  283. infoHeader[5] = (unsigned char)(img.nx >> 8);
  284. infoHeader[6] = (unsigned char)(img.nx >> 16);
  285. infoHeader[7] = (unsigned char)(img.nx >> 24);
  286. infoHeader[8] = (unsigned char)(img.ny);
  287. infoHeader[9] = (unsigned char)(img.ny >> 8);
  288. infoHeader[10] = (unsigned char)(img.ny >> 16);
  289. infoHeader[11] = (unsigned char)(img.ny >> 24);
  290. // Write file headers
  291. file.write(reinterpret_cast<char*>(fileHeader), sizeof(fileHeader));
  292. file.write(reinterpret_cast<char*>(infoHeader), sizeof(infoHeader));
  293. // Pixel data
  294. std::vector<unsigned char> padding(3, 0); // Max padding size to be added to each row
  295. for (int y = img.ny - 1; y >= 0; --y) { // BMP files are stored bottom-to-top
  296. for (int x = 0; x < img.nx; ++x) {
  297. // Each pixel
  298. size_t pixelIndex = (y * img.nx + x) * 3;
  299. unsigned char pixel[3] = {
  300. img.buf[pixelIndex + 2], // BMP stores pixels in BGR format
  301. img.buf[pixelIndex + 1],
  302. img.buf[pixelIndex]
  303. };
  304. file.write(reinterpret_cast<char*>(pixel), 3);
  305. }
  306. // Write padding for the row
  307. file.write(reinterpret_cast<char*>(padding.data()), paddingAmount);
  308. }
  309. file.close();
  310. }
  311. // debug function to convert f32 to u8
  312. static void clip_image_convert_f32_to_u8(const clip_image_f32& src, clip_image_u8& dst) {
  313. dst.nx = src.nx;
  314. dst.ny = src.ny;
  315. dst.buf.resize(3 * src.nx * src.ny);
  316. for (size_t i = 0; i < src.buf.size(); ++i) {
  317. dst.buf[i] = static_cast<uint8_t>(std::min(std::max(int(src.buf[i] * 255.0f), 0), 255));
  318. }
  319. }
  320. #endif
  321. //
  322. // clip layers
  323. //
  324. struct clip_hparams {
  325. int32_t image_size;
  326. int32_t patch_size;
  327. int32_t hidden_size;
  328. int32_t n_intermediate;
  329. int32_t projection_dim;
  330. int32_t n_head;
  331. int32_t n_layer;
  332. float eps;
  333. char mm_patch_merge_type[32] = "flat"; // spatial_unpad or flat (default)
  334. int32_t image_grid_pinpoints[32];
  335. int32_t image_crop_resolution;
  336. };
  337. struct clip_layer {
  338. // attention
  339. struct ggml_tensor * k_w;
  340. struct ggml_tensor * k_b;
  341. struct ggml_tensor * q_w;
  342. struct ggml_tensor * q_b;
  343. struct ggml_tensor * v_w;
  344. struct ggml_tensor * v_b;
  345. struct ggml_tensor * o_w;
  346. struct ggml_tensor * o_b;
  347. // layernorm 1
  348. struct ggml_tensor * ln_1_w;
  349. struct ggml_tensor * ln_1_b;
  350. // ff
  351. struct ggml_tensor * ff_i_w;
  352. struct ggml_tensor * ff_i_b;
  353. struct ggml_tensor * ff_o_w;
  354. struct ggml_tensor * ff_o_b;
  355. // layernorm 2
  356. struct ggml_tensor * ln_2_w;
  357. struct ggml_tensor * ln_2_b;
  358. };
  359. struct clip_vision_model {
  360. struct clip_hparams hparams;
  361. // embeddings
  362. struct ggml_tensor * class_embedding;
  363. struct ggml_tensor * patch_embeddings;
  364. struct ggml_tensor * position_embeddings;
  365. struct ggml_tensor * pre_ln_w;
  366. struct ggml_tensor * pre_ln_b;
  367. std::vector<clip_layer> layers;
  368. struct ggml_tensor * post_ln_w;
  369. struct ggml_tensor * post_ln_b;
  370. struct ggml_tensor * projection;
  371. // LLaVA projection
  372. struct ggml_tensor * mm_0_w = NULL;
  373. struct ggml_tensor * mm_0_b = NULL;
  374. struct ggml_tensor * mm_2_w = NULL;
  375. struct ggml_tensor * mm_2_b = NULL;
  376. struct ggml_tensor * image_newline = NULL;
  377. // Yi type models with mlp+normalization projection
  378. struct ggml_tensor * mm_1_w = NULL; // Yi type models have 0, 1, 3, 4
  379. struct ggml_tensor * mm_1_b = NULL;
  380. struct ggml_tensor * mm_3_w = NULL;
  381. struct ggml_tensor * mm_3_b = NULL;
  382. struct ggml_tensor * mm_4_w = NULL;
  383. struct ggml_tensor * mm_4_b = NULL;
  384. // MobileVLM projection
  385. struct ggml_tensor * mm_model_mlp_1_w;
  386. struct ggml_tensor * mm_model_mlp_1_b;
  387. struct ggml_tensor * mm_model_mlp_3_w;
  388. struct ggml_tensor * mm_model_mlp_3_b;
  389. struct ggml_tensor * mm_model_block_1_block_0_0_w;
  390. struct ggml_tensor * mm_model_block_1_block_0_1_w;
  391. struct ggml_tensor * mm_model_block_1_block_0_1_b;
  392. struct ggml_tensor * mm_model_block_1_block_1_fc1_w;
  393. struct ggml_tensor * mm_model_block_1_block_1_fc1_b;
  394. struct ggml_tensor * mm_model_block_1_block_1_fc2_w;
  395. struct ggml_tensor * mm_model_block_1_block_1_fc2_b;
  396. struct ggml_tensor * mm_model_block_1_block_2_0_w;
  397. struct ggml_tensor * mm_model_block_1_block_2_1_w;
  398. struct ggml_tensor * mm_model_block_1_block_2_1_b;
  399. struct ggml_tensor * mm_model_block_2_block_0_0_w;
  400. struct ggml_tensor * mm_model_block_2_block_0_1_w;
  401. struct ggml_tensor * mm_model_block_2_block_0_1_b;
  402. struct ggml_tensor * mm_model_block_2_block_1_fc1_w;
  403. struct ggml_tensor * mm_model_block_2_block_1_fc1_b;
  404. struct ggml_tensor * mm_model_block_2_block_1_fc2_w;
  405. struct ggml_tensor * mm_model_block_2_block_1_fc2_b;
  406. struct ggml_tensor * mm_model_block_2_block_2_0_w;
  407. struct ggml_tensor * mm_model_block_2_block_2_1_w;
  408. struct ggml_tensor * mm_model_block_2_block_2_1_b;
  409. // MobileVLM_V2 projection
  410. struct ggml_tensor * mm_model_mlp_0_w;
  411. struct ggml_tensor * mm_model_mlp_0_b;
  412. struct ggml_tensor * mm_model_mlp_2_w;
  413. struct ggml_tensor * mm_model_mlp_2_b;
  414. struct ggml_tensor * mm_model_peg_0_w;
  415. struct ggml_tensor * mm_model_peg_0_b;
  416. };
  417. struct clip_ctx {
  418. bool has_text_encoder = false;
  419. bool has_vision_encoder = false;
  420. bool has_llava_projector = false;
  421. struct clip_vision_model vision_model;
  422. projector_type proj_type = PROJECTOR_TYPE_MLP;
  423. float image_mean[3];
  424. float image_std[3];
  425. bool use_gelu = false;
  426. int32_t ftype = 1;
  427. struct gguf_context * ctx_gguf;
  428. struct ggml_context * ctx_data;
  429. std::vector<uint8_t> buf_compute_meta;
  430. // memory buffers to evaluate the model
  431. ggml_backend_buffer_t params_buffer = NULL;
  432. ggml_backend_t backend = NULL;
  433. ggml_gallocr_t compute_alloc = NULL;
  434. };
  435. static ggml_cgraph * clip_image_build_graph(clip_ctx * ctx, const clip_image_f32_batch * imgs) {
  436. if (!ctx->has_vision_encoder) {
  437. printf("This gguf file seems to have no vision encoder\n");
  438. return nullptr;
  439. }
  440. const auto & model = ctx->vision_model;
  441. const auto & hparams = model.hparams;
  442. const int image_size = hparams.image_size;
  443. const int patch_size = hparams.patch_size;
  444. const int num_patches = ((image_size / patch_size) * (image_size / patch_size));
  445. const int num_patches_per_side = image_size / patch_size; GGML_UNUSED(num_patches_per_side);
  446. const int num_positions = num_patches + 1;
  447. const int hidden_size = hparams.hidden_size;
  448. const int n_head = hparams.n_head;
  449. const int d_head = hidden_size / n_head;
  450. const int n_layer = hparams.n_layer;
  451. const float eps = hparams.eps;
  452. const int batch_size = imgs->size;
  453. if (ctx->has_llava_projector) {
  454. GGML_ASSERT(batch_size == 1);
  455. }
  456. struct ggml_init_params params = {
  457. /*.mem_size =*/ ctx->buf_compute_meta.size(),
  458. /*.mem_buffer =*/ ctx->buf_compute_meta.data(),
  459. /*.no_alloc =*/ true,
  460. };
  461. struct ggml_context * ctx0 = ggml_init(params);
  462. struct ggml_cgraph * gf = ggml_new_graph(ctx0);
  463. struct ggml_tensor * inp_raw = ggml_new_tensor_4d(ctx0, GGML_TYPE_F32, image_size, image_size, 3, batch_size);
  464. ggml_set_name(inp_raw, "inp_raw");
  465. ggml_set_input(inp_raw);
  466. struct ggml_tensor * inp = ggml_conv_2d(ctx0, model.patch_embeddings, inp_raw, patch_size, patch_size, 0, 0, 1, 1);
  467. inp = ggml_reshape_3d(ctx0, inp, num_patches, hidden_size, batch_size);
  468. inp = ggml_cont(ctx0, ggml_permute(ctx0, inp, 1, 0, 2, 3));
  469. // concat class_embeddings and patch_embeddings
  470. struct ggml_tensor * embeddings = ggml_new_tensor_3d(ctx0, GGML_TYPE_F32, hidden_size, num_positions, batch_size);
  471. ggml_set_name(embeddings, "embeddings");
  472. ggml_set_input(embeddings);
  473. embeddings = ggml_acc(ctx0, embeddings, model.class_embedding,
  474. embeddings->nb[1], embeddings->nb[2], embeddings->nb[3], 0);
  475. embeddings = ggml_acc(ctx0, embeddings, inp,
  476. embeddings->nb[1], embeddings->nb[2], embeddings->nb[3], model.class_embedding->nb[1]);
  477. struct ggml_tensor * positions = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, num_positions);
  478. ggml_set_name(positions, "positions");
  479. ggml_set_input(positions);
  480. embeddings =
  481. ggml_add(ctx0, embeddings, ggml_get_rows(ctx0, model.position_embeddings, positions));
  482. // pre-layernorm
  483. {
  484. embeddings = ggml_norm(ctx0, embeddings, eps);
  485. ggml_set_name(embeddings, "pre_ln");
  486. embeddings = ggml_add(ctx0, ggml_mul(ctx0, embeddings, model.pre_ln_w), model.pre_ln_b);
  487. }
  488. // loop over layers
  489. for (int il = 0; il < n_layer - 1; il++) {
  490. struct ggml_tensor * cur = embeddings; // embeddings = residual, cur = hidden_states
  491. //const size_t nb_q_w = model.layers[il].q_w->nb[0];
  492. // layernorm1
  493. {
  494. cur = ggml_norm(ctx0, cur, eps);
  495. cur = ggml_add(ctx0, ggml_mul(ctx0, cur, model.layers[il].ln_1_w),
  496. model.layers[il].ln_1_b);
  497. }
  498. // self-attention
  499. {
  500. struct ggml_tensor * Q =
  501. ggml_add(ctx0, ggml_mul_mat(ctx0, model.layers[il].q_w, cur), model.layers[il].q_b);
  502. Q = ggml_scale_inplace(ctx0, Q, 1.0f / sqrt((float)d_head));
  503. Q = ggml_reshape_4d(ctx0, Q, d_head, n_head, num_positions, batch_size);
  504. Q = ggml_cont(ctx0, ggml_permute(ctx0, Q, 0, 2, 1, 3));
  505. Q = ggml_reshape_3d(ctx0, Q, d_head, num_positions, n_head * batch_size);
  506. struct ggml_tensor * K =
  507. ggml_add(ctx0, ggml_mul_mat(ctx0, model.layers[il].k_w, cur), model.layers[il].k_b);
  508. K = ggml_reshape_4d(ctx0, K, d_head, n_head, num_positions, batch_size);
  509. K = ggml_cont(ctx0, ggml_permute(ctx0, K, 0, 2, 1, 3));
  510. K = ggml_reshape_3d(ctx0, K, d_head, num_positions, n_head * batch_size);
  511. struct ggml_tensor * V =
  512. ggml_add(ctx0, ggml_mul_mat(ctx0, model.layers[il].v_w, cur), model.layers[il].v_b);
  513. V = ggml_reshape_4d(ctx0, V, d_head, n_head, num_positions, batch_size);
  514. V = ggml_cont(ctx0, ggml_permute(ctx0, V, 1, 2, 0, 3));
  515. V = ggml_reshape_3d(ctx0, V, num_positions, d_head, n_head * batch_size);
  516. struct ggml_tensor * KQ = ggml_mul_mat(ctx0, K, Q);
  517. KQ = ggml_soft_max_inplace(ctx0, KQ);
  518. struct ggml_tensor * KQV = ggml_mul_mat(ctx0, V, KQ);
  519. KQV = ggml_reshape_4d(ctx0, KQV, d_head, num_positions, n_head, batch_size);
  520. KQV = ggml_permute(ctx0, KQV, 0, 2, 1, 3);
  521. cur = ggml_cont_3d(ctx0, KQV, hidden_size, num_positions, batch_size);
  522. }
  523. // attention output
  524. cur = ggml_add(ctx0, ggml_mul_mat(ctx0, model.layers[il].o_w, cur), model.layers[il].o_b);
  525. // re-add the layer input, e.g., residual
  526. cur = ggml_add(ctx0, cur, embeddings);
  527. embeddings = cur; // embeddings = residual, cur = hidden_states
  528. // layernorm2
  529. {
  530. cur = ggml_norm(ctx0, cur, eps);
  531. cur = ggml_add(ctx0, ggml_mul(ctx0, cur, model.layers[il].ln_2_w), model.layers[il].ln_2_b);
  532. }
  533. cur = ggml_mul_mat(ctx0, model.layers[il].ff_i_w, cur);
  534. cur = ggml_add(ctx0, cur, model.layers[il].ff_i_b);
  535. if (ctx->use_gelu) {
  536. cur = ggml_gelu_inplace(ctx0, cur);
  537. } else {
  538. cur = ggml_gelu_quick_inplace(ctx0, cur);
  539. }
  540. cur = ggml_mul_mat(ctx0, model.layers[il].ff_o_w, cur);
  541. cur = ggml_add(ctx0, cur, model.layers[il].ff_o_b);
  542. // residual 2
  543. cur = ggml_add(ctx0, embeddings, cur);
  544. embeddings = cur;
  545. }
  546. // llava projector
  547. {
  548. embeddings = ggml_reshape_2d(ctx0, embeddings, embeddings->ne[0], embeddings->ne[1]);
  549. struct ggml_tensor * patches = ggml_new_tensor_1d(ctx0, GGML_TYPE_I32, num_patches);
  550. ggml_set_name(patches, "patches");
  551. ggml_set_input(patches);
  552. // shape [1, 576, 1024]
  553. // ne is whcn, ne = [1024, 576, 1, 1]
  554. embeddings = ggml_get_rows(ctx0, embeddings, patches);
  555. // print_tensor_info(embeddings, "embeddings");
  556. // llava projector
  557. if (ctx->proj_type == PROJECTOR_TYPE_MLP) {
  558. embeddings = ggml_mul_mat(ctx0, model.mm_0_w, embeddings);
  559. embeddings = ggml_add(ctx0, embeddings, model.mm_0_b);
  560. embeddings = ggml_gelu(ctx0, embeddings);
  561. embeddings = ggml_mul_mat(ctx0, model.mm_2_w, embeddings);
  562. embeddings = ggml_add(ctx0, embeddings, model.mm_2_b);
  563. } else if (ctx->proj_type == PROJECTOR_TYPE_MLP_NORM) {
  564. embeddings = ggml_mul_mat(ctx0, model.mm_0_w, embeddings);
  565. embeddings = ggml_add(ctx0, embeddings, model.mm_0_b);
  566. // ggml_tensor_printf(embeddings, "mm_0_w",0,true,false);
  567. // First LayerNorm
  568. embeddings = ggml_norm(ctx0, embeddings, eps);
  569. embeddings = ggml_add(ctx0, ggml_mul(ctx0, embeddings, model.mm_1_w),
  570. model.mm_1_b);
  571. // GELU activation
  572. embeddings = ggml_gelu(ctx0, embeddings);
  573. // Second linear layer
  574. embeddings = ggml_mul_mat(ctx0, model.mm_3_w, embeddings);
  575. embeddings = ggml_add(ctx0, embeddings, model.mm_3_b);
  576. // Second LayerNorm
  577. embeddings = ggml_norm(ctx0, embeddings, eps);
  578. embeddings = ggml_add(ctx0, ggml_mul(ctx0, embeddings, model.mm_4_w),
  579. model.mm_4_b);
  580. }
  581. else if (ctx->proj_type == PROJECTOR_TYPE_LDP) {
  582. // MobileVLM projector
  583. int n_patch = 24;
  584. struct ggml_tensor * mlp_1 = ggml_mul_mat(ctx0, model.mm_model_mlp_1_w, embeddings);
  585. mlp_1 = ggml_add(ctx0, mlp_1, model.mm_model_mlp_1_b);
  586. mlp_1 = ggml_gelu(ctx0, mlp_1);
  587. struct ggml_tensor * mlp_3 = ggml_mul_mat(ctx0, model.mm_model_mlp_3_w, mlp_1);
  588. mlp_3 = ggml_add(ctx0, mlp_3, model.mm_model_mlp_3_b);
  589. // mlp_3 shape = [1, 576, 2048], ne = [2048, 576, 1, 1]
  590. // block 1
  591. struct ggml_tensor * block_1 = nullptr;
  592. {
  593. // transpose from [1, 576, 2048] --> [1, 2048, 576] --> [1, 2048, 24, 24]
  594. mlp_3 = ggml_cont(ctx0, ggml_permute(ctx0, mlp_3, 1, 0, 2, 3));
  595. mlp_3 = ggml_reshape_4d(ctx0, mlp_3, n_patch, n_patch, mlp_3->ne[1], mlp_3->ne[2]);
  596. // stride = 1, padding = 1, bias is nullptr
  597. block_1 = ggml_conv_depthwise_2d(ctx0, model.mm_model_block_1_block_0_0_w, mlp_3, 1, 1, 1, 1, 1, 1);
  598. // layer norm
  599. // // block_1 shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1]
  600. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 2, 0, 3));
  601. // block_1 shape = [1, 24, 24, 2048], ne = [2048, 24, 24, 1]
  602. block_1 = ggml_norm(ctx0, block_1, eps);
  603. 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);
  604. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 2, 0, 1, 3));
  605. // block_1 shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1]
  606. // hardswish
  607. struct ggml_tensor * block_1_hw = ggml_hardswish(ctx0, block_1);
  608. 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);
  609. // block_1 shape = [1, 2048, 1, 1], ne = [1, 1, 2048, 1]
  610. // pointwise conv
  611. block_1 = ggml_reshape_2d(ctx0, block_1, block_1->ne[0]*block_1->ne[1]*block_1->ne[2], block_1->ne[3]);
  612. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_1_block_1_fc1_w, block_1);
  613. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_1_block_1_fc1_b);
  614. block_1 = ggml_relu(ctx0, block_1);
  615. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_1_block_1_fc2_w, block_1);
  616. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_1_block_1_fc2_b);
  617. block_1 = ggml_hardsigmoid(ctx0, block_1);
  618. // block_1_hw shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1], block_1 shape = [1, 2048], ne = [2048, 1, 1, 1]
  619. block_1 = ggml_reshape_4d(ctx0, block_1, 1, 1, block_1->ne[0], block_1->ne[1]);
  620. block_1 = ggml_mul(ctx0, block_1_hw, block_1);
  621. int w = block_1->ne[0], h = block_1->ne[1];
  622. block_1 = ggml_reshape_3d(ctx0, block_1, w*h, block_1->ne[2], block_1->ne[3]);
  623. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 0, 2, 3));
  624. // block_1 shape = [1, 24*24, 2048], ne = [24*24, 2048, 1]
  625. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_1_block_2_0_w, block_1);
  626. block_1 = ggml_reshape_4d(ctx0, block_1, block_1->ne[0], w, h, block_1->ne[3]);
  627. // block_1 shape = [1, 24, 24, 2048], ne = [2048, 24, 24, 1]
  628. block_1 = ggml_norm(ctx0, block_1, eps);
  629. 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);
  630. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 2, 0, 1, 3));
  631. // block1 shape = [1, 2048, 24, 24], ne = [24, 24, 2048, 1]
  632. // residual
  633. block_1 = ggml_add(ctx0, mlp_3, block_1);
  634. }
  635. // block_2
  636. {
  637. // stride = 2
  638. block_1 = ggml_conv_depthwise_2d(ctx0, model.mm_model_block_2_block_0_0_w, block_1, 2, 2, 1, 1, 1, 1);
  639. // block_1 shape = [1, 2048, 12, 12], ne = [12, 12, 2048, 1]
  640. // layer norm
  641. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 2, 0, 3));
  642. // block_1 shape = [1, 12, 12, 2048], ne = [2048, 12, 12, 1]
  643. block_1 = ggml_norm(ctx0, block_1, eps);
  644. 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);
  645. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 2, 0, 1, 3));
  646. // block_1 shape = [1, 2048, 12, 12], ne = [12, 12, 2048, 1]
  647. // hardswish
  648. struct ggml_tensor * block_1_hw = ggml_hardswish(ctx0, block_1);
  649. // not sure the parameters is right for globalAvgPooling
  650. 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);
  651. // block_1 shape = [1, 2048, 1, 1], ne = [1, 1, 2048, 1]
  652. // pointwise conv
  653. block_1 = ggml_reshape_2d(ctx0, block_1, block_1->ne[0]*block_1->ne[1]*block_1->ne[2], block_1->ne[3]);
  654. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_2_block_1_fc1_w, block_1);
  655. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_2_block_1_fc1_b);
  656. block_1 = ggml_relu(ctx0, block_1);
  657. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_2_block_1_fc2_w, block_1);
  658. block_1 = ggml_add(ctx0, block_1, model.mm_model_block_2_block_1_fc2_b);
  659. block_1 = ggml_hardsigmoid(ctx0, block_1);
  660. // 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]
  661. block_1 = ggml_reshape_4d(ctx0, block_1, 1, 1, block_1->ne[0], block_1->ne[1]);
  662. block_1 = ggml_mul(ctx0, block_1_hw, block_1);
  663. int w = block_1->ne[0], h = block_1->ne[1];
  664. block_1 = ggml_reshape_3d(ctx0, block_1, w*h, block_1->ne[2], block_1->ne[3]);
  665. block_1 = ggml_cont(ctx0, ggml_permute(ctx0, block_1, 1, 0, 2, 3));
  666. // block_1 shape = [1, 24*24, 2048], ne = [24*24, 2048, 1]
  667. block_1 = ggml_mul_mat(ctx0, model.mm_model_block_2_block_2_0_w, block_1);
  668. block_1 = ggml_reshape_4d(ctx0, block_1, block_1->ne[0], w, h, block_1->ne[3]);
  669. // block_1 shape = [1, 12, 12, 2048], ne = [2048, 12, 12, 1]
  670. block_1 = ggml_norm(ctx0, block_1, eps);
  671. 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);
  672. block_1 = ggml_reshape_3d(ctx0, block_1, block_1->ne[0], block_1->ne[1] * block_1->ne[2], block_1->ne[3]);
  673. // block_1 shape = [1, 144, 2048], ne = [2048, 144, 1]
  674. }
  675. embeddings = block_1;
  676. }
  677. else if (ctx->proj_type == PROJECTOR_TYPE_LDPV2)
  678. {
  679. int n_patch = 24;
  680. struct ggml_tensor * mlp_0 = ggml_mul_mat(ctx0, model.mm_model_mlp_0_w, embeddings);
  681. mlp_0 = ggml_add(ctx0, mlp_0, model.mm_model_mlp_0_b);
  682. mlp_0 = ggml_gelu(ctx0, mlp_0);
  683. struct ggml_tensor * mlp_2 = ggml_mul_mat(ctx0, model.mm_model_mlp_2_w, mlp_0);
  684. mlp_2 = ggml_add(ctx0, mlp_2, model.mm_model_mlp_2_b);
  685. // mlp_2 ne = [2048, 576, 1, 1]
  686. // // AVG Pool Layer 2*2, strides = 2
  687. mlp_2 = ggml_cont(ctx0, ggml_permute(ctx0, mlp_2, 1, 0, 2, 3));
  688. // mlp_2 ne = [576, 2048, 1, 1]
  689. mlp_2 = ggml_reshape_4d(ctx0, mlp_2, n_patch, n_patch, mlp_2->ne[1], mlp_2->ne[2]);
  690. // mlp_2 ne [24, 24, 2048, 1]
  691. mlp_2 = ggml_pool_2d(ctx0, mlp_2, GGML_OP_POOL_AVG, 2, 2, 2, 2, 0, 0);
  692. // weight ne = [3, 3, 2048, 1]
  693. struct ggml_tensor * peg_0 = ggml_conv_depthwise_2d(ctx0, model.mm_model_peg_0_w, mlp_2, 1, 1, 1, 1, 1, 1);
  694. peg_0 = ggml_add(ctx0, peg_0, mlp_2);
  695. peg_0 = ggml_cont(ctx0, ggml_permute(ctx0, peg_0, 1, 2, 0, 3));
  696. peg_0 = ggml_add(ctx0, peg_0, model.mm_model_peg_0_b);
  697. peg_0 = ggml_reshape_3d(ctx0, peg_0, peg_0->ne[0], peg_0->ne[1] * peg_0->ne[2], peg_0->ne[3]);
  698. embeddings = peg_0;
  699. }
  700. else {
  701. GGML_ASSERT(false);
  702. }
  703. }
  704. // build the graph
  705. ggml_build_forward_expand(gf, embeddings);
  706. ggml_free(ctx0);
  707. return gf;
  708. }
  709. // read and create ggml_context containing the tensors and their data
  710. struct clip_ctx * clip_model_load(const char * fname, const int verbosity = 1) {
  711. struct ggml_context * meta = NULL;
  712. struct gguf_init_params params = {
  713. /*.no_alloc = */ true,
  714. /*.ctx = */ &meta,
  715. };
  716. struct gguf_context * ctx = gguf_init_from_file(fname, params);
  717. if (!ctx) {
  718. throw std::runtime_error(format("%s: failed to load CLIP model from %s. Does this file exist?\n", __func__, fname));
  719. }
  720. if (verbosity >= 1) {
  721. const int n_tensors = gguf_get_n_tensors(ctx);
  722. const int n_kv = gguf_get_n_kv(ctx);
  723. const int ftype = get_u32(ctx, KEY_FTYPE);
  724. const std::string ftype_str = get_ftype(ftype);
  725. const int idx_desc = get_key_idx(ctx, KEY_DESCRIPTION);
  726. const std::string description = gguf_get_val_str(ctx, idx_desc);
  727. const int idx_name = gguf_find_key(ctx, KEY_NAME);
  728. if (idx_name != -1) { // make name optional temporarily as some of the uploaded models missing it due to a bug
  729. const std::string name = gguf_get_val_str(ctx, idx_name);
  730. printf("%s: model name: %s\n", __func__, name.c_str());
  731. }
  732. printf("%s: description: %s\n", __func__, description.c_str());
  733. printf("%s: GGUF version: %d\n", __func__, gguf_get_version(ctx));
  734. printf("%s: alignment: %zu\n", __func__, gguf_get_alignment(ctx));
  735. printf("%s: n_tensors: %d\n", __func__, n_tensors);
  736. printf("%s: n_kv: %d\n", __func__, n_kv);
  737. printf("%s: ftype: %s\n", __func__, ftype_str.c_str());
  738. printf("\n");
  739. }
  740. const int n_tensors = gguf_get_n_tensors(ctx);
  741. // kv
  742. const int n_kv = gguf_get_n_kv(ctx);
  743. printf("%s: loaded meta data with %d key-value pairs and %d tensors from %s\n",
  744. __func__, n_kv, n_tensors, fname);
  745. {
  746. std::map<enum ggml_type, uint32_t> n_type;
  747. for (int i = 0; i < n_tensors; i++) {
  748. enum ggml_type type = gguf_get_tensor_type(ctx, i);
  749. n_type[type]++;
  750. }
  751. printf("%s: Dumping metadata keys/values. Note: KV overrides do not apply in this output.\n", __func__);
  752. for (int i = 0; i < n_kv; i++) {
  753. const char * name = gguf_get_key(ctx, i);
  754. const enum gguf_type type = gguf_get_kv_type(ctx, i);
  755. const std::string type_name =
  756. type == GGUF_TYPE_ARRAY
  757. ? format("%s[%s,%d]", gguf_type_name(type), gguf_type_name(gguf_get_arr_type(ctx, i)), gguf_get_arr_n(ctx, i))
  758. : gguf_type_name(type);
  759. std::string value = gguf_kv_to_str(ctx, i);
  760. const size_t MAX_VALUE_LEN = 40;
  761. if (value.size() > MAX_VALUE_LEN) {
  762. value = format("%s...", value.substr(0, MAX_VALUE_LEN - 3).c_str());
  763. }
  764. replace_all(value, "\n", "\\n");
  765. printf("%s: - kv %3d: %42s %-16s = %s\n", __func__, i, name, type_name.c_str(), value.c_str());
  766. }
  767. // print type counts
  768. for (auto & kv : n_type) {
  769. if (kv.second == 0) {
  770. continue;
  771. }
  772. printf("%s: - type %4s: %4d tensors\n", __func__, ggml_type_name(kv.first), kv.second);
  773. }
  774. }
  775. // data
  776. size_t model_size = 0;
  777. {
  778. for (int i = 0; i < n_tensors; ++i) {
  779. const char * name = gguf_get_tensor_name(ctx, i);
  780. const size_t offset = gguf_get_tensor_offset(ctx, i);
  781. enum ggml_type type = gguf_get_tensor_type(ctx, i);
  782. struct ggml_tensor * cur = ggml_get_tensor(meta, name);
  783. size_t tensor_size = ggml_nbytes(cur);
  784. model_size += tensor_size;
  785. if (verbosity >= 3) {
  786. printf("%s: tensor[%d]: n_dims = %d, name = %s, tensor_size=%zu, offset=%zu, shape:[%" PRIu64 ", %" PRIu64 ", %" PRIu64 ", %" PRIu64 "], type = %s\n",
  787. __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));
  788. }
  789. }
  790. }
  791. clip_ctx * new_clip = new clip_ctx;
  792. // update projector type
  793. {
  794. int idx = gguf_find_key(ctx, KEY_PROJ_TYPE);
  795. if (idx != -1) {
  796. const std::string proj_type = gguf_get_val_str(ctx, idx);
  797. new_clip->proj_type = clip_projector_type_from_string(proj_type);
  798. } else {
  799. new_clip->proj_type = PROJECTOR_TYPE_MLP;
  800. }
  801. if (new_clip->proj_type == PROJECTOR_TYPE_MLP) {
  802. if (gguf_find_tensor(ctx, format(TN_LLAVA_PROJ, 3, "weight").c_str()) != -1) {
  803. new_clip->proj_type = PROJECTOR_TYPE_MLP_NORM;
  804. }
  805. }
  806. }
  807. #ifdef GGML_USE_CUDA
  808. new_clip->backend = ggml_backend_cuda_init(0);
  809. printf("%s: CLIP using CUDA backend\n", __func__);
  810. #endif
  811. #ifdef GGML_USE_METAL
  812. new_clip->backend = ggml_backend_metal_init();
  813. printf("%s: CLIP using Metal backend\n", __func__);
  814. #endif
  815. if (!new_clip->backend) {
  816. new_clip->backend = ggml_backend_cpu_init();
  817. printf("%s: CLIP using CPU backend\n", __func__);
  818. }
  819. // model size and capabilities
  820. {
  821. int idx = get_key_idx(ctx, KEY_HAS_TEXT_ENC);
  822. new_clip->has_text_encoder = gguf_get_val_bool(ctx, idx);
  823. idx = get_key_idx(ctx, KEY_HAS_VIS_ENC);
  824. new_clip->has_vision_encoder = gguf_get_val_bool(ctx, idx);
  825. idx = gguf_find_key(ctx, KEY_HAS_LLAVA_PROJ);
  826. if (idx != -1) {
  827. new_clip->has_llava_projector = gguf_get_val_bool(ctx, idx);
  828. }
  829. GGML_ASSERT(new_clip->has_llava_projector); // see monatis/clip.cpp for image and/or text encoding for semantic search
  830. GGML_ASSERT(new_clip->has_vision_encoder);
  831. GGML_ASSERT(!new_clip->has_text_encoder);
  832. idx = get_key_idx(ctx, KEY_USE_GELU);
  833. new_clip->use_gelu = gguf_get_val_bool(ctx, idx);
  834. if (verbosity >= 1) {
  835. printf("%s: text_encoder: %d\n", __func__, new_clip->has_text_encoder);
  836. printf("%s: vision_encoder: %d\n", __func__, new_clip->has_vision_encoder);
  837. printf("%s: llava_projector: %d\n", __func__, new_clip->has_llava_projector);
  838. printf("%s: model size: %.2f MB\n", __func__, model_size / 1024.0 / 1024.0);
  839. printf("%s: metadata size: %.2f MB\n", __func__, ggml_get_mem_size(meta) / 1024.0 / 1024.0);
  840. }
  841. }
  842. printf("%s: params backend buffer size = % 6.2f MB (%i tensors)\n", __func__, model_size / (1024.0 * 1024.0), n_tensors);
  843. // load tensors
  844. {
  845. std::vector<uint8_t> read_buf;
  846. struct ggml_init_params params = {
  847. /*.mem_size =*/ (n_tensors + 1) * ggml_tensor_overhead(),
  848. /*.mem_buffer =*/ NULL,
  849. /*.no_alloc =*/ true,
  850. };
  851. new_clip->ctx_data = ggml_init(params);
  852. if (!new_clip->ctx_data) {
  853. fprintf(stderr, "%s: ggml_init() failed\n", __func__);
  854. clip_free(new_clip);
  855. gguf_free(ctx);
  856. return nullptr;
  857. }
  858. auto fin = std::ifstream(fname, std::ios::binary);
  859. if (!fin) {
  860. printf("cannot open model file for loading tensors\n");
  861. clip_free(new_clip);
  862. gguf_free(ctx);
  863. return nullptr;
  864. }
  865. // add tensors to context
  866. for (int i = 0; i < n_tensors; ++i) {
  867. const char * name = gguf_get_tensor_name(ctx, i);
  868. struct ggml_tensor * t = ggml_get_tensor(meta, name);
  869. struct ggml_tensor * cur = ggml_dup_tensor(new_clip->ctx_data, t);
  870. ggml_set_name(cur, name);
  871. }
  872. // alloc memory and offload data
  873. new_clip->params_buffer = ggml_backend_alloc_ctx_tensors(new_clip->ctx_data, new_clip->backend);
  874. for (int i = 0; i < n_tensors; ++i) {
  875. const char * name = gguf_get_tensor_name(ctx, i);
  876. struct ggml_tensor * cur = ggml_get_tensor(new_clip->ctx_data, name);
  877. const size_t offset = gguf_get_data_offset(ctx) + gguf_get_tensor_offset(ctx, i);
  878. fin.seekg(offset, std::ios::beg);
  879. if (!fin) {
  880. printf("%s: failed to seek for tensor %s\n", __func__, name);
  881. clip_free(new_clip);
  882. gguf_free(ctx);
  883. return nullptr;
  884. }
  885. int num_bytes = ggml_nbytes(cur);
  886. if (ggml_backend_buffer_is_host(new_clip->params_buffer)) {
  887. // for the CPU and Metal backend, we can read directly into the tensor
  888. fin.read(reinterpret_cast<char *>(cur->data), num_bytes);
  889. } else {
  890. // read into a temporary buffer first, then copy to device memory
  891. read_buf.resize(num_bytes);
  892. fin.read(reinterpret_cast<char *>(read_buf.data()), num_bytes);
  893. ggml_backend_tensor_set(cur, read_buf.data(), 0, num_bytes);
  894. }
  895. }
  896. fin.close();
  897. }
  898. // vision model
  899. if (new_clip->has_vision_encoder) {
  900. // load vision model
  901. auto & vision_model = new_clip->vision_model;
  902. auto & hparams = vision_model.hparams;
  903. hparams.hidden_size = get_u32(ctx, format(KEY_N_EMBD, "vision"));
  904. hparams.n_head = get_u32(ctx, format(KEY_N_HEAD, "vision"));
  905. hparams.n_intermediate = get_u32(ctx, format(KEY_N_FF, "vision"));
  906. hparams.n_layer = get_u32(ctx, format(KEY_N_BLOCK, "vision"));
  907. hparams.image_size = get_u32(ctx, KEY_IMAGE_SIZE);
  908. hparams.patch_size = get_u32(ctx, KEY_PATCH_SIZE);
  909. hparams.projection_dim = get_u32(ctx, format(KEY_PROJ_DIM, "vision"));
  910. hparams.eps = get_f32(ctx, format(KEY_LAYER_NORM_EPS, "vision"));
  911. try {
  912. int idx = get_key_idx(ctx, KEY_IMAGE_GRID_PINPOINTS);
  913. int n = gguf_get_arr_n(ctx, idx);
  914. const int32_t * pinpoints = (const int32_t *)gguf_get_arr_data(ctx, idx);
  915. for (int i = 0; i < 32 && i < n && pinpoints[i] != 0; ++i) {
  916. hparams.image_grid_pinpoints[i] = pinpoints[i];
  917. }
  918. if (n < 32)
  919. hparams.image_grid_pinpoints[n] = 0;
  920. } catch (std::runtime_error & e) {
  921. hparams.image_grid_pinpoints[0]=0;
  922. }
  923. try {
  924. int idx = get_key_idx(ctx, KEY_MM_PATCH_MERGE_TYPE);
  925. strcpy(hparams.mm_patch_merge_type, gguf_get_val_str(ctx, idx));
  926. } catch (std::runtime_error & e) {
  927. strcpy(hparams.mm_patch_merge_type, "flat");
  928. }
  929. try {
  930. hparams.image_crop_resolution = get_u32(ctx, KEY_IMAGE_CROP_RESOLUTION); // llava-1.6
  931. } catch(const std::exception& e) {
  932. hparams.image_crop_resolution = hparams.image_size;
  933. }
  934. int idx_mean = get_key_idx(ctx, KEY_IMAGE_MEAN);
  935. int idx_std = get_key_idx(ctx, KEY_IMAGE_STD);
  936. const float * mean_data = (const float *)gguf_get_arr_data(ctx, idx_mean);
  937. const float * std_data = (const float *)gguf_get_arr_data(ctx, idx_std);
  938. for (int i = 0; i < 3; ++i) {
  939. new_clip->image_mean[i] = mean_data[i];
  940. new_clip->image_std[i] = std_data[i];
  941. }
  942. if (verbosity >= 2) {
  943. printf("\n%s: vision model hparams\n", __func__);
  944. printf("image_size %d\n", hparams.image_size);
  945. printf("patch_size %d\n", hparams.patch_size);
  946. printf("v_hidden_size %d\n", hparams.hidden_size);
  947. printf("v_n_intermediate %d\n", hparams.n_intermediate);
  948. printf("v_projection_dim %d\n", hparams.projection_dim);
  949. printf("v_n_head %d\n", hparams.n_head);
  950. printf("v_n_layer %d\n", hparams.n_layer);
  951. printf("v_eps %f\n", hparams.eps);
  952. printf("v_image_mean %f %f %f\n", new_clip->image_mean[0], new_clip->image_mean[1], new_clip->image_mean[2]);
  953. printf("v_image_std %f %f %f\n", new_clip->image_std[0], new_clip->image_std[1], new_clip->image_std[2]);
  954. printf("v_image_grid_pinpoints: ");
  955. for (int i = 0; i < 32 && (hparams.image_grid_pinpoints[i] != 0); ++i) {
  956. printf("%d ", hparams.image_grid_pinpoints[i]);
  957. }
  958. printf("\n");
  959. printf("v_mm_patch_merge_type: %s\n", hparams.mm_patch_merge_type);
  960. }
  961. try {
  962. vision_model.patch_embeddings = get_tensor(new_clip->ctx_data, TN_PATCH_EMBD);
  963. vision_model.class_embedding = get_tensor(new_clip->ctx_data, TN_CLASS_EMBD);
  964. vision_model.position_embeddings = get_tensor(new_clip->ctx_data, format(TN_POS_EMBD, "v"));
  965. vision_model.pre_ln_w = get_tensor(new_clip->ctx_data, format(TN_LN_PRE, "v", "weight"));
  966. vision_model.pre_ln_b = get_tensor(new_clip->ctx_data, format(TN_LN_PRE, "v", "bias"));
  967. } catch(const std::exception& e) {
  968. fprintf(stderr, "%s: failed to load vision model tensors\n", __func__);
  969. }
  970. // LLaVA projection
  971. if (new_clip->proj_type == PROJECTOR_TYPE_MLP || new_clip->proj_type == PROJECTOR_TYPE_MLP_NORM) {
  972. vision_model.mm_0_w = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 0, "weight"));
  973. vision_model.mm_0_b = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 0, "bias"));
  974. try {
  975. // Yi-type llava
  976. vision_model.mm_1_w = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 1, "weight"));
  977. vision_model.mm_1_b = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 1, "bias"));
  978. } catch (std::runtime_error & e) { }
  979. try {
  980. // missing in Yi-type llava
  981. vision_model.mm_2_w = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 2, "weight"));
  982. vision_model.mm_2_b = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 2, "bias"));
  983. } catch (std::runtime_error & e) { }
  984. try {
  985. // Yi-type llava
  986. vision_model.mm_3_w = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 3, "weight"));
  987. vision_model.mm_3_b = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 3, "bias"));
  988. } catch (std::runtime_error & e) { }
  989. try {
  990. // Yi-type llava
  991. vision_model.mm_4_w = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 4, "weight"));
  992. vision_model.mm_4_b = get_tensor(new_clip->ctx_data, format(TN_LLAVA_PROJ, 4, "bias"));
  993. } catch (std::runtime_error & e) { }
  994. try {
  995. vision_model.image_newline = get_tensor(new_clip->ctx_data, TN_IMAGE_NEWLINE);
  996. // fprintf(stderr, "%s: image_newline tensor (llava-1.6) found\n", __func__);
  997. } catch (std::runtime_error & e) { }
  998. } else if (new_clip->proj_type == PROJECTOR_TYPE_LDP) {
  999. // MobileVLM projection
  1000. vision_model.mm_model_mlp_1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 1, "weight"));
  1001. vision_model.mm_model_mlp_1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 1, "bias"));
  1002. vision_model.mm_model_mlp_3_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 3, "weight"));
  1003. vision_model.mm_model_mlp_3_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 3, "bias"));
  1004. vision_model.mm_model_block_1_block_0_0_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 0, "0.weight"));
  1005. vision_model.mm_model_block_1_block_0_1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 0, "1.weight"));
  1006. vision_model.mm_model_block_1_block_0_1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 0, "1.bias"));
  1007. vision_model.mm_model_block_1_block_1_fc1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc1.weight"));
  1008. vision_model.mm_model_block_1_block_1_fc1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc1.bias"));
  1009. vision_model.mm_model_block_1_block_1_fc2_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc2.weight"));
  1010. vision_model.mm_model_block_1_block_1_fc2_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 1, "fc2.bias"));
  1011. vision_model.mm_model_block_1_block_2_0_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 2, "0.weight"));
  1012. vision_model.mm_model_block_1_block_2_1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 2, "1.weight"));
  1013. vision_model.mm_model_block_1_block_2_1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 1, 2, "1.bias"));
  1014. vision_model.mm_model_block_2_block_0_0_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 0, "0.weight"));
  1015. vision_model.mm_model_block_2_block_0_1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 0, "1.weight"));
  1016. vision_model.mm_model_block_2_block_0_1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 0, "1.bias"));
  1017. vision_model.mm_model_block_2_block_1_fc1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc1.weight"));
  1018. vision_model.mm_model_block_2_block_1_fc1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc1.bias"));
  1019. vision_model.mm_model_block_2_block_1_fc2_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc2.weight"));
  1020. vision_model.mm_model_block_2_block_1_fc2_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 1, "fc2.bias"));
  1021. vision_model.mm_model_block_2_block_2_0_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 2, "0.weight"));
  1022. vision_model.mm_model_block_2_block_2_1_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 2, "1.weight"));
  1023. vision_model.mm_model_block_2_block_2_1_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_BLOCK, 2, 2, "1.bias"));
  1024. }
  1025. else if (new_clip->proj_type == PROJECTOR_TYPE_LDPV2)
  1026. {
  1027. // MobilVLM_V2 projection
  1028. vision_model.mm_model_mlp_0_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 0, "weight"));
  1029. vision_model.mm_model_mlp_0_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 0, "bias"));
  1030. vision_model.mm_model_mlp_2_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 2, "weight"));
  1031. vision_model.mm_model_mlp_2_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_MLP, 2, "bias"));
  1032. vision_model.mm_model_peg_0_w = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_PEG, 0, "weight"));
  1033. vision_model.mm_model_peg_0_b = get_tensor(new_clip->ctx_data, format(TN_MVLM_PROJ_PEG, 0, "bias"));
  1034. }
  1035. else {
  1036. std::string proj_type = PROJECTOR_TYPE_NAMES[new_clip->proj_type];
  1037. throw std::runtime_error(format("%s: don't support projector with: %s currently\n", __func__, proj_type.c_str()));
  1038. }
  1039. vision_model.layers.resize(hparams.n_layer);
  1040. for (int il = 0; il < hparams.n_layer; ++il) {
  1041. auto & layer = vision_model.layers[il];
  1042. layer.k_w = get_tensor(new_clip->ctx_data, format(TN_ATTN_K, "v", il, "weight"));
  1043. layer.q_w = get_tensor(new_clip->ctx_data, format(TN_ATTN_Q, "v", il, "weight"));
  1044. layer.v_w = get_tensor(new_clip->ctx_data, format(TN_ATTN_V, "v", il, "weight"));
  1045. layer.o_w = get_tensor(new_clip->ctx_data, format(TN_ATTN_OUTPUT, "v", il, "weight"));
  1046. layer.ln_1_w = get_tensor(new_clip->ctx_data, format(TN_LN_1, "v", il, "weight"));
  1047. layer.ln_2_w = get_tensor(new_clip->ctx_data, format(TN_LN_2, "v", il, "weight"));
  1048. layer.ff_i_w = get_tensor(new_clip->ctx_data, format(TN_FFN_DOWN, "v", il, "weight"));
  1049. layer.ff_o_w = get_tensor(new_clip->ctx_data, format(TN_FFN_UP, "v", il, "weight"));
  1050. layer.k_b = get_tensor(new_clip->ctx_data, format(TN_ATTN_K, "v", il, "bias"));
  1051. layer.q_b = get_tensor(new_clip->ctx_data, format(TN_ATTN_Q, "v", il, "bias"));
  1052. layer.v_b = get_tensor(new_clip->ctx_data, format(TN_ATTN_V, "v", il, "bias"));
  1053. layer.o_b = get_tensor(new_clip->ctx_data, format(TN_ATTN_OUTPUT, "v", il, "bias"));
  1054. layer.ln_1_b = get_tensor(new_clip->ctx_data, format(TN_LN_1, "v", il, "bias"));
  1055. layer.ln_2_b = get_tensor(new_clip->ctx_data, format(TN_LN_2, "v", il, "bias"));
  1056. layer.ff_i_b = get_tensor(new_clip->ctx_data, format(TN_FFN_DOWN, "v", il, "bias"));
  1057. layer.ff_o_b = get_tensor(new_clip->ctx_data, format(TN_FFN_UP, "v", il, "bias"));
  1058. }
  1059. }
  1060. ggml_free(meta);
  1061. new_clip->ctx_gguf = ctx;
  1062. // measure mem requirement and allocate
  1063. {
  1064. new_clip->buf_compute_meta.resize(GGML_DEFAULT_GRAPH_SIZE * ggml_tensor_overhead() + ggml_graph_overhead());
  1065. new_clip->compute_alloc = ggml_gallocr_new(ggml_backend_get_default_buffer_type(new_clip->backend));
  1066. clip_image_f32_batch batch;
  1067. batch.size = 1;
  1068. ggml_cgraph * gf = clip_image_build_graph(new_clip, &batch);
  1069. ggml_gallocr_reserve(new_clip->compute_alloc, gf);
  1070. size_t compute_memory_buffer_size = ggml_gallocr_get_buffer_size(new_clip->compute_alloc, 0);
  1071. printf("%s: compute allocated memory: %.2f MB\n", __func__, compute_memory_buffer_size /1024.0/1024.0);
  1072. }
  1073. return new_clip;
  1074. }
  1075. struct clip_image_u8 * clip_image_u8_init() {
  1076. return new clip_image_u8();
  1077. }
  1078. struct clip_image_f32 * clip_image_f32_init() {
  1079. return new clip_image_f32();
  1080. }
  1081. void clip_image_u8_free(struct clip_image_u8 * img) { delete img; }
  1082. void clip_image_f32_free(struct clip_image_f32 * img) { delete img; }
  1083. void clip_image_u8_batch_free(struct clip_image_u8_batch * batch) {
  1084. if (batch->size > 0) {
  1085. delete[] batch->data;
  1086. batch->size = 0;
  1087. }
  1088. }
  1089. void clip_image_f32_batch_free(struct clip_image_f32_batch * batch) {
  1090. if (batch->size > 0) {
  1091. delete[] batch->data;
  1092. batch->size = 0;
  1093. }
  1094. }
  1095. static void build_clip_img_from_data(const stbi_uc * data, int nx, int ny, clip_image_u8 * img) {
  1096. img->nx = nx;
  1097. img->ny = ny;
  1098. img->buf.resize(3 * nx * ny);
  1099. memcpy(img->buf.data(), data, img->buf.size());
  1100. }
  1101. bool clip_image_load_from_file(const char * fname, clip_image_u8 * img) {
  1102. int nx, ny, nc;
  1103. auto * data = stbi_load(fname, &nx, &ny, &nc, 3);
  1104. if (!data) {
  1105. fprintf(stderr, "%s: failed to load image '%s'\n", __func__, fname);
  1106. return false;
  1107. }
  1108. build_clip_img_from_data(data, nx, ny, img);
  1109. stbi_image_free(data);
  1110. return true;
  1111. }
  1112. bool clip_image_load_from_bytes(const unsigned char * bytes, size_t bytes_length, struct clip_image_u8 * img) {
  1113. int nx, ny, nc;
  1114. auto * data = stbi_load_from_memory(bytes, bytes_length, &nx, &ny, &nc, 3);
  1115. if (!data) {
  1116. fprintf(stderr, "%s: failed to decode image bytes\n", __func__);
  1117. return false;
  1118. }
  1119. build_clip_img_from_data(data, nx, ny, img);
  1120. stbi_image_free(data);
  1121. return true;
  1122. }
  1123. // Linear interpolation between two points
  1124. inline float lerp(float s, float e, float t) {
  1125. return s + (e - s) * t;
  1126. }
  1127. // Bilinear resize function
  1128. static void bilinear_resize(const clip_image_u8& src, clip_image_u8& dst, int target_width, int target_height) {
  1129. dst.nx = target_width;
  1130. dst.ny = target_height;
  1131. dst.buf.resize(3 * target_width * target_height);
  1132. float x_ratio = static_cast<float>(src.nx - 1) / target_width;
  1133. float y_ratio = static_cast<float>(src.ny - 1) / target_height;
  1134. for (int y = 0; y < target_height; y++) {
  1135. for (int x = 0; x < target_width; x++) {
  1136. float px = x_ratio * x;
  1137. float py = y_ratio * y;
  1138. int x_floor = static_cast<int>(px);
  1139. int y_floor = static_cast<int>(py);
  1140. float x_lerp = px - x_floor;
  1141. float y_lerp = py - y_floor;
  1142. for (int c = 0; c < 3; c++) {
  1143. float top = lerp(
  1144. static_cast<float>(src.buf[3 * (y_floor * src.nx + x_floor) + c]),
  1145. static_cast<float>(src.buf[3 * (y_floor * src.nx + (x_floor + 1)) + c]),
  1146. x_lerp
  1147. );
  1148. float bottom = lerp(
  1149. static_cast<float>(src.buf[3 * ((y_floor + 1) * src.nx + x_floor) + c]),
  1150. static_cast<float>(src.buf[3 * ((y_floor + 1) * src.nx + (x_floor + 1)) + c]),
  1151. x_lerp
  1152. );
  1153. dst.buf[3 * (y * target_width + x) + c] = static_cast<uint8_t>(lerp(top, bottom, y_lerp));
  1154. }
  1155. }
  1156. }
  1157. }
  1158. // Normalize image to float32 - careful with pytorch .to(model.device, dtype=torch.float16) - this sometimes reduces precision (32>16>32), sometimes not
  1159. static void normalize_image_u8_to_f32(const clip_image_u8* src, clip_image_f32* dst, const float mean[3], const float std[3]) {
  1160. dst->nx = src->nx;
  1161. dst->ny = src->ny;
  1162. dst->buf.resize(src->buf.size());
  1163. for (size_t i = 0; i < src->buf.size(); ++i) {
  1164. int c = i % 3; // rgb
  1165. dst->buf[i] = (static_cast<float>(src->buf[i]) / 255.0f - mean[c]) / std[c];
  1166. }
  1167. }
  1168. inline float clip(float x, float lower, float upper) {
  1169. return std::max(lower, std::min(x, upper));
  1170. }
  1171. static bool bicubic_resize(const clip_image_u8 &img, clip_image_u8 &dst, int target_width, int target_height) {
  1172. const int nx = img.nx;
  1173. const int ny = img.ny;
  1174. dst.nx = target_width;
  1175. dst.ny = target_height;
  1176. dst.buf.resize(3 * target_width * target_height);
  1177. float Cc;
  1178. float C[5];
  1179. float d0, d2, d3, a0, a1, a2, a3;
  1180. int i, j, k, jj;
  1181. int x, y;
  1182. float dx, dy;
  1183. float tx, ty;
  1184. tx = (float)nx / (float)target_width;
  1185. ty = (float)ny / (float)target_height;
  1186. // Bicubic interpolation; adapted from ViT.cpp, inspired from :
  1187. // -> https://github.com/yglukhov/bicubic-interpolation-image-processing/blob/master/libimage.c#L36
  1188. // -> https://en.wikipedia.org/wiki/Bicubic_interpolation
  1189. for (i = 0; i < target_height; i++) {
  1190. for (j = 0; j < target_width; j++) {
  1191. x = (int)(tx * j);
  1192. y = (int)(ty * i);
  1193. dx = tx * j - x;
  1194. dy = ty * i - y;
  1195. for (k = 0; k < 3; k++) {
  1196. for (jj = 0; jj <= 3; jj++) {
  1197. 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];
  1198. 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];
  1199. 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];
  1200. a0 = img.buf[(clip(y - 1 + jj, 0, ny - 1) * nx + clip(x, 0, nx - 1)) * 3 + k];
  1201. a1 = -1.0 / 3 * d0 + d2 - 1.0 / 6 * d3;
  1202. a2 = 1.0 / 2 * d0 + 1.0 / 2 * d2;
  1203. a3 = -1.0 / 6 * d0 - 1.0 / 2 * d2 + 1.0 / 6 * d3;
  1204. C[jj] = a0 + a1 * dx + a2 * dx * dx + a3 * dx * dx * dx;
  1205. d0 = C[0] - C[1];
  1206. d2 = C[2] - C[1];
  1207. d3 = C[3] - C[1];
  1208. a0 = C[1];
  1209. a1 = -1.0 / 3 * d0 + d2 - 1.0 / 6 * d3;
  1210. a2 = 1.0 / 2 * d0 + 1.0 / 2 * d2;
  1211. a3 = -1.0 / 6 * d0 - 1.0 / 2 * d2 + 1.0 / 6 * d3;
  1212. Cc = a0 + a1 * dy + a2 * dy * dy + a3 * dy * dy * dy;
  1213. const uint8_t Cc2 = std::min(std::max(std::round(Cc), 0.0f), 255.0f);
  1214. dst.buf[(i * target_width + j) * 3 + k] = float(Cc2);
  1215. }
  1216. }
  1217. }
  1218. }
  1219. return true;
  1220. }
  1221. // llava-1.6 type of resize_and_pad (black)
  1222. static void resize_and_pad_image(const clip_image_u8& image, clip_image_u8 &image_output, const std::pair<int, int>& target_resolution) {
  1223. int target_width = target_resolution.first;
  1224. int target_height = target_resolution.second;
  1225. float scale_w = static_cast<float>(target_width) / image.nx;
  1226. float scale_h = static_cast<float>(target_height) / image.ny;
  1227. int new_width, new_height;
  1228. if (scale_w < scale_h) {
  1229. new_width = target_width;
  1230. new_height = std::min(static_cast<int>(std::ceil(image.ny * scale_w)), target_height);
  1231. } else {
  1232. new_height = target_height;
  1233. new_width = std::min(static_cast<int>(std::ceil(image.nx * scale_h)), target_width);
  1234. }
  1235. clip_image_u8 resized_image;
  1236. // bilinear_resize(image, resized_image, new_width, new_height);
  1237. bicubic_resize(image, resized_image, new_width, new_height);
  1238. clip_image_u8 padded_image;
  1239. padded_image.nx = target_width;
  1240. padded_image.ny = target_height;
  1241. padded_image.buf.resize(3 * target_width * target_height, 0); // Initialize with black
  1242. // Calculate padding offsets
  1243. int pad_x = (target_width - new_width) / 2;
  1244. int pad_y = (target_height - new_height) / 2;
  1245. // Copy the resized image into the center of the padded buffer
  1246. for (int y = 0; y < new_height; ++y) {
  1247. for (int x = 0; x < new_width; ++x) {
  1248. for (int c = 0; c < 3; ++c) {
  1249. padded_image.buf[3 * ((y + pad_y) * target_width + (x + pad_x)) + c] = resized_image.buf[3 * (y * new_width + x) + c];
  1250. }
  1251. }
  1252. }
  1253. image_output = std::move(padded_image);
  1254. }
  1255. /**
  1256. * Selects the best resolution from a list of possible resolutions based on the original size.
  1257. *
  1258. * @param original_size The original size of the image in the format (width, height).
  1259. * @param possible_resolutions A list of possible resolutions in the format [(width1, height1), (width2, height2), ...].
  1260. * @return The best fit resolution in the format (width, height).
  1261. */
  1262. static std::pair<int, int> select_best_resolution(const std::pair<int, int> & original_size, const std::vector<std::pair<int, int>> & possible_resolutions) {
  1263. int original_width = original_size.first;
  1264. int original_height = original_size.second;
  1265. std::pair<int, int> best_fit;
  1266. int max_effective_resolution = 0;
  1267. int min_wasted_resolution = std::numeric_limits<int>::max();
  1268. for (const auto& resolution : possible_resolutions) {
  1269. int width = resolution.first;
  1270. int height = resolution.second;
  1271. float scale = std::min(static_cast<float>(width) / original_width, static_cast<float>(height) / original_height);
  1272. int downscaled_width = static_cast<int>(original_width * scale);
  1273. int downscaled_height = static_cast<int>(original_height * scale);
  1274. int effective_resolution = std::min(downscaled_width * downscaled_height, original_width * original_height);
  1275. int wasted_resolution = (width * height) - effective_resolution;
  1276. // fprintf(stderr, "resolution: %d %d, scale: %f, downscaled: %d %d, effective: %d, wasted: %d\n", width, height, scale, downscaled_width, downscaled_height, effective_resolution, wasted_resolution);
  1277. if (effective_resolution > max_effective_resolution || (effective_resolution == max_effective_resolution && wasted_resolution < min_wasted_resolution)) {
  1278. max_effective_resolution = effective_resolution;
  1279. min_wasted_resolution = wasted_resolution;
  1280. best_fit = resolution;
  1281. }
  1282. }
  1283. return best_fit;
  1284. }
  1285. static std::vector<clip_image_u8*> divide_to_patches_u8(const clip_image_u8 & image, int patch_size) {
  1286. std::vector<clip_image_u8*> patches;
  1287. int width = image.nx;
  1288. int height = image.ny;
  1289. for (int i = 0; i < height; i += patch_size) {
  1290. for (int j = 0; j < width; j += patch_size) {
  1291. clip_image_u8 *patch = clip_image_u8_init();
  1292. patch->nx = std::min(patch_size, width - j);
  1293. patch->ny = std::min(patch_size, height - i);
  1294. patch->buf.resize(3 * patch->nx * patch->ny);
  1295. for (int y = 0; y < patch->ny; ++y) {
  1296. for (int x = 0; x < patch->nx; ++x) {
  1297. for (int c = 0; c < 3; ++c) {
  1298. patch->buf[3 * (y * patch->nx + x) + c] = image.buf[3 * ((i + y) * width + (j + x)) + c];
  1299. }
  1300. }
  1301. }
  1302. patches.push_back(patch);
  1303. }
  1304. }
  1305. return patches;
  1306. }
  1307. // 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
  1308. // res_imgs memory is being allocated here, previous allocations will be freed if found
  1309. bool clip_image_preprocess(struct clip_ctx * ctx, const clip_image_u8 * img, clip_image_f32_batch * res_imgs) {
  1310. bool pad_to_square = true;
  1311. if (!ctx->has_vision_encoder) {
  1312. printf("This gguf file seems to have no vision encoder\n");
  1313. return false;
  1314. }
  1315. auto & params = ctx->vision_model.hparams;
  1316. // 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
  1317. if (strcmp(params.mm_patch_merge_type, "spatial_unpad") == 0) {
  1318. pad_to_square = false;
  1319. }
  1320. // free the previous res_imgs if any set
  1321. if (res_imgs->size > 0) {
  1322. clip_image_f32_batch_free(res_imgs);
  1323. }
  1324. res_imgs->data = nullptr;
  1325. res_imgs->size = 0;
  1326. // the logic below is to pad the shorter side to the longer side with a background color: rgb(122, 116, 104)
  1327. // see https://github.com/haotian-liu/LLaVA/blob/e854a2bf85118c504f6f16bf5c3c7c92f8fa8c6b/llava/conversation.py#L113-L156
  1328. clip_image_u8 * temp = clip_image_u8_init(); // we will keep the input image data here temporarily
  1329. if (pad_to_square && img->nx != img->ny) {
  1330. int longer_side = std::max(img->nx, img->ny);
  1331. temp->nx = longer_side;
  1332. temp->ny = longer_side;
  1333. temp->buf.resize(3 * longer_side * longer_side);
  1334. const uint8_t bc[3] = {122, 116, 104}; // background color in RGB from LLaVA (this is the mean rgb color * 255)
  1335. // fill with background color
  1336. for (size_t i = 0; i < temp->buf.size(); i++) {
  1337. temp->buf[i] = bc[i % 3];
  1338. }
  1339. // copy from the input image
  1340. for (int y = 0; y < img->ny; y++) {
  1341. for (int x = 0; x < img->nx; x++) {
  1342. const int i = 3 * (y * img->nx + x);
  1343. const int j = 3 * (y * temp->nx + x);
  1344. temp->buf[j] = img->buf[i];
  1345. temp->buf[j+1] = img->buf[i+1];
  1346. temp->buf[j+2] = img->buf[i+2];
  1347. }
  1348. }
  1349. } else {
  1350. if (params.image_grid_pinpoints[0] != 0) {
  1351. // "spatial_unpad" with "anyres" processing for llava-1.6
  1352. std::vector<std::pair<int, int>> possible_resolutions;
  1353. for (int i = 0; i < 32 && params.image_grid_pinpoints[i] != 0; i+=2) {
  1354. possible_resolutions.push_back({params.image_grid_pinpoints[i], params.image_grid_pinpoints[i+1]});
  1355. }
  1356. std::pair<int, int> best_resolution = select_best_resolution({img->nx, img->ny}, possible_resolutions);
  1357. // clip_image_save_to_bmp(*img, "input.bmp");
  1358. resize_and_pad_image(*img, *temp, best_resolution); // we do not pad with mean-bg color anymore in llava-1.6
  1359. // clip_image_save_to_bmp(*temp, "resized.bmp");
  1360. // visually verify normalized image:
  1361. // normalize_image_u8_to_f32(*temp, *res, ctx->image_mean, ctx->image_std);
  1362. // {
  1363. // clip_image_u8 * temp2 = clip_image_u8_init();
  1364. // clip_image_convert_f32_to_u8(*res, *temp2);
  1365. // clip_image_save_to_bmp(*temp2, "resized_normalized_f32.bmp");
  1366. // clip_image_u8_free(temp2);
  1367. // }
  1368. std::vector<clip_image_u8 *> patches = divide_to_patches_u8(*temp, params.image_size); // prepare spatial sorted main patches of image_size each (336 in llava-1.6)
  1369. clip_image_u8 *image_original_resize = clip_image_u8_init();
  1370. // bilinear_resize(*img, *image_original_resize, params.image_size, params.image_size); // in python this is "shortest_edge", but all CLIP are square
  1371. bicubic_resize(*img, *image_original_resize, params.image_size, params.image_size); // in python this is "shortest_edge", but all CLIP are square
  1372. patches.insert(patches.begin(), image_original_resize);
  1373. // clip_image_f32_batch_init(patches.size());
  1374. res_imgs->size = patches.size();
  1375. res_imgs->data = new clip_image_f32[res_imgs->size];
  1376. int num=0;
  1377. for (auto& patch : patches) {
  1378. normalize_image_u8_to_f32(patch, &res_imgs->data[num], ctx->image_mean, ctx->image_std);
  1379. num++;
  1380. }
  1381. for (size_t i = 0; i < patches.size(); i++) {
  1382. // printf("patch %d: %d %d\n", i, patches[i]->nx, patches[i]->ny);
  1383. clip_image_u8_free(patches[i]);
  1384. }
  1385. clip_image_u8_free(temp);
  1386. return true;
  1387. } else {
  1388. temp->nx = img->nx;
  1389. temp->ny = img->ny;
  1390. temp->buf.resize(img->buf.size());
  1391. memcpy(temp->buf.data(), img->buf.data(), temp->buf.size());
  1392. }
  1393. }
  1394. const int nx = temp->nx;
  1395. const int ny = temp->ny;
  1396. // clip_image_save_to_bmp(*temp, "resized_vanilla.bmp");
  1397. const int nx2 = ctx->vision_model.hparams.image_size;
  1398. const int ny2 = ctx->vision_model.hparams.image_size;
  1399. clip_image_f32 * res = clip_image_f32_init();
  1400. res->nx = nx2;
  1401. res->ny = ny2;
  1402. res->buf.resize(3 * nx2 * ny2);
  1403. const float scale = std::max(nx, ny) / (float)ctx->vision_model.hparams.image_size;
  1404. const int nx3 = int(nx / scale + 0.5f);
  1405. const int ny3 = int(ny / scale + 0.5f);
  1406. const auto & m3 = ctx->image_mean; // {0.48145466f, 0.4578275f, 0.40821073f};
  1407. const auto & s3 = ctx->image_std; // {0.26862954f, 0.26130258f, 0.27577711f};
  1408. for (int y = 0; y < ny3; y++) {
  1409. for (int x = 0; x < nx3; x++) {
  1410. for (int c = 0; c < 3; c++) {
  1411. // linear interpolation
  1412. const float sx = (x + 0.5f) * scale - 0.5f;
  1413. const float sy = (y + 0.5f) * scale - 0.5f;
  1414. const int x0 = std::max(0, (int)std::floor(sx));
  1415. const int y0 = std::max(0, (int)std::floor(sy));
  1416. const int x1 = std::min(x0 + 1, nx - 1);
  1417. const int y1 = std::min(y0 + 1, ny - 1);
  1418. const float dx = sx - x0;
  1419. const float dy = sy - y0;
  1420. const int j00 = 3 * (y0 * nx + x0) + c;
  1421. const int j01 = 3 * (y0 * nx + x1) + c;
  1422. const int j10 = 3 * (y1 * nx + x0) + c;
  1423. const int j11 = 3 * (y1 * nx + x1) + c;
  1424. const float v00 = temp->buf[j00];
  1425. const float v01 = temp->buf[j01];
  1426. const float v10 = temp->buf[j10];
  1427. const float v11 = temp->buf[j11];
  1428. const float v0 = v00 * (1.0f - dx) + v01 * dx;
  1429. const float v1 = v10 * (1.0f - dx) + v11 * dx;
  1430. const float v = v0 * (1.0f - dy) + v1 * dy;
  1431. const uint8_t v2 = std::min(std::max(std::round(v), 0.0f), 255.0f);
  1432. const int i = 3 * (y * nx3 + x) + c;
  1433. res->buf[i] = ((float(v2) / 255.0f) - m3[c]) / s3[c];
  1434. }
  1435. }
  1436. }
  1437. clip_image_u8_free(temp);
  1438. // {
  1439. // clip_image_u8 * temp2 = clip_image_u8_init();
  1440. // clip_image_convert_f32_to_u8(*res, *temp2);
  1441. // clip_image_save_to_bmp(*temp2, "resized_normalized_f32_vanilla.bmp");
  1442. // clip_image_u8_free(temp2);
  1443. // }
  1444. // res_imgs.push_back(res);
  1445. res_imgs->size = 1;
  1446. res_imgs->data = new clip_image_f32[res_imgs->size];
  1447. res_imgs->data[0] = *res;
  1448. clip_image_f32_free(res);
  1449. return true;
  1450. }
  1451. ggml_tensor * clip_get_newline_tensor(const struct clip_ctx * ctx) {
  1452. return ctx->vision_model.image_newline;
  1453. }
  1454. void clip_free(clip_ctx * ctx) {
  1455. ggml_free(ctx->ctx_data);
  1456. gguf_free(ctx->ctx_gguf);
  1457. ggml_backend_buffer_free(ctx->params_buffer);
  1458. ggml_backend_free(ctx->backend);
  1459. ggml_gallocr_free(ctx->compute_alloc);
  1460. delete ctx;
  1461. }
  1462. size_t clip_embd_nbytes(const struct clip_ctx * ctx) {
  1463. return clip_n_patches(ctx) * clip_n_mmproj_embd(ctx) * sizeof(float);
  1464. }
  1465. int32_t clip_image_size(const struct clip_ctx * ctx) {
  1466. return ctx->vision_model.hparams.image_size;
  1467. }
  1468. int32_t clip_patch_size(const struct clip_ctx * ctx) {
  1469. return ctx->vision_model.hparams.patch_size;
  1470. }
  1471. int32_t clip_hidden_size(const struct clip_ctx * ctx) {
  1472. return ctx->vision_model.hparams.hidden_size;
  1473. }
  1474. const char * clip_patch_merge_type(const struct clip_ctx * ctx) {
  1475. return ctx->vision_model.hparams.mm_patch_merge_type;
  1476. }
  1477. const int32_t * clip_image_grid(const struct clip_ctx * ctx) {
  1478. return ctx->vision_model.hparams.image_grid_pinpoints;
  1479. }
  1480. int clip_n_patches(const struct clip_ctx * ctx) {
  1481. const auto & params = ctx->vision_model.hparams;
  1482. int n_patches = (params.image_size / params.patch_size) * (params.image_size / params.patch_size);
  1483. if (ctx->proj_type == PROJECTOR_TYPE_LDP) {
  1484. n_patches /= 4;
  1485. }
  1486. return n_patches;
  1487. }
  1488. bool clip_image_encode(struct clip_ctx * ctx, const int n_threads, clip_image_f32 * img, float * vec) {
  1489. if (!ctx->has_vision_encoder) {
  1490. printf("This gguf file seems to have no vision encoder\n");
  1491. return false;
  1492. }
  1493. clip_image_f32_batch imgs{};
  1494. imgs.size = 1;
  1495. imgs.data = img;
  1496. return clip_image_batch_encode(ctx, n_threads, &imgs, vec);
  1497. }
  1498. bool clip_image_batch_encode(clip_ctx * ctx, const int n_threads, const clip_image_f32_batch * imgs, float * vec) {
  1499. if (!ctx->has_vision_encoder) {
  1500. printf("This gguf file seems to have no vision encoder\n");
  1501. return false;
  1502. }
  1503. int batch_size = imgs->size;
  1504. if (ctx->has_llava_projector) {
  1505. GGML_ASSERT(batch_size == 1); // TODO: support multiple images
  1506. }
  1507. // build the inference graph
  1508. ggml_cgraph * gf = clip_image_build_graph(ctx, imgs);
  1509. ggml_gallocr_alloc_graph(ctx->compute_alloc, gf);
  1510. // set inputs
  1511. const auto & model = ctx->vision_model;
  1512. const auto & hparams = model.hparams;
  1513. const int image_size = hparams.image_size;
  1514. const int patch_size = hparams.patch_size;
  1515. const int num_patches = ((image_size / patch_size) * (image_size / patch_size));
  1516. const int num_positions = num_patches + 1;
  1517. {
  1518. struct ggml_tensor * inp_raw = ggml_graph_get_tensor(gf, "inp_raw");
  1519. float * data = (float *)malloc(ggml_nbytes(inp_raw));
  1520. for (size_t i = 0; i < imgs->size; i++) {
  1521. const int nx = imgs->data[i].nx;
  1522. const int ny = imgs->data[i].ny;
  1523. GGML_ASSERT(nx == image_size && ny == image_size);
  1524. const int n = nx * ny;
  1525. for (int b = 0; b < batch_size; b++) {
  1526. for (int k = 0; k < 3; k++) {
  1527. for (int y = 0; y < ny; y++) {
  1528. for (int x = 0; x < nx; x++) {
  1529. data[(b * 3 * n) + k * n + y * nx + x] = imgs->data[b].buf[3 * (y * nx + x) + k];
  1530. }
  1531. }
  1532. }
  1533. }
  1534. }
  1535. ggml_backend_tensor_set(inp_raw, data, 0, ggml_nbytes(inp_raw));
  1536. free(data);
  1537. }
  1538. {
  1539. struct ggml_tensor * embeddings = ggml_graph_get_tensor(gf, "embeddings");
  1540. void* zero_mem = malloc(ggml_nbytes(embeddings));
  1541. memset(zero_mem, 0, ggml_nbytes(embeddings));
  1542. ggml_backend_tensor_set(embeddings, zero_mem, 0, ggml_nbytes(embeddings));
  1543. free(zero_mem);
  1544. }
  1545. {
  1546. struct ggml_tensor * positions = ggml_graph_get_tensor(gf, "positions");
  1547. int* positions_data = (int*)malloc(ggml_nbytes(positions));
  1548. for (int i = 0; i < num_positions; i++) {
  1549. positions_data[i] = i;
  1550. }
  1551. ggml_backend_tensor_set(positions, positions_data, 0, ggml_nbytes(positions));
  1552. free(positions_data);
  1553. }
  1554. {
  1555. struct ggml_tensor * patches = ggml_graph_get_tensor(gf, "patches");
  1556. int* patches_data = (int*)malloc(ggml_nbytes(patches));
  1557. for (int i = 0; i < num_patches; i++) {
  1558. patches_data[i] = i + 1;
  1559. }
  1560. ggml_backend_tensor_set(patches, patches_data, 0, ggml_nbytes(patches));
  1561. free(patches_data);
  1562. }
  1563. if (ggml_backend_is_cpu(ctx->backend)) {
  1564. ggml_backend_cpu_set_n_threads(ctx->backend, n_threads);
  1565. }
  1566. #ifdef GGML_USE_METAL
  1567. if (ggml_backend_is_metal(ctx->backend)) {
  1568. ggml_backend_metal_set_n_cb(ctx->backend, n_threads);
  1569. }
  1570. #endif
  1571. ggml_backend_graph_compute(ctx->backend, gf);
  1572. // the last node is the embedding tensor
  1573. struct ggml_tensor * embeddings = gf->nodes[gf->n_nodes - 1];
  1574. // copy the embeddings to the location passed by the user
  1575. ggml_backend_tensor_get(embeddings, vec, 0, ggml_nbytes(embeddings));
  1576. return true;
  1577. }
  1578. bool clip_model_quantize(const char * fname_inp, const char * fname_out, const int itype) {
  1579. ggml_type type = GGML_TYPE_Q4_1;
  1580. assert(itype < GGML_TYPE_COUNT);
  1581. type = static_cast<ggml_type>(itype);
  1582. auto * ctx_clip = clip_model_load(fname_inp, 2);
  1583. const auto & ctx_src = ctx_clip->ctx_gguf;
  1584. const auto & ctx_data = ctx_clip->ctx_data;
  1585. auto * ctx_out = gguf_init_empty();
  1586. gguf_set_kv(ctx_out, ctx_src);
  1587. gguf_set_val_u32(ctx_out, "general.quantization_version", GGML_QNT_VERSION);
  1588. gguf_set_val_u32(ctx_out, "general.file_type", itype);
  1589. auto fout = std::ofstream(fname_out, std::ios::binary);
  1590. const int n_tensors = gguf_get_n_tensors(ctx_src);
  1591. for (int i = 0; i < n_tensors; ++i) {
  1592. const char * name = gguf_get_tensor_name(ctx_src, i);
  1593. struct ggml_tensor * cur = ggml_get_tensor(ctx_data, name);
  1594. gguf_add_tensor(ctx_out, cur);
  1595. }
  1596. const size_t meta_size = gguf_get_meta_size(ctx_out);
  1597. for (size_t i = 0; i < meta_size; ++i) {
  1598. fout.put(0);
  1599. }
  1600. // regexes of tensor names to be quantized
  1601. const std::vector<std::string> k_names = {
  1602. ".*weight",
  1603. };
  1604. std::vector<uint8_t> work(512);
  1605. std::vector<float> conv_buf(512);
  1606. size_t total_size_org = 0;
  1607. size_t total_size_new = 0;
  1608. for (int i = 0; i < n_tensors; ++i) {
  1609. const std::string name = gguf_get_tensor_name(ctx_src, i);
  1610. struct ggml_tensor * cur = ggml_get_tensor(ctx_data, name.c_str());
  1611. enum ggml_type new_type;
  1612. void * new_data;
  1613. size_t new_size;
  1614. bool quantize = false;
  1615. for (const auto & s : k_names) {
  1616. if (std::regex_match(name, std::regex(s))) {
  1617. quantize = true;
  1618. break;
  1619. }
  1620. }
  1621. // quantize only 2D tensors
  1622. quantize &= (ggml_n_dims(cur) == 2);
  1623. if (quantize) {
  1624. new_type = type;
  1625. if (new_type >= GGML_TYPE_Q2_K && name.find("embd") != std::string::npos) {
  1626. new_type = GGML_TYPE_Q8_0; // ggml_get_rows needs non K type
  1627. // fprintf(stderr, "%s: quantizing %s to %s\n", __func__, name.c_str(), ggml_type_name(new_type));
  1628. }
  1629. const size_t n_elms = ggml_nelements(cur);
  1630. float * f32_data;
  1631. switch (cur->type) {
  1632. case GGML_TYPE_F32:
  1633. f32_data = (float *)cur->data;
  1634. break;
  1635. case GGML_TYPE_F16:
  1636. if (conv_buf.size() < n_elms) {
  1637. conv_buf.resize(n_elms);
  1638. }
  1639. for (size_t j = 0; j < n_elms; ++j) {
  1640. conv_buf[j] = ggml_fp16_to_fp32(((ggml_fp16_t *)cur->data)[j]);
  1641. }
  1642. f32_data = (float *)conv_buf.data();
  1643. break;
  1644. default:
  1645. printf("Please use an input file in f32 or f16\n");
  1646. gguf_free(ctx_out);
  1647. return false;
  1648. }
  1649. if (work.size() < n_elms * 4) {
  1650. work.resize(n_elms * 4);
  1651. }
  1652. new_data = work.data();
  1653. new_size = ggml_quantize_chunk(new_type, f32_data, new_data, 0, n_elms/cur->ne[0], cur->ne[0], nullptr);
  1654. } else {
  1655. new_type = cur->type;
  1656. new_data = cur->data;
  1657. new_size = ggml_nbytes(cur);
  1658. }
  1659. const size_t orig_size = ggml_nbytes(cur);
  1660. total_size_org += orig_size;
  1661. total_size_new += new_size;
  1662. gguf_set_tensor_type(ctx_out, name.c_str(), new_type);
  1663. gguf_set_tensor_data(ctx_out, name.c_str(), new_data, new_size);
  1664. fout.write((const char *)new_data, new_size);
  1665. size_t pad = GGML_PAD(new_size, gguf_get_alignment(ctx_out)) - new_size;
  1666. for (size_t j = 0; j < pad; ++j) {
  1667. fout.put(0);
  1668. }
  1669. printf("%s: n_dims = %d | quantize=%d | size = %f MB -> %f MB\n", name.c_str(), ggml_n_dims(cur), quantize,
  1670. orig_size / 1024.0 / 1024.0, new_size / 1024.0 / 1024.0);
  1671. }
  1672. // go back to beginning of file and write the updated metadata
  1673. fout.seekp(0, std::ios::beg);
  1674. std::vector<uint8_t> meta(meta_size);
  1675. gguf_get_meta_data(ctx_out, meta.data());
  1676. fout.write((const char *)meta.data(), meta_size);
  1677. fout.close();
  1678. clip_free(ctx_clip);
  1679. gguf_free(ctx_out);
  1680. {
  1681. printf("%s: original size = %8.2f MB\n", __func__, total_size_org / 1024.0 / 1024.0);
  1682. printf("%s: quantized size = %8.2f MB\n", __func__, total_size_new / 1024.0 / 1024.0);
  1683. }
  1684. return true;
  1685. }
  1686. int clip_n_mmproj_embd(const struct clip_ctx * ctx) {
  1687. if (ctx->proj_type == PROJECTOR_TYPE_LDP) {
  1688. return ctx->vision_model.mm_model_block_1_block_2_1_b->ne[0];
  1689. }
  1690. if (ctx->proj_type == PROJECTOR_TYPE_LDPV2) {
  1691. return ctx->vision_model.mm_model_peg_0_b->ne[0];
  1692. }
  1693. if (ctx->proj_type == PROJECTOR_TYPE_MLP) {
  1694. return ctx->vision_model.mm_2_b->ne[0];
  1695. }
  1696. if (ctx->proj_type == PROJECTOR_TYPE_MLP_NORM) {
  1697. return ctx->vision_model.mm_3_b->ne[0];
  1698. }
  1699. std::string proj_type = PROJECTOR_TYPE_NAMES[ctx->proj_type];
  1700. throw std::runtime_error(format("%s: don't support projector with: %s currently\n", __func__, proj_type.c_str()));
  1701. }