ggml.h 79 KB

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