ggml.h 87 KB

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