ggml.h 80 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162
  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__)
  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_MUL_MAT,
  424. GGML_OP_MUL_MAT_ID,
  425. GGML_OP_OUT_PROD,
  426. GGML_OP_SCALE,
  427. GGML_OP_SET,
  428. GGML_OP_CPY,
  429. GGML_OP_CONT,
  430. GGML_OP_RESHAPE,
  431. GGML_OP_VIEW,
  432. GGML_OP_PERMUTE,
  433. GGML_OP_TRANSPOSE,
  434. GGML_OP_GET_ROWS,
  435. GGML_OP_GET_ROWS_BACK,
  436. GGML_OP_DIAG,
  437. GGML_OP_DIAG_MASK_INF,
  438. GGML_OP_DIAG_MASK_ZERO,
  439. GGML_OP_SOFT_MAX,
  440. GGML_OP_SOFT_MAX_BACK,
  441. GGML_OP_ROPE,
  442. GGML_OP_ROPE_BACK,
  443. GGML_OP_CLAMP,
  444. GGML_OP_CONV_TRANSPOSE_1D,
  445. GGML_OP_IM2COL,
  446. GGML_OP_IM2COL_BACK,
  447. GGML_OP_CONV_TRANSPOSE_2D,
  448. GGML_OP_POOL_1D,
  449. GGML_OP_POOL_2D,
  450. GGML_OP_POOL_2D_BACK,
  451. GGML_OP_UPSCALE, // nearest interpolate
  452. GGML_OP_PAD,
  453. GGML_OP_PAD_REFLECT_1D,
  454. GGML_OP_ARANGE,
  455. GGML_OP_TIMESTEP_EMBEDDING,
  456. GGML_OP_ARGSORT,
  457. GGML_OP_LEAKY_RELU,
  458. GGML_OP_FLASH_ATTN_EXT,
  459. GGML_OP_FLASH_ATTN_BACK,
  460. GGML_OP_SSM_CONV,
  461. GGML_OP_SSM_SCAN,
  462. GGML_OP_WIN_PART,
  463. GGML_OP_WIN_UNPART,
  464. GGML_OP_GET_REL_POS,
  465. GGML_OP_ADD_REL_POS,
  466. GGML_OP_RWKV_WKV6,
  467. GGML_OP_UNARY,
  468. GGML_OP_MAP_UNARY,
  469. GGML_OP_MAP_BINARY,
  470. GGML_OP_MAP_CUSTOM1_F32,
  471. GGML_OP_MAP_CUSTOM2_F32,
  472. GGML_OP_MAP_CUSTOM3_F32,
  473. GGML_OP_MAP_CUSTOM1,
  474. GGML_OP_MAP_CUSTOM2,
  475. GGML_OP_MAP_CUSTOM3,
  476. GGML_OP_CROSS_ENTROPY_LOSS,
  477. GGML_OP_CROSS_ENTROPY_LOSS_BACK,
  478. GGML_OP_OPT_STEP_ADAMW,
  479. GGML_OP_COUNT,
  480. };
  481. enum ggml_unary_op {
  482. GGML_UNARY_OP_ABS,
  483. GGML_UNARY_OP_SGN,
  484. GGML_UNARY_OP_NEG,
  485. GGML_UNARY_OP_STEP,
  486. GGML_UNARY_OP_TANH,
  487. GGML_UNARY_OP_ELU,
  488. GGML_UNARY_OP_RELU,
  489. GGML_UNARY_OP_SIGMOID,
  490. GGML_UNARY_OP_GELU,
  491. GGML_UNARY_OP_GELU_QUICK,
  492. GGML_UNARY_OP_SILU,
  493. GGML_UNARY_OP_HARDSWISH,
  494. GGML_UNARY_OP_HARDSIGMOID,
  495. GGML_UNARY_OP_EXP,
  496. GGML_UNARY_OP_COUNT,
  497. };
  498. enum ggml_object_type {
  499. GGML_OBJECT_TYPE_TENSOR,
  500. GGML_OBJECT_TYPE_GRAPH,
  501. GGML_OBJECT_TYPE_WORK_BUFFER
  502. };
  503. enum ggml_log_level {
  504. GGML_LOG_LEVEL_NONE = 0,
  505. GGML_LOG_LEVEL_DEBUG = 1,
  506. GGML_LOG_LEVEL_INFO = 2,
  507. GGML_LOG_LEVEL_WARN = 3,
  508. GGML_LOG_LEVEL_ERROR = 4,
  509. GGML_LOG_LEVEL_CONT = 5, // continue previous log
  510. };
  511. // this tensor...
  512. enum ggml_tensor_flag {
  513. GGML_TENSOR_FLAG_INPUT = 1, // ...is an input for the GGML compute graph
  514. GGML_TENSOR_FLAG_OUTPUT = 2, // ...is an output for the GGML compute graph
  515. GGML_TENSOR_FLAG_PARAM = 4, // ...contains trainable parameters
  516. GGML_TENSOR_FLAG_LOSS = 8, // ...defines loss for numerical optimization (multiple loss tensors add up)
  517. };
  518. struct ggml_init_params {
  519. // memory pool
  520. size_t mem_size; // bytes
  521. void * mem_buffer; // if NULL, memory will be allocated internally
  522. bool no_alloc; // don't allocate memory for the tensor data
  523. };
  524. // n-dimensional tensor
  525. struct ggml_tensor {
  526. enum ggml_type type;
  527. struct ggml_backend_buffer * buffer;
  528. int64_t ne[GGML_MAX_DIMS]; // number of elements
  529. size_t nb[GGML_MAX_DIMS]; // stride in bytes:
  530. // nb[0] = ggml_type_size(type)
  531. // nb[1] = nb[0] * (ne[0] / ggml_blck_size(type)) + padding
  532. // nb[i] = nb[i-1] * ne[i-1]
  533. // compute data
  534. enum ggml_op op;
  535. // op params - allocated as int32_t for alignment
  536. int32_t op_params[GGML_MAX_OP_PARAMS / sizeof(int32_t)];
  537. int32_t flags;
  538. struct ggml_tensor * src[GGML_MAX_SRC];
  539. // source tensor and offset for views
  540. struct ggml_tensor * view_src;
  541. size_t view_offs;
  542. void * data;
  543. char name[GGML_MAX_NAME];
  544. void * extra; // extra things e.g. for ggml-cuda.cu
  545. char padding[8];
  546. };
  547. static const size_t GGML_TENSOR_SIZE = sizeof(struct ggml_tensor);
  548. // Abort callback
  549. // If not NULL, called before ggml computation
  550. // If it returns true, the computation is aborted
  551. typedef bool (*ggml_abort_callback)(void * data);
  552. //
  553. // GUID
  554. //
  555. // GUID types
  556. typedef uint8_t ggml_guid[16];
  557. typedef ggml_guid * ggml_guid_t;
  558. GGML_API bool ggml_guid_matches(ggml_guid_t guid_a, ggml_guid_t guid_b);
  559. // misc
  560. GGML_API void ggml_time_init(void); // call this once at the beginning of the program
  561. GGML_API int64_t ggml_time_ms(void);
  562. GGML_API int64_t ggml_time_us(void);
  563. GGML_API int64_t ggml_cycles(void);
  564. GGML_API int64_t ggml_cycles_per_ms(void);
  565. // accepts a UTF-8 path, even on Windows
  566. GGML_API FILE * ggml_fopen(const char * fname, const char * mode);
  567. GGML_API void ggml_print_object (const struct ggml_object * obj);
  568. GGML_API void ggml_print_objects(const struct ggml_context * ctx);
  569. GGML_API int64_t ggml_nelements (const struct ggml_tensor * tensor);
  570. GGML_API int64_t ggml_nrows (const struct ggml_tensor * tensor);
  571. GGML_API size_t ggml_nbytes (const struct ggml_tensor * tensor);
  572. GGML_API size_t ggml_nbytes_pad(const struct ggml_tensor * tensor); // same as ggml_nbytes() but padded to GGML_MEM_ALIGN
  573. GGML_API int64_t ggml_blck_size(enum ggml_type type);
  574. GGML_API size_t ggml_type_size(enum ggml_type type); // size in bytes for all elements in a block
  575. GGML_API size_t ggml_row_size (enum ggml_type type, int64_t ne); // size in bytes for all elements in a row
  576. GGML_DEPRECATED(
  577. GGML_API double ggml_type_sizef(enum ggml_type type), // ggml_type_size()/ggml_blck_size() as float
  578. "use ggml_row_size() instead");
  579. GGML_API const char * ggml_type_name(enum ggml_type type);
  580. GGML_API const char * ggml_op_name (enum ggml_op op);
  581. GGML_API const char * ggml_op_symbol(enum ggml_op op);
  582. GGML_API const char * ggml_unary_op_name(enum ggml_unary_op op);
  583. GGML_API const char * ggml_op_desc(const struct ggml_tensor * t); // unary or op name
  584. GGML_API size_t ggml_element_size(const struct ggml_tensor * tensor);
  585. GGML_API bool ggml_is_quantized(enum ggml_type type);
  586. // TODO: temporary until model loading of ggml examples is refactored
  587. GGML_API enum ggml_type ggml_ftype_to_ggml_type(enum ggml_ftype ftype);
  588. GGML_API bool ggml_is_transposed(const struct ggml_tensor * tensor);
  589. GGML_API bool ggml_is_permuted (const struct ggml_tensor * tensor);
  590. GGML_API bool ggml_is_empty (const struct ggml_tensor * tensor);
  591. GGML_API bool ggml_is_scalar (const struct ggml_tensor * tensor);
  592. GGML_API bool ggml_is_vector (const struct ggml_tensor * tensor);
  593. GGML_API bool ggml_is_matrix (const struct ggml_tensor * tensor);
  594. GGML_API bool ggml_is_3d (const struct ggml_tensor * tensor);
  595. GGML_API int ggml_n_dims (const struct ggml_tensor * tensor); // returns 1 for scalars
  596. GGML_API bool ggml_is_contiguous (const struct ggml_tensor * tensor);
  597. GGML_API bool ggml_is_contiguous_0(const struct ggml_tensor * tensor); // same as ggml_is_contiguous()
  598. GGML_API bool ggml_is_contiguous_1(const struct ggml_tensor * tensor); // contiguous for dims >= 1
  599. GGML_API bool ggml_is_contiguous_2(const struct ggml_tensor * tensor); // contiguous for dims >= 2
  600. GGML_API bool ggml_are_same_shape (const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  601. GGML_API bool ggml_are_same_stride(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  602. GGML_API bool ggml_can_repeat(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  603. // use this to compute the memory overhead of a tensor
  604. GGML_API size_t ggml_tensor_overhead(void);
  605. GGML_API bool ggml_validate_row_data(enum ggml_type type, const void * data, size_t nbytes);
  606. // main
  607. GGML_API struct ggml_context * ggml_init (struct ggml_init_params params);
  608. GGML_API void ggml_reset(struct ggml_context * ctx);
  609. GGML_API void ggml_free (struct ggml_context * ctx);
  610. GGML_API size_t ggml_used_mem(const struct ggml_context * ctx);
  611. GGML_API bool ggml_get_no_alloc(struct ggml_context * ctx);
  612. GGML_API void ggml_set_no_alloc(struct ggml_context * ctx, bool no_alloc);
  613. GGML_API void * ggml_get_mem_buffer (const struct ggml_context * ctx);
  614. GGML_API size_t ggml_get_mem_size (const struct ggml_context * ctx);
  615. GGML_API size_t ggml_get_max_tensor_size(const struct ggml_context * ctx);
  616. GGML_API struct ggml_tensor * ggml_new_tensor(
  617. struct ggml_context * ctx,
  618. enum ggml_type type,
  619. int n_dims,
  620. const int64_t *ne);
  621. GGML_API struct ggml_tensor * ggml_new_tensor_1d(
  622. struct ggml_context * ctx,
  623. enum ggml_type type,
  624. int64_t ne0);
  625. GGML_API struct ggml_tensor * ggml_new_tensor_2d(
  626. struct ggml_context * ctx,
  627. enum ggml_type type,
  628. int64_t ne0,
  629. int64_t ne1);
  630. GGML_API struct ggml_tensor * ggml_new_tensor_3d(
  631. struct ggml_context * ctx,
  632. enum ggml_type type,
  633. int64_t ne0,
  634. int64_t ne1,
  635. int64_t ne2);
  636. GGML_API struct ggml_tensor * ggml_new_tensor_4d(
  637. struct ggml_context * ctx,
  638. enum ggml_type type,
  639. int64_t ne0,
  640. int64_t ne1,
  641. int64_t ne2,
  642. int64_t ne3);
  643. GGML_API void * ggml_new_buffer(struct ggml_context * ctx, size_t nbytes);
  644. GGML_API struct ggml_tensor * ggml_dup_tensor (struct ggml_context * ctx, const struct ggml_tensor * src);
  645. GGML_API struct ggml_tensor * ggml_view_tensor(struct ggml_context * ctx, struct ggml_tensor * src);
  646. // Context tensor enumeration and lookup
  647. GGML_API struct ggml_tensor * ggml_get_first_tensor(const struct ggml_context * ctx);
  648. GGML_API struct ggml_tensor * ggml_get_next_tensor (const struct ggml_context * ctx, struct ggml_tensor * tensor);
  649. GGML_API struct ggml_tensor * ggml_get_tensor(struct ggml_context * ctx, const char * name);
  650. // Converts a flat index into coordinates
  651. 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);
  652. GGML_API enum ggml_unary_op ggml_get_unary_op(const struct ggml_tensor * tensor);
  653. GGML_API void * ggml_get_data (const struct ggml_tensor * tensor);
  654. GGML_API float * ggml_get_data_f32(const struct ggml_tensor * tensor);
  655. GGML_API const char * ggml_get_name (const struct ggml_tensor * tensor);
  656. GGML_API struct ggml_tensor * ggml_set_name ( struct ggml_tensor * tensor, const char * name);
  657. GGML_ATTRIBUTE_FORMAT(2, 3)
  658. GGML_API struct ggml_tensor * ggml_format_name( struct ggml_tensor * tensor, const char * fmt, ...);
  659. // Tensor flags
  660. GGML_API void ggml_set_input(struct ggml_tensor * tensor);
  661. GGML_API void ggml_set_output(struct ggml_tensor * tensor);
  662. GGML_API void ggml_set_param(struct ggml_context * ctx, struct ggml_tensor * tensor);
  663. GGML_API void ggml_set_loss(struct ggml_tensor * tensor);
  664. //
  665. // operations on tensors with backpropagation
  666. //
  667. GGML_API struct ggml_tensor * ggml_dup(
  668. struct ggml_context * ctx,
  669. struct ggml_tensor * a);
  670. // in-place, returns view(a)
  671. GGML_API struct ggml_tensor * ggml_dup_inplace(
  672. struct ggml_context * ctx,
  673. struct ggml_tensor * a);
  674. GGML_API struct ggml_tensor * ggml_add(
  675. struct ggml_context * ctx,
  676. struct ggml_tensor * a,
  677. struct ggml_tensor * b);
  678. GGML_API struct ggml_tensor * ggml_add_inplace(
  679. struct ggml_context * ctx,
  680. struct ggml_tensor * a,
  681. struct ggml_tensor * b);
  682. GGML_API struct ggml_tensor * ggml_add_cast(
  683. struct ggml_context * ctx,
  684. struct ggml_tensor * a,
  685. struct ggml_tensor * b,
  686. enum ggml_type type);
  687. GGML_API struct ggml_tensor * ggml_add1(
  688. struct ggml_context * ctx,
  689. struct ggml_tensor * a,
  690. struct ggml_tensor * b);
  691. GGML_API struct ggml_tensor * ggml_add1_inplace(
  692. struct ggml_context * ctx,
  693. struct ggml_tensor * a,
  694. struct ggml_tensor * b);
  695. // dst = a
  696. // view(dst, nb1, nb2, nb3, offset) += b
  697. // return dst
  698. GGML_API struct ggml_tensor * ggml_acc(
  699. struct ggml_context * ctx,
  700. struct ggml_tensor * a,
  701. struct ggml_tensor * b,
  702. size_t nb1,
  703. size_t nb2,
  704. size_t nb3,
  705. size_t offset);
  706. GGML_API struct ggml_tensor * ggml_acc_inplace(
  707. struct ggml_context * ctx,
  708. struct ggml_tensor * a,
  709. struct ggml_tensor * b,
  710. size_t nb1,
  711. size_t nb2,
  712. size_t nb3,
  713. size_t offset);
  714. GGML_API struct ggml_tensor * ggml_sub(
  715. struct ggml_context * ctx,
  716. struct ggml_tensor * a,
  717. struct ggml_tensor * b);
  718. GGML_API struct ggml_tensor * ggml_sub_inplace(
  719. struct ggml_context * ctx,
  720. struct ggml_tensor * a,
  721. struct ggml_tensor * b);
  722. GGML_API struct ggml_tensor * ggml_mul(
  723. struct ggml_context * ctx,
  724. struct ggml_tensor * a,
  725. struct ggml_tensor * b);
  726. GGML_API struct ggml_tensor * ggml_mul_inplace(
  727. struct ggml_context * ctx,
  728. struct ggml_tensor * a,
  729. struct ggml_tensor * b);
  730. GGML_API struct ggml_tensor * ggml_div(
  731. struct ggml_context * ctx,
  732. struct ggml_tensor * a,
  733. struct ggml_tensor * b);
  734. GGML_API struct ggml_tensor * ggml_div_inplace(
  735. struct ggml_context * ctx,
  736. struct ggml_tensor * a,
  737. struct ggml_tensor * b);
  738. GGML_API struct ggml_tensor * ggml_sqr(
  739. struct ggml_context * ctx,
  740. struct ggml_tensor * a);
  741. GGML_API struct ggml_tensor * ggml_sqr_inplace(
  742. struct ggml_context * ctx,
  743. struct ggml_tensor * a);
  744. GGML_API struct ggml_tensor * ggml_sqrt(
  745. struct ggml_context * ctx,
  746. struct ggml_tensor * a);
  747. GGML_API struct ggml_tensor * ggml_sqrt_inplace(
  748. struct ggml_context * ctx,
  749. struct ggml_tensor * a);
  750. GGML_API struct ggml_tensor * ggml_log(
  751. struct ggml_context * ctx,
  752. struct ggml_tensor * a);
  753. GGML_API struct ggml_tensor * ggml_log_inplace(
  754. struct ggml_context * ctx,
  755. struct ggml_tensor * a);
  756. GGML_API struct ggml_tensor * ggml_sin(
  757. struct ggml_context * ctx,
  758. struct ggml_tensor * a);
  759. GGML_API struct ggml_tensor * ggml_sin_inplace(
  760. struct ggml_context * ctx,
  761. struct ggml_tensor * a);
  762. GGML_API struct ggml_tensor * ggml_cos(
  763. struct ggml_context * ctx,
  764. struct ggml_tensor * a);
  765. GGML_API struct ggml_tensor * ggml_cos_inplace(
  766. struct ggml_context * ctx,
  767. struct ggml_tensor * a);
  768. // return scalar
  769. GGML_API struct ggml_tensor * ggml_sum(
  770. struct ggml_context * ctx,
  771. struct ggml_tensor * a);
  772. // sums along rows, with input shape [a,b,c,d] return shape [1,b,c,d]
  773. GGML_API struct ggml_tensor * ggml_sum_rows(
  774. struct ggml_context * ctx,
  775. struct ggml_tensor * a);
  776. // mean along rows
  777. GGML_API struct ggml_tensor * ggml_mean(
  778. struct ggml_context * ctx,
  779. struct ggml_tensor * a);
  780. // argmax along rows
  781. GGML_API struct ggml_tensor * ggml_argmax(
  782. struct ggml_context * ctx,
  783. struct ggml_tensor * a);
  784. // count number of equal elements in a and b
  785. GGML_API struct ggml_tensor * ggml_count_equal(
  786. struct ggml_context * ctx,
  787. struct ggml_tensor * a,
  788. struct ggml_tensor * b);
  789. // if a is the same shape as b, and a is not parameter, return a
  790. // otherwise, return a new tensor: repeat(a) to fit in b
  791. GGML_API struct ggml_tensor * ggml_repeat(
  792. struct ggml_context * ctx,
  793. struct ggml_tensor * a,
  794. struct ggml_tensor * b);
  795. // sums repetitions in a into shape of b
  796. GGML_API struct ggml_tensor * ggml_repeat_back(
  797. struct ggml_context * ctx,
  798. struct ggml_tensor * a,
  799. struct ggml_tensor * b);
  800. // concat a and b along dim
  801. // used in stable-diffusion
  802. GGML_API struct ggml_tensor * ggml_concat(
  803. struct ggml_context * ctx,
  804. struct ggml_tensor * a,
  805. struct ggml_tensor * b,
  806. int dim);
  807. GGML_API struct ggml_tensor * ggml_abs(
  808. struct ggml_context * ctx,
  809. struct ggml_tensor * a);
  810. GGML_API struct ggml_tensor * ggml_abs_inplace(
  811. struct ggml_context * ctx,
  812. struct ggml_tensor * a);
  813. GGML_API struct ggml_tensor * ggml_sgn(
  814. struct ggml_context * ctx,
  815. struct ggml_tensor * a);
  816. GGML_API struct ggml_tensor * ggml_sgn_inplace(
  817. struct ggml_context * ctx,
  818. struct ggml_tensor * a);
  819. GGML_API struct ggml_tensor * ggml_neg(
  820. struct ggml_context * ctx,
  821. struct ggml_tensor * a);
  822. GGML_API struct ggml_tensor * ggml_neg_inplace(
  823. struct ggml_context * ctx,
  824. struct ggml_tensor * a);
  825. GGML_API struct ggml_tensor * ggml_step(
  826. struct ggml_context * ctx,
  827. struct ggml_tensor * a);
  828. GGML_API struct ggml_tensor * ggml_step_inplace(
  829. struct ggml_context * ctx,
  830. struct ggml_tensor * a);
  831. GGML_API struct ggml_tensor * ggml_tanh(
  832. struct ggml_context * ctx,
  833. struct ggml_tensor * a);
  834. GGML_API struct ggml_tensor * ggml_tanh_inplace(
  835. struct ggml_context * ctx,
  836. struct ggml_tensor * a);
  837. GGML_API struct ggml_tensor * ggml_elu(
  838. struct ggml_context * ctx,
  839. struct ggml_tensor * a);
  840. GGML_API struct ggml_tensor * ggml_elu_inplace(
  841. struct ggml_context * ctx,
  842. struct ggml_tensor * a);
  843. GGML_API struct ggml_tensor * ggml_relu(
  844. struct ggml_context * ctx,
  845. struct ggml_tensor * a);
  846. GGML_API struct ggml_tensor * ggml_leaky_relu(
  847. struct ggml_context * ctx,
  848. struct ggml_tensor * a, float negative_slope, bool inplace);
  849. GGML_API struct ggml_tensor * ggml_relu_inplace(
  850. struct ggml_context * ctx,
  851. struct ggml_tensor * a);
  852. GGML_API struct ggml_tensor * ggml_sigmoid(
  853. struct ggml_context * ctx,
  854. struct ggml_tensor * a);
  855. GGML_API struct ggml_tensor * ggml_sigmoid_inplace(
  856. struct ggml_context * ctx,
  857. struct ggml_tensor * a);
  858. GGML_API struct ggml_tensor * ggml_gelu(
  859. struct ggml_context * ctx,
  860. struct ggml_tensor * a);
  861. GGML_API struct ggml_tensor * ggml_gelu_inplace(
  862. struct ggml_context * ctx,
  863. struct ggml_tensor * a);
  864. GGML_API struct ggml_tensor * ggml_gelu_quick(
  865. struct ggml_context * ctx,
  866. struct ggml_tensor * a);
  867. GGML_API struct ggml_tensor * ggml_gelu_quick_inplace(
  868. struct ggml_context * ctx,
  869. struct ggml_tensor * a);
  870. GGML_API struct ggml_tensor * ggml_silu(
  871. struct ggml_context * ctx,
  872. struct ggml_tensor * a);
  873. GGML_API struct ggml_tensor * ggml_silu_inplace(
  874. struct ggml_context * ctx,
  875. struct ggml_tensor * a);
  876. // a - x
  877. // b - dy
  878. GGML_API struct ggml_tensor * ggml_silu_back(
  879. struct ggml_context * ctx,
  880. struct ggml_tensor * a,
  881. struct ggml_tensor * b);
  882. // hardswish(x) = x * relu6(x + 3) / 6
  883. GGML_API struct ggml_tensor * ggml_hardswish(
  884. struct ggml_context * ctx,
  885. struct ggml_tensor * a);
  886. // hardsigmoid(x) = relu6(x + 3) / 6
  887. GGML_API struct ggml_tensor * ggml_hardsigmoid(
  888. struct ggml_context * ctx,
  889. struct ggml_tensor * a);
  890. GGML_API struct ggml_tensor * ggml_exp(
  891. struct ggml_context * ctx,
  892. struct ggml_tensor * a);
  893. GGML_API struct ggml_tensor * ggml_exp_inplace(
  894. struct ggml_context * ctx,
  895. struct ggml_tensor * a);
  896. // normalize along rows
  897. GGML_API struct ggml_tensor * ggml_norm(
  898. struct ggml_context * ctx,
  899. struct ggml_tensor * a,
  900. float eps);
  901. GGML_API struct ggml_tensor * ggml_norm_inplace(
  902. struct ggml_context * ctx,
  903. struct ggml_tensor * a,
  904. float eps);
  905. GGML_API struct ggml_tensor * ggml_rms_norm(
  906. struct ggml_context * ctx,
  907. struct ggml_tensor * a,
  908. float eps);
  909. GGML_API struct ggml_tensor * ggml_rms_norm_inplace(
  910. struct ggml_context * ctx,
  911. struct ggml_tensor * a,
  912. float eps);
  913. // group normalize along ne0*ne1*n_groups
  914. // used in stable-diffusion
  915. GGML_API struct ggml_tensor * ggml_group_norm(
  916. struct ggml_context * ctx,
  917. struct ggml_tensor * a,
  918. int n_groups,
  919. float eps);
  920. GGML_API struct ggml_tensor * ggml_group_norm_inplace(
  921. struct ggml_context * ctx,
  922. struct ggml_tensor * a,
  923. int n_groups,
  924. float eps);
  925. // a - x
  926. // b - dy
  927. GGML_API struct ggml_tensor * ggml_rms_norm_back(
  928. struct ggml_context * ctx,
  929. struct ggml_tensor * a,
  930. struct ggml_tensor * b,
  931. float eps);
  932. // A: k columns, n rows => [ne03, ne02, n, k]
  933. // B: k columns, m rows (i.e. we transpose it internally) => [ne03 * x, ne02 * y, m, k]
  934. // result is n columns, m rows => [ne03 * x, ne02 * y, m, n]
  935. GGML_API struct ggml_tensor * ggml_mul_mat(
  936. struct ggml_context * ctx,
  937. struct ggml_tensor * a,
  938. struct ggml_tensor * b);
  939. // change the precision of a matrix multiplication
  940. // set to GGML_PREC_F32 for higher precision (useful for phi-2)
  941. GGML_API void ggml_mul_mat_set_prec(
  942. struct ggml_tensor * a,
  943. enum ggml_prec prec);
  944. // indirect matrix multiplication
  945. GGML_API struct ggml_tensor * ggml_mul_mat_id(
  946. struct ggml_context * ctx,
  947. struct ggml_tensor * as,
  948. struct ggml_tensor * b,
  949. struct ggml_tensor * ids);
  950. // A: m columns, n rows,
  951. // B: p columns, n rows,
  952. // result is m columns, p rows
  953. GGML_API struct ggml_tensor * ggml_out_prod(
  954. struct ggml_context * ctx,
  955. struct ggml_tensor * a,
  956. struct ggml_tensor * b);
  957. //
  958. // operations on tensors without backpropagation
  959. //
  960. GGML_API struct ggml_tensor * ggml_scale(
  961. struct ggml_context * ctx,
  962. struct ggml_tensor * a,
  963. float s);
  964. // in-place, returns view(a)
  965. GGML_API struct ggml_tensor * ggml_scale_inplace(
  966. struct ggml_context * ctx,
  967. struct ggml_tensor * a,
  968. float s);
  969. // b -> view(a,offset,nb1,nb2,3), return modified a
  970. GGML_API struct ggml_tensor * ggml_set(
  971. struct ggml_context * ctx,
  972. struct ggml_tensor * a,
  973. struct ggml_tensor * b,
  974. size_t nb1,
  975. size_t nb2,
  976. size_t nb3,
  977. size_t offset); // in bytes
  978. // b -> view(a,offset,nb1,nb2,3), return view(a)
  979. GGML_API struct ggml_tensor * ggml_set_inplace(
  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. GGML_API struct ggml_tensor * ggml_set_1d(
  988. struct ggml_context * ctx,
  989. struct ggml_tensor * a,
  990. struct ggml_tensor * b,
  991. size_t offset); // in bytes
  992. GGML_API struct ggml_tensor * ggml_set_1d_inplace(
  993. struct ggml_context * ctx,
  994. struct ggml_tensor * a,
  995. struct ggml_tensor * b,
  996. size_t offset); // in bytes
  997. // b -> view(a,offset,nb1,nb2,3), return modified a
  998. GGML_API struct ggml_tensor * ggml_set_2d(
  999. struct ggml_context * ctx,
  1000. struct ggml_tensor * a,
  1001. struct ggml_tensor * b,
  1002. size_t nb1,
  1003. size_t offset); // in bytes
  1004. // b -> view(a,offset,nb1,nb2,3), return view(a)
  1005. GGML_API struct ggml_tensor * ggml_set_2d_inplace(
  1006. struct ggml_context * ctx,
  1007. struct ggml_tensor * a,
  1008. struct ggml_tensor * b,
  1009. size_t nb1,
  1010. size_t offset); // in bytes
  1011. // a -> b, return view(b)
  1012. GGML_API struct ggml_tensor * ggml_cpy(
  1013. struct ggml_context * ctx,
  1014. struct ggml_tensor * a,
  1015. struct ggml_tensor * b);
  1016. GGML_API struct ggml_tensor * ggml_cast(
  1017. struct ggml_context * ctx,
  1018. struct ggml_tensor * a,
  1019. enum ggml_type type);
  1020. // make contiguous
  1021. GGML_API struct ggml_tensor * ggml_cont(
  1022. struct ggml_context * ctx,
  1023. struct ggml_tensor * a);
  1024. // make contiguous, with new shape
  1025. GGML_API struct ggml_tensor * ggml_cont_1d(
  1026. struct ggml_context * ctx,
  1027. struct ggml_tensor * a,
  1028. int64_t ne0);
  1029. GGML_API struct ggml_tensor * ggml_cont_2d(
  1030. struct ggml_context * ctx,
  1031. struct ggml_tensor * a,
  1032. int64_t ne0,
  1033. int64_t ne1);
  1034. GGML_API struct ggml_tensor * ggml_cont_3d(
  1035. struct ggml_context * ctx,
  1036. struct ggml_tensor * a,
  1037. int64_t ne0,
  1038. int64_t ne1,
  1039. int64_t ne2);
  1040. GGML_API struct ggml_tensor * ggml_cont_4d(
  1041. struct ggml_context * ctx,
  1042. struct ggml_tensor * a,
  1043. int64_t ne0,
  1044. int64_t ne1,
  1045. int64_t ne2,
  1046. int64_t ne3);
  1047. // return view(a), b specifies the new shape
  1048. // TODO: when we start computing gradient, make a copy instead of view
  1049. GGML_API struct ggml_tensor * ggml_reshape(
  1050. struct ggml_context * ctx,
  1051. struct ggml_tensor * a,
  1052. struct ggml_tensor * b);
  1053. // return view(a)
  1054. // TODO: when we start computing gradient, make a copy instead of view
  1055. GGML_API struct ggml_tensor * ggml_reshape_1d(
  1056. struct ggml_context * ctx,
  1057. struct ggml_tensor * a,
  1058. int64_t ne0);
  1059. GGML_API struct ggml_tensor * ggml_reshape_2d(
  1060. struct ggml_context * ctx,
  1061. struct ggml_tensor * a,
  1062. int64_t ne0,
  1063. int64_t ne1);
  1064. // return view(a)
  1065. // TODO: when we start computing gradient, make a copy instead of view
  1066. GGML_API struct ggml_tensor * ggml_reshape_3d(
  1067. struct ggml_context * ctx,
  1068. struct ggml_tensor * a,
  1069. int64_t ne0,
  1070. int64_t ne1,
  1071. int64_t ne2);
  1072. GGML_API struct ggml_tensor * ggml_reshape_4d(
  1073. struct ggml_context * ctx,
  1074. struct ggml_tensor * a,
  1075. int64_t ne0,
  1076. int64_t ne1,
  1077. int64_t ne2,
  1078. int64_t ne3);
  1079. // offset in bytes
  1080. GGML_API struct ggml_tensor * ggml_view_1d(
  1081. struct ggml_context * ctx,
  1082. struct ggml_tensor * a,
  1083. int64_t ne0,
  1084. size_t offset);
  1085. GGML_API struct ggml_tensor * ggml_view_2d(
  1086. struct ggml_context * ctx,
  1087. struct ggml_tensor * a,
  1088. int64_t ne0,
  1089. int64_t ne1,
  1090. size_t nb1, // row stride in bytes
  1091. size_t offset);
  1092. GGML_API struct ggml_tensor * ggml_view_3d(
  1093. struct ggml_context * ctx,
  1094. struct ggml_tensor * a,
  1095. int64_t ne0,
  1096. int64_t ne1,
  1097. int64_t ne2,
  1098. size_t nb1, // row stride in bytes
  1099. size_t nb2, // slice stride in bytes
  1100. size_t offset);
  1101. GGML_API struct ggml_tensor * ggml_view_4d(
  1102. struct ggml_context * ctx,
  1103. struct ggml_tensor * a,
  1104. int64_t ne0,
  1105. int64_t ne1,
  1106. int64_t ne2,
  1107. int64_t ne3,
  1108. size_t nb1, // row stride in bytes
  1109. size_t nb2, // slice stride in bytes
  1110. size_t nb3,
  1111. size_t offset);
  1112. GGML_API struct ggml_tensor * ggml_permute(
  1113. struct ggml_context * ctx,
  1114. struct ggml_tensor * a,
  1115. int axis0,
  1116. int axis1,
  1117. int axis2,
  1118. int axis3);
  1119. // alias for ggml_permute(ctx, a, 1, 0, 2, 3)
  1120. GGML_API struct ggml_tensor * ggml_transpose(
  1121. struct ggml_context * ctx,
  1122. struct ggml_tensor * a);
  1123. // supports 3D: a->ne[2] == b->ne[1]
  1124. GGML_API struct ggml_tensor * ggml_get_rows(
  1125. struct ggml_context * ctx,
  1126. struct ggml_tensor * a, // data
  1127. struct ggml_tensor * b); // row indices
  1128. GGML_API struct ggml_tensor * ggml_get_rows_back(
  1129. struct ggml_context * ctx,
  1130. struct ggml_tensor * a, // gradients of ggml_get_rows result
  1131. struct ggml_tensor * b, // row indices
  1132. struct ggml_tensor * c); // data for ggml_get_rows, only used for its shape
  1133. GGML_API struct ggml_tensor * ggml_diag(
  1134. struct ggml_context * ctx,
  1135. struct ggml_tensor * a);
  1136. // set elements above the diagonal to -INF
  1137. GGML_API struct ggml_tensor * ggml_diag_mask_inf(
  1138. struct ggml_context * ctx,
  1139. struct ggml_tensor * a,
  1140. int n_past);
  1141. // in-place, returns view(a)
  1142. GGML_API struct ggml_tensor * ggml_diag_mask_inf_inplace(
  1143. struct ggml_context * ctx,
  1144. struct ggml_tensor * a,
  1145. int n_past);
  1146. // set elements above the diagonal to 0
  1147. GGML_API struct ggml_tensor * ggml_diag_mask_zero(
  1148. struct ggml_context * ctx,
  1149. struct ggml_tensor * a,
  1150. int n_past);
  1151. // in-place, returns view(a)
  1152. GGML_API struct ggml_tensor * ggml_diag_mask_zero_inplace(
  1153. struct ggml_context * ctx,
  1154. struct ggml_tensor * a,
  1155. int n_past);
  1156. GGML_API struct ggml_tensor * ggml_soft_max(
  1157. struct ggml_context * ctx,
  1158. struct ggml_tensor * a);
  1159. // in-place, returns view(a)
  1160. GGML_API struct ggml_tensor * ggml_soft_max_inplace(
  1161. struct ggml_context * ctx,
  1162. struct ggml_tensor * a);
  1163. // fused soft_max(a*scale + mask*(ALiBi slope))
  1164. // mask is optional
  1165. // max_bias = 0.0f for no ALiBi
  1166. GGML_API struct ggml_tensor * ggml_soft_max_ext(
  1167. struct ggml_context * ctx,
  1168. struct ggml_tensor * a,
  1169. struct ggml_tensor * mask,
  1170. float scale,
  1171. float max_bias);
  1172. GGML_API struct ggml_tensor * ggml_soft_max_back(
  1173. struct ggml_context * ctx,
  1174. struct ggml_tensor * a,
  1175. struct ggml_tensor * b);
  1176. // in-place, returns view(a)
  1177. GGML_API struct ggml_tensor * ggml_soft_max_back_inplace(
  1178. struct ggml_context * ctx,
  1179. struct ggml_tensor * a,
  1180. struct ggml_tensor * b);
  1181. // rotary position embedding
  1182. // if (mode & 1) - skip n_past elements (NOT SUPPORTED)
  1183. // if (mode & GGML_ROPE_TYPE_NEOX) - GPT-NeoX style
  1184. //
  1185. // b is an int32 vector with size a->ne[2], it contains the positions
  1186. GGML_API struct ggml_tensor * ggml_rope(
  1187. struct ggml_context * ctx,
  1188. struct ggml_tensor * a,
  1189. struct ggml_tensor * b,
  1190. int n_dims,
  1191. int mode);
  1192. // in-place, returns view(a)
  1193. GGML_API struct ggml_tensor * ggml_rope_inplace(
  1194. struct ggml_context * ctx,
  1195. struct ggml_tensor * a,
  1196. struct ggml_tensor * b,
  1197. int n_dims,
  1198. int mode);
  1199. // custom RoPE
  1200. // c is freq factors (e.g. phi3-128k), (optional)
  1201. GGML_API struct ggml_tensor * ggml_rope_ext(
  1202. struct ggml_context * ctx,
  1203. struct ggml_tensor * a,
  1204. struct ggml_tensor * b,
  1205. struct ggml_tensor * c,
  1206. int n_dims,
  1207. int mode,
  1208. int n_ctx_orig,
  1209. float freq_base,
  1210. float freq_scale,
  1211. float ext_factor,
  1212. float attn_factor,
  1213. float beta_fast,
  1214. float beta_slow);
  1215. GGML_API struct ggml_tensor * ggml_rope_multi(
  1216. struct ggml_context * ctx,
  1217. struct ggml_tensor * a,
  1218. struct ggml_tensor * b,
  1219. struct ggml_tensor * c,
  1220. int n_dims,
  1221. int sections[4],
  1222. int mode,
  1223. int n_ctx_orig,
  1224. float freq_base,
  1225. float freq_scale,
  1226. float ext_factor,
  1227. float attn_factor,
  1228. float beta_fast,
  1229. float beta_slow);
  1230. // in-place, returns view(a)
  1231. GGML_API struct ggml_tensor * ggml_rope_ext_inplace(
  1232. struct ggml_context * ctx,
  1233. struct ggml_tensor * a,
  1234. struct ggml_tensor * b,
  1235. struct ggml_tensor * c,
  1236. int n_dims,
  1237. int mode,
  1238. int n_ctx_orig,
  1239. float freq_base,
  1240. float freq_scale,
  1241. float ext_factor,
  1242. float attn_factor,
  1243. float beta_fast,
  1244. float beta_slow);
  1245. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_rope_custom(
  1246. struct ggml_context * ctx,
  1247. struct ggml_tensor * a,
  1248. struct ggml_tensor * b,
  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. "use ggml_rope_ext instead");
  1259. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_rope_custom_inplace(
  1260. struct ggml_context * ctx,
  1261. struct ggml_tensor * a,
  1262. struct ggml_tensor * b,
  1263. int n_dims,
  1264. int mode,
  1265. int n_ctx_orig,
  1266. float freq_base,
  1267. float freq_scale,
  1268. float ext_factor,
  1269. float attn_factor,
  1270. float beta_fast,
  1271. float beta_slow),
  1272. "use ggml_rope_ext_inplace instead");
  1273. // compute correction dims for YaRN RoPE scaling
  1274. GGML_API void ggml_rope_yarn_corr_dims(
  1275. int n_dims, int n_ctx_orig, float freq_base, float beta_fast, float beta_slow, float dims[2]);
  1276. // rotary position embedding backward, i.e compute dx from dy
  1277. // a - dy
  1278. GGML_API struct ggml_tensor * ggml_rope_back(
  1279. struct ggml_context * ctx,
  1280. struct ggml_tensor * a, // gradients of ggml_rope result
  1281. struct ggml_tensor * b, // positions
  1282. struct ggml_tensor * c, // freq factors
  1283. int n_dims,
  1284. int mode,
  1285. int n_ctx_orig,
  1286. float freq_base,
  1287. float freq_scale,
  1288. float ext_factor,
  1289. float attn_factor,
  1290. float beta_fast,
  1291. float beta_slow);
  1292. // clamp
  1293. // in-place, returns view(a)
  1294. GGML_API struct ggml_tensor * ggml_clamp(
  1295. struct ggml_context * ctx,
  1296. struct ggml_tensor * a,
  1297. float min,
  1298. float max);
  1299. // im2col
  1300. // converts data into a format that effectively results in a convolution when combined with matrix multiplication
  1301. GGML_API struct ggml_tensor * ggml_im2col(
  1302. struct ggml_context * ctx,
  1303. struct ggml_tensor * a, // convolution kernel
  1304. struct ggml_tensor * b, // data
  1305. int s0, // stride dimension 0
  1306. int s1, // stride dimension 1
  1307. int p0, // padding dimension 0
  1308. int p1, // padding dimension 1
  1309. int d0, // dilation dimension 0
  1310. int d1, // dilation dimension 1
  1311. bool is_2D,
  1312. enum ggml_type dst_type);
  1313. GGML_API struct ggml_tensor * ggml_im2col_back(
  1314. struct ggml_context * ctx,
  1315. struct ggml_tensor * a, // convolution kernel
  1316. struct ggml_tensor * b, // gradient of im2col output
  1317. int64_t * ne, // shape of im2col input
  1318. int s0, // stride dimension 0
  1319. int s1, // stride dimension 1
  1320. int p0, // padding dimension 0
  1321. int p1, // padding dimension 1
  1322. int d0, // dilation dimension 0
  1323. int d1, // dilation dimension 1
  1324. bool is_2D);
  1325. GGML_API struct ggml_tensor * ggml_conv_1d(
  1326. struct ggml_context * ctx,
  1327. struct ggml_tensor * a, // convolution kernel
  1328. struct ggml_tensor * b, // data
  1329. int s0, // stride
  1330. int p0, // padding
  1331. int d0); // dilation
  1332. // conv_1d with padding = half
  1333. // alias for ggml_conv_1d(a, b, s, a->ne[0]/2, d)
  1334. GGML_API struct ggml_tensor* ggml_conv_1d_ph(
  1335. struct ggml_context * ctx,
  1336. struct ggml_tensor * a, // convolution kernel
  1337. struct ggml_tensor * b, // data
  1338. int s, // stride
  1339. int d); // dilation
  1340. // depthwise
  1341. // TODO: this is very likely wrong for some cases! - needs more testing
  1342. GGML_API struct ggml_tensor * ggml_conv_1d_dw(
  1343. struct ggml_context * ctx,
  1344. struct ggml_tensor * a, // convolution kernel
  1345. struct ggml_tensor * b, // data
  1346. int s0, // stride
  1347. int p0, // padding
  1348. int d0); // dilation
  1349. GGML_API struct ggml_tensor * ggml_conv_1d_dw_ph(
  1350. struct ggml_context * ctx,
  1351. struct ggml_tensor * a, // convolution kernel
  1352. struct ggml_tensor * b, // data
  1353. int s0, // stride
  1354. int d0); // dilation
  1355. GGML_API struct ggml_tensor * ggml_conv_transpose_1d(
  1356. struct ggml_context * ctx,
  1357. struct ggml_tensor * a, // convolution kernel
  1358. struct ggml_tensor * b, // data
  1359. int s0, // stride
  1360. int p0, // padding
  1361. int d0); // dilation
  1362. GGML_API struct ggml_tensor * ggml_conv_2d(
  1363. struct ggml_context * ctx,
  1364. struct ggml_tensor * a, // convolution kernel
  1365. struct ggml_tensor * b, // data
  1366. int s0, // stride dimension 0
  1367. int s1, // stride dimension 1
  1368. int p0, // padding dimension 0
  1369. int p1, // padding dimension 1
  1370. int d0, // dilation dimension 0
  1371. int d1); // dilation dimension 1
  1372. // kernel size is a->ne[0] x a->ne[1]
  1373. // stride is equal to kernel size
  1374. // padding is zero
  1375. // example:
  1376. // a: 16 16 3 768
  1377. // b: 1024 1024 3 1
  1378. // res: 64 64 768 1
  1379. // used in sam
  1380. GGML_API struct ggml_tensor * ggml_conv_2d_sk_p0(
  1381. struct ggml_context * ctx,
  1382. struct ggml_tensor * a,
  1383. struct ggml_tensor * b);
  1384. // kernel size is a->ne[0] x a->ne[1]
  1385. // stride is 1
  1386. // padding is half
  1387. // example:
  1388. // a: 3 3 256 256
  1389. // b: 64 64 256 1
  1390. // res: 64 64 256 1
  1391. // used in sam
  1392. GGML_API struct ggml_tensor * ggml_conv_2d_s1_ph(
  1393. struct ggml_context * ctx,
  1394. struct ggml_tensor * a,
  1395. struct ggml_tensor * b);
  1396. // depthwise
  1397. GGML_API struct ggml_tensor * ggml_conv_2d_dw(
  1398. struct ggml_context * ctx,
  1399. struct ggml_tensor * a, // convolution kernel
  1400. struct ggml_tensor * b, // data
  1401. int s0, // stride dimension 0
  1402. int s1, // stride dimension 1
  1403. int p0, // padding dimension 0
  1404. int p1, // padding dimension 1
  1405. int d0, // dilation dimension 0
  1406. int d1); // dilation dimension 1
  1407. GGML_API struct ggml_tensor * ggml_conv_transpose_2d_p0(
  1408. struct ggml_context * ctx,
  1409. struct ggml_tensor * a,
  1410. struct ggml_tensor * b,
  1411. int stride);
  1412. enum ggml_op_pool {
  1413. GGML_OP_POOL_MAX,
  1414. GGML_OP_POOL_AVG,
  1415. GGML_OP_POOL_COUNT,
  1416. };
  1417. GGML_API struct ggml_tensor * ggml_pool_1d(
  1418. struct ggml_context * ctx,
  1419. struct ggml_tensor * a,
  1420. enum ggml_op_pool op,
  1421. int k0, // kernel size
  1422. int s0, // stride
  1423. int p0); // padding
  1424. // the result will have 2*p0 padding for the first dimension
  1425. // and 2*p1 padding for the second dimension
  1426. GGML_API struct ggml_tensor * ggml_pool_2d(
  1427. struct ggml_context * ctx,
  1428. struct ggml_tensor * a,
  1429. enum ggml_op_pool op,
  1430. int k0,
  1431. int k1,
  1432. int s0,
  1433. int s1,
  1434. float p0,
  1435. float p1);
  1436. GGML_API struct ggml_tensor * ggml_pool_2d_back(
  1437. struct ggml_context * ctx,
  1438. struct ggml_tensor * a,
  1439. struct ggml_tensor * af, // "a"/input used in forward pass
  1440. enum ggml_op_pool op,
  1441. int k0,
  1442. int k1,
  1443. int s0,
  1444. int s1,
  1445. float p0,
  1446. float p1);
  1447. // nearest interpolate
  1448. // multiplies ne0 and ne1 by scale factor
  1449. // used in stable-diffusion
  1450. GGML_API struct ggml_tensor * ggml_upscale(
  1451. struct ggml_context * ctx,
  1452. struct ggml_tensor * a,
  1453. int scale_factor);
  1454. // nearest interpolate
  1455. // nearest interpolate to specified dimensions
  1456. // used in tortoise.cpp
  1457. GGML_API struct ggml_tensor * ggml_upscale_ext(
  1458. struct ggml_context * ctx,
  1459. struct ggml_tensor * a,
  1460. int ne0,
  1461. int ne1,
  1462. int ne2,
  1463. int ne3);
  1464. // pad each dimension with zeros: [x, ..., x] -> [x, ..., x, 0, ..., 0]
  1465. GGML_API struct ggml_tensor * ggml_pad(
  1466. struct ggml_context * ctx,
  1467. struct ggml_tensor * a,
  1468. int p0,
  1469. int p1,
  1470. int p2,
  1471. int p3);
  1472. // pad each dimension with reflection: [a, b, c, d] -> [b, a, b, c, d, c]
  1473. GGML_API struct ggml_tensor * ggml_pad_reflect_1d(
  1474. struct ggml_context * ctx,
  1475. struct ggml_tensor * a,
  1476. int p0,
  1477. int p1);
  1478. // Ref: https://github.com/CompVis/stable-diffusion/blob/main/ldm/modules/diffusionmodules/util.py#L151
  1479. // timesteps: [N,]
  1480. // return: [N, dim]
  1481. GGML_API struct ggml_tensor * ggml_timestep_embedding(
  1482. struct ggml_context * ctx,
  1483. struct ggml_tensor * timesteps,
  1484. int dim,
  1485. int max_period);
  1486. // sort rows
  1487. enum ggml_sort_order {
  1488. GGML_SORT_ORDER_ASC,
  1489. GGML_SORT_ORDER_DESC,
  1490. };
  1491. GGML_API struct ggml_tensor * ggml_argsort(
  1492. struct ggml_context * ctx,
  1493. struct ggml_tensor * a,
  1494. enum ggml_sort_order order);
  1495. GGML_API struct ggml_tensor * ggml_arange(
  1496. struct ggml_context * ctx,
  1497. float start,
  1498. float stop,
  1499. float step);
  1500. // top k elements per row
  1501. GGML_API struct ggml_tensor * ggml_top_k(
  1502. struct ggml_context * ctx,
  1503. struct ggml_tensor * a,
  1504. int k);
  1505. #define GGML_KQ_MASK_PAD 32
  1506. // q: [n_embd, n_batch, n_head, 1]
  1507. // k: [n_embd, n_kv, n_head_kv, 1]
  1508. // v: [n_embd, n_kv, n_head_kv, 1] !! not transposed !!
  1509. // mask: [n_kv, n_batch_pad, 1, 1] !! n_batch_pad = GGML_PAD(n_batch, GGML_KQ_MASK_PAD) !!
  1510. // res: [n_embd, n_head, n_batch, 1] !! permuted !!
  1511. GGML_API struct ggml_tensor * ggml_flash_attn_ext(
  1512. struct ggml_context * ctx,
  1513. struct ggml_tensor * q,
  1514. struct ggml_tensor * k,
  1515. struct ggml_tensor * v,
  1516. struct ggml_tensor * mask,
  1517. float scale,
  1518. float max_bias,
  1519. float logit_softcap);
  1520. GGML_API void ggml_flash_attn_ext_set_prec(
  1521. struct ggml_tensor * a,
  1522. enum ggml_prec prec);
  1523. GGML_API enum ggml_prec ggml_flash_attn_ext_get_prec(
  1524. const struct ggml_tensor * a);
  1525. // TODO: needs to be adapted to ggml_flash_attn_ext
  1526. GGML_API struct ggml_tensor * ggml_flash_attn_back(
  1527. struct ggml_context * ctx,
  1528. struct ggml_tensor * q,
  1529. struct ggml_tensor * k,
  1530. struct ggml_tensor * v,
  1531. struct ggml_tensor * d,
  1532. bool masked);
  1533. GGML_API struct ggml_tensor * ggml_ssm_conv(
  1534. struct ggml_context * ctx,
  1535. struct ggml_tensor * sx,
  1536. struct ggml_tensor * c);
  1537. GGML_API struct ggml_tensor * ggml_ssm_scan(
  1538. struct ggml_context * ctx,
  1539. struct ggml_tensor * s,
  1540. struct ggml_tensor * x,
  1541. struct ggml_tensor * dt,
  1542. struct ggml_tensor * A,
  1543. struct ggml_tensor * B,
  1544. struct ggml_tensor * C);
  1545. // partition into non-overlapping windows with padding if needed
  1546. // example:
  1547. // a: 768 64 64 1
  1548. // w: 14
  1549. // res: 768 14 14 25
  1550. // used in sam
  1551. GGML_API struct ggml_tensor * ggml_win_part(
  1552. struct ggml_context * ctx,
  1553. struct ggml_tensor * a,
  1554. int w);
  1555. // reverse of ggml_win_part
  1556. // used in sam
  1557. GGML_API struct ggml_tensor * ggml_win_unpart(
  1558. struct ggml_context * ctx,
  1559. struct ggml_tensor * a,
  1560. int w0,
  1561. int h0,
  1562. int w);
  1563. GGML_API struct ggml_tensor * ggml_unary(
  1564. struct ggml_context * ctx,
  1565. struct ggml_tensor * a,
  1566. enum ggml_unary_op op);
  1567. GGML_API struct ggml_tensor * ggml_unary_inplace(
  1568. struct ggml_context * ctx,
  1569. struct ggml_tensor * a,
  1570. enum ggml_unary_op op);
  1571. // used in sam
  1572. GGML_API struct ggml_tensor * ggml_get_rel_pos(
  1573. struct ggml_context * ctx,
  1574. struct ggml_tensor * a,
  1575. int qh,
  1576. int kh);
  1577. // used in sam
  1578. GGML_API struct ggml_tensor * ggml_add_rel_pos(
  1579. struct ggml_context * ctx,
  1580. struct ggml_tensor * a,
  1581. struct ggml_tensor * pw,
  1582. struct ggml_tensor * ph);
  1583. GGML_API struct ggml_tensor * ggml_add_rel_pos_inplace(
  1584. struct ggml_context * ctx,
  1585. struct ggml_tensor * a,
  1586. struct ggml_tensor * pw,
  1587. struct ggml_tensor * ph);
  1588. GGML_API struct ggml_tensor * ggml_rwkv_wkv6(
  1589. struct ggml_context * ctx,
  1590. struct ggml_tensor * k,
  1591. struct ggml_tensor * v,
  1592. struct ggml_tensor * r,
  1593. struct ggml_tensor * tf,
  1594. struct ggml_tensor * td,
  1595. struct ggml_tensor * state);
  1596. // custom operators
  1597. typedef void (*ggml_unary_op_f32_t) (const int, float *, const float *);
  1598. typedef void (*ggml_binary_op_f32_t)(const int, float *, const float *, const float *);
  1599. typedef void (*ggml_custom1_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *);
  1600. typedef void (*ggml_custom2_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1601. typedef void (*ggml_custom3_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1602. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_f32(
  1603. struct ggml_context * ctx,
  1604. struct ggml_tensor * a,
  1605. ggml_unary_op_f32_t fun),
  1606. "use ggml_map_custom1 instead");
  1607. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_inplace_f32(
  1608. struct ggml_context * ctx,
  1609. struct ggml_tensor * a,
  1610. ggml_unary_op_f32_t fun),
  1611. "use ggml_map_custom1_inplace instead");
  1612. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_f32(
  1613. struct ggml_context * ctx,
  1614. struct ggml_tensor * a,
  1615. struct ggml_tensor * b,
  1616. ggml_binary_op_f32_t fun),
  1617. "use ggml_map_custom2 instead");
  1618. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_inplace_f32(
  1619. struct ggml_context * ctx,
  1620. struct ggml_tensor * a,
  1621. struct ggml_tensor * b,
  1622. ggml_binary_op_f32_t fun),
  1623. "use ggml_map_custom2_inplace instead");
  1624. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_f32(
  1625. struct ggml_context * ctx,
  1626. struct ggml_tensor * a,
  1627. ggml_custom1_op_f32_t fun),
  1628. "use ggml_map_custom1 instead");
  1629. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_inplace_f32(
  1630. struct ggml_context * ctx,
  1631. struct ggml_tensor * a,
  1632. ggml_custom1_op_f32_t fun),
  1633. "use ggml_map_custom1_inplace instead");
  1634. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_f32(
  1635. struct ggml_context * ctx,
  1636. struct ggml_tensor * a,
  1637. struct ggml_tensor * b,
  1638. ggml_custom2_op_f32_t fun),
  1639. "use ggml_map_custom2 instead");
  1640. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_inplace_f32(
  1641. struct ggml_context * ctx,
  1642. struct ggml_tensor * a,
  1643. struct ggml_tensor * b,
  1644. ggml_custom2_op_f32_t fun),
  1645. "use ggml_map_custom2_inplace instead");
  1646. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_f32(
  1647. struct ggml_context * ctx,
  1648. struct ggml_tensor * a,
  1649. struct ggml_tensor * b,
  1650. struct ggml_tensor * c,
  1651. ggml_custom3_op_f32_t fun),
  1652. "use ggml_map_custom3 instead");
  1653. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_inplace_f32(
  1654. struct ggml_context * ctx,
  1655. struct ggml_tensor * a,
  1656. struct ggml_tensor * b,
  1657. struct ggml_tensor * c,
  1658. ggml_custom3_op_f32_t fun),
  1659. "use ggml_map_custom3_inplace instead");
  1660. // custom operators v2
  1661. typedef void (*ggml_custom1_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, int ith, int nth, void * userdata);
  1662. 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);
  1663. 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);
  1664. #define GGML_N_TASKS_MAX (-1)
  1665. // n_tasks == GGML_N_TASKS_MAX means to use max number of tasks
  1666. GGML_API struct ggml_tensor * ggml_map_custom1(
  1667. struct ggml_context * ctx,
  1668. struct ggml_tensor * a,
  1669. ggml_custom1_op_t fun,
  1670. int n_tasks,
  1671. void * userdata);
  1672. GGML_API struct ggml_tensor * ggml_map_custom1_inplace(
  1673. struct ggml_context * ctx,
  1674. struct ggml_tensor * a,
  1675. ggml_custom1_op_t fun,
  1676. int n_tasks,
  1677. void * userdata);
  1678. GGML_API struct ggml_tensor * ggml_map_custom2(
  1679. struct ggml_context * ctx,
  1680. struct ggml_tensor * a,
  1681. struct ggml_tensor * b,
  1682. ggml_custom2_op_t fun,
  1683. int n_tasks,
  1684. void * userdata);
  1685. GGML_API struct ggml_tensor * ggml_map_custom2_inplace(
  1686. struct ggml_context * ctx,
  1687. struct ggml_tensor * a,
  1688. struct ggml_tensor * b,
  1689. ggml_custom2_op_t fun,
  1690. int n_tasks,
  1691. void * userdata);
  1692. GGML_API struct ggml_tensor * ggml_map_custom3(
  1693. struct ggml_context * ctx,
  1694. struct ggml_tensor * a,
  1695. struct ggml_tensor * b,
  1696. struct ggml_tensor * c,
  1697. ggml_custom3_op_t fun,
  1698. int n_tasks,
  1699. void * userdata);
  1700. GGML_API struct ggml_tensor * ggml_map_custom3_inplace(
  1701. struct ggml_context * ctx,
  1702. struct ggml_tensor * a,
  1703. struct ggml_tensor * b,
  1704. struct ggml_tensor * c,
  1705. ggml_custom3_op_t fun,
  1706. int n_tasks,
  1707. void * userdata);
  1708. // loss function
  1709. GGML_API struct ggml_tensor * ggml_cross_entropy_loss(
  1710. struct ggml_context * ctx,
  1711. struct ggml_tensor * a, // logits
  1712. struct ggml_tensor * b); // labels
  1713. GGML_API struct ggml_tensor * ggml_cross_entropy_loss_back(
  1714. struct ggml_context * ctx,
  1715. struct ggml_tensor * a, // logits
  1716. struct ggml_tensor * b, // labels
  1717. struct ggml_tensor * c); // gradients of cross_entropy_loss result
  1718. // AdamW optimizer step
  1719. // Paper: https://arxiv.org/pdf/1711.05101v3.pdf
  1720. // PyTorch: https://pytorch.org/docs/stable/generated/torch.optim.AdamW.html
  1721. GGML_API struct ggml_tensor * ggml_opt_step_adamw(
  1722. struct ggml_context * ctx,
  1723. struct ggml_tensor * a,
  1724. struct ggml_tensor * grad,
  1725. struct ggml_tensor * m,
  1726. struct ggml_tensor * v,
  1727. struct ggml_tensor * adamw_params); // parameters such a the learning rate
  1728. //
  1729. // automatic differentiation
  1730. //
  1731. GGML_API void ggml_build_forward_expand(struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1732. GGML_API void ggml_build_backward_expand(
  1733. struct ggml_context * ctx_static, // context for static gradients (loss + gradient accumulation)
  1734. struct ggml_context * ctx_compute, // context for gradient computation
  1735. struct ggml_cgraph * cgraph,
  1736. bool accumulate); // whether or not gradients should be accumulated, requires static allocation of tensors in ctx_static
  1737. // graph allocation in a context
  1738. GGML_API struct ggml_cgraph * ggml_new_graph (struct ggml_context * ctx); // size = GGML_DEFAULT_GRAPH_SIZE, grads = false
  1739. GGML_API struct ggml_cgraph * ggml_new_graph_custom(struct ggml_context * ctx, size_t size, bool grads);
  1740. GGML_API struct ggml_cgraph * ggml_graph_dup (struct ggml_context * ctx, struct ggml_cgraph * cgraph);
  1741. GGML_API void ggml_graph_cpy (struct ggml_cgraph * src, struct ggml_cgraph * dst);
  1742. GGML_API void ggml_graph_reset (struct ggml_cgraph * cgraph); // set regular grads + optimizer momenta to 0, set loss grad to 1
  1743. GGML_API void ggml_graph_clear (struct ggml_cgraph * cgraph);
  1744. GGML_API int ggml_graph_size (struct ggml_cgraph * cgraph);
  1745. GGML_API struct ggml_tensor * ggml_graph_node (struct ggml_cgraph * cgraph, int i); // if i < 0, returns nodes[n_nodes + i]
  1746. GGML_API struct ggml_tensor ** ggml_graph_nodes (struct ggml_cgraph * cgraph);
  1747. GGML_API int ggml_graph_n_nodes(struct ggml_cgraph * cgraph);
  1748. GGML_API void ggml_graph_add_node(struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1749. GGML_API size_t ggml_graph_overhead(void);
  1750. GGML_API size_t ggml_graph_overhead_custom(size_t size, bool grads);
  1751. GGML_API struct ggml_tensor * ggml_graph_get_tensor (const struct ggml_cgraph * cgraph, const char * name);
  1752. GGML_API struct ggml_tensor * ggml_graph_get_grad (const struct ggml_cgraph * cgraph, const struct ggml_tensor * node);
  1753. GGML_API struct ggml_tensor * ggml_graph_get_grad_acc(const struct ggml_cgraph * cgraph, const struct ggml_tensor * node);
  1754. GGML_API void ggml_graph_export(const struct ggml_cgraph * cgraph, const char * fname);
  1755. GGML_API struct ggml_cgraph * ggml_graph_import(const char * fname, struct ggml_context ** ctx_data, struct ggml_context ** ctx_eval);
  1756. // print info and performance information for the graph
  1757. GGML_API void ggml_graph_print(const struct ggml_cgraph * cgraph);
  1758. // dump the graph into a file using the dot format
  1759. GGML_API void ggml_graph_dump_dot(const struct ggml_cgraph * gb, const struct ggml_cgraph * gf, const char * filename);
  1760. // TODO these functions were sandwiched in the old optimization interface, is there a better place for them?
  1761. typedef void (*ggml_log_callback)(enum ggml_log_level level, const char * text, void * user_data);
  1762. // Set callback for all future logging events.
  1763. // If this is not called, or NULL is supplied, everything is output on stderr.
  1764. GGML_API void ggml_log_set(ggml_log_callback log_callback, void * user_data);
  1765. GGML_API struct ggml_tensor * ggml_set_zero(struct ggml_tensor * tensor);
  1766. //
  1767. // quantization
  1768. //
  1769. // - ggml_quantize_init can be called multiple times with the same type
  1770. // it will only initialize the quantization tables for the first call or after ggml_quantize_free
  1771. // automatically called by ggml_quantize_chunk for convenience
  1772. //
  1773. // - ggml_quantize_free will free any memory allocated by ggml_quantize_init
  1774. // call this at the end of the program to avoid memory leaks
  1775. //
  1776. // note: these are thread-safe
  1777. //
  1778. GGML_API void ggml_quantize_init(enum ggml_type type);
  1779. GGML_API void ggml_quantize_free(void);
  1780. // some quantization type cannot be used without an importance matrix
  1781. GGML_API bool ggml_quantize_requires_imatrix(enum ggml_type type);
  1782. // calls ggml_quantize_init internally (i.e. can allocate memory)
  1783. GGML_API size_t ggml_quantize_chunk(
  1784. enum ggml_type type,
  1785. const float * src,
  1786. void * dst,
  1787. int64_t start,
  1788. int64_t nrows,
  1789. int64_t n_per_row,
  1790. const float * imatrix);
  1791. #ifdef __cplusplus
  1792. // restrict not standard in C++
  1793. # if defined(__GNUC__)
  1794. # define GGML_RESTRICT __restrict__
  1795. # elif defined(__clang__)
  1796. # define GGML_RESTRICT __restrict
  1797. # elif defined(_MSC_VER)
  1798. # define GGML_RESTRICT __restrict
  1799. # else
  1800. # define GGML_RESTRICT
  1801. # endif
  1802. #else
  1803. # define GGML_RESTRICT restrict
  1804. #endif
  1805. typedef void (*ggml_to_float_t) (const void * GGML_RESTRICT x, float * GGML_RESTRICT y, int64_t k);
  1806. typedef void (*ggml_from_float_t)(const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int64_t k);
  1807. struct ggml_type_traits {
  1808. const char * type_name;
  1809. int64_t blck_size;
  1810. int64_t blck_size_interleave; // interleave elements in blocks
  1811. size_t type_size;
  1812. bool is_quantized;
  1813. ggml_to_float_t to_float;
  1814. ggml_from_float_t from_float_ref;
  1815. };
  1816. GGML_API const struct ggml_type_traits * ggml_get_type_traits(enum ggml_type type);
  1817. // ggml threadpool
  1818. // TODO: currently, only a few functions are in the base ggml API, while the rest are in the CPU backend
  1819. // the goal should be to create an API that other backends can use move everything to the ggml base
  1820. // scheduling priorities
  1821. enum ggml_sched_priority {
  1822. GGML_SCHED_PRIO_NORMAL,
  1823. GGML_SCHED_PRIO_MEDIUM,
  1824. GGML_SCHED_PRIO_HIGH,
  1825. GGML_SCHED_PRIO_REALTIME
  1826. };
  1827. // threadpool params
  1828. // Use ggml_threadpool_params_default() or ggml_threadpool_params_init() to populate the defaults
  1829. struct ggml_threadpool_params {
  1830. bool cpumask[GGML_MAX_N_THREADS]; // mask of cpu cores (all-zeros means use default affinity settings)
  1831. int n_threads; // number of threads
  1832. enum ggml_sched_priority prio; // thread priority
  1833. uint32_t poll; // polling level (0 - no polling, 100 - aggressive polling)
  1834. bool strict_cpu; // strict cpu placement
  1835. bool paused; // start in paused state
  1836. };
  1837. struct ggml_threadpool; // forward declaration, see ggml.c
  1838. typedef struct ggml_threadpool * ggml_threadpool_t;
  1839. GGML_API struct ggml_threadpool_params ggml_threadpool_params_default(int n_threads);
  1840. GGML_API void ggml_threadpool_params_init (struct ggml_threadpool_params * p, int n_threads);
  1841. GGML_API bool ggml_threadpool_params_match (const struct ggml_threadpool_params * p0, const struct ggml_threadpool_params * p1);
  1842. #ifdef __cplusplus
  1843. }
  1844. #endif