ggml.h 89 KB

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