ggml.h 71 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023
  1. #pragma once
  2. //
  3. // GGML Tensor Library
  4. //
  5. // This documentation is still a work in progress.
  6. // If you wish some specific topics to be covered, feel free to drop a comment:
  7. //
  8. // https://github.com/ggerganov/whisper.cpp/issues/40
  9. //
  10. // ## Overview
  11. //
  12. // This library implements:
  13. //
  14. // - a set of tensor operations
  15. // - automatic differentiation
  16. // - basic optimization algorithms
  17. //
  18. // The aim of this library is to provide a minimalistic approach for various machine learning tasks. This includes,
  19. // but is not limited to, the following:
  20. //
  21. // - linear regression
  22. // - support vector machines
  23. // - neural networks
  24. //
  25. // The library allows the user to define a certain function using the available tensor operations. This function
  26. // definition is represented internally via a computation graph. Each tensor operation in the function definition
  27. // corresponds to a node in the graph. Having the computation graph defined, the user can choose to compute the
  28. // function's value and/or its gradient with respect to the input variables. Optionally, the function can be optimized
  29. // using one of the available optimization algorithms.
  30. //
  31. // For example, here we define the function: f(x) = a*x^2 + b
  32. //
  33. // {
  34. // struct ggml_init_params params = {
  35. // .mem_size = 16*1024*1024,
  36. // .mem_buffer = NULL,
  37. // };
  38. //
  39. // // memory allocation happens here
  40. // struct ggml_context * ctx = ggml_init(params);
  41. //
  42. // struct ggml_tensor * x = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, 1);
  43. //
  44. // ggml_set_param(ctx, x); // x is an input variable
  45. //
  46. // struct ggml_tensor * a = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, 1);
  47. // struct ggml_tensor * b = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, 1);
  48. // struct ggml_tensor * x2 = ggml_mul(ctx, x, x);
  49. // struct ggml_tensor * f = ggml_add(ctx, ggml_mul(ctx, a, x2), b);
  50. //
  51. // ...
  52. // }
  53. //
  54. // Notice that the function definition above does not involve any actual computation. The computation is performed only
  55. // when the user explicitly requests it. For example, to compute the function's value at x = 2.0:
  56. //
  57. // {
  58. // ...
  59. //
  60. // struct ggml_cgraph gf = ggml_build_forward(f);
  61. //
  62. // // set the input variable and parameter values
  63. // ggml_set_f32(x, 2.0f);
  64. // ggml_set_f32(a, 3.0f);
  65. // ggml_set_f32(b, 4.0f);
  66. //
  67. // ggml_graph_compute_with_ctx(ctx, &gf, n_threads);
  68. //
  69. // printf("f = %f\n", ggml_get_f32_1d(f, 0));
  70. //
  71. // ...
  72. // }
  73. //
  74. // The actual computation is performed in the ggml_graph_compute() function.
  75. //
  76. // The ggml_new_tensor_...() functions create new tensors. They are allocated in the memory buffer provided to the
  77. // ggml_init() function. You have to be careful not to exceed the memory buffer size. Therefore, you have to know
  78. // in advance how much memory you need for your computation. Alternatively, you can allocate a large enough memory
  79. // and after defining the computation graph, call the ggml_used_mem() function to find out how much memory was
  80. // actually needed.
  81. //
  82. // The ggml_set_param() function marks a tensor as an input variable. This is used by the automatic
  83. // differentiation and optimization algorithms.
  84. //
  85. // The described approach allows to define the function graph once and then compute its forward or backward graphs
  86. // multiple times. All computations will use the same memory buffer allocated in the ggml_init() function. This way
  87. // the user can avoid the memory allocation overhead at runtime.
  88. //
  89. // The library supports multi-dimensional tensors - up to 4 dimensions. The FP16 and FP32 data types are first class
  90. // citizens, but in theory the library can be extended to support FP8 and integer data types.
  91. //
  92. // Each tensor operation produces a new tensor. Initially the library was envisioned to support only the use of unary
  93. // and binary operations. Most of the available operations fall into one of these two categories. With time, it became
  94. // clear that the library needs to support more complex operations. The way to support these operations is not clear
  95. // yet, but a few examples are demonstrated in the following operations:
  96. //
  97. // - ggml_permute()
  98. // - ggml_conv_1d_1s()
  99. // - ggml_conv_1d_2s()
  100. //
  101. // For each tensor operator, the library implements a forward and backward computation function. The forward function
  102. // computes the output tensor value given the input tensor values. The backward function computes the adjoint of the
  103. // input tensors given the adjoint of the output tensor. For a detailed explanation of what this means, take a
  104. // calculus class, or watch the following video:
  105. //
  106. // What is Automatic Differentiation?
  107. // https://www.youtube.com/watch?v=wG_nF1awSSY
  108. //
  109. //
  110. // ## Tensor data (struct ggml_tensor)
  111. //
  112. // The tensors are stored in memory via the ggml_tensor struct. The structure provides information about the size of
  113. // the tensor, the data type, and the memory buffer where the tensor data is stored. Additionally, it contains
  114. // pointers to the "source" tensors - i.e. the tensors that were used to compute the current tensor. For example:
  115. //
  116. // {
  117. // struct ggml_tensor * c = ggml_add(ctx, a, b);
  118. //
  119. // assert(c->src[0] == a);
  120. // assert(c->src[1] == b);
  121. // }
  122. //
  123. // The multi-dimensional tensors are stored in row-major order. The ggml_tensor struct contains fields for the
  124. // number of elements in each dimension ("ne") as well as the number of bytes ("nb", a.k.a. stride). This allows
  125. // to store tensors that are not contiguous in memory, which is useful for operations such as transposition and
  126. // permutation. All tensor operations have to take the stride into account and not assume that the tensor is
  127. // contiguous in memory.
  128. //
  129. // The data of the tensor is accessed via the "data" pointer. For example:
  130. //
  131. // {
  132. // const int nx = 2;
  133. // const int ny = 3;
  134. //
  135. // struct ggml_tensor * a = ggml_new_tensor_2d(ctx, GGML_TYPE_F32, nx, ny);
  136. //
  137. // for (int y = 0; y < ny; y++) {
  138. // for (int x = 0; x < nx; x++) {
  139. // *(float *) ((char *) a->data + y*a->nb[1] + x*a->nb[0]) = x + y;
  140. // }
  141. // }
  142. //
  143. // ...
  144. // }
  145. //
  146. // Alternatively, there are helper functions, such as ggml_get_f32_1d() and ggml_set_f32_1d() that can be used.
  147. //
  148. // ## The matrix multiplication operator (ggml_mul_mat)
  149. //
  150. // TODO
  151. //
  152. //
  153. // ## Multi-threading
  154. //
  155. // TODO
  156. //
  157. //
  158. // ## Overview of ggml.c
  159. //
  160. // TODO
  161. //
  162. //
  163. // ## SIMD optimizations
  164. //
  165. // TODO
  166. //
  167. //
  168. // ## Debugging ggml
  169. //
  170. // TODO
  171. //
  172. //
  173. #ifdef GGML_SHARED
  174. # if defined(_WIN32) && !defined(__MINGW32__)
  175. # ifdef GGML_BUILD
  176. # define GGML_API __declspec(dllexport)
  177. # else
  178. # define GGML_API __declspec(dllimport)
  179. # endif
  180. # else
  181. # define GGML_API __attribute__ ((visibility ("default")))
  182. # endif
  183. #else
  184. # define GGML_API
  185. #endif
  186. // TODO: support for clang
  187. #ifdef __GNUC__
  188. # define GGML_DEPRECATED(func, hint) func __attribute__((deprecated(hint)))
  189. #elif defined(_MSC_VER)
  190. # define GGML_DEPRECATED(func, hint) __declspec(deprecated(hint)) func
  191. #else
  192. # define GGML_DEPRECATED(func, hint) func
  193. #endif
  194. #ifndef __GNUC__
  195. # define GGML_ATTRIBUTE_FORMAT(...)
  196. #elif defined(__MINGW32__)
  197. # define GGML_ATTRIBUTE_FORMAT(...) __attribute__((format(gnu_printf, __VA_ARGS__)))
  198. #else
  199. # define GGML_ATTRIBUTE_FORMAT(...) __attribute__((format(printf, __VA_ARGS__)))
  200. #endif
  201. #include <stdint.h>
  202. #include <stddef.h>
  203. #include <stdbool.h>
  204. #define GGML_FILE_MAGIC 0x67676d6c // "ggml"
  205. #define GGML_FILE_VERSION 1
  206. #define GGML_QNT_VERSION 2 // bump this on quantization format changes
  207. #define GGML_QNT_VERSION_FACTOR 1000 // do not change this
  208. #define GGML_MAX_DIMS 4
  209. #define GGML_MAX_NODES 4096
  210. #define GGML_MAX_PARAMS 256
  211. #define GGML_MAX_CONTEXTS 64
  212. #define GGML_MAX_SRC 6
  213. #define GGML_MAX_NAME 64
  214. #define GGML_MAX_OP_PARAMS 32
  215. #define GGML_DEFAULT_N_THREADS 4
  216. #if UINTPTR_MAX == 0xFFFFFFFF
  217. #define GGML_MEM_ALIGN 4
  218. #else
  219. #define GGML_MEM_ALIGN 16
  220. #endif
  221. #define GGML_EXIT_SUCCESS 0
  222. #define GGML_EXIT_ABORTED 1
  223. #define GGUF_MAGIC 0x46554747 // "GGUF"
  224. #define GGUF_VERSION 2
  225. #define GGUF_DEFAULT_ALIGNMENT 32
  226. #define GGML_UNUSED(x) (void)(x)
  227. #define GGML_PAD(x, n) (((x) + (n) - 1) & ~((n) - 1))
  228. #define GGML_ASSERT(x) \
  229. do { \
  230. if (!(x)) { \
  231. fprintf(stderr, "GGML_ASSERT: %s:%d: %s\n", __FILE__, __LINE__, #x); \
  232. abort(); \
  233. } \
  234. } while (0)
  235. // used to copy the number of elements and stride in bytes of tensors into local variables.
  236. // main purpose is to reduce code duplication and improve readability.
  237. //
  238. // example:
  239. //
  240. // GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne);
  241. // GGML_TENSOR_LOCALS(size_t, nb1, src1, nb);
  242. //
  243. #define GGML_TENSOR_LOCALS_1(type, prefix, pointer, array) \
  244. const type prefix##0 = (pointer)->array[0]; \
  245. GGML_UNUSED(prefix##0);
  246. #define GGML_TENSOR_LOCALS_2(type, prefix, pointer, array) \
  247. GGML_TENSOR_LOCALS_1 (type, prefix, pointer, array) \
  248. const type prefix##1 = (pointer)->array[1]; \
  249. GGML_UNUSED(prefix##1);
  250. #define GGML_TENSOR_LOCALS_3(type, prefix, pointer, array) \
  251. GGML_TENSOR_LOCALS_2 (type, prefix, pointer, array) \
  252. const type prefix##2 = (pointer)->array[2]; \
  253. GGML_UNUSED(prefix##2);
  254. #define GGML_TENSOR_LOCALS(type, prefix, pointer, array) \
  255. GGML_TENSOR_LOCALS_3 (type, prefix, pointer, array) \
  256. const type prefix##3 = (pointer)->array[3]; \
  257. GGML_UNUSED(prefix##3);
  258. #ifdef __cplusplus
  259. extern "C" {
  260. #endif
  261. #if defined(__ARM_NEON) && defined(__CUDACC__)
  262. typedef half ggml_fp16_t;
  263. #elif defined(__ARM_NEON)
  264. typedef __fp16 ggml_fp16_t;
  265. #else
  266. typedef uint16_t ggml_fp16_t;
  267. #endif
  268. // convert FP16 <-> FP32
  269. GGML_API float ggml_fp16_to_fp32(ggml_fp16_t x);
  270. GGML_API ggml_fp16_t ggml_fp32_to_fp16(float x);
  271. GGML_API void ggml_fp16_to_fp32_row(const ggml_fp16_t * x, float * y, int n);
  272. GGML_API void ggml_fp32_to_fp16_row(const float * x, ggml_fp16_t * y, int n);
  273. struct ggml_object;
  274. struct ggml_context;
  275. enum ggml_type {
  276. GGML_TYPE_F32 = 0,
  277. GGML_TYPE_F16 = 1,
  278. GGML_TYPE_Q4_0 = 2,
  279. GGML_TYPE_Q4_1 = 3,
  280. // GGML_TYPE_Q4_2 = 4, support has been removed
  281. // GGML_TYPE_Q4_3 (5) support has been removed
  282. GGML_TYPE_Q5_0 = 6,
  283. GGML_TYPE_Q5_1 = 7,
  284. GGML_TYPE_Q8_0 = 8,
  285. GGML_TYPE_Q8_1 = 9,
  286. // k-quantizations
  287. GGML_TYPE_Q2_K = 10,
  288. GGML_TYPE_Q3_K = 11,
  289. GGML_TYPE_Q4_K = 12,
  290. GGML_TYPE_Q5_K = 13,
  291. GGML_TYPE_Q6_K = 14,
  292. GGML_TYPE_Q8_K = 15,
  293. GGML_TYPE_I8,
  294. GGML_TYPE_I16,
  295. GGML_TYPE_I32,
  296. GGML_TYPE_COUNT,
  297. };
  298. enum ggml_backend {
  299. GGML_BACKEND_CPU = 0,
  300. GGML_BACKEND_GPU = 10,
  301. GGML_BACKEND_GPU_SPLIT = 20,
  302. };
  303. // model file types
  304. enum ggml_ftype {
  305. GGML_FTYPE_UNKNOWN = -1,
  306. GGML_FTYPE_ALL_F32 = 0,
  307. GGML_FTYPE_MOSTLY_F16 = 1, // except 1d tensors
  308. GGML_FTYPE_MOSTLY_Q4_0 = 2, // except 1d tensors
  309. GGML_FTYPE_MOSTLY_Q4_1 = 3, // except 1d tensors
  310. GGML_FTYPE_MOSTLY_Q4_1_SOME_F16 = 4, // tok_embeddings.weight and output.weight are F16
  311. GGML_FTYPE_MOSTLY_Q8_0 = 7, // except 1d tensors
  312. GGML_FTYPE_MOSTLY_Q5_0 = 8, // except 1d tensors
  313. GGML_FTYPE_MOSTLY_Q5_1 = 9, // except 1d tensors
  314. GGML_FTYPE_MOSTLY_Q2_K = 10, // except 1d tensors
  315. GGML_FTYPE_MOSTLY_Q3_K = 11, // except 1d tensors
  316. GGML_FTYPE_MOSTLY_Q4_K = 12, // except 1d tensors
  317. GGML_FTYPE_MOSTLY_Q5_K = 13, // except 1d tensors
  318. GGML_FTYPE_MOSTLY_Q6_K = 14, // except 1d tensors
  319. };
  320. // available tensor operations:
  321. enum ggml_op {
  322. GGML_OP_NONE = 0,
  323. GGML_OP_DUP,
  324. GGML_OP_ADD, //2
  325. GGML_OP_ADD1,
  326. GGML_OP_ACC,
  327. GGML_OP_SUB,
  328. GGML_OP_MUL,
  329. GGML_OP_DIV,
  330. GGML_OP_SQR,
  331. GGML_OP_SQRT,
  332. GGML_OP_LOG,
  333. GGML_OP_SUM,
  334. GGML_OP_SUM_ROWS,
  335. GGML_OP_MEAN,
  336. GGML_OP_ARGMAX,
  337. GGML_OP_REPEAT,
  338. GGML_OP_REPEAT_BACK,
  339. GGML_OP_CONCAT,
  340. GGML_OP_REMOVE_HEAD_ROW,
  341. GGML_OP_GET_FIRST_COLS_BY_ROWS,
  342. GGML_OP_SILU_BACK,
  343. GGML_OP_NORM, // normalize
  344. GGML_OP_RMS_NORM,
  345. GGML_OP_RMS_NORM_BACK,
  346. GGML_OP_GROUP_NORM,
  347. GGML_OP_MUL_MAT, //23
  348. GGML_OP_OUT_PROD,
  349. GGML_OP_SCALE,
  350. GGML_OP_SET,
  351. GGML_OP_CPY,
  352. GGML_OP_CONT,
  353. GGML_OP_RESHAPE, //29
  354. GGML_OP_VIEW,
  355. GGML_OP_PERMUTE, //32
  356. GGML_OP_TRANSPOSE,
  357. GGML_OP_GET_ROWS,
  358. GGML_OP_GET_ROWS_BACK,
  359. GGML_OP_DIAG,
  360. GGML_OP_DIAG_MASK_INF,
  361. GGML_OP_DIAG_MASK_ZERO,
  362. GGML_OP_SOFT_MAX,
  363. GGML_OP_SOFT_MAX_BACK,
  364. GGML_OP_ROPE,
  365. GGML_OP_ROPE_BACK,
  366. GGML_OP_ALIBI,
  367. GGML_OP_CLAMP,
  368. GGML_OP_CONV_1D,
  369. GGML_OP_CONV_2D,
  370. GGML_OP_CONV_TRANSPOSE_2D,
  371. GGML_OP_POOL_1D,
  372. GGML_OP_POOL_2D,
  373. GGML_OP_UPSCALE, // nearest interpolate
  374. GGML_OP_FLASH_ATTN,
  375. GGML_OP_FLASH_FF,
  376. GGML_OP_FLASH_ATTN_BACK,
  377. GGML_OP_WIN_PART,
  378. GGML_OP_WIN_UNPART,
  379. GGML_OP_GET_REL_POS,
  380. GGML_OP_ADD_REL_POS,
  381. GGML_OP_UNARY,
  382. GGML_OP_MAP_UNARY,
  383. GGML_OP_MAP_BINARY,
  384. GGML_OP_MAP_CUSTOM1_F32,
  385. GGML_OP_MAP_CUSTOM2_F32,
  386. GGML_OP_MAP_CUSTOM3_F32,
  387. GGML_OP_MAP_CUSTOM1,
  388. GGML_OP_MAP_CUSTOM2,
  389. GGML_OP_MAP_CUSTOM3,
  390. GGML_OP_CROSS_ENTROPY_LOSS,
  391. GGML_OP_CROSS_ENTROPY_LOSS_BACK,
  392. GGML_OP_COUNT,
  393. };
  394. enum ggml_unary_op {
  395. GGML_UNARY_OP_ABS,
  396. GGML_UNARY_OP_SGN,
  397. GGML_UNARY_OP_NEG,
  398. GGML_UNARY_OP_STEP,
  399. GGML_UNARY_OP_TANH,
  400. GGML_UNARY_OP_ELU,
  401. GGML_UNARY_OP_RELU,
  402. GGML_UNARY_OP_GELU,
  403. GGML_UNARY_OP_GELU_QUICK,
  404. GGML_UNARY_OP_SILU,
  405. };
  406. enum ggml_object_type {
  407. GGML_OBJECT_TENSOR,
  408. GGML_OBJECT_GRAPH,
  409. GGML_OBJECT_WORK_BUFFER
  410. };
  411. // ggml object
  412. struct ggml_object {
  413. size_t offs;
  414. size_t size;
  415. struct ggml_object * next;
  416. enum ggml_object_type type;
  417. char padding[4];
  418. };
  419. static const size_t GGML_OBJECT_SIZE = sizeof(struct ggml_object);
  420. // n-dimensional tensor
  421. struct ggml_tensor {
  422. enum ggml_type type;
  423. enum ggml_backend backend;
  424. int n_dims;
  425. int64_t ne[GGML_MAX_DIMS]; // number of elements
  426. size_t nb[GGML_MAX_DIMS]; // stride in bytes:
  427. // nb[0] = sizeof(type)
  428. // nb[1] = nb[0] * ne[0] + padding
  429. // nb[i] = nb[i-1] * ne[i-1]
  430. // compute data
  431. enum ggml_op op;
  432. // op params - allocated as int32_t for alignment
  433. int32_t op_params[GGML_MAX_OP_PARAMS / sizeof(int32_t)];
  434. bool is_param;
  435. struct ggml_tensor * grad;
  436. struct ggml_tensor * src[GGML_MAX_SRC];
  437. // performance
  438. int perf_runs;
  439. int64_t perf_cycles;
  440. int64_t perf_time_us;
  441. struct ggml_tensor * view_src;
  442. size_t view_offs;
  443. void * data;
  444. char name[GGML_MAX_NAME];
  445. void * extra; // extra things e.g. for ggml-cuda.cu
  446. char padding[4];
  447. };
  448. static const size_t GGML_TENSOR_SIZE = sizeof(struct ggml_tensor);
  449. // the compute plan that needs to be prepared for ggml_graph_compute()
  450. // since https://github.com/ggerganov/ggml/issues/287
  451. struct ggml_cplan {
  452. size_t work_size; // size of work buffer, calculated by `ggml_graph_plan()`
  453. uint8_t * work_data; // work buffer, to be allocated by caller before calling to `ggml_graph_compute()`
  454. int n_threads;
  455. // the `n_tasks` of nodes, 1:1 mapping to cgraph nodes
  456. int n_tasks[GGML_MAX_NODES];
  457. // abort ggml_graph_compute when true
  458. bool (*abort_callback)(void * data);
  459. void * abort_callback_data;
  460. };
  461. // next prime after GGML_MAX_NODES
  462. // #define GGML_GRAPH_HASHTABLE_SIZE 4099
  463. // next prime after GGML_MAX_NODES * 2 (nodes + leafs)
  464. #define GGML_GRAPH_HASHTABLE_SIZE 8273
  465. // computation graph
  466. struct ggml_cgraph {
  467. int n_nodes;
  468. int n_leafs;
  469. struct ggml_tensor * nodes[GGML_MAX_NODES];
  470. struct ggml_tensor * grads[GGML_MAX_NODES];
  471. struct ggml_tensor * leafs[GGML_MAX_NODES];
  472. void * visited_hash_table[GGML_GRAPH_HASHTABLE_SIZE];
  473. // performance
  474. int perf_runs;
  475. int64_t perf_cycles;
  476. int64_t perf_time_us;
  477. };
  478. static const size_t GGML_GRAPH_SIZE = sizeof(struct ggml_cgraph);
  479. // scratch buffer
  480. struct ggml_scratch {
  481. size_t offs;
  482. size_t size;
  483. void * data;
  484. };
  485. struct ggml_init_params {
  486. // memory pool
  487. size_t mem_size; // bytes
  488. void * mem_buffer; // if NULL, memory will be allocated internally
  489. bool no_alloc; // don't allocate memory for the tensor data
  490. };
  491. // compute types
  492. // NOTE: the INIT or FINALIZE pass is not scheduled unless explicitly enabled.
  493. // This behavior was changed since https://github.com/ggerganov/llama.cpp/pull/1995.
  494. enum ggml_task_type {
  495. GGML_TASK_INIT = 0,
  496. GGML_TASK_COMPUTE,
  497. GGML_TASK_FINALIZE,
  498. };
  499. struct ggml_compute_params {
  500. enum ggml_task_type type;
  501. // ith = thread index, nth = number of threads
  502. int ith, nth;
  503. // work buffer for all threads
  504. size_t wsize;
  505. void * wdata;
  506. };
  507. // misc
  508. GGML_API void ggml_time_init(void); // call this once at the beginning of the program
  509. GGML_API int64_t ggml_time_ms(void);
  510. GGML_API int64_t ggml_time_us(void);
  511. GGML_API int64_t ggml_cycles(void);
  512. GGML_API int64_t ggml_cycles_per_ms(void);
  513. GGML_API void ggml_numa_init(void); // call once for better performance on NUMA systems
  514. GGML_API bool ggml_is_numa(void); // true if init detected that system has >1 NUMA node
  515. GGML_API void ggml_print_object (const struct ggml_object * obj);
  516. GGML_API void ggml_print_objects(const struct ggml_context * ctx);
  517. GGML_API int64_t ggml_nelements (const struct ggml_tensor * tensor);
  518. GGML_API int64_t ggml_nrows (const struct ggml_tensor * tensor);
  519. GGML_API size_t ggml_nbytes (const struct ggml_tensor * tensor);
  520. GGML_API size_t ggml_nbytes_pad (const struct ggml_tensor * tensor); // same as ggml_nbytes() but padded to GGML_MEM_ALIGN
  521. GGML_API size_t ggml_nbytes_split(const struct ggml_tensor * tensor, int nrows_split);
  522. GGML_API int ggml_blck_size (enum ggml_type type);
  523. GGML_API size_t ggml_type_size (enum ggml_type type); // size in bytes for all elements in a block
  524. GGML_API float ggml_type_sizef(enum ggml_type type); // ggml_type_size()/ggml_blck_size() as float
  525. GGML_API const char * ggml_type_name(enum ggml_type type);
  526. GGML_API const char * ggml_op_name (enum ggml_op op);
  527. GGML_API const char * ggml_op_symbol(enum ggml_op op);
  528. GGML_API size_t ggml_element_size(const struct ggml_tensor * tensor);
  529. GGML_API bool ggml_is_quantized(enum ggml_type type);
  530. // TODO: temporary until model loading of ggml examples is refactored
  531. GGML_API enum ggml_type ggml_ftype_to_ggml_type(enum ggml_ftype ftype);
  532. GGML_API bool ggml_is_transposed(const struct ggml_tensor * tensor);
  533. GGML_API bool ggml_is_contiguous(const struct ggml_tensor * tensor);
  534. GGML_API bool ggml_is_permuted (const struct ggml_tensor * tensor);
  535. GGML_API bool ggml_are_same_shape(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  536. // use this to compute the memory overhead of a tensor
  537. GGML_API size_t ggml_tensor_overhead(void);
  538. // main
  539. GGML_API struct ggml_context * ggml_init(struct ggml_init_params params);
  540. GGML_API void ggml_free(struct ggml_context * ctx);
  541. GGML_API size_t ggml_used_mem(const struct ggml_context * ctx);
  542. GGML_API size_t ggml_set_scratch (struct ggml_context * ctx, struct ggml_scratch scratch);
  543. GGML_API bool ggml_get_no_alloc(struct ggml_context * ctx);
  544. GGML_API void ggml_set_no_alloc(struct ggml_context * ctx, bool no_alloc);
  545. GGML_API void * ggml_get_mem_buffer (const struct ggml_context * ctx);
  546. GGML_API size_t ggml_get_mem_size (const struct ggml_context * ctx);
  547. GGML_API size_t ggml_get_max_tensor_size(const struct ggml_context * ctx);
  548. GGML_API struct ggml_tensor * ggml_new_tensor(
  549. struct ggml_context * ctx,
  550. enum ggml_type type,
  551. int n_dims,
  552. const int64_t *ne);
  553. GGML_API struct ggml_tensor * ggml_new_tensor_1d(
  554. struct ggml_context * ctx,
  555. enum ggml_type type,
  556. int64_t ne0);
  557. GGML_API struct ggml_tensor * ggml_new_tensor_2d(
  558. struct ggml_context * ctx,
  559. enum ggml_type type,
  560. int64_t ne0,
  561. int64_t ne1);
  562. GGML_API struct ggml_tensor * ggml_new_tensor_3d(
  563. struct ggml_context * ctx,
  564. enum ggml_type type,
  565. int64_t ne0,
  566. int64_t ne1,
  567. int64_t ne2);
  568. GGML_API struct ggml_tensor * ggml_new_tensor_4d(
  569. struct ggml_context * ctx,
  570. enum ggml_type type,
  571. int64_t ne0,
  572. int64_t ne1,
  573. int64_t ne2,
  574. int64_t ne3);
  575. GGML_API struct ggml_tensor * ggml_new_i32(struct ggml_context * ctx, int32_t value);
  576. GGML_API struct ggml_tensor * ggml_new_f32(struct ggml_context * ctx, float value);
  577. GGML_API struct ggml_tensor * ggml_dup_tensor (struct ggml_context * ctx, const struct ggml_tensor * src);
  578. GGML_API struct ggml_tensor * ggml_view_tensor(struct ggml_context * ctx, struct ggml_tensor * src);
  579. GGML_API struct ggml_tensor * ggml_get_tensor(struct ggml_context * ctx, const char * name);
  580. GGML_API struct ggml_tensor * ggml_set_zero(struct ggml_tensor * tensor);
  581. GGML_API struct ggml_tensor * ggml_set_i32 (struct ggml_tensor * tensor, int32_t value);
  582. GGML_API struct ggml_tensor * ggml_set_f32 (struct ggml_tensor * tensor, float value);
  583. GGML_API int32_t ggml_get_i32_1d(const struct ggml_tensor * tensor, int i);
  584. GGML_API void ggml_set_i32_1d(const struct ggml_tensor * tensor, int i, int32_t value);
  585. GGML_API float ggml_get_f32_1d(const struct ggml_tensor * tensor, int i);
  586. GGML_API void ggml_set_f32_1d(const struct ggml_tensor * tensor, int i, float value);
  587. GGML_API void * ggml_get_data (const struct ggml_tensor * tensor);
  588. GGML_API float * ggml_get_data_f32(const struct ggml_tensor * tensor);
  589. GGML_API enum ggml_unary_op ggml_get_unary_op(const struct ggml_tensor * tensor);
  590. GGML_API const char * ggml_get_name (const struct ggml_tensor * tensor);
  591. GGML_API struct ggml_tensor * ggml_set_name ( struct ggml_tensor * tensor, const char * name);
  592. GGML_ATTRIBUTE_FORMAT(2, 3)
  593. GGML_API struct ggml_tensor * ggml_format_name( struct ggml_tensor * tensor, const char * fmt, ...);
  594. //
  595. // operations on tensors with backpropagation
  596. //
  597. GGML_API struct ggml_tensor * ggml_dup(
  598. struct ggml_context * ctx,
  599. struct ggml_tensor * a);
  600. // in-place, returns view(a)
  601. GGML_API struct ggml_tensor * ggml_dup_inplace(
  602. struct ggml_context * ctx,
  603. struct ggml_tensor * a);
  604. GGML_API struct ggml_tensor * ggml_add(
  605. struct ggml_context * ctx,
  606. struct ggml_tensor * a,
  607. struct ggml_tensor * b);
  608. GGML_API struct ggml_tensor * ggml_add_inplace(
  609. struct ggml_context * ctx,
  610. struct ggml_tensor * a,
  611. struct ggml_tensor * b);
  612. GGML_API struct ggml_tensor * ggml_add1(
  613. struct ggml_context * ctx,
  614. struct ggml_tensor * a,
  615. struct ggml_tensor * b);
  616. GGML_API struct ggml_tensor * ggml_add1_inplace(
  617. struct ggml_context * ctx,
  618. struct ggml_tensor * a,
  619. struct ggml_tensor * b);
  620. GGML_API struct ggml_tensor * ggml_acc(
  621. struct ggml_context * ctx,
  622. struct ggml_tensor * a,
  623. struct ggml_tensor * b,
  624. size_t nb1,
  625. size_t nb2,
  626. size_t nb3,
  627. size_t offset);
  628. GGML_API struct ggml_tensor * ggml_acc_inplace(
  629. struct ggml_context * ctx,
  630. struct ggml_tensor * a,
  631. struct ggml_tensor * b,
  632. size_t nb1,
  633. size_t nb2,
  634. size_t nb3,
  635. size_t offset);
  636. GGML_API struct ggml_tensor * ggml_sub(
  637. struct ggml_context * ctx,
  638. struct ggml_tensor * a,
  639. struct ggml_tensor * b);
  640. GGML_API struct ggml_tensor * ggml_sub_inplace(
  641. struct ggml_context * ctx,
  642. struct ggml_tensor * a,
  643. struct ggml_tensor * b);
  644. GGML_API struct ggml_tensor * ggml_mul(
  645. struct ggml_context * ctx,
  646. struct ggml_tensor * a,
  647. struct ggml_tensor * b);
  648. GGML_API struct ggml_tensor * ggml_mul_inplace(
  649. struct ggml_context * ctx,
  650. struct ggml_tensor * a,
  651. struct ggml_tensor * b);
  652. GGML_API struct ggml_tensor * ggml_div(
  653. struct ggml_context * ctx,
  654. struct ggml_tensor * a,
  655. struct ggml_tensor * b);
  656. GGML_API struct ggml_tensor * ggml_div_inplace(
  657. struct ggml_context * ctx,
  658. struct ggml_tensor * a,
  659. struct ggml_tensor * b);
  660. GGML_API struct ggml_tensor * ggml_sqr(
  661. struct ggml_context * ctx,
  662. struct ggml_tensor * a);
  663. GGML_API struct ggml_tensor * ggml_sqr_inplace(
  664. struct ggml_context * ctx,
  665. struct ggml_tensor * a);
  666. GGML_API struct ggml_tensor * ggml_sqrt(
  667. struct ggml_context * ctx,
  668. struct ggml_tensor * a);
  669. GGML_API struct ggml_tensor * ggml_sqrt_inplace(
  670. struct ggml_context * ctx,
  671. struct ggml_tensor * a);
  672. GGML_API struct ggml_tensor * ggml_log(
  673. struct ggml_context * ctx,
  674. struct ggml_tensor * a);
  675. GGML_API struct ggml_tensor * ggml_log_inplace(
  676. struct ggml_context * ctx,
  677. struct ggml_tensor * a);
  678. // return scalar
  679. GGML_API struct ggml_tensor * ggml_sum(
  680. struct ggml_context * ctx,
  681. struct ggml_tensor * a);
  682. // sums along rows, with input shape [a,b,c,d] return shape [1,b,c,d]
  683. GGML_API struct ggml_tensor * ggml_sum_rows(
  684. struct ggml_context * ctx,
  685. struct ggml_tensor * a);
  686. // mean along rows
  687. GGML_API struct ggml_tensor * ggml_mean(
  688. struct ggml_context * ctx,
  689. struct ggml_tensor * a);
  690. // argmax along rows
  691. GGML_API struct ggml_tensor * ggml_argmax(
  692. struct ggml_context * ctx,
  693. struct ggml_tensor * a);
  694. // if a is the same shape as b, and a is not parameter, return a
  695. // otherwise, return a new tensor: repeat(a) to fit in b
  696. GGML_API struct ggml_tensor * ggml_repeat(
  697. struct ggml_context * ctx,
  698. struct ggml_tensor * a,
  699. struct ggml_tensor * b);
  700. GGML_API struct ggml_tensor * ggml_repeat_back(
  701. struct ggml_context * ctx,
  702. struct ggml_tensor * a,
  703. struct ggml_tensor * b);
  704. // concat a and b on dim 2
  705. // used in stable-diffusion
  706. GGML_API struct ggml_tensor * ggml_concat(
  707. struct ggml_context * ctx,
  708. struct ggml_tensor * a,
  709. struct ggml_tensor * b);
  710. GGML_API struct ggml_tensor * ggml_remove_head_row(
  711. struct ggml_context * ctx,
  712. struct ggml_tensor * a);
  713. GGML_API struct ggml_tensor * ggml_get_first_cols_by_rows(
  714. struct ggml_context * ctx,
  715. struct ggml_tensor * a);
  716. GGML_API struct ggml_tensor * ggml_abs(
  717. struct ggml_context * ctx,
  718. struct ggml_tensor * a);
  719. GGML_API struct ggml_tensor * ggml_abs_inplace(
  720. struct ggml_context * ctx,
  721. struct ggml_tensor * a);
  722. GGML_API struct ggml_tensor * ggml_sgn(
  723. struct ggml_context * ctx,
  724. struct ggml_tensor * a);
  725. GGML_API struct ggml_tensor * ggml_sgn_inplace(
  726. struct ggml_context * ctx,
  727. struct ggml_tensor * a);
  728. GGML_API struct ggml_tensor * ggml_neg(
  729. struct ggml_context * ctx,
  730. struct ggml_tensor * a);
  731. GGML_API struct ggml_tensor * ggml_neg_inplace(
  732. struct ggml_context * ctx,
  733. struct ggml_tensor * a);
  734. GGML_API struct ggml_tensor * ggml_step(
  735. struct ggml_context * ctx,
  736. struct ggml_tensor * a);
  737. GGML_API struct ggml_tensor * ggml_step_inplace(
  738. struct ggml_context * ctx,
  739. struct ggml_tensor * a);
  740. GGML_API struct ggml_tensor * ggml_tanh(
  741. struct ggml_context * ctx,
  742. struct ggml_tensor * a);
  743. GGML_API struct ggml_tensor * ggml_tanh_inplace(
  744. struct ggml_context * ctx,
  745. struct ggml_tensor * a);
  746. GGML_API struct ggml_tensor * ggml_elu(
  747. struct ggml_context * ctx,
  748. struct ggml_tensor * a);
  749. GGML_API struct ggml_tensor * ggml_elu_inplace(
  750. struct ggml_context * ctx,
  751. struct ggml_tensor * a);
  752. GGML_API struct ggml_tensor * ggml_relu(
  753. struct ggml_context * ctx,
  754. struct ggml_tensor * a);
  755. GGML_API struct ggml_tensor * ggml_relu_inplace(
  756. struct ggml_context * ctx,
  757. struct ggml_tensor * a);
  758. // TODO: double-check this computation is correct
  759. GGML_API struct ggml_tensor * ggml_gelu(
  760. struct ggml_context * ctx,
  761. struct ggml_tensor * a);
  762. GGML_API struct ggml_tensor * ggml_gelu_inplace(
  763. struct ggml_context * ctx,
  764. struct ggml_tensor * a);
  765. GGML_API struct ggml_tensor * ggml_gelu_quick(
  766. struct ggml_context * ctx,
  767. struct ggml_tensor * a);
  768. GGML_API struct ggml_tensor * ggml_gelu_quick_inplace(
  769. struct ggml_context * ctx,
  770. struct ggml_tensor * a);
  771. GGML_API struct ggml_tensor * ggml_silu(
  772. struct ggml_context * ctx,
  773. struct ggml_tensor * a);
  774. GGML_API struct ggml_tensor * ggml_silu_inplace(
  775. struct ggml_context * ctx,
  776. struct ggml_tensor * a);
  777. // a - x
  778. // b - dy
  779. GGML_API struct ggml_tensor * ggml_silu_back(
  780. struct ggml_context * ctx,
  781. struct ggml_tensor * a,
  782. struct ggml_tensor * b);
  783. // normalize along rows
  784. GGML_API struct ggml_tensor * ggml_norm(
  785. struct ggml_context * ctx,
  786. struct ggml_tensor * a,
  787. float eps);
  788. GGML_API struct ggml_tensor * ggml_norm_inplace(
  789. struct ggml_context * ctx,
  790. struct ggml_tensor * a,
  791. float eps);
  792. GGML_API struct ggml_tensor * ggml_rms_norm(
  793. struct ggml_context * ctx,
  794. struct ggml_tensor * a,
  795. float eps);
  796. GGML_API struct ggml_tensor * ggml_rms_norm_inplace(
  797. struct ggml_context * ctx,
  798. struct ggml_tensor * a,
  799. float eps);
  800. // group normalize along ne0*ne1*n_groups
  801. // used in stable-diffusion
  802. // TODO: eps is hardcoded to 1e-6 for now
  803. GGML_API struct ggml_tensor * ggml_group_norm(
  804. struct ggml_context * ctx,
  805. struct ggml_tensor * a,
  806. int n_groups);
  807. GGML_API struct ggml_tensor * ggml_group_norm_inplace(
  808. struct ggml_context * ctx,
  809. struct ggml_tensor * a,
  810. int n_groups);
  811. // a - x
  812. // b - dy
  813. GGML_API struct ggml_tensor * ggml_rms_norm_back(
  814. struct ggml_context * ctx,
  815. struct ggml_tensor * a,
  816. struct ggml_tensor * b,
  817. float eps);
  818. // A: n columns, m rows
  819. // B: n columns, p rows (i.e. we transpose it internally)
  820. // result is m columns, p rows
  821. GGML_API struct ggml_tensor * ggml_mul_mat(
  822. struct ggml_context * ctx,
  823. struct ggml_tensor * a,
  824. struct ggml_tensor * b);
  825. // A: m columns, n rows,
  826. // B: p columns, n rows,
  827. // result is m columns, p rows
  828. GGML_API struct ggml_tensor * ggml_out_prod(
  829. struct ggml_context * ctx,
  830. struct ggml_tensor * a,
  831. struct ggml_tensor * b);
  832. //
  833. // operations on tensors without backpropagation
  834. //
  835. GGML_API struct ggml_tensor * ggml_scale(
  836. struct ggml_context * ctx,
  837. struct ggml_tensor * a,
  838. struct ggml_tensor * b);
  839. // in-place, returns view(a)
  840. GGML_API struct ggml_tensor * ggml_scale_inplace(
  841. struct ggml_context * ctx,
  842. struct ggml_tensor * a,
  843. struct ggml_tensor * b);
  844. // b -> view(a,offset,nb1,nb2,3), return modified a
  845. GGML_API struct ggml_tensor * ggml_set(
  846. struct ggml_context * ctx,
  847. struct ggml_tensor * a,
  848. struct ggml_tensor * b,
  849. size_t nb1,
  850. size_t nb2,
  851. size_t nb3,
  852. size_t offset);
  853. // b -> view(a,offset,nb1,nb2,3), return view(a)
  854. GGML_API struct ggml_tensor * ggml_set_inplace(
  855. struct ggml_context * ctx,
  856. struct ggml_tensor * a,
  857. struct ggml_tensor * b,
  858. size_t nb1,
  859. size_t nb2,
  860. size_t nb3,
  861. size_t offset);
  862. GGML_API struct ggml_tensor * ggml_set_1d(
  863. struct ggml_context * ctx,
  864. struct ggml_tensor * a,
  865. struct ggml_tensor * b,
  866. size_t offset);
  867. GGML_API struct ggml_tensor * ggml_set_1d_inplace(
  868. struct ggml_context * ctx,
  869. struct ggml_tensor * a,
  870. struct ggml_tensor * b,
  871. size_t offset);
  872. // b -> view(a,offset,nb1,nb2,3), return modified a
  873. GGML_API struct ggml_tensor * ggml_set_2d(
  874. struct ggml_context * ctx,
  875. struct ggml_tensor * a,
  876. struct ggml_tensor * b,
  877. size_t nb1,
  878. size_t offset);
  879. // b -> view(a,offset,nb1,nb2,3), return view(a)
  880. GGML_API struct ggml_tensor * ggml_set_2d_inplace(
  881. struct ggml_context * ctx,
  882. struct ggml_tensor * a,
  883. struct ggml_tensor * b,
  884. size_t nb1,
  885. size_t offset);
  886. // a -> b, return view(b)
  887. GGML_API struct ggml_tensor * ggml_cpy(
  888. struct ggml_context * ctx,
  889. struct ggml_tensor * a,
  890. struct ggml_tensor * b);
  891. // a -> b, in-place, return view(b)
  892. GGML_API struct ggml_tensor * ggml_cpy_inplace(
  893. struct ggml_context * ctx,
  894. struct ggml_tensor * a,
  895. struct ggml_tensor * b);
  896. // make contiguous
  897. GGML_API struct ggml_tensor * ggml_cont(
  898. struct ggml_context * ctx,
  899. struct ggml_tensor * a);
  900. // make contiguous, in-place
  901. GGML_API struct ggml_tensor * ggml_cont_inplace(
  902. struct ggml_context * ctx,
  903. struct ggml_tensor * a);
  904. // return view(a), b specifies the new shape
  905. // TODO: when we start computing gradient, make a copy instead of view
  906. GGML_API struct ggml_tensor * ggml_reshape(
  907. struct ggml_context * ctx,
  908. struct ggml_tensor * a,
  909. struct ggml_tensor * b);
  910. // return view(a)
  911. // TODO: when we start computing gradient, make a copy instead of view
  912. GGML_API struct ggml_tensor * ggml_reshape_1d(
  913. struct ggml_context * ctx,
  914. struct ggml_tensor * a,
  915. int64_t ne0);
  916. GGML_API struct ggml_tensor * ggml_reshape_2d(
  917. struct ggml_context * ctx,
  918. struct ggml_tensor * a,
  919. int64_t ne0,
  920. int64_t ne1);
  921. // return view(a)
  922. // TODO: when we start computing gradient, make a copy instead of view
  923. GGML_API struct ggml_tensor * ggml_reshape_3d(
  924. struct ggml_context * ctx,
  925. struct ggml_tensor * a,
  926. int64_t ne0,
  927. int64_t ne1,
  928. int64_t ne2);
  929. GGML_API struct ggml_tensor * ggml_reshape_4d(
  930. struct ggml_context * ctx,
  931. struct ggml_tensor * a,
  932. int64_t ne0,
  933. int64_t ne1,
  934. int64_t ne2,
  935. int64_t ne3);
  936. // offset in bytes
  937. GGML_API struct ggml_tensor * ggml_view_1d(
  938. struct ggml_context * ctx,
  939. struct ggml_tensor * a,
  940. int64_t ne0,
  941. size_t offset);
  942. GGML_API struct ggml_tensor * ggml_view_2d(
  943. struct ggml_context * ctx,
  944. struct ggml_tensor * a,
  945. int64_t ne0,
  946. int64_t ne1,
  947. size_t nb1, // row stride in bytes
  948. size_t offset);
  949. GGML_API struct ggml_tensor * ggml_view_3d(
  950. struct ggml_context * ctx,
  951. struct ggml_tensor * a,
  952. int64_t ne0,
  953. int64_t ne1,
  954. int64_t ne2,
  955. size_t nb1, // row stride in bytes
  956. size_t nb2, // slice stride in bytes
  957. size_t offset);
  958. GGML_API struct ggml_tensor * ggml_view_4d(
  959. struct ggml_context * ctx,
  960. struct ggml_tensor * a,
  961. int64_t ne0,
  962. int64_t ne1,
  963. int64_t ne2,
  964. int64_t ne3,
  965. size_t nb1, // row stride in bytes
  966. size_t nb2, // slice stride in bytes
  967. size_t nb3,
  968. size_t offset);
  969. GGML_API struct ggml_tensor * ggml_permute(
  970. struct ggml_context * ctx,
  971. struct ggml_tensor * a,
  972. int axis0,
  973. int axis1,
  974. int axis2,
  975. int axis3);
  976. // alias for ggml_permute(ctx, a, 1, 0, 2, 3)
  977. GGML_API struct ggml_tensor * ggml_transpose(
  978. struct ggml_context * ctx,
  979. struct ggml_tensor * a);
  980. GGML_API struct ggml_tensor * ggml_get_rows(
  981. struct ggml_context * ctx,
  982. struct ggml_tensor * a,
  983. struct ggml_tensor * b);
  984. GGML_API struct ggml_tensor * ggml_get_rows_back(
  985. struct ggml_context * ctx,
  986. struct ggml_tensor * a,
  987. struct ggml_tensor * b,
  988. struct ggml_tensor * c);
  989. GGML_API struct ggml_tensor * ggml_diag(
  990. struct ggml_context * ctx,
  991. struct ggml_tensor * a);
  992. // set elements above the diagonal to -INF
  993. GGML_API struct ggml_tensor * ggml_diag_mask_inf(
  994. struct ggml_context * ctx,
  995. struct ggml_tensor * a,
  996. int n_past);
  997. // in-place, returns view(a)
  998. GGML_API struct ggml_tensor * ggml_diag_mask_inf_inplace(
  999. struct ggml_context * ctx,
  1000. struct ggml_tensor * a,
  1001. int n_past);
  1002. // set elements above the diagonal to 0
  1003. GGML_API struct ggml_tensor * ggml_diag_mask_zero(
  1004. struct ggml_context * ctx,
  1005. struct ggml_tensor * a,
  1006. int n_past);
  1007. // in-place, returns view(a)
  1008. GGML_API struct ggml_tensor * ggml_diag_mask_zero_inplace(
  1009. struct ggml_context * ctx,
  1010. struct ggml_tensor * a,
  1011. int n_past);
  1012. GGML_API struct ggml_tensor * ggml_soft_max(
  1013. struct ggml_context * ctx,
  1014. struct ggml_tensor * a);
  1015. // in-place, returns view(a)
  1016. GGML_API struct ggml_tensor * ggml_soft_max_inplace(
  1017. struct ggml_context * ctx,
  1018. struct ggml_tensor * a);
  1019. GGML_API struct ggml_tensor * ggml_soft_max_back(
  1020. struct ggml_context * ctx,
  1021. struct ggml_tensor * a,
  1022. struct ggml_tensor * b);
  1023. // in-place, returns view(a)
  1024. GGML_API struct ggml_tensor * ggml_soft_max_back_inplace(
  1025. struct ggml_context * ctx,
  1026. struct ggml_tensor * a,
  1027. struct ggml_tensor * b);
  1028. // rotary position embedding
  1029. // if mode & 1 == 1, skip n_past elements
  1030. // if mode & 2 == 1, GPT-NeoX style
  1031. // if mode & 4 == 1, ChatGLM style
  1032. // TODO: avoid creating a new tensor every time
  1033. GGML_API struct ggml_tensor * ggml_rope(
  1034. struct ggml_context * ctx,
  1035. struct ggml_tensor * a,
  1036. int n_past,
  1037. int n_dims,
  1038. int mode,
  1039. int n_ctx);
  1040. // in-place, returns view(a)
  1041. GGML_API struct ggml_tensor * ggml_rope_inplace(
  1042. struct ggml_context * ctx,
  1043. struct ggml_tensor * a,
  1044. int n_past,
  1045. int n_dims,
  1046. int mode,
  1047. int n_ctx);
  1048. // custom RoPE
  1049. GGML_API struct ggml_tensor * ggml_rope_custom(
  1050. struct ggml_context * ctx,
  1051. struct ggml_tensor * a,
  1052. int n_past,
  1053. int n_dims,
  1054. int mode,
  1055. int n_ctx,
  1056. float freq_base,
  1057. float freq_scale);
  1058. // in-place, returns view(a)
  1059. GGML_API struct ggml_tensor * ggml_rope_custom_inplace(
  1060. struct ggml_context * ctx,
  1061. struct ggml_tensor * a,
  1062. int n_past,
  1063. int n_dims,
  1064. int mode,
  1065. int n_ctx,
  1066. float freq_base,
  1067. float freq_scale);
  1068. // xPos RoPE, in-place, returns view(a)
  1069. GGML_API struct ggml_tensor * ggml_rope_xpos_inplace(
  1070. struct ggml_context * ctx,
  1071. struct ggml_tensor * a,
  1072. int n_past,
  1073. int n_dims,
  1074. float base,
  1075. bool down);
  1076. // rotary position embedding backward, i.e compute dx from dy
  1077. // a - dy
  1078. GGML_API struct ggml_tensor * ggml_rope_back(
  1079. struct ggml_context * ctx,
  1080. struct ggml_tensor * a,
  1081. int n_past,
  1082. int n_dims,
  1083. int mode,
  1084. int n_ctx,
  1085. float freq_base,
  1086. float freq_scale,
  1087. float xpos_base,
  1088. bool xpos_down);
  1089. // alibi position embedding
  1090. // in-place, returns view(a)
  1091. struct ggml_tensor * ggml_alibi(
  1092. struct ggml_context * ctx,
  1093. struct ggml_tensor * a,
  1094. int n_past,
  1095. int n_head,
  1096. float bias_max);
  1097. // clamp
  1098. // in-place, returns view(a)
  1099. struct ggml_tensor * ggml_clamp(
  1100. struct ggml_context * ctx,
  1101. struct ggml_tensor * a,
  1102. float min,
  1103. float max);
  1104. GGML_API struct ggml_tensor * ggml_conv_1d(
  1105. struct ggml_context * ctx,
  1106. struct ggml_tensor * a,
  1107. struct ggml_tensor * b,
  1108. int s0, // stride
  1109. int p0, // padding
  1110. int d0); // dilation
  1111. // conv_1d with padding = half
  1112. // alias for ggml_conv_1d(a, b, s, a->ne[0]/2, d)
  1113. GGML_API struct ggml_tensor* ggml_conv_1d_ph(
  1114. struct ggml_context * ctx,
  1115. struct ggml_tensor * a,
  1116. struct ggml_tensor * b,
  1117. int s,
  1118. int d);
  1119. GGML_API struct ggml_tensor * ggml_conv_2d(
  1120. struct ggml_context * ctx,
  1121. struct ggml_tensor * a,
  1122. struct ggml_tensor * b,
  1123. int s0,
  1124. int s1,
  1125. int p0,
  1126. int p1,
  1127. int d0,
  1128. int d1);
  1129. // kernel size is a->ne[0] x a->ne[1]
  1130. // stride is equal to kernel size
  1131. // padding is zero
  1132. // example:
  1133. // a: 16 16 3 768
  1134. // b: 1024 1024 3 1
  1135. // res: 64 64 768 1
  1136. // used in sam
  1137. GGML_API struct ggml_tensor * ggml_conv_2d_sk_p0(
  1138. struct ggml_context * ctx,
  1139. struct ggml_tensor * a,
  1140. struct ggml_tensor * b);
  1141. // kernel size is a->ne[0] x a->ne[1]
  1142. // stride is 1
  1143. // padding is half
  1144. // example:
  1145. // a: 3 3 256 256
  1146. // b: 64 64 256 1
  1147. // res: 64 64 256 1
  1148. // used in sam
  1149. GGML_API struct ggml_tensor * ggml_conv_2d_s1_ph(
  1150. struct ggml_context * ctx,
  1151. struct ggml_tensor * a,
  1152. struct ggml_tensor * b);
  1153. GGML_API struct ggml_tensor * ggml_conv_transpose_2d_p0(
  1154. struct ggml_context * ctx,
  1155. struct ggml_tensor * a,
  1156. struct ggml_tensor * b,
  1157. int stride);
  1158. enum ggml_op_pool {
  1159. GGML_OP_POOL_MAX,
  1160. GGML_OP_POOL_AVG,
  1161. GGML_OP_POOL_COUNT,
  1162. };
  1163. GGML_API struct ggml_tensor * ggml_pool_1d(
  1164. struct ggml_context * ctx,
  1165. struct ggml_tensor * a,
  1166. enum ggml_op_pool op,
  1167. int k0, // kernel size
  1168. int s0, // stride
  1169. int p0); // padding
  1170. GGML_API struct ggml_tensor * ggml_pool_2d(
  1171. struct ggml_context * ctx,
  1172. struct ggml_tensor * a,
  1173. enum ggml_op_pool op,
  1174. int k0,
  1175. int k1,
  1176. int s0,
  1177. int s1,
  1178. int p0,
  1179. int p1);
  1180. // nearest interpolate
  1181. // used in stable-diffusion
  1182. GGML_API struct ggml_tensor * ggml_upscale(
  1183. struct ggml_context * ctx,
  1184. struct ggml_tensor * a,
  1185. int scale_factor);
  1186. GGML_API struct ggml_tensor * ggml_flash_attn(
  1187. struct ggml_context * ctx,
  1188. struct ggml_tensor * q,
  1189. struct ggml_tensor * k,
  1190. struct ggml_tensor * v,
  1191. bool masked);
  1192. GGML_API struct ggml_tensor * ggml_flash_attn_back(
  1193. struct ggml_context * ctx,
  1194. struct ggml_tensor * q,
  1195. struct ggml_tensor * k,
  1196. struct ggml_tensor * v,
  1197. struct ggml_tensor * d,
  1198. bool masked);
  1199. GGML_API struct ggml_tensor * ggml_flash_ff(
  1200. struct ggml_context * ctx,
  1201. struct ggml_tensor * a,
  1202. struct ggml_tensor * b0,
  1203. struct ggml_tensor * b1,
  1204. struct ggml_tensor * c0,
  1205. struct ggml_tensor * c1);
  1206. // partition into non-overlapping windows with padding if needed
  1207. // example:
  1208. // a: 768 64 64 1
  1209. // w: 14
  1210. // res: 768 14 14 25
  1211. // used in sam
  1212. GGML_API struct ggml_tensor * ggml_win_part(
  1213. struct ggml_context * ctx,
  1214. struct ggml_tensor * a,
  1215. int w);
  1216. // reverse of ggml_win_part
  1217. // used in sam
  1218. GGML_API struct ggml_tensor * ggml_win_unpart(
  1219. struct ggml_context * ctx,
  1220. struct ggml_tensor * a,
  1221. int w0,
  1222. int h0,
  1223. int w);
  1224. GGML_API struct ggml_tensor * ggml_unary(
  1225. struct ggml_context * ctx,
  1226. struct ggml_tensor * a,
  1227. enum ggml_unary_op op);
  1228. GGML_API struct ggml_tensor * ggml_unary_inplace(
  1229. struct ggml_context * ctx,
  1230. struct ggml_tensor * a,
  1231. enum ggml_unary_op op);
  1232. // used in sam
  1233. GGML_API struct ggml_tensor * ggml_get_rel_pos(
  1234. struct ggml_context * ctx,
  1235. struct ggml_tensor * a,
  1236. int qh,
  1237. int kh);
  1238. // used in sam
  1239. GGML_API struct ggml_tensor * ggml_add_rel_pos(
  1240. struct ggml_context * ctx,
  1241. struct ggml_tensor * a,
  1242. struct ggml_tensor * pw,
  1243. struct ggml_tensor * ph);
  1244. GGML_API struct ggml_tensor * ggml_add_rel_pos_inplace(
  1245. struct ggml_context * ctx,
  1246. struct ggml_tensor * a,
  1247. struct ggml_tensor * pw,
  1248. struct ggml_tensor * ph);
  1249. // custom operators
  1250. typedef void (*ggml_unary_op_f32_t) (const int, float *, const float *);
  1251. typedef void (*ggml_binary_op_f32_t)(const int, float *, const float *, const float *);
  1252. typedef void (*ggml_custom1_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *);
  1253. typedef void (*ggml_custom2_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1254. typedef void (*ggml_custom3_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1255. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_f32(
  1256. struct ggml_context * ctx,
  1257. struct ggml_tensor * a,
  1258. ggml_unary_op_f32_t fun),
  1259. "use ggml_map_custom1 instead");
  1260. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_inplace_f32(
  1261. struct ggml_context * ctx,
  1262. struct ggml_tensor * a,
  1263. ggml_unary_op_f32_t fun),
  1264. "use ggml_map_custom1_inplace instead");
  1265. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_f32(
  1266. struct ggml_context * ctx,
  1267. struct ggml_tensor * a,
  1268. struct ggml_tensor * b,
  1269. ggml_binary_op_f32_t fun),
  1270. "use ggml_map_custom2 instead");
  1271. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_inplace_f32(
  1272. struct ggml_context * ctx,
  1273. struct ggml_tensor * a,
  1274. struct ggml_tensor * b,
  1275. ggml_binary_op_f32_t fun),
  1276. "use ggml_map_custom2_inplace instead");
  1277. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_f32(
  1278. struct ggml_context * ctx,
  1279. struct ggml_tensor * a,
  1280. ggml_custom1_op_f32_t fun),
  1281. "use ggml_map_custom1 instead");
  1282. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_inplace_f32(
  1283. struct ggml_context * ctx,
  1284. struct ggml_tensor * a,
  1285. ggml_custom1_op_f32_t fun),
  1286. "use ggml_map_custom1_inplace instead");
  1287. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_f32(
  1288. struct ggml_context * ctx,
  1289. struct ggml_tensor * a,
  1290. struct ggml_tensor * b,
  1291. ggml_custom2_op_f32_t fun),
  1292. "use ggml_map_custom2 instead");
  1293. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_inplace_f32(
  1294. struct ggml_context * ctx,
  1295. struct ggml_tensor * a,
  1296. struct ggml_tensor * b,
  1297. ggml_custom2_op_f32_t fun),
  1298. "use ggml_map_custom2_inplace instead");
  1299. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_f32(
  1300. struct ggml_context * ctx,
  1301. struct ggml_tensor * a,
  1302. struct ggml_tensor * b,
  1303. struct ggml_tensor * c,
  1304. ggml_custom3_op_f32_t fun),
  1305. "use ggml_map_custom3 instead");
  1306. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_inplace_f32(
  1307. struct ggml_context * ctx,
  1308. struct ggml_tensor * a,
  1309. struct ggml_tensor * b,
  1310. struct ggml_tensor * c,
  1311. ggml_custom3_op_f32_t fun),
  1312. "use ggml_map_custom3_inplace instead");
  1313. // custom operators v2
  1314. typedef void (*ggml_custom1_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, int ith, int nth, void * userdata);
  1315. typedef void (*ggml_custom2_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, const struct ggml_tensor * b, int ith, int nth, void * userdata);
  1316. typedef void (*ggml_custom3_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, const struct ggml_tensor * b, const struct ggml_tensor * c, int ith, int nth, void * userdata);
  1317. #define GGML_N_TASKS_MAX -1
  1318. GGML_API struct ggml_tensor * ggml_map_custom1(
  1319. struct ggml_context * ctx,
  1320. struct ggml_tensor * a,
  1321. ggml_custom1_op_t fun,
  1322. int n_tasks,
  1323. void * userdata);
  1324. GGML_API struct ggml_tensor * ggml_map_custom1_inplace(
  1325. struct ggml_context * ctx,
  1326. struct ggml_tensor * a,
  1327. ggml_custom1_op_t fun,
  1328. int n_tasks,
  1329. void * userdata);
  1330. GGML_API struct ggml_tensor * ggml_map_custom2(
  1331. struct ggml_context * ctx,
  1332. struct ggml_tensor * a,
  1333. struct ggml_tensor * b,
  1334. ggml_custom2_op_t fun,
  1335. int n_tasks,
  1336. void * userdata);
  1337. GGML_API struct ggml_tensor * ggml_map_custom2_inplace(
  1338. struct ggml_context * ctx,
  1339. struct ggml_tensor * a,
  1340. struct ggml_tensor * b,
  1341. ggml_custom2_op_t fun,
  1342. int n_tasks,
  1343. void * userdata);
  1344. GGML_API struct ggml_tensor * ggml_map_custom3(
  1345. struct ggml_context * ctx,
  1346. struct ggml_tensor * a,
  1347. struct ggml_tensor * b,
  1348. struct ggml_tensor * c,
  1349. ggml_custom3_op_t fun,
  1350. int n_tasks,
  1351. void * userdata);
  1352. GGML_API struct ggml_tensor * ggml_map_custom3_inplace(
  1353. struct ggml_context * ctx,
  1354. struct ggml_tensor * a,
  1355. struct ggml_tensor * b,
  1356. struct ggml_tensor * c,
  1357. ggml_custom3_op_t fun,
  1358. int n_tasks,
  1359. void * userdata);
  1360. // loss function
  1361. GGML_API struct ggml_tensor * ggml_cross_entropy_loss(
  1362. struct ggml_context * ctx,
  1363. struct ggml_tensor * a,
  1364. struct ggml_tensor * b);
  1365. GGML_API struct ggml_tensor * ggml_cross_entropy_loss_back(
  1366. struct ggml_context * ctx,
  1367. struct ggml_tensor * a,
  1368. struct ggml_tensor * b,
  1369. struct ggml_tensor * c);
  1370. //
  1371. // automatic differentiation
  1372. //
  1373. GGML_API void ggml_set_param(
  1374. struct ggml_context * ctx,
  1375. struct ggml_tensor * tensor);
  1376. GGML_API void ggml_build_forward_expand (struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1377. GGML_API void ggml_build_backward_expand(struct ggml_context * ctx, struct ggml_cgraph * gf, struct ggml_cgraph * gb, bool keep);
  1378. GGML_API struct ggml_cgraph ggml_build_forward (struct ggml_tensor * tensor);
  1379. GGML_API struct ggml_cgraph ggml_build_backward(struct ggml_context * ctx, struct ggml_cgraph * gf, bool keep);
  1380. // graph allocation in a context
  1381. GGML_API struct ggml_cgraph * ggml_new_graph (struct ggml_context * ctx);
  1382. GGML_API struct ggml_cgraph * ggml_build_forward_ctx(struct ggml_context * ctx, struct ggml_tensor * tensor);
  1383. GGML_API size_t ggml_graph_overhead(void);
  1384. // ggml_graph_plan() has to be called before ggml_graph_compute()
  1385. // when plan.work_size > 0, caller must allocate memory for plan.work_data
  1386. GGML_API struct ggml_cplan ggml_graph_plan (struct ggml_cgraph * cgraph, int n_threads /*= GGML_DEFAULT_N_THREADS*/);
  1387. GGML_API int ggml_graph_compute(struct ggml_cgraph * cgraph, struct ggml_cplan * cplan);
  1388. GGML_API void ggml_graph_reset (struct ggml_cgraph * cgraph);
  1389. // same as ggml_graph_compute() but the work data is allocated as a part of the context
  1390. // note: the drawback of this API is that you must have ensured that the context has enough memory for the work data
  1391. GGML_API void ggml_graph_compute_with_ctx(struct ggml_context * ctx, struct ggml_cgraph * cgraph, int n_threads);
  1392. GGML_API struct ggml_tensor * ggml_graph_get_tensor(struct ggml_cgraph * cgraph, const char * name);
  1393. GGML_API void ggml_graph_export(const struct ggml_cgraph * cgraph, const char * fname);
  1394. GGML_API struct ggml_cgraph ggml_graph_import(const char * fname, struct ggml_context ** ctx_data, struct ggml_context ** ctx_eval);
  1395. // print info and performance information for the graph
  1396. GGML_API void ggml_graph_print(const struct ggml_cgraph * cgraph);
  1397. // dump the graph into a file using the dot format
  1398. GGML_API void ggml_graph_dump_dot(const struct ggml_cgraph * gb, const struct ggml_cgraph * gf, const char * filename);
  1399. //
  1400. // optimization
  1401. //
  1402. // optimization methods
  1403. enum ggml_opt_type {
  1404. GGML_OPT_ADAM,
  1405. GGML_OPT_LBFGS,
  1406. };
  1407. // linesearch methods
  1408. enum ggml_linesearch {
  1409. GGML_LINESEARCH_DEFAULT = 1,
  1410. GGML_LINESEARCH_BACKTRACKING_ARMIJO = 0,
  1411. GGML_LINESEARCH_BACKTRACKING_WOLFE = 1,
  1412. GGML_LINESEARCH_BACKTRACKING_STRONG_WOLFE = 2,
  1413. };
  1414. // optimization return values
  1415. enum ggml_opt_result {
  1416. GGML_OPT_OK = 0,
  1417. GGML_OPT_DID_NOT_CONVERGE,
  1418. GGML_OPT_NO_CONTEXT,
  1419. GGML_OPT_INVALID_WOLFE,
  1420. GGML_OPT_FAIL,
  1421. GGML_LINESEARCH_FAIL = -128,
  1422. GGML_LINESEARCH_MINIMUM_STEP,
  1423. GGML_LINESEARCH_MAXIMUM_STEP,
  1424. GGML_LINESEARCH_MAXIMUM_ITERATIONS,
  1425. GGML_LINESEARCH_INVALID_PARAMETERS,
  1426. };
  1427. typedef void (*ggml_opt_callback)(void * data, float * sched);
  1428. // optimization parameters
  1429. //
  1430. // see ggml.c (ggml_opt_default_params) for default values
  1431. //
  1432. struct ggml_opt_params {
  1433. enum ggml_opt_type type;
  1434. int n_threads;
  1435. // delta-based convergence test
  1436. //
  1437. // if past == 0 - disabled
  1438. // if past > 0:
  1439. // stop if |f(x) - f(x_past)| < delta * max(1, |f(x)|)
  1440. //
  1441. int past;
  1442. float delta;
  1443. // maximum number of iterations without improvement
  1444. //
  1445. // if 0 - disabled
  1446. // if > 0:
  1447. // assume convergence if no cost improvement in this number of iterations
  1448. //
  1449. int max_no_improvement;
  1450. bool print_forward_graph;
  1451. bool print_backward_graph;
  1452. // ADAM parameters
  1453. struct {
  1454. int n_iter;
  1455. float sched; // schedule multiplier (fixed, decay or warmup)
  1456. float decay; // weight decay for AdamW, use 0.0f to disable
  1457. int decay_min_ndim; // minimum number of tensor dimension to apply weight decay
  1458. float alpha; // learning rate
  1459. float beta1;
  1460. float beta2;
  1461. float eps; // epsilon for numerical stability
  1462. float eps_f; // epsilon for convergence test
  1463. float eps_g; // epsilon for convergence test
  1464. float gclip; // gradient clipping
  1465. } adam;
  1466. // LBFGS parameters
  1467. struct {
  1468. int m; // number of corrections to approximate the inv. Hessian
  1469. int n_iter;
  1470. int max_linesearch;
  1471. float eps; // convergence tolerance
  1472. float ftol; // line search tolerance
  1473. float wolfe;
  1474. float min_step;
  1475. float max_step;
  1476. enum ggml_linesearch linesearch;
  1477. } lbfgs;
  1478. };
  1479. struct ggml_opt_context {
  1480. struct ggml_context * ctx;
  1481. struct ggml_opt_params params;
  1482. int iter;
  1483. int64_t nx; // number of parameter elements
  1484. bool just_initialized;
  1485. float loss_before;
  1486. float loss_after;
  1487. struct {
  1488. struct ggml_tensor * m; // first moment
  1489. struct ggml_tensor * v; // second moment
  1490. struct ggml_tensor * pf; // past function values
  1491. float fx_best;
  1492. float fx_prev;
  1493. int n_no_improvement;
  1494. } adam;
  1495. struct {
  1496. struct ggml_tensor * x; // current parameters
  1497. struct ggml_tensor * xp; // previous parameters
  1498. struct ggml_tensor * g; // current gradient
  1499. struct ggml_tensor * gp; // previous gradient
  1500. struct ggml_tensor * d; // search direction
  1501. struct ggml_tensor * pf; // past function values
  1502. struct ggml_tensor * lmal; // the L-BFGS memory alpha
  1503. struct ggml_tensor * lmys; // the L-BFGS memory ys
  1504. struct ggml_tensor * lms; // the L-BFGS memory s
  1505. struct ggml_tensor * lmy; // the L-BFGS memory y
  1506. float fx_best;
  1507. float step;
  1508. int j;
  1509. int k;
  1510. int end;
  1511. int n_no_improvement;
  1512. } lbfgs;
  1513. };
  1514. GGML_API struct ggml_opt_params ggml_opt_default_params(enum ggml_opt_type type);
  1515. // optimize the function defined by the tensor f
  1516. GGML_API enum ggml_opt_result ggml_opt(
  1517. struct ggml_context * ctx,
  1518. struct ggml_opt_params params,
  1519. struct ggml_tensor * f);
  1520. // initialize optimizer context
  1521. GGML_API void ggml_opt_init(
  1522. struct ggml_context * ctx,
  1523. struct ggml_opt_context * opt,
  1524. struct ggml_opt_params params,
  1525. int64_t nx);
  1526. // continue optimizing the function defined by the tensor f
  1527. GGML_API enum ggml_opt_result ggml_opt_resume(
  1528. struct ggml_context * ctx,
  1529. struct ggml_opt_context * opt,
  1530. struct ggml_tensor * f);
  1531. // continue optimizing the function defined by the tensor f
  1532. GGML_API enum ggml_opt_result ggml_opt_resume_g(
  1533. struct ggml_context * ctx,
  1534. struct ggml_opt_context * opt,
  1535. struct ggml_tensor * f,
  1536. struct ggml_cgraph * gf,
  1537. struct ggml_cgraph * gb,
  1538. ggml_opt_callback callback,
  1539. void * callback_data);
  1540. //
  1541. // quantization
  1542. //
  1543. GGML_API size_t ggml_quantize_q4_0(const float * src, void * dst, int n, int k, int64_t * hist);
  1544. GGML_API size_t ggml_quantize_q4_1(const float * src, void * dst, int n, int k, int64_t * hist);
  1545. GGML_API size_t ggml_quantize_q5_0(const float * src, void * dst, int n, int k, int64_t * hist);
  1546. GGML_API size_t ggml_quantize_q5_1(const float * src, void * dst, int n, int k, int64_t * hist);
  1547. GGML_API size_t ggml_quantize_q8_0(const float * src, void * dst, int n, int k, int64_t * hist);
  1548. GGML_API size_t ggml_quantize_chunk(enum ggml_type type, const float * src, void * dst, int start, int n, int64_t * hist);
  1549. //
  1550. // gguf
  1551. //
  1552. enum gguf_type {
  1553. GGUF_TYPE_UINT8 = 0,
  1554. GGUF_TYPE_INT8 = 1,
  1555. GGUF_TYPE_UINT16 = 2,
  1556. GGUF_TYPE_INT16 = 3,
  1557. GGUF_TYPE_UINT32 = 4,
  1558. GGUF_TYPE_INT32 = 5,
  1559. GGUF_TYPE_FLOAT32 = 6,
  1560. GGUF_TYPE_BOOL = 7,
  1561. GGUF_TYPE_STRING = 8,
  1562. GGUF_TYPE_ARRAY = 9,
  1563. GGUF_TYPE_UINT64 = 10,
  1564. GGUF_TYPE_INT64 = 11,
  1565. GGUF_TYPE_FLOAT64 = 12,
  1566. GGUF_TYPE_COUNT, // marks the end of the enum
  1567. };
  1568. struct gguf_context;
  1569. struct gguf_init_params {
  1570. bool no_alloc;
  1571. // if not NULL, create a ggml_context and allocate the tensor data in it
  1572. struct ggml_context ** ctx;
  1573. };
  1574. GGML_API struct gguf_context * gguf_init_empty(void);
  1575. GGML_API struct gguf_context * gguf_init_from_file(const char * fname, struct gguf_init_params params);
  1576. //GGML_API struct gguf_context * gguf_init_from_buffer(..);
  1577. GGML_API void gguf_free(struct gguf_context * ctx);
  1578. GGML_API const char * gguf_type_name(enum gguf_type type);
  1579. GGML_API int gguf_get_version (const struct gguf_context * ctx);
  1580. GGML_API size_t gguf_get_alignment (const struct gguf_context * ctx);
  1581. GGML_API size_t gguf_get_data_offset(const struct gguf_context * ctx);
  1582. GGML_API void * gguf_get_data (const struct gguf_context * ctx);
  1583. GGML_API int gguf_get_n_kv(const struct gguf_context * ctx);
  1584. GGML_API int gguf_find_key(const struct gguf_context * ctx, const char * key);
  1585. GGML_API const char * gguf_get_key (const struct gguf_context * ctx, int i);
  1586. GGML_API enum gguf_type gguf_get_kv_type (const struct gguf_context * ctx, int i);
  1587. GGML_API enum gguf_type gguf_get_arr_type(const struct gguf_context * ctx, int i);
  1588. // results are undefined if the wrong type is used for the key
  1589. GGML_API uint8_t gguf_get_val_u8 (const struct gguf_context * ctx, int i);
  1590. GGML_API int8_t gguf_get_val_i8 (const struct gguf_context * ctx, int i);
  1591. GGML_API uint16_t gguf_get_val_u16 (const struct gguf_context * ctx, int i);
  1592. GGML_API int16_t gguf_get_val_i16 (const struct gguf_context * ctx, int i);
  1593. GGML_API uint32_t gguf_get_val_u32 (const struct gguf_context * ctx, int i);
  1594. GGML_API int32_t gguf_get_val_i32 (const struct gguf_context * ctx, int i);
  1595. GGML_API float gguf_get_val_f32 (const struct gguf_context * ctx, int i);
  1596. GGML_API uint64_t gguf_get_val_u64 (const struct gguf_context * ctx, int i);
  1597. GGML_API int64_t gguf_get_val_i64 (const struct gguf_context * ctx, int i);
  1598. GGML_API double gguf_get_val_f64 (const struct gguf_context * ctx, int i);
  1599. GGML_API bool gguf_get_val_bool(const struct gguf_context * ctx, int i);
  1600. GGML_API const char * gguf_get_val_str (const struct gguf_context * ctx, int i);
  1601. GGML_API int gguf_get_arr_n (const struct gguf_context * ctx, int i);
  1602. GGML_API const void * gguf_get_arr_data(const struct gguf_context * ctx, int i);
  1603. GGML_API const char * gguf_get_arr_str (const struct gguf_context * ctx, int key_id, int i);
  1604. GGML_API int gguf_get_n_tensors (const struct gguf_context * ctx);
  1605. GGML_API int gguf_find_tensor (const struct gguf_context * ctx, const char * name);
  1606. GGML_API size_t gguf_get_tensor_offset(const struct gguf_context * ctx, int i);
  1607. GGML_API char * gguf_get_tensor_name (const struct gguf_context * ctx, int i);
  1608. // overrides existing values or adds a new one
  1609. GGML_API void gguf_set_val_u8 (struct gguf_context * ctx, const char * key, uint8_t val);
  1610. GGML_API void gguf_set_val_i8 (struct gguf_context * ctx, const char * key, int8_t val);
  1611. GGML_API void gguf_set_val_u16 (struct gguf_context * ctx, const char * key, uint16_t val);
  1612. GGML_API void gguf_set_val_i16 (struct gguf_context * ctx, const char * key, int16_t val);
  1613. GGML_API void gguf_set_val_u32 (struct gguf_context * ctx, const char * key, uint32_t val);
  1614. GGML_API void gguf_set_val_i32 (struct gguf_context * ctx, const char * key, int32_t val);
  1615. GGML_API void gguf_set_val_f32 (struct gguf_context * ctx, const char * key, float val);
  1616. GGML_API void gguf_set_val_u64 (struct gguf_context * ctx, const char * key, uint64_t val);
  1617. GGML_API void gguf_set_val_i64 (struct gguf_context * ctx, const char * key, int64_t val);
  1618. GGML_API void gguf_set_val_f64 (struct gguf_context * ctx, const char * key, double val);
  1619. GGML_API void gguf_set_val_bool(struct gguf_context * ctx, const char * key, bool val);
  1620. GGML_API void gguf_set_val_str (struct gguf_context * ctx, const char * key, const char * val);
  1621. GGML_API void gguf_set_arr_data(struct gguf_context * ctx, const char * key, enum gguf_type type, const void * data, int n);
  1622. GGML_API void gguf_set_arr_str (struct gguf_context * ctx, const char * key, const char ** data, int n);
  1623. // set or add KV pairs from another context
  1624. GGML_API void gguf_set_kv(struct gguf_context * ctx, struct gguf_context * src);
  1625. // manage tensor info
  1626. GGML_API void gguf_add_tensor(struct gguf_context * ctx, const struct ggml_tensor * tensor);
  1627. GGML_API void gguf_set_tensor_type(struct gguf_context * ctx, const char * name, enum ggml_type type);
  1628. GGML_API void gguf_set_tensor_data(struct gguf_context * ctx, const char * name, const void * data, size_t size);
  1629. // writing gguf files can be done in 2 ways:
  1630. //
  1631. // - write the entire gguf_context to a binary file in a single pass:
  1632. //
  1633. // gguf_write_to_file(ctx, fname);
  1634. //
  1635. // - first prepare a file with a placeholder for the meta data, write the tensor data, then write the meta data:
  1636. //
  1637. // FILE * f = fopen(fname, "wb");
  1638. // fseek(f, gguf_get_meta_size(ctx), SEEK_SET);
  1639. // fwrite(f, ...);
  1640. // void * data = gguf_meta_get_meta_data(ctx);
  1641. // fseek(f, 0, SEEK_SET);
  1642. // fwrite(f, data, gguf_get_meta_size(ctx));
  1643. // free(data);
  1644. // fclose(f);
  1645. //
  1646. // write the entire context to a binary file
  1647. GGML_API void gguf_write_to_file(const struct gguf_context * ctx, const char * fname, bool only_meta);
  1648. // get the size in bytes of the meta data (header, kv pairs, tensor info) including padding
  1649. GGML_API size_t gguf_get_meta_size(const struct gguf_context * ctx);
  1650. GGML_API void gguf_get_meta_data(const struct gguf_context * ctx, void * data);
  1651. //
  1652. // system info
  1653. //
  1654. GGML_API int ggml_cpu_has_avx (void);
  1655. GGML_API int ggml_cpu_has_avx2 (void);
  1656. GGML_API int ggml_cpu_has_avx512 (void);
  1657. GGML_API int ggml_cpu_has_avx512_vbmi(void);
  1658. GGML_API int ggml_cpu_has_avx512_vnni(void);
  1659. GGML_API int ggml_cpu_has_fma (void);
  1660. GGML_API int ggml_cpu_has_neon (void);
  1661. GGML_API int ggml_cpu_has_arm_fma (void);
  1662. GGML_API int ggml_cpu_has_f16c (void);
  1663. GGML_API int ggml_cpu_has_fp16_va (void);
  1664. GGML_API int ggml_cpu_has_wasm_simd (void);
  1665. GGML_API int ggml_cpu_has_blas (void);
  1666. GGML_API int ggml_cpu_has_cublas (void);
  1667. GGML_API int ggml_cpu_has_clblast (void);
  1668. GGML_API int ggml_cpu_has_gpublas (void);
  1669. GGML_API int ggml_cpu_has_sse3 (void);
  1670. GGML_API int ggml_cpu_has_ssse3 (void);
  1671. GGML_API int ggml_cpu_has_vsx (void);
  1672. //
  1673. // Internal types and functions exposed for tests and benchmarks
  1674. //
  1675. #ifdef __cplusplus
  1676. // restrict not standard in C++
  1677. #define GGML_RESTRICT
  1678. #else
  1679. #define GGML_RESTRICT restrict
  1680. #endif
  1681. typedef void (*ggml_to_float_t) (const void * GGML_RESTRICT x, float * GGML_RESTRICT y, int k);
  1682. typedef void (*ggml_from_float_t)(const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int k);
  1683. typedef void (*ggml_vec_dot_t) (const int n, float * GGML_RESTRICT s, const void * GGML_RESTRICT x, const void * GGML_RESTRICT y);
  1684. typedef struct {
  1685. const char * type_name;
  1686. int blck_size;
  1687. size_t type_size;
  1688. bool is_quantized;
  1689. ggml_to_float_t to_float;
  1690. ggml_from_float_t from_float;
  1691. ggml_from_float_t from_float_reference;
  1692. ggml_vec_dot_t vec_dot;
  1693. enum ggml_type vec_dot_type;
  1694. } ggml_type_traits_t;
  1695. ggml_type_traits_t ggml_internal_get_type_traits(enum ggml_type type);
  1696. #ifdef __cplusplus
  1697. }
  1698. #endif