ggml.h 86 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290
  1. /**
  2. * llama.cpp - commit 40c6d79fb52f995f47507fedfeaae2ac05d9b35c - do not edit this file
  3. *
  4. * MIT License
  5. *
  6. * Copyright (c) 2023-2024 The ggml authors
  7. *
  8. * Permission is hereby granted, free of charge, to any person obtaining a copy
  9. * of this software and associated documentation files (the "Software"), to deal
  10. * in the Software without restriction, including without limitation the rights
  11. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. * copies of the Software, and to permit persons to whom the Software is
  13. * furnished to do so, subject to the following conditions:
  14. *
  15. * The above copyright notice and this permission notice shall be included in all
  16. * copies or substantial portions of the Software.
  17. *
  18. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24. * SOFTWARE.
  25. */
  26. #pragma once
  27. //
  28. // GGML Tensor Library
  29. //
  30. // This documentation is still a work in progress.
  31. // If you wish some specific topics to be covered, feel free to drop a comment:
  32. //
  33. // https://github.com/ggerganov/whisper.cpp/issues/40
  34. //
  35. // ## Overview
  36. //
  37. // This library implements:
  38. //
  39. // - a set of tensor operations
  40. // - automatic differentiation
  41. // - basic optimization algorithms
  42. //
  43. // The aim of this library is to provide a minimalistic approach for various machine learning tasks. This includes,
  44. // but is not limited to, the following:
  45. //
  46. // - linear regression
  47. // - support vector machines
  48. // - neural networks
  49. //
  50. // The library allows the user to define a certain function using the available tensor operations. This function
  51. // definition is represented internally via a computation graph. Each tensor operation in the function definition
  52. // corresponds to a node in the graph. Having the computation graph defined, the user can choose to compute the
  53. // function's value and/or its gradient with respect to the input variables. Optionally, the function can be optimized
  54. // using one of the available optimization algorithms.
  55. //
  56. // For example, here we define the function: f(x) = a*x^2 + b
  57. //
  58. // {
  59. // struct ggml_init_params params = {
  60. // .mem_size = 16*1024*1024,
  61. // .mem_buffer = NULL,
  62. // };
  63. //
  64. // // memory allocation happens here
  65. // struct ggml_context * ctx = ggml_init(params);
  66. //
  67. // struct ggml_tensor * x = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, 1);
  68. //
  69. // ggml_set_param(ctx, x); // x is an input variable
  70. //
  71. // struct ggml_tensor * a = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, 1);
  72. // struct ggml_tensor * b = ggml_new_tensor_1d(ctx, GGML_TYPE_F32, 1);
  73. // struct ggml_tensor * x2 = ggml_mul(ctx, x, x);
  74. // struct ggml_tensor * f = ggml_add(ctx, ggml_mul(ctx, a, x2), b);
  75. //
  76. // ...
  77. // }
  78. //
  79. // Notice that the function definition above does not involve any actual computation. The computation is performed only
  80. // when the user explicitly requests it. For example, to compute the function's value at x = 2.0:
  81. //
  82. // {
  83. // ...
  84. //
  85. // struct ggml_cgraph * gf = ggml_new_graph(ctx);
  86. // ggml_build_forward_expand(gf, f);
  87. //
  88. // // set the input variable and parameter values
  89. // ggml_set_f32(x, 2.0f);
  90. // ggml_set_f32(a, 3.0f);
  91. // ggml_set_f32(b, 4.0f);
  92. //
  93. // ggml_graph_compute_with_ctx(ctx, &gf, n_threads);
  94. //
  95. // printf("f = %f\n", ggml_get_f32_1d(f, 0));
  96. //
  97. // ...
  98. // }
  99. //
  100. // The actual computation is performed in the ggml_graph_compute() function.
  101. //
  102. // The ggml_new_tensor_...() functions create new tensors. They are allocated in the memory buffer provided to the
  103. // ggml_init() function. You have to be careful not to exceed the memory buffer size. Therefore, you have to know
  104. // in advance how much memory you need for your computation. Alternatively, you can allocate a large enough memory
  105. // and after defining the computation graph, call the ggml_used_mem() function to find out how much memory was
  106. // actually needed.
  107. //
  108. // The ggml_set_param() function marks a tensor as an input variable. This is used by the automatic
  109. // differentiation and optimization algorithms.
  110. //
  111. // The described approach allows to define the function graph once and then compute its forward or backward graphs
  112. // multiple times. All computations will use the same memory buffer allocated in the ggml_init() function. This way
  113. // the user can avoid the memory allocation overhead at runtime.
  114. //
  115. // The library supports multi-dimensional tensors - up to 4 dimensions. The FP16 and FP32 data types are first class
  116. // citizens, but in theory the library can be extended to support FP8 and integer data types.
  117. //
  118. // Each tensor operation produces a new tensor. Initially the library was envisioned to support only the use of unary
  119. // and binary operations. Most of the available operations fall into one of these two categories. With time, it became
  120. // clear that the library needs to support more complex operations. The way to support these operations is not clear
  121. // yet, but a few examples are demonstrated in the following operations:
  122. //
  123. // - ggml_permute()
  124. // - ggml_conv_1d_1s()
  125. // - ggml_conv_1d_2s()
  126. //
  127. // For each tensor operator, the library implements a forward and backward computation function. The forward function
  128. // computes the output tensor value given the input tensor values. The backward function computes the adjoint of the
  129. // input tensors given the adjoint of the output tensor. For a detailed explanation of what this means, take a
  130. // calculus class, or watch the following video:
  131. //
  132. // What is Automatic Differentiation?
  133. // https://www.youtube.com/watch?v=wG_nF1awSSY
  134. //
  135. //
  136. // ## Tensor data (struct ggml_tensor)
  137. //
  138. // The tensors are stored in memory via the ggml_tensor struct. The structure provides information about the size of
  139. // the tensor, the data type, and the memory buffer where the tensor data is stored. Additionally, it contains
  140. // pointers to the "source" tensors - i.e. the tensors that were used to compute the current tensor. For example:
  141. //
  142. // {
  143. // struct ggml_tensor * c = ggml_add(ctx, a, b);
  144. //
  145. // assert(c->src[0] == a);
  146. // assert(c->src[1] == b);
  147. // }
  148. //
  149. // The multi-dimensional tensors are stored in row-major order. The ggml_tensor struct contains fields for the
  150. // number of elements in each dimension ("ne") as well as the number of bytes ("nb", a.k.a. stride). This allows
  151. // to store tensors that are not contiguous in memory, which is useful for operations such as transposition and
  152. // permutation. All tensor operations have to take the stride into account and not assume that the tensor is
  153. // contiguous in memory.
  154. //
  155. // The data of the tensor is accessed via the "data" pointer. For example:
  156. //
  157. // {
  158. // const int nx = 2;
  159. // const int ny = 3;
  160. //
  161. // struct ggml_tensor * a = ggml_new_tensor_2d(ctx, GGML_TYPE_F32, nx, ny);
  162. //
  163. // for (int y = 0; y < ny; y++) {
  164. // for (int x = 0; x < nx; x++) {
  165. // *(float *) ((char *) a->data + y*a->nb[1] + x*a->nb[0]) = x + y;
  166. // }
  167. // }
  168. //
  169. // ...
  170. // }
  171. //
  172. // Alternatively, there are helper functions, such as ggml_get_f32_1d() and ggml_set_f32_1d() that can be used.
  173. //
  174. // ## The matrix multiplication operator (ggml_mul_mat)
  175. //
  176. // TODO
  177. //
  178. //
  179. // ## Multi-threading
  180. //
  181. // TODO
  182. //
  183. //
  184. // ## Overview of ggml.c
  185. //
  186. // TODO
  187. //
  188. //
  189. // ## SIMD optimizations
  190. //
  191. // TODO
  192. //
  193. //
  194. // ## Debugging ggml
  195. //
  196. // TODO
  197. //
  198. //
  199. #ifdef GGML_SHARED
  200. # if defined(_WIN32) && !defined(__MINGW32__)
  201. # ifdef GGML_BUILD
  202. # define GGML_API __declspec(dllexport) extern
  203. # else
  204. # define GGML_API __declspec(dllimport) extern
  205. # endif
  206. # else
  207. # define GGML_API __attribute__ ((visibility ("default"))) extern
  208. # endif
  209. #else
  210. # define GGML_API extern
  211. #endif
  212. // TODO: support for clang
  213. #ifdef __GNUC__
  214. # define GGML_DEPRECATED(func, hint) func __attribute__((deprecated(hint)))
  215. #elif defined(_MSC_VER)
  216. # define GGML_DEPRECATED(func, hint) __declspec(deprecated(hint)) func
  217. #else
  218. # define GGML_DEPRECATED(func, hint) func
  219. #endif
  220. #ifndef __GNUC__
  221. # define GGML_ATTRIBUTE_FORMAT(...)
  222. #elif defined(__MINGW32__)
  223. # define GGML_ATTRIBUTE_FORMAT(...) __attribute__((format(gnu_printf, __VA_ARGS__)))
  224. #else
  225. # define GGML_ATTRIBUTE_FORMAT(...) __attribute__((format(printf, __VA_ARGS__)))
  226. #endif
  227. #include <stdbool.h>
  228. #include <stddef.h>
  229. #include <stdint.h>
  230. #include <stdio.h>
  231. #define GGML_FILE_MAGIC 0x67676d6c // "ggml"
  232. #define GGML_FILE_VERSION 2
  233. #define GGML_QNT_VERSION 2 // bump this on quantization format changes
  234. #define GGML_QNT_VERSION_FACTOR 1000 // do not change this
  235. #define GGML_MAX_DIMS 4
  236. #define GGML_MAX_PARAMS 2048
  237. #define GGML_MAX_SRC 10
  238. #define GGML_MAX_N_THREADS 512
  239. #define GGML_MAX_OP_PARAMS 64
  240. #ifndef GGML_MAX_NAME
  241. # define GGML_MAX_NAME 64
  242. #endif
  243. #define GGML_DEFAULT_N_THREADS 4
  244. #define GGML_DEFAULT_GRAPH_SIZE 2048
  245. #if UINTPTR_MAX == 0xFFFFFFFF
  246. #define GGML_MEM_ALIGN 4
  247. #else
  248. #define GGML_MEM_ALIGN 16
  249. #endif
  250. #define GGML_EXIT_SUCCESS 0
  251. #define GGML_EXIT_ABORTED 1
  252. #define GGML_ROPE_TYPE_NEOX 2
  253. #define GGUF_MAGIC "GGUF"
  254. #define GGUF_VERSION 3
  255. #define GGUF_DEFAULT_ALIGNMENT 32
  256. #define GGML_UNUSED(x) (void)(x)
  257. #define GGML_PAD(x, n) (((x) + (n) - 1) & ~((n) - 1))
  258. #ifndef NDEBUG
  259. # define GGML_UNREACHABLE() do { fprintf(stderr, "statement should be unreachable\n"); abort(); } while(0)
  260. #elif defined(__GNUC__)
  261. # define GGML_UNREACHABLE() __builtin_unreachable()
  262. #elif defined(_MSC_VER)
  263. # define GGML_UNREACHABLE() __assume(0)
  264. #else
  265. # define GGML_UNREACHABLE() ((void) 0)
  266. #endif
  267. #ifdef __cplusplus
  268. # define GGML_NORETURN [[noreturn]]
  269. #elif defined(_MSC_VER)
  270. # define GGML_NORETURN __declspec(noreturn)
  271. #else
  272. # define GGML_NORETURN _Noreturn
  273. #endif
  274. #define GGML_ABORT(...) ggml_abort(__FILE__, __LINE__, __VA_ARGS__)
  275. #define GGML_ASSERT(x) if (!(x)) GGML_ABORT("GGML_ASSERT(%s) failed", #x)
  276. // used to copy the number of elements and stride in bytes of tensors into local variables.
  277. // main purpose is to reduce code duplication and improve readability.
  278. //
  279. // example:
  280. //
  281. // GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne);
  282. // GGML_TENSOR_LOCALS(size_t, nb1, src1, nb);
  283. //
  284. #define GGML_TENSOR_LOCALS_1(type, prefix, pointer, array) \
  285. const type prefix##0 = (pointer)->array[0]; \
  286. GGML_UNUSED(prefix##0);
  287. #define GGML_TENSOR_LOCALS_2(type, prefix, pointer, array) \
  288. GGML_TENSOR_LOCALS_1 (type, prefix, pointer, array) \
  289. const type prefix##1 = (pointer)->array[1]; \
  290. GGML_UNUSED(prefix##1);
  291. #define GGML_TENSOR_LOCALS_3(type, prefix, pointer, array) \
  292. GGML_TENSOR_LOCALS_2 (type, prefix, pointer, array) \
  293. const type prefix##2 = (pointer)->array[2]; \
  294. GGML_UNUSED(prefix##2);
  295. #define GGML_TENSOR_LOCALS(type, prefix, pointer, array) \
  296. GGML_TENSOR_LOCALS_3 (type, prefix, pointer, array) \
  297. const type prefix##3 = (pointer)->array[3]; \
  298. GGML_UNUSED(prefix##3);
  299. #define GGML_TENSOR_UNARY_OP_LOCALS \
  300. GGML_TENSOR_LOCALS(int64_t, ne0, src0, ne) \
  301. GGML_TENSOR_LOCALS(size_t, nb0, src0, nb) \
  302. GGML_TENSOR_LOCALS(int64_t, ne, dst, ne) \
  303. GGML_TENSOR_LOCALS(size_t, nb, dst, nb)
  304. #define GGML_TENSOR_BINARY_OP_LOCALS \
  305. GGML_TENSOR_LOCALS(int64_t, ne0, src0, ne) \
  306. GGML_TENSOR_LOCALS(size_t, nb0, src0, nb) \
  307. GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne) \
  308. GGML_TENSOR_LOCALS(size_t, nb1, src1, nb) \
  309. GGML_TENSOR_LOCALS(int64_t, ne, dst, ne) \
  310. GGML_TENSOR_LOCALS(size_t, nb, dst, nb)
  311. #define GGML_TENSOR_BINARY_OP_LOCALS01 \
  312. GGML_TENSOR_LOCALS(int64_t, ne0, src0, ne) \
  313. GGML_TENSOR_LOCALS(size_t, nb0, src0, nb) \
  314. GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne) \
  315. GGML_TENSOR_LOCALS(size_t, nb1, src1, nb)
  316. #ifdef __cplusplus
  317. extern "C" {
  318. #endif
  319. GGML_NORETURN GGML_ATTRIBUTE_FORMAT(3, 4)
  320. GGML_API void ggml_abort(const char * file, int line, const char * fmt, ...);
  321. enum ggml_status {
  322. GGML_STATUS_ALLOC_FAILED = -2,
  323. GGML_STATUS_FAILED = -1,
  324. GGML_STATUS_SUCCESS = 0,
  325. GGML_STATUS_ABORTED = 1,
  326. };
  327. // get ggml_status name string
  328. GGML_API const char * ggml_status_to_string(enum ggml_status status);
  329. // ieee 754-2008 half-precision float16
  330. // todo: make this not an integral type
  331. typedef uint16_t ggml_fp16_t;
  332. GGML_API float ggml_fp16_to_fp32(ggml_fp16_t);
  333. GGML_API ggml_fp16_t ggml_fp32_to_fp16(float);
  334. GGML_API void ggml_fp16_to_fp32_row(const ggml_fp16_t *, float *, int64_t);
  335. GGML_API void ggml_fp32_to_fp16_row(const float *, ggml_fp16_t *, int64_t);
  336. // google brain half-precision bfloat16
  337. typedef struct { uint16_t bits; } ggml_bf16_t;
  338. GGML_API ggml_bf16_t ggml_fp32_to_bf16(float);
  339. GGML_API float ggml_bf16_to_fp32(ggml_bf16_t); // consider just doing << 16
  340. GGML_API void ggml_bf16_to_fp32_row(const ggml_bf16_t *, float *, int64_t);
  341. GGML_API void ggml_fp32_to_bf16_row_ref(const float *, ggml_bf16_t *, int64_t);
  342. GGML_API void ggml_fp32_to_bf16_row(const float *, ggml_bf16_t *, int64_t);
  343. struct ggml_object;
  344. struct ggml_context;
  345. struct ggml_cgraph;
  346. // NOTE: always add types at the end of the enum to keep backward compatibility
  347. enum ggml_type {
  348. GGML_TYPE_F32 = 0,
  349. GGML_TYPE_F16 = 1,
  350. GGML_TYPE_Q4_0 = 2,
  351. GGML_TYPE_Q4_1 = 3,
  352. // GGML_TYPE_Q4_2 = 4, support has been removed
  353. // GGML_TYPE_Q4_3 = 5, support has been removed
  354. GGML_TYPE_Q5_0 = 6,
  355. GGML_TYPE_Q5_1 = 7,
  356. GGML_TYPE_Q8_0 = 8,
  357. GGML_TYPE_Q8_1 = 9,
  358. GGML_TYPE_Q2_K = 10,
  359. GGML_TYPE_Q3_K = 11,
  360. GGML_TYPE_Q4_K = 12,
  361. GGML_TYPE_Q5_K = 13,
  362. GGML_TYPE_Q6_K = 14,
  363. GGML_TYPE_Q8_K = 15,
  364. GGML_TYPE_IQ2_XXS = 16,
  365. GGML_TYPE_IQ2_XS = 17,
  366. GGML_TYPE_IQ3_XXS = 18,
  367. GGML_TYPE_IQ1_S = 19,
  368. GGML_TYPE_IQ4_NL = 20,
  369. GGML_TYPE_IQ3_S = 21,
  370. GGML_TYPE_IQ2_S = 22,
  371. GGML_TYPE_IQ4_XS = 23,
  372. GGML_TYPE_I8 = 24,
  373. GGML_TYPE_I16 = 25,
  374. GGML_TYPE_I32 = 26,
  375. GGML_TYPE_I64 = 27,
  376. GGML_TYPE_F64 = 28,
  377. GGML_TYPE_IQ1_M = 29,
  378. GGML_TYPE_BF16 = 30,
  379. GGML_TYPE_Q4_0_4_4 = 31,
  380. GGML_TYPE_Q4_0_4_8 = 32,
  381. GGML_TYPE_Q4_0_8_8 = 33,
  382. GGML_TYPE_TQ1_0 = 34,
  383. GGML_TYPE_TQ2_0 = 35,
  384. GGML_TYPE_IQ4_NL_4_4 = 36,
  385. // GGML_TYPE_IQ4_NL_4_8 = 37,
  386. // GGML_TYPE_IQ4_NL_8_8 = 38,
  387. GGML_TYPE_COUNT,
  388. };
  389. // precision
  390. enum ggml_prec {
  391. GGML_PREC_DEFAULT,
  392. GGML_PREC_F32,
  393. };
  394. enum ggml_backend_type {
  395. GGML_BACKEND_TYPE_CPU = 0,
  396. GGML_BACKEND_TYPE_GPU = 10,
  397. GGML_BACKEND_TYPE_GPU_SPLIT = 20,
  398. };
  399. // model file types
  400. enum ggml_ftype {
  401. GGML_FTYPE_UNKNOWN = -1,
  402. GGML_FTYPE_ALL_F32 = 0,
  403. GGML_FTYPE_MOSTLY_F16 = 1, // except 1d tensors
  404. GGML_FTYPE_MOSTLY_Q4_0 = 2, // except 1d tensors
  405. GGML_FTYPE_MOSTLY_Q4_1 = 3, // except 1d tensors
  406. GGML_FTYPE_MOSTLY_Q4_1_SOME_F16 = 4, // tok_embeddings.weight and output.weight are F16
  407. GGML_FTYPE_MOSTLY_Q8_0 = 7, // except 1d tensors
  408. GGML_FTYPE_MOSTLY_Q5_0 = 8, // except 1d tensors
  409. GGML_FTYPE_MOSTLY_Q5_1 = 9, // except 1d tensors
  410. GGML_FTYPE_MOSTLY_Q2_K = 10, // except 1d tensors
  411. GGML_FTYPE_MOSTLY_Q3_K = 11, // except 1d tensors
  412. GGML_FTYPE_MOSTLY_Q4_K = 12, // except 1d tensors
  413. GGML_FTYPE_MOSTLY_Q5_K = 13, // except 1d tensors
  414. GGML_FTYPE_MOSTLY_Q6_K = 14, // except 1d tensors
  415. GGML_FTYPE_MOSTLY_IQ2_XXS = 15, // except 1d tensors
  416. GGML_FTYPE_MOSTLY_IQ2_XS = 16, // except 1d tensors
  417. GGML_FTYPE_MOSTLY_IQ3_XXS = 17, // except 1d tensors
  418. GGML_FTYPE_MOSTLY_IQ1_S = 18, // except 1d tensors
  419. GGML_FTYPE_MOSTLY_IQ4_NL = 19, // except 1d tensors
  420. GGML_FTYPE_MOSTLY_IQ3_S = 20, // except 1d tensors
  421. GGML_FTYPE_MOSTLY_IQ2_S = 21, // except 1d tensors
  422. GGML_FTYPE_MOSTLY_IQ4_XS = 22, // except 1d tensors
  423. GGML_FTYPE_MOSTLY_IQ1_M = 23, // except 1d tensors
  424. GGML_FTYPE_MOSTLY_BF16 = 24, // except 1d tensors
  425. GGML_FTYPE_MOSTLY_Q4_0_4_4 = 25, // except 1d tensors
  426. GGML_FTYPE_MOSTLY_Q4_0_4_8 = 26, // except 1d tensors
  427. GGML_FTYPE_MOSTLY_Q4_0_8_8 = 27, // except 1d tensors
  428. };
  429. // available tensor operations:
  430. enum ggml_op {
  431. GGML_OP_NONE = 0,
  432. GGML_OP_DUP,
  433. GGML_OP_ADD,
  434. GGML_OP_ADD1,
  435. GGML_OP_ACC,
  436. GGML_OP_SUB,
  437. GGML_OP_MUL,
  438. GGML_OP_DIV,
  439. GGML_OP_SQR,
  440. GGML_OP_SQRT,
  441. GGML_OP_LOG,
  442. GGML_OP_SIN,
  443. GGML_OP_COS,
  444. GGML_OP_SUM,
  445. GGML_OP_SUM_ROWS,
  446. GGML_OP_MEAN,
  447. GGML_OP_ARGMAX,
  448. GGML_OP_COUNT_EQUAL,
  449. GGML_OP_REPEAT,
  450. GGML_OP_REPEAT_BACK,
  451. GGML_OP_CONCAT,
  452. GGML_OP_SILU_BACK,
  453. GGML_OP_NORM, // normalize
  454. GGML_OP_RMS_NORM,
  455. GGML_OP_RMS_NORM_BACK,
  456. GGML_OP_GROUP_NORM,
  457. GGML_OP_MUL_MAT,
  458. GGML_OP_MUL_MAT_ID,
  459. GGML_OP_OUT_PROD,
  460. GGML_OP_SCALE,
  461. GGML_OP_SET,
  462. GGML_OP_CPY,
  463. GGML_OP_CONT,
  464. GGML_OP_RESHAPE,
  465. GGML_OP_VIEW,
  466. GGML_OP_PERMUTE,
  467. GGML_OP_TRANSPOSE,
  468. GGML_OP_GET_ROWS,
  469. GGML_OP_GET_ROWS_BACK,
  470. GGML_OP_DIAG,
  471. GGML_OP_DIAG_MASK_INF,
  472. GGML_OP_DIAG_MASK_ZERO,
  473. GGML_OP_SOFT_MAX,
  474. GGML_OP_SOFT_MAX_BACK,
  475. GGML_OP_ROPE,
  476. GGML_OP_ROPE_BACK,
  477. GGML_OP_CLAMP,
  478. GGML_OP_CONV_TRANSPOSE_1D,
  479. GGML_OP_IM2COL,
  480. GGML_OP_IM2COL_BACK,
  481. GGML_OP_CONV_TRANSPOSE_2D,
  482. GGML_OP_POOL_1D,
  483. GGML_OP_POOL_2D,
  484. GGML_OP_POOL_2D_BACK,
  485. GGML_OP_UPSCALE, // nearest interpolate
  486. GGML_OP_PAD,
  487. GGML_OP_UNPAD,
  488. GGML_OP_ARANGE,
  489. GGML_OP_TIMESTEP_EMBEDDING,
  490. GGML_OP_ARGSORT,
  491. GGML_OP_LEAKY_RELU,
  492. GGML_OP_FLASH_ATTN_EXT,
  493. GGML_OP_FLASH_ATTN_BACK,
  494. GGML_OP_SSM_CONV,
  495. GGML_OP_SSM_SCAN,
  496. GGML_OP_WIN_PART,
  497. GGML_OP_WIN_UNPART,
  498. GGML_OP_GET_REL_POS,
  499. GGML_OP_ADD_REL_POS,
  500. GGML_OP_RWKV_WKV6,
  501. GGML_OP_UNARY,
  502. GGML_OP_MAP_UNARY,
  503. GGML_OP_MAP_BINARY,
  504. GGML_OP_MAP_CUSTOM1_F32,
  505. GGML_OP_MAP_CUSTOM2_F32,
  506. GGML_OP_MAP_CUSTOM3_F32,
  507. GGML_OP_MAP_CUSTOM1,
  508. GGML_OP_MAP_CUSTOM2,
  509. GGML_OP_MAP_CUSTOM3,
  510. GGML_OP_CROSS_ENTROPY_LOSS,
  511. GGML_OP_CROSS_ENTROPY_LOSS_BACK,
  512. GGML_OP_OPT_STEP_ADAMW,
  513. GGML_OP_COUNT,
  514. };
  515. enum ggml_unary_op {
  516. GGML_UNARY_OP_ABS,
  517. GGML_UNARY_OP_SGN,
  518. GGML_UNARY_OP_NEG,
  519. GGML_UNARY_OP_STEP,
  520. GGML_UNARY_OP_TANH,
  521. GGML_UNARY_OP_ELU,
  522. GGML_UNARY_OP_RELU,
  523. GGML_UNARY_OP_SIGMOID,
  524. GGML_UNARY_OP_GELU,
  525. GGML_UNARY_OP_GELU_QUICK,
  526. GGML_UNARY_OP_SILU,
  527. GGML_UNARY_OP_HARDSWISH,
  528. GGML_UNARY_OP_HARDSIGMOID,
  529. GGML_UNARY_OP_EXP,
  530. GGML_UNARY_OP_COUNT,
  531. };
  532. enum ggml_object_type {
  533. GGML_OBJECT_TYPE_TENSOR,
  534. GGML_OBJECT_TYPE_GRAPH,
  535. GGML_OBJECT_TYPE_WORK_BUFFER
  536. };
  537. enum ggml_log_level {
  538. GGML_LOG_LEVEL_NONE = 0,
  539. GGML_LOG_LEVEL_DEBUG = 1,
  540. GGML_LOG_LEVEL_INFO = 2,
  541. GGML_LOG_LEVEL_WARN = 3,
  542. GGML_LOG_LEVEL_ERROR = 4,
  543. GGML_LOG_LEVEL_CONT = 5, // continue previous log
  544. };
  545. // this tensor...
  546. enum ggml_tensor_flag {
  547. GGML_TENSOR_FLAG_INPUT = 1, // ...is an input for the GGML compute graph
  548. GGML_TENSOR_FLAG_OUTPUT = 2, // ...is an output for the GGML compute graph
  549. GGML_TENSOR_FLAG_PARAM = 4, // ...contains trainable parameters
  550. GGML_TENSOR_FLAG_LOSS = 8, // ...defines loss for numerical optimization (multiple loss tensors add up)
  551. };
  552. struct ggml_init_params {
  553. // memory pool
  554. size_t mem_size; // bytes
  555. void * mem_buffer; // if NULL, memory will be allocated internally
  556. bool no_alloc; // don't allocate memory for the tensor data
  557. };
  558. // n-dimensional tensor
  559. struct ggml_tensor {
  560. enum ggml_type type;
  561. GGML_DEPRECATED(enum ggml_backend_type backend, "use the buffer type to find the storage location of the tensor");
  562. struct ggml_backend_buffer * buffer;
  563. int64_t ne[GGML_MAX_DIMS]; // number of elements
  564. size_t nb[GGML_MAX_DIMS]; // stride in bytes:
  565. // nb[0] = ggml_type_size(type)
  566. // nb[1] = nb[0] * (ne[0] / ggml_blck_size(type)) + padding
  567. // nb[i] = nb[i-1] * ne[i-1]
  568. // compute data
  569. enum ggml_op op;
  570. // op params - allocated as int32_t for alignment
  571. int32_t op_params[GGML_MAX_OP_PARAMS / sizeof(int32_t)];
  572. int32_t flags;
  573. struct ggml_tensor * src[GGML_MAX_SRC];
  574. // source tensor and offset for views
  575. struct ggml_tensor * view_src;
  576. size_t view_offs;
  577. void * data;
  578. char name[GGML_MAX_NAME];
  579. void * extra; // extra things e.g. for ggml-cuda.cu
  580. char padding[8];
  581. };
  582. static const size_t GGML_TENSOR_SIZE = sizeof(struct ggml_tensor);
  583. // Abort callback
  584. // If not NULL, called before ggml computation
  585. // If it returns true, the computation is aborted
  586. typedef bool (*ggml_abort_callback)(void * data);
  587. //
  588. // GUID
  589. //
  590. // GUID types
  591. typedef uint8_t ggml_guid[16];
  592. typedef ggml_guid * ggml_guid_t;
  593. GGML_API bool ggml_guid_matches(ggml_guid_t guid_a, ggml_guid_t guid_b);
  594. // misc
  595. GGML_API void ggml_time_init(void); // call this once at the beginning of the program
  596. GGML_API int64_t ggml_time_ms(void);
  597. GGML_API int64_t ggml_time_us(void);
  598. GGML_API int64_t ggml_cycles(void);
  599. GGML_API int64_t ggml_cycles_per_ms(void);
  600. // accepts a UTF-8 path, even on Windows
  601. GGML_API FILE * ggml_fopen(const char * fname, const char * mode);
  602. GGML_API void ggml_print_object (const struct ggml_object * obj);
  603. GGML_API void ggml_print_objects(const struct ggml_context * ctx);
  604. GGML_API int64_t ggml_nelements (const struct ggml_tensor * tensor);
  605. GGML_API int64_t ggml_nrows (const struct ggml_tensor * tensor);
  606. GGML_API size_t ggml_nbytes (const struct ggml_tensor * tensor);
  607. GGML_API size_t ggml_nbytes_pad(const struct ggml_tensor * tensor); // same as ggml_nbytes() but padded to GGML_MEM_ALIGN
  608. GGML_API int64_t ggml_blck_size(enum ggml_type type);
  609. GGML_API size_t ggml_type_size(enum ggml_type type); // size in bytes for all elements in a block
  610. GGML_API size_t ggml_row_size (enum ggml_type type, int64_t ne); // size in bytes for all elements in a row
  611. GGML_DEPRECATED(
  612. GGML_API double ggml_type_sizef(enum ggml_type type), // ggml_type_size()/ggml_blck_size() as float
  613. "use ggml_row_size() instead");
  614. GGML_API const char * ggml_type_name(enum ggml_type type);
  615. GGML_API const char * ggml_op_name (enum ggml_op op);
  616. GGML_API const char * ggml_op_symbol(enum ggml_op op);
  617. GGML_API const char * ggml_unary_op_name(enum ggml_unary_op op);
  618. GGML_API const char * ggml_op_desc(const struct ggml_tensor * t); // unary or op name
  619. GGML_API size_t ggml_element_size(const struct ggml_tensor * tensor);
  620. GGML_API bool ggml_is_quantized(enum ggml_type type);
  621. // TODO: temporary until model loading of ggml examples is refactored
  622. GGML_API enum ggml_type ggml_ftype_to_ggml_type(enum ggml_ftype ftype);
  623. GGML_API bool ggml_is_transposed(const struct ggml_tensor * tensor);
  624. GGML_API bool ggml_is_permuted (const struct ggml_tensor * tensor);
  625. GGML_API bool ggml_is_empty (const struct ggml_tensor * tensor);
  626. GGML_API bool ggml_is_scalar (const struct ggml_tensor * tensor);
  627. GGML_API bool ggml_is_vector (const struct ggml_tensor * tensor);
  628. GGML_API bool ggml_is_matrix (const struct ggml_tensor * tensor);
  629. GGML_API bool ggml_is_3d (const struct ggml_tensor * tensor);
  630. GGML_API int ggml_n_dims (const struct ggml_tensor * tensor); // returns 1 for scalars
  631. GGML_API bool ggml_is_contiguous (const struct ggml_tensor * tensor);
  632. GGML_API bool ggml_is_contiguous_0(const struct ggml_tensor * tensor); // same as ggml_is_contiguous()
  633. GGML_API bool ggml_is_contiguous_1(const struct ggml_tensor * tensor); // contiguous for dims >= 1
  634. GGML_API bool ggml_is_contiguous_2(const struct ggml_tensor * tensor); // contiguous for dims >= 2
  635. GGML_API bool ggml_are_same_shape (const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  636. GGML_API bool ggml_are_same_stride(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  637. GGML_API bool ggml_can_repeat(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  638. // use this to compute the memory overhead of a tensor
  639. GGML_API size_t ggml_tensor_overhead(void);
  640. GGML_API bool ggml_validate_row_data(enum ggml_type type, const void * data, size_t nbytes);
  641. // main
  642. GGML_API struct ggml_context * ggml_init (struct ggml_init_params params);
  643. GGML_API void ggml_reset(struct ggml_context * ctx);
  644. GGML_API void ggml_free (struct ggml_context * ctx);
  645. GGML_API size_t ggml_used_mem(const struct ggml_context * ctx);
  646. GGML_API bool ggml_get_no_alloc(struct ggml_context * ctx);
  647. GGML_API void ggml_set_no_alloc(struct ggml_context * ctx, bool no_alloc);
  648. GGML_API void * ggml_get_mem_buffer (const struct ggml_context * ctx);
  649. GGML_API size_t ggml_get_mem_size (const struct ggml_context * ctx);
  650. GGML_API size_t ggml_get_max_tensor_size(const struct ggml_context * ctx);
  651. GGML_API struct ggml_tensor * ggml_new_tensor(
  652. struct ggml_context * ctx,
  653. enum ggml_type type,
  654. int n_dims,
  655. const int64_t *ne);
  656. GGML_API struct ggml_tensor * ggml_new_tensor_1d(
  657. struct ggml_context * ctx,
  658. enum ggml_type type,
  659. int64_t ne0);
  660. GGML_API struct ggml_tensor * ggml_new_tensor_2d(
  661. struct ggml_context * ctx,
  662. enum ggml_type type,
  663. int64_t ne0,
  664. int64_t ne1);
  665. GGML_API struct ggml_tensor * ggml_new_tensor_3d(
  666. struct ggml_context * ctx,
  667. enum ggml_type type,
  668. int64_t ne0,
  669. int64_t ne1,
  670. int64_t ne2);
  671. GGML_API struct ggml_tensor * ggml_new_tensor_4d(
  672. struct ggml_context * ctx,
  673. enum ggml_type type,
  674. int64_t ne0,
  675. int64_t ne1,
  676. int64_t ne2,
  677. int64_t ne3);
  678. GGML_API void * ggml_new_buffer(struct ggml_context * ctx, size_t nbytes);
  679. GGML_API struct ggml_tensor * ggml_dup_tensor (struct ggml_context * ctx, const struct ggml_tensor * src);
  680. GGML_API struct ggml_tensor * ggml_view_tensor(struct ggml_context * ctx, struct ggml_tensor * src);
  681. // Context tensor enumeration and lookup
  682. GGML_API struct ggml_tensor * ggml_get_first_tensor(const struct ggml_context * ctx);
  683. GGML_API struct ggml_tensor * ggml_get_next_tensor (const struct ggml_context * ctx, struct ggml_tensor * tensor);
  684. GGML_API struct ggml_tensor * ggml_get_tensor(struct ggml_context * ctx, const char * name);
  685. // Converts a flat index into coordinates
  686. GGML_API void ggml_unravel_index(const struct ggml_tensor * tensor, int64_t i, int64_t * i0, int64_t * i1, int64_t * i2, int64_t * i3);
  687. GGML_API enum ggml_unary_op ggml_get_unary_op(const struct ggml_tensor * tensor);
  688. GGML_API void * ggml_get_data (const struct ggml_tensor * tensor);
  689. GGML_API float * ggml_get_data_f32(const struct ggml_tensor * tensor);
  690. GGML_API const char * ggml_get_name (const struct ggml_tensor * tensor);
  691. GGML_API struct ggml_tensor * ggml_set_name ( struct ggml_tensor * tensor, const char * name);
  692. GGML_ATTRIBUTE_FORMAT(2, 3)
  693. GGML_API struct ggml_tensor * ggml_format_name( struct ggml_tensor * tensor, const char * fmt, ...);
  694. // Tensor flags
  695. GGML_API void ggml_set_input(struct ggml_tensor * tensor);
  696. GGML_API void ggml_set_output(struct ggml_tensor * tensor);
  697. GGML_API void ggml_set_param(struct ggml_context * ctx, struct ggml_tensor * tensor);
  698. GGML_API void ggml_set_loss(struct ggml_tensor * tensor);
  699. //
  700. // operations on tensors with backpropagation
  701. //
  702. GGML_API struct ggml_tensor * ggml_dup(
  703. struct ggml_context * ctx,
  704. struct ggml_tensor * a);
  705. // in-place, returns view(a)
  706. GGML_API struct ggml_tensor * ggml_dup_inplace(
  707. struct ggml_context * ctx,
  708. struct ggml_tensor * a);
  709. GGML_API struct ggml_tensor * ggml_add(
  710. struct ggml_context * ctx,
  711. struct ggml_tensor * a,
  712. struct ggml_tensor * b);
  713. GGML_API struct ggml_tensor * ggml_add_inplace(
  714. struct ggml_context * ctx,
  715. struct ggml_tensor * a,
  716. struct ggml_tensor * b);
  717. GGML_API struct ggml_tensor * ggml_add_cast(
  718. struct ggml_context * ctx,
  719. struct ggml_tensor * a,
  720. struct ggml_tensor * b,
  721. enum ggml_type type);
  722. GGML_API struct ggml_tensor * ggml_add1(
  723. struct ggml_context * ctx,
  724. struct ggml_tensor * a,
  725. struct ggml_tensor * b);
  726. GGML_API struct ggml_tensor * ggml_add1_inplace(
  727. struct ggml_context * ctx,
  728. struct ggml_tensor * a,
  729. struct ggml_tensor * b);
  730. // dst = a
  731. // view(dst, nb1, nb2, nb3, offset) += b
  732. // return dst
  733. GGML_API struct ggml_tensor * ggml_acc(
  734. struct ggml_context * ctx,
  735. struct ggml_tensor * a,
  736. struct ggml_tensor * b,
  737. size_t nb1,
  738. size_t nb2,
  739. size_t nb3,
  740. size_t offset);
  741. GGML_API struct ggml_tensor * ggml_acc_inplace(
  742. struct ggml_context * ctx,
  743. struct ggml_tensor * a,
  744. struct ggml_tensor * b,
  745. size_t nb1,
  746. size_t nb2,
  747. size_t nb3,
  748. size_t offset);
  749. GGML_API struct ggml_tensor * ggml_sub(
  750. struct ggml_context * ctx,
  751. struct ggml_tensor * a,
  752. struct ggml_tensor * b);
  753. GGML_API struct ggml_tensor * ggml_sub_inplace(
  754. struct ggml_context * ctx,
  755. struct ggml_tensor * a,
  756. struct ggml_tensor * b);
  757. GGML_API struct ggml_tensor * ggml_mul(
  758. struct ggml_context * ctx,
  759. struct ggml_tensor * a,
  760. struct ggml_tensor * b);
  761. GGML_API struct ggml_tensor * ggml_mul_inplace(
  762. struct ggml_context * ctx,
  763. struct ggml_tensor * a,
  764. struct ggml_tensor * b);
  765. GGML_API struct ggml_tensor * ggml_div(
  766. struct ggml_context * ctx,
  767. struct ggml_tensor * a,
  768. struct ggml_tensor * b);
  769. GGML_API struct ggml_tensor * ggml_div_inplace(
  770. struct ggml_context * ctx,
  771. struct ggml_tensor * a,
  772. struct ggml_tensor * b);
  773. GGML_API struct ggml_tensor * ggml_sqr(
  774. struct ggml_context * ctx,
  775. struct ggml_tensor * a);
  776. GGML_API struct ggml_tensor * ggml_sqr_inplace(
  777. struct ggml_context * ctx,
  778. struct ggml_tensor * a);
  779. GGML_API struct ggml_tensor * ggml_sqrt(
  780. struct ggml_context * ctx,
  781. struct ggml_tensor * a);
  782. GGML_API struct ggml_tensor * ggml_sqrt_inplace(
  783. struct ggml_context * ctx,
  784. struct ggml_tensor * a);
  785. GGML_API struct ggml_tensor * ggml_log(
  786. struct ggml_context * ctx,
  787. struct ggml_tensor * a);
  788. GGML_API struct ggml_tensor * ggml_log_inplace(
  789. struct ggml_context * ctx,
  790. struct ggml_tensor * a);
  791. GGML_API struct ggml_tensor * ggml_sin(
  792. struct ggml_context * ctx,
  793. struct ggml_tensor * a);
  794. GGML_API struct ggml_tensor * ggml_sin_inplace(
  795. struct ggml_context * ctx,
  796. struct ggml_tensor * a);
  797. GGML_API struct ggml_tensor * ggml_cos(
  798. struct ggml_context * ctx,
  799. struct ggml_tensor * a);
  800. GGML_API struct ggml_tensor * ggml_cos_inplace(
  801. struct ggml_context * ctx,
  802. struct ggml_tensor * a);
  803. // return scalar
  804. GGML_API struct ggml_tensor * ggml_sum(
  805. struct ggml_context * ctx,
  806. struct ggml_tensor * a);
  807. // sums along rows, with input shape [a,b,c,d] return shape [1,b,c,d]
  808. GGML_API struct ggml_tensor * ggml_sum_rows(
  809. struct ggml_context * ctx,
  810. struct ggml_tensor * a);
  811. // mean along rows
  812. GGML_API struct ggml_tensor * ggml_mean(
  813. struct ggml_context * ctx,
  814. struct ggml_tensor * a);
  815. // argmax along rows
  816. GGML_API struct ggml_tensor * ggml_argmax(
  817. struct ggml_context * ctx,
  818. struct ggml_tensor * a);
  819. // count number of equal elements in a and b
  820. GGML_API struct ggml_tensor * ggml_count_equal(
  821. struct ggml_context * ctx,
  822. struct ggml_tensor * a,
  823. struct ggml_tensor * b);
  824. // if a is the same shape as b, and a is not parameter, return a
  825. // otherwise, return a new tensor: repeat(a) to fit in b
  826. GGML_API struct ggml_tensor * ggml_repeat(
  827. struct ggml_context * ctx,
  828. struct ggml_tensor * a,
  829. struct ggml_tensor * b);
  830. // sums repetitions in a into shape of b
  831. GGML_API struct ggml_tensor * ggml_repeat_back(
  832. struct ggml_context * ctx,
  833. struct ggml_tensor * a,
  834. struct ggml_tensor * b);
  835. // concat a and b along dim
  836. // used in stable-diffusion
  837. GGML_API struct ggml_tensor * ggml_concat(
  838. struct ggml_context * ctx,
  839. struct ggml_tensor * a,
  840. struct ggml_tensor * b,
  841. int dim);
  842. GGML_API struct ggml_tensor * ggml_abs(
  843. struct ggml_context * ctx,
  844. struct ggml_tensor * a);
  845. GGML_API struct ggml_tensor * ggml_abs_inplace(
  846. struct ggml_context * ctx,
  847. struct ggml_tensor * a);
  848. GGML_API struct ggml_tensor * ggml_sgn(
  849. struct ggml_context * ctx,
  850. struct ggml_tensor * a);
  851. GGML_API struct ggml_tensor * ggml_sgn_inplace(
  852. struct ggml_context * ctx,
  853. struct ggml_tensor * a);
  854. GGML_API struct ggml_tensor * ggml_neg(
  855. struct ggml_context * ctx,
  856. struct ggml_tensor * a);
  857. GGML_API struct ggml_tensor * ggml_neg_inplace(
  858. struct ggml_context * ctx,
  859. struct ggml_tensor * a);
  860. GGML_API struct ggml_tensor * ggml_step(
  861. struct ggml_context * ctx,
  862. struct ggml_tensor * a);
  863. GGML_API struct ggml_tensor * ggml_step_inplace(
  864. struct ggml_context * ctx,
  865. struct ggml_tensor * a);
  866. GGML_API struct ggml_tensor * ggml_tanh(
  867. struct ggml_context * ctx,
  868. struct ggml_tensor * a);
  869. GGML_API struct ggml_tensor * ggml_tanh_inplace(
  870. struct ggml_context * ctx,
  871. struct ggml_tensor * a);
  872. GGML_API struct ggml_tensor * ggml_elu(
  873. struct ggml_context * ctx,
  874. struct ggml_tensor * a);
  875. GGML_API struct ggml_tensor * ggml_elu_inplace(
  876. struct ggml_context * ctx,
  877. struct ggml_tensor * a);
  878. GGML_API struct ggml_tensor * ggml_relu(
  879. struct ggml_context * ctx,
  880. struct ggml_tensor * a);
  881. GGML_API struct ggml_tensor * ggml_leaky_relu(
  882. struct ggml_context * ctx,
  883. struct ggml_tensor * a, float negative_slope, bool inplace);
  884. GGML_API struct ggml_tensor * ggml_relu_inplace(
  885. struct ggml_context * ctx,
  886. struct ggml_tensor * a);
  887. GGML_API struct ggml_tensor * ggml_sigmoid(
  888. struct ggml_context * ctx,
  889. struct ggml_tensor * a);
  890. GGML_API struct ggml_tensor * ggml_sigmoid_inplace(
  891. struct ggml_context * ctx,
  892. struct ggml_tensor * a);
  893. GGML_API struct ggml_tensor * ggml_gelu(
  894. struct ggml_context * ctx,
  895. struct ggml_tensor * a);
  896. GGML_API struct ggml_tensor * ggml_gelu_inplace(
  897. struct ggml_context * ctx,
  898. struct ggml_tensor * a);
  899. GGML_API struct ggml_tensor * ggml_gelu_quick(
  900. struct ggml_context * ctx,
  901. struct ggml_tensor * a);
  902. GGML_API struct ggml_tensor * ggml_gelu_quick_inplace(
  903. struct ggml_context * ctx,
  904. struct ggml_tensor * a);
  905. GGML_API struct ggml_tensor * ggml_silu(
  906. struct ggml_context * ctx,
  907. struct ggml_tensor * a);
  908. GGML_API struct ggml_tensor * ggml_silu_inplace(
  909. struct ggml_context * ctx,
  910. struct ggml_tensor * a);
  911. // a - x
  912. // b - dy
  913. GGML_API struct ggml_tensor * ggml_silu_back(
  914. struct ggml_context * ctx,
  915. struct ggml_tensor * a,
  916. struct ggml_tensor * b);
  917. // hardswish(x) = x * relu6(x + 3) / 6
  918. GGML_API struct ggml_tensor * ggml_hardswish(
  919. struct ggml_context * ctx,
  920. struct ggml_tensor * a);
  921. // hardsigmoid(x) = relu6(x + 3) / 6
  922. GGML_API struct ggml_tensor * ggml_hardsigmoid(
  923. struct ggml_context * ctx,
  924. struct ggml_tensor * a);
  925. GGML_API struct ggml_tensor * ggml_exp(
  926. struct ggml_context * ctx,
  927. struct ggml_tensor * a);
  928. GGML_API struct ggml_tensor * ggml_exp_inplace(
  929. struct ggml_context * ctx,
  930. struct ggml_tensor * a);
  931. // normalize along rows
  932. GGML_API struct ggml_tensor * ggml_norm(
  933. struct ggml_context * ctx,
  934. struct ggml_tensor * a,
  935. float eps);
  936. GGML_API struct ggml_tensor * ggml_norm_inplace(
  937. struct ggml_context * ctx,
  938. struct ggml_tensor * a,
  939. float eps);
  940. GGML_API struct ggml_tensor * ggml_rms_norm(
  941. struct ggml_context * ctx,
  942. struct ggml_tensor * a,
  943. float eps);
  944. GGML_API struct ggml_tensor * ggml_rms_norm_inplace(
  945. struct ggml_context * ctx,
  946. struct ggml_tensor * a,
  947. float eps);
  948. // group normalize along ne0*ne1*n_groups
  949. // used in stable-diffusion
  950. GGML_API struct ggml_tensor * ggml_group_norm(
  951. struct ggml_context * ctx,
  952. struct ggml_tensor * a,
  953. int n_groups,
  954. float eps);
  955. GGML_API struct ggml_tensor * ggml_group_norm_inplace(
  956. struct ggml_context * ctx,
  957. struct ggml_tensor * a,
  958. int n_groups,
  959. float eps);
  960. // a - x
  961. // b - dy
  962. GGML_API struct ggml_tensor * ggml_rms_norm_back(
  963. struct ggml_context * ctx,
  964. struct ggml_tensor * a,
  965. struct ggml_tensor * b,
  966. float eps);
  967. // A: k columns, n rows => [ne03, ne02, n, k]
  968. // B: k columns, m rows (i.e. we transpose it internally) => [ne03 * x, ne02 * y, m, k]
  969. // result is n columns, m rows => [ne03 * x, ne02 * y, m, n]
  970. GGML_API struct ggml_tensor * ggml_mul_mat(
  971. struct ggml_context * ctx,
  972. struct ggml_tensor * a,
  973. struct ggml_tensor * b);
  974. // change the precision of a matrix multiplication
  975. // set to GGML_PREC_F32 for higher precision (useful for phi-2)
  976. GGML_API void ggml_mul_mat_set_prec(
  977. struct ggml_tensor * a,
  978. enum ggml_prec prec);
  979. // indirect matrix multiplication
  980. GGML_API struct ggml_tensor * ggml_mul_mat_id(
  981. struct ggml_context * ctx,
  982. struct ggml_tensor * as,
  983. struct ggml_tensor * b,
  984. struct ggml_tensor * ids);
  985. // A: m columns, n rows,
  986. // B: p columns, n rows,
  987. // result is m columns, p rows
  988. GGML_API struct ggml_tensor * ggml_out_prod(
  989. struct ggml_context * ctx,
  990. struct ggml_tensor * a,
  991. struct ggml_tensor * b);
  992. //
  993. // operations on tensors without backpropagation
  994. //
  995. GGML_API struct ggml_tensor * ggml_scale(
  996. struct ggml_context * ctx,
  997. struct ggml_tensor * a,
  998. float s);
  999. // in-place, returns view(a)
  1000. GGML_API struct ggml_tensor * ggml_scale_inplace(
  1001. struct ggml_context * ctx,
  1002. struct ggml_tensor * a,
  1003. float s);
  1004. // b -> view(a,offset,nb1,nb2,3), return modified a
  1005. GGML_API struct ggml_tensor * ggml_set(
  1006. struct ggml_context * ctx,
  1007. struct ggml_tensor * a,
  1008. struct ggml_tensor * b,
  1009. size_t nb1,
  1010. size_t nb2,
  1011. size_t nb3,
  1012. size_t offset); // in bytes
  1013. // b -> view(a,offset,nb1,nb2,3), return view(a)
  1014. GGML_API struct ggml_tensor * ggml_set_inplace(
  1015. struct ggml_context * ctx,
  1016. struct ggml_tensor * a,
  1017. struct ggml_tensor * b,
  1018. size_t nb1,
  1019. size_t nb2,
  1020. size_t nb3,
  1021. size_t offset); // in bytes
  1022. GGML_API struct ggml_tensor * ggml_set_1d(
  1023. struct ggml_context * ctx,
  1024. struct ggml_tensor * a,
  1025. struct ggml_tensor * b,
  1026. size_t offset); // in bytes
  1027. GGML_API struct ggml_tensor * ggml_set_1d_inplace(
  1028. struct ggml_context * ctx,
  1029. struct ggml_tensor * a,
  1030. struct ggml_tensor * b,
  1031. size_t offset); // in bytes
  1032. // b -> view(a,offset,nb1,nb2,3), return modified a
  1033. GGML_API struct ggml_tensor * ggml_set_2d(
  1034. struct ggml_context * ctx,
  1035. struct ggml_tensor * a,
  1036. struct ggml_tensor * b,
  1037. size_t nb1,
  1038. size_t offset); // in bytes
  1039. // b -> view(a,offset,nb1,nb2,3), return view(a)
  1040. GGML_API struct ggml_tensor * ggml_set_2d_inplace(
  1041. struct ggml_context * ctx,
  1042. struct ggml_tensor * a,
  1043. struct ggml_tensor * b,
  1044. size_t nb1,
  1045. size_t offset); // in bytes
  1046. // a -> b, return view(b)
  1047. GGML_API struct ggml_tensor * ggml_cpy(
  1048. struct ggml_context * ctx,
  1049. struct ggml_tensor * a,
  1050. struct ggml_tensor * b);
  1051. GGML_API struct ggml_tensor * ggml_cast(
  1052. struct ggml_context * ctx,
  1053. struct ggml_tensor * a,
  1054. enum ggml_type type);
  1055. // make contiguous
  1056. GGML_API struct ggml_tensor * ggml_cont(
  1057. struct ggml_context * ctx,
  1058. struct ggml_tensor * a);
  1059. // make contiguous, with new shape
  1060. GGML_API struct ggml_tensor * ggml_cont_1d(
  1061. struct ggml_context * ctx,
  1062. struct ggml_tensor * a,
  1063. int64_t ne0);
  1064. GGML_API struct ggml_tensor * ggml_cont_2d(
  1065. struct ggml_context * ctx,
  1066. struct ggml_tensor * a,
  1067. int64_t ne0,
  1068. int64_t ne1);
  1069. GGML_API struct ggml_tensor * ggml_cont_3d(
  1070. struct ggml_context * ctx,
  1071. struct ggml_tensor * a,
  1072. int64_t ne0,
  1073. int64_t ne1,
  1074. int64_t ne2);
  1075. GGML_API struct ggml_tensor * ggml_cont_4d(
  1076. struct ggml_context * ctx,
  1077. struct ggml_tensor * a,
  1078. int64_t ne0,
  1079. int64_t ne1,
  1080. int64_t ne2,
  1081. int64_t ne3);
  1082. // return view(a), b specifies the new shape
  1083. // TODO: when we start computing gradient, make a copy instead of view
  1084. GGML_API struct ggml_tensor * ggml_reshape(
  1085. struct ggml_context * ctx,
  1086. struct ggml_tensor * a,
  1087. struct ggml_tensor * b);
  1088. // return view(a)
  1089. // TODO: when we start computing gradient, make a copy instead of view
  1090. GGML_API struct ggml_tensor * ggml_reshape_1d(
  1091. struct ggml_context * ctx,
  1092. struct ggml_tensor * a,
  1093. int64_t ne0);
  1094. GGML_API struct ggml_tensor * ggml_reshape_2d(
  1095. struct ggml_context * ctx,
  1096. struct ggml_tensor * a,
  1097. int64_t ne0,
  1098. int64_t ne1);
  1099. // return view(a)
  1100. // TODO: when we start computing gradient, make a copy instead of view
  1101. GGML_API struct ggml_tensor * ggml_reshape_3d(
  1102. struct ggml_context * ctx,
  1103. struct ggml_tensor * a,
  1104. int64_t ne0,
  1105. int64_t ne1,
  1106. int64_t ne2);
  1107. GGML_API struct ggml_tensor * ggml_reshape_4d(
  1108. struct ggml_context * ctx,
  1109. struct ggml_tensor * a,
  1110. int64_t ne0,
  1111. int64_t ne1,
  1112. int64_t ne2,
  1113. int64_t ne3);
  1114. // offset in bytes
  1115. GGML_API struct ggml_tensor * ggml_view_1d(
  1116. struct ggml_context * ctx,
  1117. struct ggml_tensor * a,
  1118. int64_t ne0,
  1119. size_t offset);
  1120. GGML_API struct ggml_tensor * ggml_view_2d(
  1121. struct ggml_context * ctx,
  1122. struct ggml_tensor * a,
  1123. int64_t ne0,
  1124. int64_t ne1,
  1125. size_t nb1, // row stride in bytes
  1126. size_t offset);
  1127. GGML_API struct ggml_tensor * ggml_view_3d(
  1128. struct ggml_context * ctx,
  1129. struct ggml_tensor * a,
  1130. int64_t ne0,
  1131. int64_t ne1,
  1132. int64_t ne2,
  1133. size_t nb1, // row stride in bytes
  1134. size_t nb2, // slice stride in bytes
  1135. size_t offset);
  1136. GGML_API struct ggml_tensor * ggml_view_4d(
  1137. struct ggml_context * ctx,
  1138. struct ggml_tensor * a,
  1139. int64_t ne0,
  1140. int64_t ne1,
  1141. int64_t ne2,
  1142. int64_t ne3,
  1143. size_t nb1, // row stride in bytes
  1144. size_t nb2, // slice stride in bytes
  1145. size_t nb3,
  1146. size_t offset);
  1147. GGML_API struct ggml_tensor * ggml_permute(
  1148. struct ggml_context * ctx,
  1149. struct ggml_tensor * a,
  1150. int axis0,
  1151. int axis1,
  1152. int axis2,
  1153. int axis3);
  1154. // alias for ggml_permute(ctx, a, 1, 0, 2, 3)
  1155. GGML_API struct ggml_tensor * ggml_transpose(
  1156. struct ggml_context * ctx,
  1157. struct ggml_tensor * a);
  1158. // supports 3D: a->ne[2] == b->ne[1]
  1159. GGML_API struct ggml_tensor * ggml_get_rows(
  1160. struct ggml_context * ctx,
  1161. struct ggml_tensor * a, // data
  1162. struct ggml_tensor * b); // row indices
  1163. GGML_API struct ggml_tensor * ggml_get_rows_back(
  1164. struct ggml_context * ctx,
  1165. struct ggml_tensor * a, // gradients of ggml_get_rows result
  1166. struct ggml_tensor * b, // row indices
  1167. struct ggml_tensor * c); // data for ggml_get_rows, only used for its shape
  1168. GGML_API struct ggml_tensor * ggml_diag(
  1169. struct ggml_context * ctx,
  1170. struct ggml_tensor * a);
  1171. // set elements above the diagonal to -INF
  1172. GGML_API struct ggml_tensor * ggml_diag_mask_inf(
  1173. struct ggml_context * ctx,
  1174. struct ggml_tensor * a,
  1175. int n_past);
  1176. // in-place, returns view(a)
  1177. GGML_API struct ggml_tensor * ggml_diag_mask_inf_inplace(
  1178. struct ggml_context * ctx,
  1179. struct ggml_tensor * a,
  1180. int n_past);
  1181. // set elements above the diagonal to 0
  1182. GGML_API struct ggml_tensor * ggml_diag_mask_zero(
  1183. struct ggml_context * ctx,
  1184. struct ggml_tensor * a,
  1185. int n_past);
  1186. // in-place, returns view(a)
  1187. GGML_API struct ggml_tensor * ggml_diag_mask_zero_inplace(
  1188. struct ggml_context * ctx,
  1189. struct ggml_tensor * a,
  1190. int n_past);
  1191. GGML_API struct ggml_tensor * ggml_soft_max(
  1192. struct ggml_context * ctx,
  1193. struct ggml_tensor * a);
  1194. // in-place, returns view(a)
  1195. GGML_API struct ggml_tensor * ggml_soft_max_inplace(
  1196. struct ggml_context * ctx,
  1197. struct ggml_tensor * a);
  1198. // fused soft_max(a*scale + mask*(ALiBi slope))
  1199. // mask is optional
  1200. // max_bias = 0.0f for no ALiBi
  1201. GGML_API struct ggml_tensor * ggml_soft_max_ext(
  1202. struct ggml_context * ctx,
  1203. struct ggml_tensor * a,
  1204. struct ggml_tensor * mask,
  1205. float scale,
  1206. float max_bias);
  1207. GGML_API struct ggml_tensor * ggml_soft_max_back(
  1208. struct ggml_context * ctx,
  1209. struct ggml_tensor * a,
  1210. struct ggml_tensor * b);
  1211. // in-place, returns view(a)
  1212. GGML_API struct ggml_tensor * ggml_soft_max_back_inplace(
  1213. struct ggml_context * ctx,
  1214. struct ggml_tensor * a,
  1215. struct ggml_tensor * b);
  1216. // rotary position embedding
  1217. // if (mode & 1) - skip n_past elements (NOT SUPPORTED)
  1218. // if (mode & GGML_ROPE_TYPE_NEOX) - GPT-NeoX style
  1219. //
  1220. // b is an int32 vector with size a->ne[2], it contains the positions
  1221. GGML_API struct ggml_tensor * ggml_rope(
  1222. struct ggml_context * ctx,
  1223. struct ggml_tensor * a,
  1224. struct ggml_tensor * b,
  1225. int n_dims,
  1226. int mode);
  1227. // in-place, returns view(a)
  1228. GGML_API struct ggml_tensor * ggml_rope_inplace(
  1229. struct ggml_context * ctx,
  1230. struct ggml_tensor * a,
  1231. struct ggml_tensor * b,
  1232. int n_dims,
  1233. int mode);
  1234. // custom RoPE
  1235. // c is freq factors (e.g. phi3-128k), (optional)
  1236. GGML_API struct ggml_tensor * ggml_rope_ext(
  1237. struct ggml_context * ctx,
  1238. struct ggml_tensor * a,
  1239. struct ggml_tensor * b,
  1240. struct ggml_tensor * c,
  1241. int n_dims,
  1242. int mode,
  1243. int n_ctx_orig,
  1244. float freq_base,
  1245. float freq_scale,
  1246. float ext_factor,
  1247. float attn_factor,
  1248. float beta_fast,
  1249. float beta_slow);
  1250. // in-place, returns view(a)
  1251. GGML_API struct ggml_tensor * ggml_rope_ext_inplace(
  1252. struct ggml_context * ctx,
  1253. struct ggml_tensor * a,
  1254. struct ggml_tensor * b,
  1255. struct ggml_tensor * c,
  1256. int n_dims,
  1257. int mode,
  1258. int n_ctx_orig,
  1259. float freq_base,
  1260. float freq_scale,
  1261. float ext_factor,
  1262. float attn_factor,
  1263. float beta_fast,
  1264. float beta_slow);
  1265. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_rope_custom(
  1266. struct ggml_context * ctx,
  1267. struct ggml_tensor * a,
  1268. struct ggml_tensor * b,
  1269. int n_dims,
  1270. int mode,
  1271. int n_ctx_orig,
  1272. float freq_base,
  1273. float freq_scale,
  1274. float ext_factor,
  1275. float attn_factor,
  1276. float beta_fast,
  1277. float beta_slow),
  1278. "use ggml_rope_ext instead");
  1279. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_rope_custom_inplace(
  1280. struct ggml_context * ctx,
  1281. struct ggml_tensor * a,
  1282. struct ggml_tensor * b,
  1283. int n_dims,
  1284. int mode,
  1285. int n_ctx_orig,
  1286. float freq_base,
  1287. float freq_scale,
  1288. float ext_factor,
  1289. float attn_factor,
  1290. float beta_fast,
  1291. float beta_slow),
  1292. "use ggml_rope_ext_inplace instead");
  1293. // compute correction dims for YaRN RoPE scaling
  1294. GGML_API void ggml_rope_yarn_corr_dims(
  1295. int n_dims, int n_ctx_orig, float freq_base, float beta_fast, float beta_slow, float dims[2]);
  1296. // rotary position embedding backward, i.e compute dx from dy
  1297. // a - dy
  1298. GGML_API struct ggml_tensor * ggml_rope_back(
  1299. struct ggml_context * ctx,
  1300. struct ggml_tensor * a, // gradients of ggml_rope result
  1301. struct ggml_tensor * b, // positions
  1302. struct ggml_tensor * c, // freq factors
  1303. int n_dims,
  1304. int mode,
  1305. int n_ctx_orig,
  1306. float freq_base,
  1307. float freq_scale,
  1308. float ext_factor,
  1309. float attn_factor,
  1310. float beta_fast,
  1311. float beta_slow);
  1312. // clamp
  1313. // in-place, returns view(a)
  1314. GGML_API struct ggml_tensor * ggml_clamp(
  1315. struct ggml_context * ctx,
  1316. struct ggml_tensor * a,
  1317. float min,
  1318. float max);
  1319. // im2col
  1320. // converts data into a format that effectively results in a convolution when combined with matrix multiplication
  1321. GGML_API struct ggml_tensor * ggml_im2col(
  1322. struct ggml_context * ctx,
  1323. struct ggml_tensor * a, // convolution kernel
  1324. struct ggml_tensor * b, // data
  1325. int s0, // stride dimension 0
  1326. int s1, // stride dimension 1
  1327. int p0, // padding dimension 0
  1328. int p1, // padding dimension 1
  1329. int d0, // dilation dimension 0
  1330. int d1, // dilation dimension 1
  1331. bool is_2D,
  1332. enum ggml_type dst_type);
  1333. GGML_API struct ggml_tensor * ggml_im2col_back(
  1334. struct ggml_context * ctx,
  1335. struct ggml_tensor * a, // convolution kernel
  1336. struct ggml_tensor * b, // gradient of im2col output
  1337. int64_t * ne, // shape of im2col input
  1338. int s0, // stride dimension 0
  1339. int s1, // stride dimension 1
  1340. int p0, // padding dimension 0
  1341. int p1, // padding dimension 1
  1342. int d0, // dilation dimension 0
  1343. int d1, // dilation dimension 1
  1344. bool is_2D);
  1345. GGML_API struct ggml_tensor * ggml_conv_depthwise_2d(
  1346. struct ggml_context * ctx,
  1347. struct ggml_tensor * a, // convolution kernel
  1348. struct ggml_tensor * b, // data
  1349. int s0, // stride dimension 0
  1350. int s1, // stride dimension 1
  1351. int p0, // padding dimension 0
  1352. int p1, // padding dimension 1
  1353. int d0, // dilation dimension 0
  1354. int d1); // dilation dimension 1
  1355. GGML_API struct ggml_tensor * ggml_conv_1d(
  1356. struct ggml_context * ctx,
  1357. struct ggml_tensor * a, // convolution kernel
  1358. struct ggml_tensor * b, // data
  1359. int s0, // stride
  1360. int p0, // padding
  1361. int d0); // dilation
  1362. // conv_1d with padding = half
  1363. // alias for ggml_conv_1d(a, b, s, a->ne[0]/2, d)
  1364. GGML_API struct ggml_tensor* ggml_conv_1d_ph(
  1365. struct ggml_context * ctx,
  1366. struct ggml_tensor * a, // convolution kernel
  1367. struct ggml_tensor * b, // data
  1368. int s, // stride
  1369. int d); // dilation
  1370. GGML_API struct ggml_tensor * ggml_conv_transpose_1d(
  1371. struct ggml_context * ctx,
  1372. struct ggml_tensor * a, // convolution kernel
  1373. struct ggml_tensor * b, // data
  1374. int s0, // stride
  1375. int p0, // padding
  1376. int d0); // dilation
  1377. GGML_API struct ggml_tensor * ggml_conv_2d(
  1378. struct ggml_context * ctx,
  1379. struct ggml_tensor * a, // convolution kernel
  1380. struct ggml_tensor * b, // data
  1381. int s0, // stride dimension 0
  1382. int s1, // stride dimension 1
  1383. int p0, // padding dimension 0
  1384. int p1, // padding dimension 1
  1385. int d0, // dilation dimension 0
  1386. int d1); // dilation dimension 1
  1387. // kernel size is a->ne[0] x a->ne[1]
  1388. // stride is equal to kernel size
  1389. // padding is zero
  1390. // example:
  1391. // a: 16 16 3 768
  1392. // b: 1024 1024 3 1
  1393. // res: 64 64 768 1
  1394. // used in sam
  1395. GGML_API struct ggml_tensor * ggml_conv_2d_sk_p0(
  1396. struct ggml_context * ctx,
  1397. struct ggml_tensor * a,
  1398. struct ggml_tensor * b);
  1399. // kernel size is a->ne[0] x a->ne[1]
  1400. // stride is 1
  1401. // padding is half
  1402. // example:
  1403. // a: 3 3 256 256
  1404. // b: 64 64 256 1
  1405. // res: 64 64 256 1
  1406. // used in sam
  1407. GGML_API struct ggml_tensor * ggml_conv_2d_s1_ph(
  1408. struct ggml_context * ctx,
  1409. struct ggml_tensor * a,
  1410. struct ggml_tensor * b);
  1411. GGML_API struct ggml_tensor * ggml_conv_transpose_2d_p0(
  1412. struct ggml_context * ctx,
  1413. struct ggml_tensor * a,
  1414. struct ggml_tensor * b,
  1415. int stride);
  1416. enum ggml_op_pool {
  1417. GGML_OP_POOL_MAX,
  1418. GGML_OP_POOL_AVG,
  1419. GGML_OP_POOL_COUNT,
  1420. };
  1421. GGML_API struct ggml_tensor * ggml_pool_1d(
  1422. struct ggml_context * ctx,
  1423. struct ggml_tensor * a,
  1424. enum ggml_op_pool op,
  1425. int k0, // kernel size
  1426. int s0, // stride
  1427. int p0); // padding
  1428. // the result will have 2*p0 padding for the first dimension
  1429. // and 2*p1 padding for the second dimension
  1430. GGML_API struct ggml_tensor * ggml_pool_2d(
  1431. struct ggml_context * ctx,
  1432. struct ggml_tensor * a,
  1433. enum ggml_op_pool op,
  1434. int k0,
  1435. int k1,
  1436. int s0,
  1437. int s1,
  1438. float p0,
  1439. float p1);
  1440. GGML_API struct ggml_tensor * ggml_pool_2d_back(
  1441. struct ggml_context * ctx,
  1442. struct ggml_tensor * a,
  1443. struct ggml_tensor * af, // "a"/input used in forward pass
  1444. enum ggml_op_pool op,
  1445. int k0,
  1446. int k1,
  1447. int s0,
  1448. int s1,
  1449. float p0,
  1450. float p1);
  1451. // nearest interpolate
  1452. // multiplies ne0 and ne1 by scale factor
  1453. // used in stable-diffusion
  1454. GGML_API struct ggml_tensor * ggml_upscale(
  1455. struct ggml_context * ctx,
  1456. struct ggml_tensor * a,
  1457. int scale_factor);
  1458. // nearest interpolate
  1459. // nearest interpolate to specified dimensions
  1460. // used in tortoise.cpp
  1461. GGML_API struct ggml_tensor * ggml_upscale_ext(
  1462. struct ggml_context * ctx,
  1463. struct ggml_tensor * a,
  1464. int ne0,
  1465. int ne1,
  1466. int ne2,
  1467. int ne3);
  1468. // pad each dimension with zeros: [x, ..., x] -> [x, ..., x, 0, ..., 0]
  1469. GGML_API struct ggml_tensor * ggml_pad(
  1470. struct ggml_context * ctx,
  1471. struct ggml_tensor * a,
  1472. int p0,
  1473. int p1,
  1474. int p2,
  1475. int p3);
  1476. // unpad each dimension: [x, ..., x, y, ..., y] -> [x, ..., x]
  1477. GGML_API struct ggml_tensor * ggml_unpad(
  1478. struct ggml_context * ctx,
  1479. struct ggml_tensor * a,
  1480. int p0,
  1481. int p1,
  1482. int p2,
  1483. int p3);
  1484. // Ref: https://github.com/CompVis/stable-diffusion/blob/main/ldm/modules/diffusionmodules/util.py#L151
  1485. // timesteps: [N,]
  1486. // return: [N, dim]
  1487. GGML_API struct ggml_tensor * ggml_timestep_embedding(
  1488. struct ggml_context * ctx,
  1489. struct ggml_tensor * timesteps,
  1490. int dim,
  1491. int max_period);
  1492. // sort rows
  1493. enum ggml_sort_order {
  1494. GGML_SORT_ORDER_ASC,
  1495. GGML_SORT_ORDER_DESC,
  1496. };
  1497. GGML_API struct ggml_tensor * ggml_argsort(
  1498. struct ggml_context * ctx,
  1499. struct ggml_tensor * a,
  1500. enum ggml_sort_order order);
  1501. GGML_API struct ggml_tensor * ggml_arange(
  1502. struct ggml_context * ctx,
  1503. float start,
  1504. float stop,
  1505. float step);
  1506. // top k elements per row
  1507. GGML_API struct ggml_tensor * ggml_top_k(
  1508. struct ggml_context * ctx,
  1509. struct ggml_tensor * a,
  1510. int k);
  1511. #define GGML_KQ_MASK_PAD 32
  1512. // q: [n_embd, n_batch, n_head, 1]
  1513. // k: [n_embd, n_kv, n_head_kv, 1]
  1514. // v: [n_embd, n_kv, n_head_kv, 1] !! not transposed !!
  1515. // mask: [n_kv, n_batch_pad, 1, 1] !! n_batch_pad = GGML_PAD(n_batch, GGML_KQ_MASK_PAD) !!
  1516. // res: [n_embd, n_head, n_batch, 1] !! permuted !!
  1517. GGML_API struct ggml_tensor * ggml_flash_attn_ext(
  1518. struct ggml_context * ctx,
  1519. struct ggml_tensor * q,
  1520. struct ggml_tensor * k,
  1521. struct ggml_tensor * v,
  1522. struct ggml_tensor * mask,
  1523. float scale,
  1524. float max_bias,
  1525. float logit_softcap);
  1526. GGML_API void ggml_flash_attn_ext_set_prec(
  1527. struct ggml_tensor * a,
  1528. enum ggml_prec prec);
  1529. GGML_API enum ggml_prec ggml_flash_attn_ext_get_prec(
  1530. const struct ggml_tensor * a);
  1531. // TODO: needs to be adapted to ggml_flash_attn_ext
  1532. GGML_API struct ggml_tensor * ggml_flash_attn_back(
  1533. struct ggml_context * ctx,
  1534. struct ggml_tensor * q,
  1535. struct ggml_tensor * k,
  1536. struct ggml_tensor * v,
  1537. struct ggml_tensor * d,
  1538. bool masked);
  1539. GGML_API struct ggml_tensor * ggml_ssm_conv(
  1540. struct ggml_context * ctx,
  1541. struct ggml_tensor * sx,
  1542. struct ggml_tensor * c);
  1543. GGML_API struct ggml_tensor * ggml_ssm_scan(
  1544. struct ggml_context * ctx,
  1545. struct ggml_tensor * s,
  1546. struct ggml_tensor * x,
  1547. struct ggml_tensor * dt,
  1548. struct ggml_tensor * A,
  1549. struct ggml_tensor * B,
  1550. struct ggml_tensor * C);
  1551. // partition into non-overlapping windows with padding if needed
  1552. // example:
  1553. // a: 768 64 64 1
  1554. // w: 14
  1555. // res: 768 14 14 25
  1556. // used in sam
  1557. GGML_API struct ggml_tensor * ggml_win_part(
  1558. struct ggml_context * ctx,
  1559. struct ggml_tensor * a,
  1560. int w);
  1561. // reverse of ggml_win_part
  1562. // used in sam
  1563. GGML_API struct ggml_tensor * ggml_win_unpart(
  1564. struct ggml_context * ctx,
  1565. struct ggml_tensor * a,
  1566. int w0,
  1567. int h0,
  1568. int w);
  1569. GGML_API struct ggml_tensor * ggml_unary(
  1570. struct ggml_context * ctx,
  1571. struct ggml_tensor * a,
  1572. enum ggml_unary_op op);
  1573. GGML_API struct ggml_tensor * ggml_unary_inplace(
  1574. struct ggml_context * ctx,
  1575. struct ggml_tensor * a,
  1576. enum ggml_unary_op op);
  1577. // used in sam
  1578. GGML_API struct ggml_tensor * ggml_get_rel_pos(
  1579. struct ggml_context * ctx,
  1580. struct ggml_tensor * a,
  1581. int qh,
  1582. int kh);
  1583. // used in sam
  1584. GGML_API struct ggml_tensor * ggml_add_rel_pos(
  1585. struct ggml_context * ctx,
  1586. struct ggml_tensor * a,
  1587. struct ggml_tensor * pw,
  1588. struct ggml_tensor * ph);
  1589. GGML_API struct ggml_tensor * ggml_add_rel_pos_inplace(
  1590. struct ggml_context * ctx,
  1591. struct ggml_tensor * a,
  1592. struct ggml_tensor * pw,
  1593. struct ggml_tensor * ph);
  1594. GGML_API struct ggml_tensor * ggml_rwkv_wkv6(
  1595. struct ggml_context * ctx,
  1596. struct ggml_tensor * k,
  1597. struct ggml_tensor * v,
  1598. struct ggml_tensor * r,
  1599. struct ggml_tensor * tf,
  1600. struct ggml_tensor * td,
  1601. struct ggml_tensor * state);
  1602. // custom operators
  1603. typedef void (*ggml_unary_op_f32_t) (const int, float *, const float *);
  1604. typedef void (*ggml_binary_op_f32_t)(const int, float *, const float *, const float *);
  1605. typedef void (*ggml_custom1_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *);
  1606. typedef void (*ggml_custom2_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1607. typedef void (*ggml_custom3_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1608. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_f32(
  1609. struct ggml_context * ctx,
  1610. struct ggml_tensor * a,
  1611. ggml_unary_op_f32_t fun),
  1612. "use ggml_map_custom1 instead");
  1613. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_inplace_f32(
  1614. struct ggml_context * ctx,
  1615. struct ggml_tensor * a,
  1616. ggml_unary_op_f32_t fun),
  1617. "use ggml_map_custom1_inplace instead");
  1618. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_f32(
  1619. struct ggml_context * ctx,
  1620. struct ggml_tensor * a,
  1621. struct ggml_tensor * b,
  1622. ggml_binary_op_f32_t fun),
  1623. "use ggml_map_custom2 instead");
  1624. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_inplace_f32(
  1625. struct ggml_context * ctx,
  1626. struct ggml_tensor * a,
  1627. struct ggml_tensor * b,
  1628. ggml_binary_op_f32_t fun),
  1629. "use ggml_map_custom2_inplace instead");
  1630. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_f32(
  1631. struct ggml_context * ctx,
  1632. struct ggml_tensor * a,
  1633. ggml_custom1_op_f32_t fun),
  1634. "use ggml_map_custom1 instead");
  1635. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_inplace_f32(
  1636. struct ggml_context * ctx,
  1637. struct ggml_tensor * a,
  1638. ggml_custom1_op_f32_t fun),
  1639. "use ggml_map_custom1_inplace instead");
  1640. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_f32(
  1641. struct ggml_context * ctx,
  1642. struct ggml_tensor * a,
  1643. struct ggml_tensor * b,
  1644. ggml_custom2_op_f32_t fun),
  1645. "use ggml_map_custom2 instead");
  1646. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_inplace_f32(
  1647. struct ggml_context * ctx,
  1648. struct ggml_tensor * a,
  1649. struct ggml_tensor * b,
  1650. ggml_custom2_op_f32_t fun),
  1651. "use ggml_map_custom2_inplace instead");
  1652. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_f32(
  1653. struct ggml_context * ctx,
  1654. struct ggml_tensor * a,
  1655. struct ggml_tensor * b,
  1656. struct ggml_tensor * c,
  1657. ggml_custom3_op_f32_t fun),
  1658. "use ggml_map_custom3 instead");
  1659. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_inplace_f32(
  1660. struct ggml_context * ctx,
  1661. struct ggml_tensor * a,
  1662. struct ggml_tensor * b,
  1663. struct ggml_tensor * c,
  1664. ggml_custom3_op_f32_t fun),
  1665. "use ggml_map_custom3_inplace instead");
  1666. // custom operators v2
  1667. typedef void (*ggml_custom1_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, int ith, int nth, void * userdata);
  1668. 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);
  1669. 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);
  1670. #define GGML_N_TASKS_MAX (-1)
  1671. // n_tasks == GGML_N_TASKS_MAX means to use max number of tasks
  1672. GGML_API struct ggml_tensor * ggml_map_custom1(
  1673. struct ggml_context * ctx,
  1674. struct ggml_tensor * a,
  1675. ggml_custom1_op_t fun,
  1676. int n_tasks,
  1677. void * userdata);
  1678. GGML_API struct ggml_tensor * ggml_map_custom1_inplace(
  1679. struct ggml_context * ctx,
  1680. struct ggml_tensor * a,
  1681. ggml_custom1_op_t fun,
  1682. int n_tasks,
  1683. void * userdata);
  1684. GGML_API struct ggml_tensor * ggml_map_custom2(
  1685. struct ggml_context * ctx,
  1686. struct ggml_tensor * a,
  1687. struct ggml_tensor * b,
  1688. ggml_custom2_op_t fun,
  1689. int n_tasks,
  1690. void * userdata);
  1691. GGML_API struct ggml_tensor * ggml_map_custom2_inplace(
  1692. struct ggml_context * ctx,
  1693. struct ggml_tensor * a,
  1694. struct ggml_tensor * b,
  1695. ggml_custom2_op_t fun,
  1696. int n_tasks,
  1697. void * userdata);
  1698. GGML_API struct ggml_tensor * ggml_map_custom3(
  1699. struct ggml_context * ctx,
  1700. struct ggml_tensor * a,
  1701. struct ggml_tensor * b,
  1702. struct ggml_tensor * c,
  1703. ggml_custom3_op_t fun,
  1704. int n_tasks,
  1705. void * userdata);
  1706. GGML_API struct ggml_tensor * ggml_map_custom3_inplace(
  1707. struct ggml_context * ctx,
  1708. struct ggml_tensor * a,
  1709. struct ggml_tensor * b,
  1710. struct ggml_tensor * c,
  1711. ggml_custom3_op_t fun,
  1712. int n_tasks,
  1713. void * userdata);
  1714. // loss function
  1715. GGML_API struct ggml_tensor * ggml_cross_entropy_loss(
  1716. struct ggml_context * ctx,
  1717. struct ggml_tensor * a, // logits
  1718. struct ggml_tensor * b); // labels
  1719. GGML_API struct ggml_tensor * ggml_cross_entropy_loss_back(
  1720. struct ggml_context * ctx,
  1721. struct ggml_tensor * a, // logits
  1722. struct ggml_tensor * b, // labels
  1723. struct ggml_tensor * c); // gradients of cross_entropy_loss result
  1724. // AdamW optimizer step
  1725. // Paper: https://arxiv.org/pdf/1711.05101v3.pdf
  1726. // PyTorch: https://pytorch.org/docs/stable/generated/torch.optim.AdamW.html
  1727. GGML_API struct ggml_tensor * ggml_opt_step_adamw(
  1728. struct ggml_context * ctx,
  1729. struct ggml_tensor * a,
  1730. struct ggml_tensor * grad,
  1731. struct ggml_tensor * m,
  1732. struct ggml_tensor * v,
  1733. struct ggml_tensor * adamw_params); // parameters such a the learning rate
  1734. //
  1735. // automatic differentiation
  1736. //
  1737. GGML_API void ggml_build_forward_expand(struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1738. GGML_API void ggml_build_backward_expand(
  1739. struct ggml_context * ctx_static, // context for static gradients (loss + gradient accumulation)
  1740. struct ggml_context * ctx_compute, // context for gradient computation
  1741. struct ggml_cgraph * cgraph,
  1742. bool accumulate); // whether or not gradients should be accumulated, requires static allocation of tensors in ctx_static
  1743. // graph allocation in a context
  1744. GGML_API struct ggml_cgraph * ggml_new_graph (struct ggml_context * ctx); // size = GGML_DEFAULT_GRAPH_SIZE, grads = false
  1745. GGML_API struct ggml_cgraph * ggml_new_graph_custom(struct ggml_context * ctx, size_t size, bool grads);
  1746. GGML_API struct ggml_cgraph * ggml_graph_dup (struct ggml_context * ctx, struct ggml_cgraph * cgraph);
  1747. GGML_API void ggml_graph_cpy (struct ggml_cgraph * src, struct ggml_cgraph * dst);
  1748. GGML_API void ggml_graph_reset (struct ggml_cgraph * cgraph); // set regular grads + optimizer momenta to 0, set loss grad to 1
  1749. GGML_API void ggml_graph_clear (struct ggml_cgraph * cgraph);
  1750. GGML_API int ggml_graph_size (struct ggml_cgraph * cgraph);
  1751. GGML_API struct ggml_tensor * ggml_graph_node (struct ggml_cgraph * cgraph, int i); // if i < 0, returns nodes[n_nodes + i]
  1752. GGML_API struct ggml_tensor ** ggml_graph_nodes (struct ggml_cgraph * cgraph);
  1753. GGML_API int ggml_graph_n_nodes(struct ggml_cgraph * cgraph);
  1754. GGML_API void ggml_graph_add_node(struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1755. GGML_API size_t ggml_graph_overhead(void);
  1756. GGML_API size_t ggml_graph_overhead_custom(size_t size, bool grads);
  1757. GGML_API struct ggml_tensor * ggml_graph_get_tensor (const struct ggml_cgraph * cgraph, const char * name);
  1758. GGML_API struct ggml_tensor * ggml_graph_get_grad (const struct ggml_cgraph * cgraph, const struct ggml_tensor * node);
  1759. GGML_API struct ggml_tensor * ggml_graph_get_grad_acc(const struct ggml_cgraph * cgraph, const struct ggml_tensor * node);
  1760. GGML_API void ggml_graph_export(const struct ggml_cgraph * cgraph, const char * fname);
  1761. GGML_API struct ggml_cgraph * ggml_graph_import(const char * fname, struct ggml_context ** ctx_data, struct ggml_context ** ctx_eval);
  1762. // print info and performance information for the graph
  1763. GGML_API void ggml_graph_print(const struct ggml_cgraph * cgraph);
  1764. // dump the graph into a file using the dot format
  1765. GGML_API void ggml_graph_dump_dot(const struct ggml_cgraph * gb, const struct ggml_cgraph * gf, const char * filename);
  1766. // TODO these functions were sandwiched in the old optimization interface, is there a better place for them?
  1767. typedef void (*ggml_log_callback)(enum ggml_log_level level, const char * text, void * user_data);
  1768. // Set callback for all future logging events.
  1769. // If this is not called, or NULL is supplied, everything is output on stderr.
  1770. GGML_API void ggml_log_set(ggml_log_callback log_callback, void * user_data);
  1771. GGML_API struct ggml_tensor * ggml_set_zero(struct ggml_tensor * tensor);
  1772. //
  1773. // quantization
  1774. //
  1775. // - ggml_quantize_init can be called multiple times with the same type
  1776. // it will only initialize the quantization tables for the first call or after ggml_quantize_free
  1777. // automatically called by ggml_quantize_chunk for convenience
  1778. //
  1779. // - ggml_quantize_free will free any memory allocated by ggml_quantize_init
  1780. // call this at the end of the program to avoid memory leaks
  1781. //
  1782. // note: these are thread-safe
  1783. //
  1784. GGML_API void ggml_quantize_init(enum ggml_type type);
  1785. GGML_API void ggml_quantize_free(void);
  1786. // some quantization type cannot be used without an importance matrix
  1787. GGML_API bool ggml_quantize_requires_imatrix(enum ggml_type type);
  1788. // calls ggml_quantize_init internally (i.e. can allocate memory)
  1789. GGML_API size_t ggml_quantize_chunk(
  1790. enum ggml_type type,
  1791. const float * src,
  1792. void * dst,
  1793. int64_t start,
  1794. int64_t nrows,
  1795. int64_t n_per_row,
  1796. const float * imatrix);
  1797. //
  1798. // gguf
  1799. //
  1800. enum gguf_type {
  1801. GGUF_TYPE_UINT8 = 0,
  1802. GGUF_TYPE_INT8 = 1,
  1803. GGUF_TYPE_UINT16 = 2,
  1804. GGUF_TYPE_INT16 = 3,
  1805. GGUF_TYPE_UINT32 = 4,
  1806. GGUF_TYPE_INT32 = 5,
  1807. GGUF_TYPE_FLOAT32 = 6,
  1808. GGUF_TYPE_BOOL = 7,
  1809. GGUF_TYPE_STRING = 8,
  1810. GGUF_TYPE_ARRAY = 9,
  1811. GGUF_TYPE_UINT64 = 10,
  1812. GGUF_TYPE_INT64 = 11,
  1813. GGUF_TYPE_FLOAT64 = 12,
  1814. GGUF_TYPE_COUNT, // marks the end of the enum
  1815. };
  1816. struct gguf_context;
  1817. struct gguf_init_params {
  1818. bool no_alloc;
  1819. // if not NULL, create a ggml_context and allocate the tensor data in it
  1820. struct ggml_context ** ctx;
  1821. };
  1822. GGML_API struct gguf_context * gguf_init_empty(void);
  1823. GGML_API struct gguf_context * gguf_init_from_file(const char * fname, struct gguf_init_params params);
  1824. //GGML_API struct gguf_context * gguf_init_from_buffer(..);
  1825. GGML_API void gguf_free(struct gguf_context * ctx);
  1826. GGML_API const char * gguf_type_name(enum gguf_type type);
  1827. GGML_API int gguf_get_version (const struct gguf_context * ctx);
  1828. GGML_API size_t gguf_get_alignment (const struct gguf_context * ctx);
  1829. GGML_API size_t gguf_get_data_offset(const struct gguf_context * ctx);
  1830. GGML_API void * gguf_get_data (const struct gguf_context * ctx);
  1831. GGML_API int gguf_get_n_kv(const struct gguf_context * ctx);
  1832. GGML_API int gguf_find_key(const struct gguf_context * ctx, const char * key);
  1833. GGML_API const char * gguf_get_key (const struct gguf_context * ctx, int key_id);
  1834. GGML_API enum gguf_type gguf_get_kv_type (const struct gguf_context * ctx, int key_id);
  1835. GGML_API enum gguf_type gguf_get_arr_type(const struct gguf_context * ctx, int key_id);
  1836. // will abort if the wrong type is used for the key
  1837. GGML_API uint8_t gguf_get_val_u8 (const struct gguf_context * ctx, int key_id);
  1838. GGML_API int8_t gguf_get_val_i8 (const struct gguf_context * ctx, int key_id);
  1839. GGML_API uint16_t gguf_get_val_u16 (const struct gguf_context * ctx, int key_id);
  1840. GGML_API int16_t gguf_get_val_i16 (const struct gguf_context * ctx, int key_id);
  1841. GGML_API uint32_t gguf_get_val_u32 (const struct gguf_context * ctx, int key_id);
  1842. GGML_API int32_t gguf_get_val_i32 (const struct gguf_context * ctx, int key_id);
  1843. GGML_API float gguf_get_val_f32 (const struct gguf_context * ctx, int key_id);
  1844. GGML_API uint64_t gguf_get_val_u64 (const struct gguf_context * ctx, int key_id);
  1845. GGML_API int64_t gguf_get_val_i64 (const struct gguf_context * ctx, int key_id);
  1846. GGML_API double gguf_get_val_f64 (const struct gguf_context * ctx, int key_id);
  1847. GGML_API bool gguf_get_val_bool(const struct gguf_context * ctx, int key_id);
  1848. GGML_API const char * gguf_get_val_str (const struct gguf_context * ctx, int key_id);
  1849. GGML_API const void * gguf_get_val_data(const struct gguf_context * ctx, int key_id);
  1850. GGML_API int gguf_get_arr_n (const struct gguf_context * ctx, int key_id);
  1851. GGML_API const void * gguf_get_arr_data(const struct gguf_context * ctx, int key_id);
  1852. GGML_API const char * gguf_get_arr_str (const struct gguf_context * ctx, int key_id, int i);
  1853. GGML_API int gguf_get_n_tensors (const struct gguf_context * ctx);
  1854. GGML_API int gguf_find_tensor (const struct gguf_context * ctx, const char * name);
  1855. GGML_API size_t gguf_get_tensor_offset(const struct gguf_context * ctx, int i);
  1856. GGML_API char * gguf_get_tensor_name (const struct gguf_context * ctx, int i);
  1857. GGML_API enum ggml_type gguf_get_tensor_type (const struct gguf_context * ctx, int i);
  1858. // removes key if it exists
  1859. GGML_API void gguf_remove_key(struct gguf_context * ctx, const char * key);
  1860. // overrides existing values or adds a new one
  1861. GGML_API void gguf_set_val_u8 (struct gguf_context * ctx, const char * key, uint8_t val);
  1862. GGML_API void gguf_set_val_i8 (struct gguf_context * ctx, const char * key, int8_t val);
  1863. GGML_API void gguf_set_val_u16 (struct gguf_context * ctx, const char * key, uint16_t val);
  1864. GGML_API void gguf_set_val_i16 (struct gguf_context * ctx, const char * key, int16_t val);
  1865. GGML_API void gguf_set_val_u32 (struct gguf_context * ctx, const char * key, uint32_t val);
  1866. GGML_API void gguf_set_val_i32 (struct gguf_context * ctx, const char * key, int32_t val);
  1867. GGML_API void gguf_set_val_f32 (struct gguf_context * ctx, const char * key, float val);
  1868. GGML_API void gguf_set_val_u64 (struct gguf_context * ctx, const char * key, uint64_t val);
  1869. GGML_API void gguf_set_val_i64 (struct gguf_context * ctx, const char * key, int64_t val);
  1870. GGML_API void gguf_set_val_f64 (struct gguf_context * ctx, const char * key, double val);
  1871. GGML_API void gguf_set_val_bool(struct gguf_context * ctx, const char * key, bool val);
  1872. GGML_API void gguf_set_val_str (struct gguf_context * ctx, const char * key, const char * val);
  1873. GGML_API void gguf_set_arr_data(struct gguf_context * ctx, const char * key, enum gguf_type type, const void * data, int n);
  1874. GGML_API void gguf_set_arr_str (struct gguf_context * ctx, const char * key, const char ** data, int n);
  1875. // set or add KV pairs from another context
  1876. GGML_API void gguf_set_kv(struct gguf_context * ctx, struct gguf_context * src);
  1877. // manage tensor info
  1878. GGML_API void gguf_add_tensor(struct gguf_context * ctx, const struct ggml_tensor * tensor);
  1879. GGML_API void gguf_set_tensor_type(struct gguf_context * ctx, const char * name, enum ggml_type type);
  1880. GGML_API void gguf_set_tensor_data(struct gguf_context * ctx, const char * name, const void * data, size_t size);
  1881. // writing gguf files can be done in 2 ways:
  1882. //
  1883. // - write the entire gguf_context to a binary file in a single pass:
  1884. //
  1885. // gguf_write_to_file(ctx, fname);
  1886. //
  1887. // - first prepare a file with a placeholder for the meta data, write the tensor data, then write the meta data:
  1888. //
  1889. // FILE * f = fopen(fname, "wb");
  1890. // fseek(f, gguf_get_meta_size(ctx), SEEK_SET);
  1891. // fwrite(f, ...);
  1892. // void * data = gguf_meta_get_meta_data(ctx);
  1893. // fseek(f, 0, SEEK_SET);
  1894. // fwrite(f, data, gguf_get_meta_size(ctx));
  1895. // free(data);
  1896. // fclose(f);
  1897. //
  1898. // write the entire context to a binary file
  1899. GGML_API void gguf_write_to_file(const struct gguf_context * ctx, const char * fname, bool only_meta);
  1900. // get the size in bytes of the meta data (header, kv pairs, tensor info) including padding
  1901. GGML_API size_t gguf_get_meta_size(const struct gguf_context * ctx);
  1902. GGML_API void gguf_get_meta_data(const struct gguf_context * ctx, void * data);
  1903. #ifdef __cplusplus
  1904. // restrict not standard in C++
  1905. #define GGML_RESTRICT
  1906. #else
  1907. #define GGML_RESTRICT restrict
  1908. #endif
  1909. typedef void (*ggml_to_float_t) (const void * GGML_RESTRICT x, float * GGML_RESTRICT y, int64_t k);
  1910. typedef void (*ggml_from_float_t)(const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int64_t k);
  1911. struct ggml_type_traits {
  1912. const char * type_name;
  1913. int64_t blck_size;
  1914. int64_t blck_size_interleave; // interleave elements in blocks
  1915. size_t type_size;
  1916. bool is_quantized;
  1917. ggml_to_float_t to_float;
  1918. ggml_from_float_t from_float_ref;
  1919. };
  1920. GGML_API const struct ggml_type_traits * ggml_get_type_traits(enum ggml_type type);
  1921. // ggml threadpool
  1922. // TODO: currently, only a few functions are in the base ggml API, while the rest are in the CPU backend
  1923. // the goal should be to create an API that other backends can use move everything to the ggml base
  1924. // scheduling priorities
  1925. enum ggml_sched_priority {
  1926. GGML_SCHED_PRIO_NORMAL,
  1927. GGML_SCHED_PRIO_MEDIUM,
  1928. GGML_SCHED_PRIO_HIGH,
  1929. GGML_SCHED_PRIO_REALTIME
  1930. };
  1931. // threadpool params
  1932. // Use ggml_threadpool_params_default() or ggml_threadpool_params_init() to populate the defaults
  1933. struct ggml_threadpool_params {
  1934. bool cpumask[GGML_MAX_N_THREADS]; // mask of cpu cores (all-zeros means use default affinity settings)
  1935. int n_threads; // number of threads
  1936. enum ggml_sched_priority prio; // thread priority
  1937. uint32_t poll; // polling level (0 - no polling, 100 - aggressive polling)
  1938. bool strict_cpu; // strict cpu placement
  1939. bool paused; // start in paused state
  1940. };
  1941. struct ggml_threadpool; // forward declaration, see ggml.c
  1942. typedef struct ggml_threadpool * ggml_threadpool_t;
  1943. GGML_API struct ggml_threadpool_params ggml_threadpool_params_default(int n_threads);
  1944. GGML_API void ggml_threadpool_params_init (struct ggml_threadpool_params * p, int n_threads);
  1945. GGML_API bool ggml_threadpool_params_match (const struct ggml_threadpool_params * p0, const struct ggml_threadpool_params * p1);
  1946. #ifdef __cplusplus
  1947. }
  1948. #endif