ggml.h 84 KB

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