clip-impl.h 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578
  1. #pragma once
  2. #include "ggml.h"
  3. #include "gguf.h"
  4. #include "clip.h"
  5. #include <climits>
  6. #include <cstdarg>
  7. #include <cinttypes>
  8. #include <string>
  9. #include <map>
  10. #include <sstream>
  11. #include <vector>
  12. #include <memory>
  13. // Internal header for clip.cpp
  14. #define MTMD_INTERNAL_HEADER
  15. #define KEY_FTYPE "general.file_type"
  16. #define KEY_NAME "general.name"
  17. #define KEY_DESCRIPTION "general.description"
  18. #define KEY_PROJ_TYPE "clip.projector_type"
  19. #define KEY_HAS_AUDIO_ENC "clip.has_audio_encoder"
  20. #define KEY_HAS_VISION_ENC "clip.has_vision_encoder"
  21. #define KEY_USE_GELU "clip.use_gelu"
  22. #define KEY_USE_SILU "clip.use_silu"
  23. #define KEY_N_EMBD "clip.%s.embedding_length"
  24. #define KEY_N_FF "clip.%s.feed_forward_length"
  25. #define KEY_N_BLOCK "clip.%s.block_count"
  26. #define KEY_PROJ_DIM "clip.%s.projection_dim"
  27. #define KEY_N_HEAD "clip.%s.attention.head_count"
  28. #define KEY_LAYER_NORM_EPS "clip.%s.attention.layer_norm_epsilon"
  29. // vision-specific
  30. #define KEY_VISION_PROJ_TYPE "clip.vision.projector_type" // for models with mixed modalities
  31. #define KEY_IMAGE_SIZE "clip.vision.image_size"
  32. #define KEY_PREPROC_IMAGE_SIZE "clip.vision.preproc_image_size"
  33. #define KEY_PATCH_SIZE "clip.vision.patch_size"
  34. #define KEY_IMAGE_MEAN "clip.vision.image_mean"
  35. #define KEY_IMAGE_STD "clip.vision.image_std"
  36. #define KEY_FEATURE_LAYER "clip.vision.feature_layer"
  37. #define KEY_PROJ_SCALE_FACTOR "clip.vision.projector.scale_factor"
  38. #define KEY_SPATIAL_MERGE_SIZE "clip.vision.spatial_merge_size"
  39. #define KEY_IS_DEEPSTACK_LAYERS "clip.vision.is_deepstack_layers"
  40. #define KEY_MM_PATCH_MERGE_TYPE "clip.vision.mm_patch_merge_type"
  41. #define KEY_IMAGE_GRID_PINPOINTS "clip.vision.image_grid_pinpoints"
  42. #define KEY_IMAGE_CROP_RESOLUTION "clip.vision.image_crop_resolution"
  43. #define KEY_WIN_ATTN_PATTERN "clip.vision.n_wa_pattern"
  44. #define KEY_WIN_ATTN_LAYER_INDEXES "clip.vision.wa_layer_indexes"
  45. #define KEY_ATTN_WINDOW_SIZE "clip.vision.window_size"
  46. #define KEY_MINICPMV_VERSION "clip.minicpmv_version"
  47. #define KEY_MINICPMV_QUERY_NUM "clip.minicpmv_query_num"
  48. // audio-specific
  49. #define KEY_AUDIO_PROJ_TYPE "clip.audio.projector_type" // for models with mixed modalities
  50. #define KEY_A_NUM_MEL_BINS "clip.audio.num_mel_bins"
  51. #define KEY_A_PROJ_STACK_FACTOR "clip.audio.projector.stack_factor"
  52. //
  53. // tensor name constants
  54. //
  55. #define TN_POS_EMBD "%s.position_embd.weight"
  56. #define TN_CLASS_EMBD "v.class_embd"
  57. #define TN_PATCH_EMBD "v.patch_embd.weight" // not rename tensor with ".0" postfix for backwrad compat
  58. #define TN_PATCH_EMBD_1 "v.patch_embd.weight.1"
  59. #define TN_PATCH_BIAS "v.patch_embd.bias"
  60. #define TN_NORM_EMBD "v.norm_embd.%s"
  61. #define TN_ATTN_QKV "%s.blk.%d.attn_qkv.%s"
  62. #define TN_ATTN_K "%s.blk.%d.attn_k.%s"
  63. #define TN_ATTN_Q "%s.blk.%d.attn_q.%s"
  64. #define TN_ATTN_V "%s.blk.%d.attn_v.%s"
  65. #define TN_ATTN_OUTPUT "%s.blk.%d.attn_out.%s"
  66. #define TN_ATTN_K_NORM "%s.blk.%d.attn_k_norm.%s"
  67. #define TN_ATTN_Q_NORM "%s.blk.%d.attn_q_norm.%s"
  68. #define TN_FFN_DOWN "%s.blk.%d.ffn_down.%s"
  69. #define TN_FFN_GATE "%s.blk.%d.ffn_gate.%s"
  70. #define TN_FFN_UP "%s.blk.%d.ffn_up.%s"
  71. #define TN_FFN_GATE "%s.blk.%d.ffn_gate.%s"
  72. #define TN_LN_1 "%s.blk.%d.ln1.%s" // layer norm
  73. #define TN_LN_2 "%s.blk.%d.ln2.%s" // layer norm
  74. #define TN_LS_1 "%s.blk.%d.ls1.%s" // layer scale
  75. #define TN_LS_2 "%s.blk.%d.ls2.%s" // layer scale
  76. #define TN_LN_PRE "%s.pre_ln.%s"
  77. #define TN_LN_POST "%s.post_ln.%s"
  78. #define TN_LLAVA_PROJ "mm.%d.%s"
  79. #define TN_MM_UP "mm.up.%s"
  80. #define TN_MM_GATE "mm.gate.%s"
  81. #define TN_MM_DOWN "mm.down.%s"
  82. #define TN_MM_POST_NORM "mm.post_norm.%s"
  83. #define TN_MVLM_PROJ_MLP "mm.model.mlp.%d.%s"
  84. #define TN_MVLM_PROJ_BLOCK "mm.model.mb_block.%d.block.%d.%s"
  85. #define TN_MVLM_PROJ_PEG "mm.model.peg.%d.%s"
  86. #define TN_IMAGE_NEWLINE "model.image_newline"
  87. #define TN_MM_INP_NORM "mm.input_norm.weight"
  88. #define TN_MM_INP_NORM_B "mm.input_norm.bias"
  89. #define TN_MM_INP_PROJ "mm.input_projection.weight" // gemma3
  90. #define TN_MM_SOFT_EMB_N "mm.soft_emb_norm.weight" // gemma3
  91. #define TN_MM_PROJECTOR "mm.model.fc.weight" // idefics3
  92. #define TN_MM_PATCH_MERGER "mm.patch_merger.%s" // mistral small 3.1, glm4v
  93. #define TN_TOK_IMG_BREAK "v.token_embd.img_break" // pixtral
  94. #define TN_TOK_GLM_BOI "adapter.boi" // glm-edge (these embeddings are not in text model)
  95. #define TN_TOK_GLM_EOI "adapter.eoi" // glm-edge (these embeddings are not in text model)
  96. #define TN_DEEPSTACK_NORM "v.deepstack.%d.norm.%s" // qwen3vl deepstack
  97. #define TN_DEEPSTACK_FC1 "v.deepstack.%d.fc1.%s" // qwen3vl deepstack
  98. #define TN_DEEPSTACK_FC2 "v.deepstack.%d.fc2.%s" // qwen3vl deepstack
  99. // mimicpmv
  100. #define TN_MINICPMV_POS_EMBD_K "resampler.pos_embed_k"
  101. #define TN_MINICPMV_QUERY "resampler.query"
  102. #define TN_MINICPMV_PROJ "resampler.proj.weight"
  103. #define TN_MINICPMV_KV_PROJ "resampler.kv.weight"
  104. #define TN_MINICPMV_ATTN "resampler.attn.%s.%s"
  105. #define TN_MINICPMV_LN "resampler.ln_%s.%s"
  106. #define TN_GLM_ADAPER_CONV "adapter.conv.%s"
  107. #define TN_GLM_ADAPTER_LINEAR "adapter.linear.linear.%s"
  108. #define TN_GLM_ADAPTER_NORM_1 "adapter.linear.norm1.%s"
  109. #define TN_GLM_ADAPTER_D_H_2_4H "adapter.linear.dense_h_to_4h.%s"
  110. #define TN_GLM_ADAPTER_GATE "adapter.linear.gate.%s"
  111. #define TN_GLM_ADAPTER_D_4H_2_H "adapter.linear.dense_4h_to_h.%s"
  112. // ultravox
  113. #define TN_CONV1D "a.conv1d.%d.%s"
  114. #define TN_MM_AUDIO_MLP "mm.a.mlp.%d.%s"
  115. #define TN_MM_AUDIO_FC "mm.a.fc.%s" // fully connected layer
  116. #define TN_MM_NORM_PRE "mm.a.norm_pre.%s"
  117. #define TN_MM_NORM_MID "mm.a.norm_mid.%s"
  118. // cogvlm
  119. #define TN_MM_POST_FC_NORM "mm.post_fc_norm.%s"
  120. #define TN_MM_H_TO_4H "mm.up.%s"
  121. #define TN_MM_GATE "mm.gate.%s"
  122. #define TN_MM_4H_TO_H "mm.down.%s"
  123. #define TN_TOK_BOI "v.boi"
  124. #define TN_TOK_EOI "v.eoi"
  125. // (conformer) lfm2
  126. #define TN_PRE_ENCODE_OUT "a.pre_encode.out.%s"
  127. #define TN_FFN_NORM "%s.blk.%d.ffn_norm.%s"
  128. #define TN_FFN_NORM_1 "%s.blk.%d.ffn_norm_1.%s"
  129. #define TN_FFN_UP_1 "%s.blk.%d.ffn_up_1.%s"
  130. #define TN_FFN_DOWN_1 "%s.blk.%d.ffn_down_1.%s"
  131. #define TN_POS_BIAS_U "%s.blk.%d.pos_bias_u"
  132. #define TN_POS_BIAS_V "%s.blk.%d.pos_bias_v"
  133. #define TN_NORM_CONV "%s.blk.%d.norm_conv.%s"
  134. #define TN_LINEAR_POS "%s.blk.%d.linear_pos.%s"
  135. #define TN_CONV_DW "%s.blk.%d.conv_dw.%s"
  136. #define TN_CONV_NORM "%s.blk.%d.conv_norm.%s"
  137. #define TN_CONV_PW1 "%s.blk.%d.conv_pw1.%s"
  138. #define TN_CONV_PW2 "%s.blk.%d.conv_pw2.%s"
  139. // mobilenetv5 (gemma3n) definitions
  140. #define TN_MNV5_STEM_CONV "v.conv_stem.conv.weight"
  141. #define TN_MNV5_STEM_BIAS "v.conv_stem.conv.bias"
  142. #define TN_MNV5_STEM_BN "v.conv_stem.bn.weight"
  143. // Stage 0 Block (Edge Residual)
  144. #define TN_MNV5_BLK_S0_EXP_W "v.blk.%d.%d.conv_exp.weight"
  145. #define TN_MNV5_BLK_S0_BN1_W "v.blk.%d.%d.bn1.weight"
  146. #define TN_MNV5_BLK_S0_PWL_W "v.blk.%d.%d.conv_pwl.weight"
  147. #define TN_MNV5_BLK_S0_BN2_W "v.blk.%d.%d.bn2.weight"
  148. // Stage 1+ Block (Universal Inverted Residual)
  149. #define TN_MNV5_BLK_DW_START_W "v.blk.%d.%d.dw_start.conv.weight"
  150. #define TN_MNV5_BLK_DW_START_BN "v.blk.%d.%d.dw_start.bn.weight"
  151. #define TN_MNV5_BLK_DW_MID_W "v.blk.%d.%d.dw_mid.conv.weight"
  152. #define TN_MNV5_BLK_DW_MID_BN "v.blk.%d.%d.dw_mid.bn.weight"
  153. #define TN_MNV5_BLK_PW_EXP_W "v.blk.%d.%d.pw_exp.conv.weight"
  154. #define TN_MNV5_BLK_PW_EXP_BN "v.blk.%d.%d.pw_exp.bn.weight"
  155. #define TN_MNV5_BLK_PW_PROJ_W "v.blk.%d.%d.pw_proj.conv.weight"
  156. #define TN_MNV5_BLK_PW_PROJ_BN "v.blk.%d.%d.pw_proj.bn.weight"
  157. #define TN_MNV5_BLK_LAYER_SCALE "v.blk.%d.%d.layer_scale.gamma"
  158. // Attention Components
  159. #define TN_MNV5_ATTN_Q_W "v.blk.%d.%d.attn.query.proj.weight"
  160. #define TN_MNV5_ATTN_K_W "v.blk.%d.%d.attn.key.proj.weight"
  161. #define TN_MNV5_ATTN_V_W "v.blk.%d.%d.attn.value.proj.weight"
  162. #define TN_MNV5_ATTN_O_W "v.blk.%d.%d.attn.output.proj.weight"
  163. #define TN_MNV5_ATTN_K_DW "v.blk.%d.%d.attn.key.down_conv.weight"
  164. #define TN_MNV5_ATTN_K_NORM "v.blk.%d.%d.attn.key.norm.weight"
  165. #define TN_MNV5_ATTN_V_DW "v.blk.%d.%d.attn.value.down_conv.weight"
  166. #define TN_MNV5_ATTN_V_NORM "v.blk.%d.%d.attn.value.norm.weight"
  167. #define TN_MNV5_ATTN_NORM "v.blk.%d.%d.norm.weight" // Block norm used in attn blocks
  168. // MSFA
  169. #define TN_MNV5_MSFA_FFN_EXP_W "v.msfa.ffn.pw_exp.conv.weight"
  170. #define TN_MNV5_MSFA_FFN_EXP_BN "v.msfa.ffn.pw_exp.bn.weight"
  171. #define TN_MNV5_MSFA_FFN_PROJ_W "v.msfa.ffn.pw_proj.conv.weight"
  172. #define TN_MNV5_MSFA_FFN_PROJ_BN "v.msfa.ffn.pw_proj.bn.weight"
  173. #define TN_MNV5_MSFA_NORM "v.msfa.norm.weight"
  174. // align x to upper multiple of n
  175. #define CLIP_ALIGN(x, n) ((((x) + (n) - 1) / (n)) * (n))
  176. // forward declaration
  177. // TODO: improve this later
  178. struct clip_ctx;
  179. enum projector_type {
  180. PROJECTOR_TYPE_MLP,
  181. PROJECTOR_TYPE_MLP_NORM,
  182. PROJECTOR_TYPE_LDP,
  183. PROJECTOR_TYPE_LDPV2,
  184. PROJECTOR_TYPE_MINICPMV,
  185. PROJECTOR_TYPE_GLM_EDGE,
  186. PROJECTOR_TYPE_QWEN2VL,
  187. PROJECTOR_TYPE_QWEN3VL,
  188. PROJECTOR_TYPE_GEMMA3,
  189. PROJECTOR_TYPE_GEMMA3NV,
  190. PROJECTOR_TYPE_GEMMA3NA,
  191. PROJECTOR_TYPE_IDEFICS3,
  192. PROJECTOR_TYPE_PIXTRAL,
  193. PROJECTOR_TYPE_QWEN25VL,
  194. PROJECTOR_TYPE_ULTRAVOX,
  195. PROJECTOR_TYPE_INTERNVL,
  196. PROJECTOR_TYPE_LLAMA4,
  197. PROJECTOR_TYPE_QWEN2A,
  198. PROJECTOR_TYPE_GLMA,
  199. PROJECTOR_TYPE_QWEN25O, // will be replaced by QWEN2A or QWEN25VL depending on clip_ctx
  200. PROJECTOR_TYPE_VOXTRAL,
  201. PROJECTOR_TYPE_MUSIC_FLAMINGO,
  202. PROJECTOR_TYPE_LFM2,
  203. PROJECTOR_TYPE_KIMIVL,
  204. PROJECTOR_TYPE_LIGHTONOCR,
  205. PROJECTOR_TYPE_COGVLM,
  206. PROJECTOR_TYPE_JANUS_PRO,
  207. PROJECTOR_TYPE_LFM2A,
  208. PROJECTOR_TYPE_GLM4V,
  209. PROJECTOR_TYPE_YOUTUVL,
  210. PROJECTOR_TYPE_UNKNOWN,
  211. };
  212. static std::map<projector_type, std::string> PROJECTOR_TYPE_NAMES = {
  213. { PROJECTOR_TYPE_MLP, "mlp" },
  214. { PROJECTOR_TYPE_LDP, "ldp" },
  215. { PROJECTOR_TYPE_LDPV2, "ldpv2"},
  216. { PROJECTOR_TYPE_MINICPMV, "resampler"},
  217. { PROJECTOR_TYPE_GLM_EDGE, "adapter"},
  218. { PROJECTOR_TYPE_QWEN2VL, "qwen2vl_merger"},
  219. { PROJECTOR_TYPE_QWEN25VL, "qwen2.5vl_merger"},
  220. { PROJECTOR_TYPE_QWEN3VL, "qwen3vl_merger"},
  221. { PROJECTOR_TYPE_GEMMA3, "gemma3"},
  222. { PROJECTOR_TYPE_GEMMA3NV, "gemma3nv"},
  223. { PROJECTOR_TYPE_GEMMA3NA, "gemma3na"},
  224. { PROJECTOR_TYPE_IDEFICS3, "idefics3"},
  225. { PROJECTOR_TYPE_PIXTRAL, "pixtral"},
  226. { PROJECTOR_TYPE_ULTRAVOX, "ultravox"},
  227. { PROJECTOR_TYPE_INTERNVL, "internvl"},
  228. { PROJECTOR_TYPE_LLAMA4, "llama4"},
  229. { PROJECTOR_TYPE_QWEN2A, "qwen2a"},
  230. { PROJECTOR_TYPE_GLMA, "glma"},
  231. { PROJECTOR_TYPE_QWEN25O, "qwen2.5o"},
  232. { PROJECTOR_TYPE_VOXTRAL, "voxtral"},
  233. { PROJECTOR_TYPE_MUSIC_FLAMINGO, "musicflamingo"},
  234. { PROJECTOR_TYPE_LFM2, "lfm2"},
  235. { PROJECTOR_TYPE_KIMIVL, "kimivl"},
  236. { PROJECTOR_TYPE_LIGHTONOCR,"lightonocr"},
  237. { PROJECTOR_TYPE_COGVLM, "cogvlm"},
  238. { PROJECTOR_TYPE_JANUS_PRO, "janus_pro"},
  239. { PROJECTOR_TYPE_LFM2A, "lfm2a"},
  240. { PROJECTOR_TYPE_GLM4V, "glm4v"},
  241. { PROJECTOR_TYPE_YOUTUVL, "youtuvl"},
  242. };
  243. static projector_type clip_projector_type_from_string(const std::string & str) {
  244. for (const auto & pair : PROJECTOR_TYPE_NAMES) {
  245. if (pair.second == str) {
  246. return pair.first;
  247. }
  248. }
  249. return PROJECTOR_TYPE_UNKNOWN;
  250. }
  251. // RGB uint8 image
  252. struct clip_image_u8 {
  253. int nx;
  254. int ny;
  255. std::vector<uint8_t> buf;
  256. };
  257. // For images, buf.size() == nx*ny*3
  258. // Memory layout: RGBRGBRGB...
  259. // For audio, only one channel is used, buf.size() == nx*ny
  260. // nx will be n_frames and ny will be n_mel
  261. struct clip_image_f32 {
  262. int nx;
  263. int ny;
  264. std::vector<float> buf;
  265. };
  266. //
  267. // logging
  268. //
  269. static void clip_log_callback_default(enum ggml_log_level level, const char * text, void * user_data) {
  270. (void) level;
  271. (void) user_data;
  272. fputs(text, stderr);
  273. fflush(stderr);
  274. }
  275. struct clip_logger_state {
  276. ggml_log_callback log_callback;
  277. void * log_callback_user_data;
  278. };
  279. extern struct clip_logger_state g_logger_state;
  280. static void clip_log_internal_v(enum ggml_log_level level, const char * format, va_list args) {
  281. if (format == NULL) {
  282. return;
  283. }
  284. va_list args_copy;
  285. va_copy(args_copy, args);
  286. char buffer[128];
  287. int len = vsnprintf(buffer, 128, format, args);
  288. if (len < 128) {
  289. g_logger_state.log_callback(level, buffer, g_logger_state.log_callback_user_data);
  290. } else {
  291. char * buffer2 = (char *) calloc(len + 1, sizeof(char));
  292. vsnprintf(buffer2, len + 1, format, args_copy);
  293. buffer2[len] = 0;
  294. g_logger_state.log_callback(level, buffer2, g_logger_state.log_callback_user_data);
  295. free(buffer2);
  296. }
  297. va_end(args_copy);
  298. }
  299. static void clip_log_internal(enum ggml_log_level level, const char * format, ...) {
  300. va_list args;
  301. va_start(args, format);
  302. clip_log_internal_v(level, format, args);
  303. va_end(args);
  304. }
  305. #define LOG_INF(...) clip_log_internal(GGML_LOG_LEVEL_INFO, __VA_ARGS__)
  306. #define LOG_WRN(...) clip_log_internal(GGML_LOG_LEVEL_WARN, __VA_ARGS__)
  307. #define LOG_ERR(...) clip_log_internal(GGML_LOG_LEVEL_ERROR, __VA_ARGS__)
  308. #define LOG_DBG(...) clip_log_internal(GGML_LOG_LEVEL_DEBUG, __VA_ARGS__)
  309. #define LOG_CNT(...) clip_log_internal(GGML_LOG_LEVEL_CONT, __VA_ARGS__)
  310. //
  311. // cpp wrappers
  312. //
  313. // wrapper for clip_image_size
  314. struct clip_image_size_deleter {
  315. void operator()(clip_image_size * val) { clip_image_size_free(val); }
  316. };
  317. typedef std::unique_ptr<clip_image_size, clip_image_size_deleter> clip_image_size_ptr;
  318. // wrapper for clip_image_u8
  319. struct clip_image_u8_deleter {
  320. void operator()(clip_image_u8 * val) { clip_image_u8_free(val); }
  321. };
  322. typedef std::unique_ptr<clip_image_u8, clip_image_u8_deleter> clip_image_u8_ptr;
  323. // wrapper for clip_image_f32
  324. struct clip_image_f32_deleter {
  325. void operator()(clip_image_f32 * val) { clip_image_f32_free(val); }
  326. };
  327. typedef std::unique_ptr<clip_image_f32, clip_image_f32_deleter> clip_image_f32_ptr;
  328. struct clip_image_u8_batch {
  329. std::vector<clip_image_u8_ptr> entries;
  330. };
  331. struct clip_image_f32_batch {
  332. std::vector<clip_image_f32_ptr> entries;
  333. bool is_audio = false;
  334. // for llava-uhd style models, we need to know the grid size
  335. // note: entries.size() == grid_x * grid_y + 1 (one overview image)
  336. int grid_x = 0;
  337. int grid_y = 0;
  338. clip_image_f32_batch clone() const {
  339. clip_image_f32_batch new_batch{
  340. /* entries */ {},
  341. /* is_audio */ is_audio,
  342. /* grid_x */ grid_x,
  343. /* grid_y */ grid_y,
  344. };
  345. new_batch.entries.reserve(entries.size());
  346. for (const auto & entry : entries) {
  347. new_batch.entries.emplace_back(new clip_image_f32(*entry));
  348. }
  349. return new_batch;
  350. }
  351. };
  352. //
  353. // common utils
  354. //
  355. static std::string string_format(const char * fmt, ...) {
  356. va_list ap;
  357. va_list ap2;
  358. va_start(ap, fmt);
  359. va_copy(ap2, ap);
  360. int size = vsnprintf(NULL, 0, fmt, ap);
  361. GGML_ASSERT(size >= 0 && size < INT_MAX); // NOLINT
  362. std::vector<char> buf(size + 1);
  363. int size2 = vsnprintf(buf.data(), size + 1, fmt, ap2);
  364. GGML_ASSERT(size2 == size);
  365. va_end(ap2);
  366. va_end(ap);
  367. return std::string(buf.data(), buf.size());
  368. }
  369. static void string_replace_all(std::string & s, const std::string & search, const std::string & replace) {
  370. if (search.empty()) {
  371. return;
  372. }
  373. std::string builder;
  374. builder.reserve(s.length());
  375. size_t pos = 0;
  376. size_t last_pos = 0;
  377. while ((pos = s.find(search, last_pos)) != std::string::npos) {
  378. builder.append(s, last_pos, pos - last_pos);
  379. builder.append(replace);
  380. last_pos = pos + search.length();
  381. }
  382. builder.append(s, last_pos, std::string::npos);
  383. s = std::move(builder);
  384. }
  385. // split string by a `std::string delim` instead of `char delim`
  386. static std::vector<std::string> string_split_str(std::string s, const std::string & delimiter) {
  387. std::vector<std::string> tokens;
  388. size_t pos = 0;
  389. std::string token;
  390. while ((pos = s.find(delimiter)) != std::string::npos) {
  391. token = s.substr(0, pos);
  392. tokens.push_back(token);
  393. s.erase(0, pos + delimiter.length());
  394. }
  395. tokens.push_back(s);
  396. return tokens;
  397. }
  398. //
  399. // gguf utils
  400. //
  401. static std::string gguf_data_to_str(enum gguf_type type, const void * data, int i) {
  402. switch (type) {
  403. case GGUF_TYPE_UINT8: return std::to_string(((const uint8_t *)data)[i]);
  404. case GGUF_TYPE_INT8: return std::to_string(((const int8_t *)data)[i]);
  405. case GGUF_TYPE_UINT16: return std::to_string(((const uint16_t *)data)[i]);
  406. case GGUF_TYPE_INT16: return std::to_string(((const int16_t *)data)[i]);
  407. case GGUF_TYPE_UINT32: return std::to_string(((const uint32_t *)data)[i]);
  408. case GGUF_TYPE_INT32: return std::to_string(((const int32_t *)data)[i]);
  409. case GGUF_TYPE_UINT64: return std::to_string(((const uint64_t *)data)[i]);
  410. case GGUF_TYPE_INT64: return std::to_string(((const int64_t *)data)[i]);
  411. case GGUF_TYPE_FLOAT32: return std::to_string(((const float *)data)[i]);
  412. case GGUF_TYPE_FLOAT64: return std::to_string(((const double *)data)[i]);
  413. case GGUF_TYPE_BOOL: return ((const bool *)data)[i] ? "true" : "false";
  414. default: return string_format("unknown type %d", type);
  415. }
  416. }
  417. static std::string gguf_kv_to_str(const struct gguf_context * ctx_gguf, int i) {
  418. const enum gguf_type type = gguf_get_kv_type(ctx_gguf, i);
  419. switch (type) {
  420. case GGUF_TYPE_STRING:
  421. return gguf_get_val_str(ctx_gguf, i);
  422. case GGUF_TYPE_ARRAY:
  423. {
  424. const enum gguf_type arr_type = gguf_get_arr_type(ctx_gguf, i);
  425. int arr_n = gguf_get_arr_n(ctx_gguf, i);
  426. const void * data = arr_type == GGUF_TYPE_STRING ? nullptr : gguf_get_arr_data(ctx_gguf, i);
  427. std::stringstream ss;
  428. ss << "[";
  429. for (int j = 0; j < arr_n; j++) {
  430. if (arr_type == GGUF_TYPE_STRING) {
  431. std::string val = gguf_get_arr_str(ctx_gguf, i, j);
  432. // escape quotes
  433. string_replace_all(val, "\\", "\\\\");
  434. string_replace_all(val, "\"", "\\\"");
  435. ss << '"' << val << '"';
  436. } else if (arr_type == GGUF_TYPE_ARRAY) {
  437. ss << "???";
  438. } else {
  439. ss << gguf_data_to_str(arr_type, data, j);
  440. }
  441. if (j < arr_n - 1) {
  442. ss << ", ";
  443. }
  444. }
  445. ss << "]";
  446. return ss.str();
  447. }
  448. default:
  449. return gguf_data_to_str(type, gguf_get_val_data(ctx_gguf, i), 0);
  450. }
  451. }
  452. //
  453. // debugging
  454. //
  455. static void print_tensor_shape(ggml_tensor * t) {
  456. printf("%s.shape = [", t->name);
  457. for (int i = 0; i < ggml_n_dims(t); ++i) {
  458. printf("%" PRId64, t->ne[i]);
  459. if (i < ggml_n_dims(t) - 1) {
  460. printf(", ");
  461. }
  462. }
  463. printf("]\n");
  464. }
  465. static void print_tensor_data(ggml_tensor * t, uint8_t * data, int64_t n) {
  466. ggml_type type = t->type;
  467. int64_t * ne = t->ne;
  468. size_t * nb = t->nb;
  469. for (int64_t i3 = 0; i3 < ne[3]; i3++) {
  470. printf("%s.data: [\n", t->name);
  471. for (int64_t i2 = 0; i2 < ne[2]; i2++) {
  472. if (i2 == n && ne[2] > 2*n) {
  473. printf(" ..., \n");
  474. i2 = ne[2] - n;
  475. }
  476. printf(" [\n");
  477. for (int64_t i1 = 0; i1 < ne[1]; i1++) {
  478. if (i1 == n && ne[1] > 2*n) {
  479. printf(" ..., \n");
  480. i1 = ne[1] - n;
  481. }
  482. printf(" [");
  483. for (int64_t i0 = 0; i0 < ne[0]; i0++) {
  484. if (i0 == n && ne[0] > 2*n) {
  485. printf("..., ");
  486. i0 = ne[0] - n;
  487. }
  488. size_t i = i3 * nb[3] + i2 * nb[2] + i1 * nb[1] + i0 * nb[0];
  489. float v;
  490. if (type == GGML_TYPE_F16) {
  491. v = ggml_fp16_to_fp32(*(ggml_fp16_t *) &data[i]);
  492. } else if (type == GGML_TYPE_F32) {
  493. v = *(float *) &data[i];
  494. } else if (type == GGML_TYPE_I32) {
  495. v = (float) *(int32_t *) &data[i];
  496. } else if (type == GGML_TYPE_I16) {
  497. v = (float) *(int16_t *) &data[i];
  498. } else if (type == GGML_TYPE_I8) {
  499. v = (float) *(int8_t *) &data[i];
  500. } else {
  501. GGML_ABORT("fatal error");
  502. }
  503. printf("%8.4f", v);
  504. if (i0 < ne[0] - 1) printf(", ");
  505. }
  506. printf("],\n");
  507. }
  508. printf(" ],\n");
  509. }
  510. printf(" ]\n");
  511. }
  512. }
  513. void clip_debug_encode(clip_ctx * ctx, int h, int w, float fill_value);
  514. //
  515. // API used internally with mtmd
  516. //
  517. projector_type clip_get_projector_type(const struct clip_ctx * ctx);