ggml.h 77 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153
  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)
  178. # else
  179. # define GGML_API __declspec(dllimport)
  180. # endif
  181. # else
  182. # define GGML_API __attribute__ ((visibility ("default")))
  183. # endif
  184. #else
  185. # define GGML_API
  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 <stdint.h>
  203. #include <stddef.h>
  204. #include <stdbool.h>
  205. #define GGML_FILE_MAGIC 0x67676d6c // "ggml"
  206. #define GGML_FILE_VERSION 1
  207. #define GGML_QNT_VERSION 2 // bump this on quantization format changes
  208. #define GGML_QNT_VERSION_FACTOR 1000 // do not change this
  209. #define GGML_MAX_DIMS 4
  210. #define GGML_MAX_PARAMS 1024
  211. #define GGML_MAX_CONTEXTS 64
  212. #define GGML_MAX_SRC 6
  213. #define GGML_MAX_NAME 64
  214. #define GGML_MAX_OP_PARAMS 64
  215. #define GGML_DEFAULT_N_THREADS 4
  216. #define GGML_DEFAULT_GRAPH_SIZE 2048
  217. #if UINTPTR_MAX == 0xFFFFFFFF
  218. #define GGML_MEM_ALIGN 4
  219. #else
  220. #define GGML_MEM_ALIGN 16
  221. #endif
  222. #define GGML_EXIT_SUCCESS 0
  223. #define GGML_EXIT_ABORTED 1
  224. #define GGUF_MAGIC "GGUF"
  225. #define GGUF_VERSION 3
  226. #define GGUF_DEFAULT_ALIGNMENT 32
  227. #define GGML_UNUSED(x) (void)(x)
  228. #define GGML_PAD(x, n) (((x) + (n) - 1) & ~((n) - 1))
  229. #define GGML_ASSERT(x) \
  230. do { \
  231. if (!(x)) { \
  232. fprintf(stderr, "GGML_ASSERT: %s:%d: %s\n", __FILE__, __LINE__, #x); \
  233. fflush(stderr); \
  234. fflush(stdout); \
  235. ggml_print_backtrace(); \
  236. exit(1); \
  237. } \
  238. } while (0)
  239. #ifndef NDEBUG
  240. #define GGML_UNREACHABLE() GGML_ASSERT(!"statement should not be reached")
  241. #elif defined(__GNUC__)
  242. #define GGML_UNREACHABLE() __builtin_unreachable()
  243. #else
  244. #define GGML_UNREACHABLE() ((void) 0)
  245. #endif
  246. // used to copy the number of elements and stride in bytes of tensors into local variables.
  247. // main purpose is to reduce code duplication and improve readability.
  248. //
  249. // example:
  250. //
  251. // GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne);
  252. // GGML_TENSOR_LOCALS(size_t, nb1, src1, nb);
  253. //
  254. #define GGML_TENSOR_LOCALS_1(type, prefix, pointer, array) \
  255. const type prefix##0 = (pointer)->array[0]; \
  256. GGML_UNUSED(prefix##0);
  257. #define GGML_TENSOR_LOCALS_2(type, prefix, pointer, array) \
  258. GGML_TENSOR_LOCALS_1 (type, prefix, pointer, array) \
  259. const type prefix##1 = (pointer)->array[1]; \
  260. GGML_UNUSED(prefix##1);
  261. #define GGML_TENSOR_LOCALS_3(type, prefix, pointer, array) \
  262. GGML_TENSOR_LOCALS_2 (type, prefix, pointer, array) \
  263. const type prefix##2 = (pointer)->array[2]; \
  264. GGML_UNUSED(prefix##2);
  265. #define GGML_TENSOR_LOCALS(type, prefix, pointer, array) \
  266. GGML_TENSOR_LOCALS_3 (type, prefix, pointer, array) \
  267. const type prefix##3 = (pointer)->array[3]; \
  268. GGML_UNUSED(prefix##3);
  269. #ifdef __cplusplus
  270. extern "C" {
  271. #endif
  272. #if defined(__ARM_NEON) && defined(__CUDACC__)
  273. typedef half ggml_fp16_t;
  274. #elif defined(__ARM_NEON)
  275. typedef __fp16 ggml_fp16_t;
  276. #else
  277. typedef uint16_t ggml_fp16_t;
  278. #endif
  279. // convert FP16 <-> FP32
  280. GGML_API float ggml_fp16_to_fp32(ggml_fp16_t x);
  281. GGML_API ggml_fp16_t ggml_fp32_to_fp16(float x);
  282. GGML_API void ggml_fp16_to_fp32_row(const ggml_fp16_t * x, float * y, int n);
  283. GGML_API void ggml_fp32_to_fp16_row(const float * x, ggml_fp16_t * y, int n);
  284. struct ggml_object;
  285. struct ggml_context;
  286. enum ggml_type {
  287. GGML_TYPE_F32 = 0,
  288. GGML_TYPE_F16 = 1,
  289. GGML_TYPE_Q4_0 = 2,
  290. GGML_TYPE_Q4_1 = 3,
  291. // GGML_TYPE_Q4_2 = 4, support has been removed
  292. // GGML_TYPE_Q4_3 (5) support has been removed
  293. GGML_TYPE_Q5_0 = 6,
  294. GGML_TYPE_Q5_1 = 7,
  295. GGML_TYPE_Q8_0 = 8,
  296. GGML_TYPE_Q8_1 = 9,
  297. // k-quantizations
  298. GGML_TYPE_Q2_K = 10,
  299. GGML_TYPE_Q3_K = 11,
  300. GGML_TYPE_Q4_K = 12,
  301. GGML_TYPE_Q5_K = 13,
  302. GGML_TYPE_Q6_K = 14,
  303. GGML_TYPE_Q8_K = 15,
  304. GGML_TYPE_I8,
  305. GGML_TYPE_I16,
  306. GGML_TYPE_I32,
  307. GGML_TYPE_COUNT,
  308. };
  309. enum ggml_backend_type {
  310. GGML_BACKEND_CPU = 0,
  311. GGML_BACKEND_GPU = 10,
  312. GGML_BACKEND_GPU_SPLIT = 20,
  313. };
  314. // model file types
  315. enum ggml_ftype {
  316. GGML_FTYPE_UNKNOWN = -1,
  317. GGML_FTYPE_ALL_F32 = 0,
  318. GGML_FTYPE_MOSTLY_F16 = 1, // except 1d tensors
  319. GGML_FTYPE_MOSTLY_Q4_0 = 2, // except 1d tensors
  320. GGML_FTYPE_MOSTLY_Q4_1 = 3, // except 1d tensors
  321. GGML_FTYPE_MOSTLY_Q4_1_SOME_F16 = 4, // tok_embeddings.weight and output.weight are F16
  322. GGML_FTYPE_MOSTLY_Q8_0 = 7, // except 1d tensors
  323. GGML_FTYPE_MOSTLY_Q5_0 = 8, // except 1d tensors
  324. GGML_FTYPE_MOSTLY_Q5_1 = 9, // except 1d tensors
  325. GGML_FTYPE_MOSTLY_Q2_K = 10, // except 1d tensors
  326. GGML_FTYPE_MOSTLY_Q3_K = 11, // except 1d tensors
  327. GGML_FTYPE_MOSTLY_Q4_K = 12, // except 1d tensors
  328. GGML_FTYPE_MOSTLY_Q5_K = 13, // except 1d tensors
  329. GGML_FTYPE_MOSTLY_Q6_K = 14, // except 1d tensors
  330. };
  331. // available tensor operations:
  332. enum ggml_op {
  333. GGML_OP_NONE = 0,
  334. GGML_OP_DUP,
  335. GGML_OP_ADD,
  336. GGML_OP_ADD1,
  337. GGML_OP_ACC,
  338. GGML_OP_SUB,
  339. GGML_OP_MUL,
  340. GGML_OP_DIV,
  341. GGML_OP_SQR,
  342. GGML_OP_SQRT,
  343. GGML_OP_LOG,
  344. GGML_OP_SUM,
  345. GGML_OP_SUM_ROWS,
  346. GGML_OP_MEAN,
  347. GGML_OP_ARGMAX,
  348. GGML_OP_REPEAT,
  349. GGML_OP_REPEAT_BACK,
  350. GGML_OP_CONCAT,
  351. GGML_OP_SILU_BACK,
  352. GGML_OP_NORM, // normalize
  353. GGML_OP_RMS_NORM,
  354. GGML_OP_RMS_NORM_BACK,
  355. GGML_OP_GROUP_NORM,
  356. GGML_OP_MUL_MAT,
  357. GGML_OP_OUT_PROD,
  358. GGML_OP_SCALE,
  359. GGML_OP_SET,
  360. GGML_OP_CPY,
  361. GGML_OP_CONT,
  362. GGML_OP_RESHAPE,
  363. GGML_OP_VIEW,
  364. GGML_OP_PERMUTE,
  365. GGML_OP_TRANSPOSE,
  366. GGML_OP_GET_ROWS,
  367. GGML_OP_GET_ROWS_BACK,
  368. GGML_OP_DIAG,
  369. GGML_OP_DIAG_MASK_INF,
  370. GGML_OP_DIAG_MASK_ZERO,
  371. GGML_OP_SOFT_MAX,
  372. GGML_OP_SOFT_MAX_BACK,
  373. GGML_OP_ROPE,
  374. GGML_OP_ROPE_BACK,
  375. GGML_OP_ALIBI,
  376. GGML_OP_CLAMP,
  377. GGML_OP_CONV_1D,
  378. GGML_OP_CONV_1D_STAGE_0, // internal
  379. GGML_OP_CONV_1D_STAGE_1, // internal
  380. GGML_OP_CONV_TRANSPOSE_1D,
  381. GGML_OP_CONV_2D,
  382. GGML_OP_CONV_2D_STAGE_0, // internal
  383. GGML_OP_CONV_2D_STAGE_1, // internal
  384. GGML_OP_CONV_TRANSPOSE_2D,
  385. GGML_OP_POOL_1D,
  386. GGML_OP_POOL_2D,
  387. GGML_OP_UPSCALE, // nearest interpolate
  388. GGML_OP_FLASH_ATTN,
  389. GGML_OP_FLASH_FF,
  390. GGML_OP_FLASH_ATTN_BACK,
  391. GGML_OP_WIN_PART,
  392. GGML_OP_WIN_UNPART,
  393. GGML_OP_GET_REL_POS,
  394. GGML_OP_ADD_REL_POS,
  395. GGML_OP_UNARY,
  396. GGML_OP_MAP_UNARY,
  397. GGML_OP_MAP_BINARY,
  398. GGML_OP_MAP_CUSTOM1_F32,
  399. GGML_OP_MAP_CUSTOM2_F32,
  400. GGML_OP_MAP_CUSTOM3_F32,
  401. GGML_OP_MAP_CUSTOM1,
  402. GGML_OP_MAP_CUSTOM2,
  403. GGML_OP_MAP_CUSTOM3,
  404. GGML_OP_CROSS_ENTROPY_LOSS,
  405. GGML_OP_CROSS_ENTROPY_LOSS_BACK,
  406. GGML_OP_COUNT,
  407. };
  408. enum ggml_unary_op {
  409. GGML_UNARY_OP_ABS,
  410. GGML_UNARY_OP_SGN,
  411. GGML_UNARY_OP_NEG,
  412. GGML_UNARY_OP_STEP,
  413. GGML_UNARY_OP_TANH,
  414. GGML_UNARY_OP_ELU,
  415. GGML_UNARY_OP_RELU,
  416. GGML_UNARY_OP_GELU,
  417. GGML_UNARY_OP_GELU_QUICK,
  418. GGML_UNARY_OP_SILU,
  419. GGML_UNARY_OP_LEAKY
  420. };
  421. enum ggml_object_type {
  422. GGML_OBJECT_TENSOR,
  423. GGML_OBJECT_GRAPH,
  424. GGML_OBJECT_WORK_BUFFER
  425. };
  426. enum ggml_log_level {
  427. GGML_LOG_LEVEL_ERROR = 2,
  428. GGML_LOG_LEVEL_WARN = 3,
  429. GGML_LOG_LEVEL_INFO = 4
  430. };
  431. // ggml object
  432. struct ggml_object {
  433. size_t offs;
  434. size_t size;
  435. struct ggml_object * next;
  436. enum ggml_object_type type;
  437. char padding[4];
  438. };
  439. static const size_t GGML_OBJECT_SIZE = sizeof(struct ggml_object);
  440. // n-dimensional tensor
  441. struct ggml_tensor {
  442. enum ggml_type type;
  443. enum ggml_backend_type backend;
  444. struct ggml_backend_buffer * buffer;
  445. int n_dims;
  446. int64_t ne[GGML_MAX_DIMS]; // number of elements
  447. size_t nb[GGML_MAX_DIMS]; // stride in bytes:
  448. // nb[0] = ggml_type_size(type)
  449. // nb[1] = nb[0] * (ne[0] / ggml_blck_size(type)) + padding
  450. // nb[i] = nb[i-1] * ne[i-1]
  451. // compute data
  452. enum ggml_op op;
  453. // op params - allocated as int32_t for alignment
  454. int32_t op_params[GGML_MAX_OP_PARAMS / sizeof(int32_t)];
  455. bool is_param;
  456. struct ggml_tensor * grad;
  457. struct ggml_tensor * src[GGML_MAX_SRC];
  458. // performance
  459. int perf_runs;
  460. int64_t perf_cycles;
  461. int64_t perf_time_us;
  462. struct ggml_tensor * view_src;
  463. size_t view_offs;
  464. void * data;
  465. char name[GGML_MAX_NAME];
  466. void * extra; // extra things e.g. for ggml-cuda.cu
  467. char padding[12];
  468. };
  469. static const size_t GGML_TENSOR_SIZE = sizeof(struct ggml_tensor);
  470. // the compute plan that needs to be prepared for ggml_graph_compute()
  471. // since https://github.com/ggerganov/ggml/issues/287
  472. struct ggml_cplan {
  473. size_t work_size; // size of work buffer, calculated by `ggml_graph_plan()`
  474. uint8_t * work_data; // work buffer, to be allocated by caller before calling to `ggml_graph_compute()`
  475. int n_threads;
  476. // abort ggml_graph_compute when true
  477. bool (*abort_callback)(void * data);
  478. void * abort_callback_data;
  479. };
  480. enum ggml_cgraph_eval_order {
  481. GGML_CGRAPH_EVAL_ORDER_LEFT_TO_RIGHT = 0,
  482. GGML_CGRAPH_EVAL_ORDER_RIGHT_TO_LEFT,
  483. GGML_CGRAPH_EVAL_ORDER_COUNT
  484. };
  485. struct ggml_hash_set {
  486. size_t size;
  487. struct ggml_tensor ** keys;
  488. };
  489. // computation graph
  490. struct ggml_cgraph {
  491. int size;
  492. int n_nodes;
  493. int n_leafs;
  494. struct ggml_tensor ** nodes;
  495. struct ggml_tensor ** grads;
  496. struct ggml_tensor ** leafs;
  497. struct ggml_hash_set visited_hash_table;
  498. enum ggml_cgraph_eval_order order;
  499. // performance
  500. int perf_runs;
  501. int64_t perf_cycles;
  502. int64_t perf_time_us;
  503. };
  504. // scratch buffer
  505. struct ggml_scratch {
  506. size_t offs;
  507. size_t size;
  508. void * data;
  509. };
  510. struct ggml_init_params {
  511. // memory pool
  512. size_t mem_size; // bytes
  513. void * mem_buffer; // if NULL, memory will be allocated internally
  514. bool no_alloc; // don't allocate memory for the tensor data
  515. };
  516. // compute types
  517. // NOTE: the INIT or FINALIZE pass is not scheduled unless explicitly enabled.
  518. // This behavior was changed since https://github.com/ggerganov/llama.cpp/pull/1995.
  519. enum ggml_task_type {
  520. GGML_TASK_INIT = 0,
  521. GGML_TASK_COMPUTE,
  522. GGML_TASK_FINALIZE,
  523. };
  524. struct ggml_compute_params {
  525. enum ggml_task_type type;
  526. // ith = thread index, nth = number of threads
  527. int ith, nth;
  528. // work buffer for all threads
  529. size_t wsize;
  530. void * wdata;
  531. };
  532. // misc
  533. GGML_API void ggml_time_init(void); // call this once at the beginning of the program
  534. GGML_API int64_t ggml_time_ms(void);
  535. GGML_API int64_t ggml_time_us(void);
  536. GGML_API int64_t ggml_cycles(void);
  537. GGML_API int64_t ggml_cycles_per_ms(void);
  538. GGML_API void ggml_print_backtrace(void);
  539. GGML_API void ggml_numa_init(void); // call once for better performance on NUMA systems
  540. GGML_API bool ggml_is_numa(void); // true if init detected that system has >1 NUMA node
  541. GGML_API void ggml_print_object (const struct ggml_object * obj);
  542. GGML_API void ggml_print_objects(const struct ggml_context * ctx);
  543. GGML_API int64_t ggml_nelements (const struct ggml_tensor * tensor);
  544. GGML_API int64_t ggml_nrows (const struct ggml_tensor * tensor);
  545. GGML_API size_t ggml_nbytes (const struct ggml_tensor * tensor);
  546. GGML_API size_t ggml_nbytes_pad (const struct ggml_tensor * tensor); // same as ggml_nbytes() but padded to GGML_MEM_ALIGN
  547. GGML_API size_t ggml_nbytes_split(const struct ggml_tensor * tensor, int nrows_split);
  548. GGML_API int ggml_blck_size (enum ggml_type type);
  549. GGML_API size_t ggml_type_size (enum ggml_type type); // size in bytes for all elements in a block
  550. GGML_API float ggml_type_sizef(enum ggml_type type); // ggml_type_size()/ggml_blck_size() as float
  551. GGML_API const char * ggml_type_name(enum ggml_type type);
  552. GGML_API const char * ggml_op_name (enum ggml_op op);
  553. GGML_API const char * ggml_op_symbol(enum ggml_op op);
  554. GGML_API size_t ggml_element_size(const struct ggml_tensor * tensor);
  555. GGML_API bool ggml_is_quantized(enum ggml_type type);
  556. // TODO: temporary until model loading of ggml examples is refactored
  557. GGML_API enum ggml_type ggml_ftype_to_ggml_type(enum ggml_ftype ftype);
  558. GGML_API bool ggml_is_transposed(const struct ggml_tensor * tensor);
  559. GGML_API bool ggml_is_contiguous(const struct ggml_tensor * tensor);
  560. GGML_API bool ggml_is_permuted (const struct ggml_tensor * tensor);
  561. GGML_API bool ggml_are_same_shape(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  562. // use this to compute the memory overhead of a tensor
  563. GGML_API size_t ggml_tensor_overhead(void);
  564. // main
  565. GGML_API struct ggml_context * ggml_init(struct ggml_init_params params);
  566. GGML_API void ggml_free(struct ggml_context * ctx);
  567. GGML_API size_t ggml_used_mem(const struct ggml_context * ctx);
  568. GGML_API size_t ggml_set_scratch (struct ggml_context * ctx, struct ggml_scratch scratch);
  569. GGML_API bool ggml_get_no_alloc(struct ggml_context * ctx);
  570. GGML_API void ggml_set_no_alloc(struct ggml_context * ctx, bool no_alloc);
  571. GGML_API void * ggml_get_mem_buffer (const struct ggml_context * ctx);
  572. GGML_API size_t ggml_get_mem_size (const struct ggml_context * ctx);
  573. GGML_API size_t ggml_get_max_tensor_size(const struct ggml_context * ctx);
  574. GGML_API struct ggml_tensor * ggml_new_tensor(
  575. struct ggml_context * ctx,
  576. enum ggml_type type,
  577. int n_dims,
  578. const int64_t *ne);
  579. GGML_API struct ggml_tensor * ggml_new_tensor_1d(
  580. struct ggml_context * ctx,
  581. enum ggml_type type,
  582. int64_t ne0);
  583. GGML_API struct ggml_tensor * ggml_new_tensor_2d(
  584. struct ggml_context * ctx,
  585. enum ggml_type type,
  586. int64_t ne0,
  587. int64_t ne1);
  588. GGML_API struct ggml_tensor * ggml_new_tensor_3d(
  589. struct ggml_context * ctx,
  590. enum ggml_type type,
  591. int64_t ne0,
  592. int64_t ne1,
  593. int64_t ne2);
  594. GGML_API struct ggml_tensor * ggml_new_tensor_4d(
  595. struct ggml_context * ctx,
  596. enum ggml_type type,
  597. int64_t ne0,
  598. int64_t ne1,
  599. int64_t ne2,
  600. int64_t ne3);
  601. GGML_API struct ggml_tensor * ggml_new_i32(struct ggml_context * ctx, int32_t value);
  602. GGML_API struct ggml_tensor * ggml_new_f32(struct ggml_context * ctx, float value);
  603. GGML_API struct ggml_tensor * ggml_dup_tensor (struct ggml_context * ctx, const struct ggml_tensor * src);
  604. GGML_API struct ggml_tensor * ggml_view_tensor(struct ggml_context * ctx, struct ggml_tensor * src);
  605. // Context tensor enumeration and lookup
  606. GGML_API struct ggml_tensor * ggml_get_first_tensor(struct ggml_context * ctx);
  607. GGML_API struct ggml_tensor * ggml_get_next_tensor (struct ggml_context * ctx, struct ggml_tensor * tensor);
  608. GGML_API struct ggml_tensor * ggml_get_tensor(struct ggml_context * ctx, const char * name);
  609. GGML_API struct ggml_tensor * ggml_set_zero(struct ggml_tensor * tensor);
  610. GGML_API struct ggml_tensor * ggml_set_i32 (struct ggml_tensor * tensor, int32_t value);
  611. GGML_API struct ggml_tensor * ggml_set_f32 (struct ggml_tensor * tensor, float value);
  612. // Converts a flat index into coordinates
  613. 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);
  614. GGML_API int32_t ggml_get_i32_1d(const struct ggml_tensor * tensor, int i);
  615. GGML_API void ggml_set_i32_1d(const struct ggml_tensor * tensor, int i, int32_t value);
  616. GGML_API int32_t ggml_get_i32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3);
  617. GGML_API void ggml_set_i32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3, int32_t value);
  618. GGML_API float ggml_get_f32_1d(const struct ggml_tensor * tensor, int i);
  619. GGML_API void ggml_set_f32_1d(const struct ggml_tensor * tensor, int i, float value);
  620. GGML_API float ggml_get_f32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3);
  621. GGML_API void ggml_set_f32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3, float value);
  622. GGML_API void * ggml_get_data (const struct ggml_tensor * tensor);
  623. GGML_API float * ggml_get_data_f32(const struct ggml_tensor * tensor);
  624. GGML_API enum ggml_unary_op ggml_get_unary_op(const struct ggml_tensor * tensor);
  625. GGML_API const char * ggml_get_name (const struct ggml_tensor * tensor);
  626. GGML_API struct ggml_tensor * ggml_set_name ( struct ggml_tensor * tensor, const char * name);
  627. GGML_ATTRIBUTE_FORMAT(2, 3)
  628. GGML_API struct ggml_tensor * ggml_format_name( struct ggml_tensor * tensor, const char * fmt, ...);
  629. //
  630. // operations on tensors with backpropagation
  631. //
  632. GGML_API struct ggml_tensor * ggml_dup(
  633. struct ggml_context * ctx,
  634. struct ggml_tensor * a);
  635. // in-place, returns view(a)
  636. GGML_API struct ggml_tensor * ggml_dup_inplace(
  637. struct ggml_context * ctx,
  638. struct ggml_tensor * a);
  639. GGML_API struct ggml_tensor * ggml_add(
  640. struct ggml_context * ctx,
  641. struct ggml_tensor * a,
  642. struct ggml_tensor * b);
  643. GGML_API struct ggml_tensor * ggml_add_inplace(
  644. struct ggml_context * ctx,
  645. struct ggml_tensor * a,
  646. struct ggml_tensor * b);
  647. GGML_API struct ggml_tensor * ggml_add_cast(
  648. struct ggml_context * ctx,
  649. struct ggml_tensor * a,
  650. struct ggml_tensor * b,
  651. enum ggml_type type);
  652. GGML_API struct ggml_tensor * ggml_add1(
  653. struct ggml_context * ctx,
  654. struct ggml_tensor * a,
  655. struct ggml_tensor * b);
  656. GGML_API struct ggml_tensor * ggml_add1_inplace(
  657. struct ggml_context * ctx,
  658. struct ggml_tensor * a,
  659. struct ggml_tensor * b);
  660. GGML_API struct ggml_tensor * ggml_acc(
  661. struct ggml_context * ctx,
  662. struct ggml_tensor * a,
  663. struct ggml_tensor * b,
  664. size_t nb1,
  665. size_t nb2,
  666. size_t nb3,
  667. size_t offset);
  668. GGML_API struct ggml_tensor * ggml_acc_inplace(
  669. struct ggml_context * ctx,
  670. struct ggml_tensor * a,
  671. struct ggml_tensor * b,
  672. size_t nb1,
  673. size_t nb2,
  674. size_t nb3,
  675. size_t offset);
  676. GGML_API struct ggml_tensor * ggml_sub(
  677. struct ggml_context * ctx,
  678. struct ggml_tensor * a,
  679. struct ggml_tensor * b);
  680. GGML_API struct ggml_tensor * ggml_sub_inplace(
  681. struct ggml_context * ctx,
  682. struct ggml_tensor * a,
  683. struct ggml_tensor * b);
  684. GGML_API struct ggml_tensor * ggml_mul(
  685. struct ggml_context * ctx,
  686. struct ggml_tensor * a,
  687. struct ggml_tensor * b);
  688. GGML_API struct ggml_tensor * ggml_mul_inplace(
  689. struct ggml_context * ctx,
  690. struct ggml_tensor * a,
  691. struct ggml_tensor * b);
  692. GGML_API struct ggml_tensor * ggml_div(
  693. struct ggml_context * ctx,
  694. struct ggml_tensor * a,
  695. struct ggml_tensor * b);
  696. GGML_API struct ggml_tensor * ggml_div_inplace(
  697. struct ggml_context * ctx,
  698. struct ggml_tensor * a,
  699. struct ggml_tensor * b);
  700. GGML_API struct ggml_tensor * ggml_sqr(
  701. struct ggml_context * ctx,
  702. struct ggml_tensor * a);
  703. GGML_API struct ggml_tensor * ggml_sqr_inplace(
  704. struct ggml_context * ctx,
  705. struct ggml_tensor * a);
  706. GGML_API struct ggml_tensor * ggml_sqrt(
  707. struct ggml_context * ctx,
  708. struct ggml_tensor * a);
  709. GGML_API struct ggml_tensor * ggml_sqrt_inplace(
  710. struct ggml_context * ctx,
  711. struct ggml_tensor * a);
  712. GGML_API struct ggml_tensor * ggml_log(
  713. struct ggml_context * ctx,
  714. struct ggml_tensor * a);
  715. GGML_API struct ggml_tensor * ggml_log_inplace(
  716. struct ggml_context * ctx,
  717. struct ggml_tensor * a);
  718. // return scalar
  719. GGML_API struct ggml_tensor * ggml_sum(
  720. struct ggml_context * ctx,
  721. struct ggml_tensor * a);
  722. // sums along rows, with input shape [a,b,c,d] return shape [1,b,c,d]
  723. GGML_API struct ggml_tensor * ggml_sum_rows(
  724. struct ggml_context * ctx,
  725. struct ggml_tensor * a);
  726. // mean along rows
  727. GGML_API struct ggml_tensor * ggml_mean(
  728. struct ggml_context * ctx,
  729. struct ggml_tensor * a);
  730. // argmax along rows
  731. GGML_API struct ggml_tensor * ggml_argmax(
  732. struct ggml_context * ctx,
  733. struct ggml_tensor * a);
  734. // if a is the same shape as b, and a is not parameter, return a
  735. // otherwise, return a new tensor: repeat(a) to fit in b
  736. GGML_API struct ggml_tensor * ggml_repeat(
  737. struct ggml_context * ctx,
  738. struct ggml_tensor * a,
  739. struct ggml_tensor * b);
  740. // sums repetitions in a into shape of b
  741. GGML_API struct ggml_tensor * ggml_repeat_back(
  742. struct ggml_context * ctx,
  743. struct ggml_tensor * a,
  744. struct ggml_tensor * b);
  745. // concat a and b on dim 2
  746. // used in stable-diffusion
  747. GGML_API struct ggml_tensor * ggml_concat(
  748. struct ggml_context * ctx,
  749. struct ggml_tensor * a,
  750. struct ggml_tensor * b);
  751. GGML_API struct ggml_tensor * ggml_abs(
  752. struct ggml_context * ctx,
  753. struct ggml_tensor * a);
  754. GGML_API struct ggml_tensor * ggml_abs_inplace(
  755. struct ggml_context * ctx,
  756. struct ggml_tensor * a);
  757. GGML_API struct ggml_tensor * ggml_sgn(
  758. struct ggml_context * ctx,
  759. struct ggml_tensor * a);
  760. GGML_API struct ggml_tensor * ggml_sgn_inplace(
  761. struct ggml_context * ctx,
  762. struct ggml_tensor * a);
  763. GGML_API struct ggml_tensor * ggml_neg(
  764. struct ggml_context * ctx,
  765. struct ggml_tensor * a);
  766. GGML_API struct ggml_tensor * ggml_neg_inplace(
  767. struct ggml_context * ctx,
  768. struct ggml_tensor * a);
  769. GGML_API struct ggml_tensor * ggml_step(
  770. struct ggml_context * ctx,
  771. struct ggml_tensor * a);
  772. GGML_API struct ggml_tensor * ggml_step_inplace(
  773. struct ggml_context * ctx,
  774. struct ggml_tensor * a);
  775. GGML_API struct ggml_tensor * ggml_tanh(
  776. struct ggml_context * ctx,
  777. struct ggml_tensor * a);
  778. GGML_API struct ggml_tensor * ggml_tanh_inplace(
  779. struct ggml_context * ctx,
  780. struct ggml_tensor * a);
  781. GGML_API struct ggml_tensor * ggml_elu(
  782. struct ggml_context * ctx,
  783. struct ggml_tensor * a);
  784. GGML_API struct ggml_tensor * ggml_elu_inplace(
  785. struct ggml_context * ctx,
  786. struct ggml_tensor * a);
  787. GGML_API struct ggml_tensor * ggml_relu(
  788. struct ggml_context * ctx,
  789. struct ggml_tensor * a);
  790. GGML_API struct ggml_tensor * ggml_leaky(
  791. struct ggml_context * ctx,
  792. struct ggml_tensor * a);
  793. GGML_API struct ggml_tensor * ggml_relu_inplace(
  794. struct ggml_context * ctx,
  795. struct ggml_tensor * a);
  796. // TODO: double-check this computation is correct
  797. GGML_API struct ggml_tensor * ggml_gelu(
  798. struct ggml_context * ctx,
  799. struct ggml_tensor * a);
  800. GGML_API struct ggml_tensor * ggml_gelu_inplace(
  801. struct ggml_context * ctx,
  802. struct ggml_tensor * a);
  803. GGML_API struct ggml_tensor * ggml_gelu_quick(
  804. struct ggml_context * ctx,
  805. struct ggml_tensor * a);
  806. GGML_API struct ggml_tensor * ggml_gelu_quick_inplace(
  807. struct ggml_context * ctx,
  808. struct ggml_tensor * a);
  809. GGML_API struct ggml_tensor * ggml_silu(
  810. struct ggml_context * ctx,
  811. struct ggml_tensor * a);
  812. GGML_API struct ggml_tensor * ggml_silu_inplace(
  813. struct ggml_context * ctx,
  814. struct ggml_tensor * a);
  815. // a - x
  816. // b - dy
  817. GGML_API struct ggml_tensor * ggml_silu_back(
  818. struct ggml_context * ctx,
  819. struct ggml_tensor * a,
  820. struct ggml_tensor * b);
  821. // normalize along rows
  822. GGML_API struct ggml_tensor * ggml_norm(
  823. struct ggml_context * ctx,
  824. struct ggml_tensor * a,
  825. float eps);
  826. GGML_API struct ggml_tensor * ggml_norm_inplace(
  827. struct ggml_context * ctx,
  828. struct ggml_tensor * a,
  829. float eps);
  830. GGML_API struct ggml_tensor * ggml_rms_norm(
  831. struct ggml_context * ctx,
  832. struct ggml_tensor * a,
  833. float eps);
  834. GGML_API struct ggml_tensor * ggml_rms_norm_inplace(
  835. struct ggml_context * ctx,
  836. struct ggml_tensor * a,
  837. float eps);
  838. // group normalize along ne0*ne1*n_groups
  839. // used in stable-diffusion
  840. // TODO: eps is hardcoded to 1e-6 for now
  841. GGML_API struct ggml_tensor * ggml_group_norm(
  842. struct ggml_context * ctx,
  843. struct ggml_tensor * a,
  844. int n_groups);
  845. GGML_API struct ggml_tensor * ggml_group_norm_inplace(
  846. struct ggml_context * ctx,
  847. struct ggml_tensor * a,
  848. int n_groups);
  849. // a - x
  850. // b - dy
  851. GGML_API struct ggml_tensor * ggml_rms_norm_back(
  852. struct ggml_context * ctx,
  853. struct ggml_tensor * a,
  854. struct ggml_tensor * b,
  855. float eps);
  856. // A: k columns, n rows => [ne03, ne02, n, k]
  857. // B: k columns, m rows (i.e. we transpose it internally) => [ne03 * x, ne02 * y, m, k]
  858. // result is n columns, m rows => [ne03 * x, ne02 * y, m, n]
  859. GGML_API struct ggml_tensor * ggml_mul_mat(
  860. struct ggml_context * ctx,
  861. struct ggml_tensor * a,
  862. struct ggml_tensor * b);
  863. // A: m columns, n rows,
  864. // B: p columns, n rows,
  865. // result is m columns, p rows
  866. GGML_API struct ggml_tensor * ggml_out_prod(
  867. struct ggml_context * ctx,
  868. struct ggml_tensor * a,
  869. struct ggml_tensor * b);
  870. //
  871. // operations on tensors without backpropagation
  872. //
  873. GGML_API struct ggml_tensor * ggml_scale(
  874. struct ggml_context * ctx,
  875. struct ggml_tensor * a,
  876. struct ggml_tensor * b);
  877. // in-place, returns view(a)
  878. GGML_API struct ggml_tensor * ggml_scale_inplace(
  879. struct ggml_context * ctx,
  880. struct ggml_tensor * a,
  881. struct ggml_tensor * b);
  882. // b -> view(a,offset,nb1,nb2,3), return modified a
  883. GGML_API struct ggml_tensor * ggml_set(
  884. struct ggml_context * ctx,
  885. struct ggml_tensor * a,
  886. struct ggml_tensor * b,
  887. size_t nb1,
  888. size_t nb2,
  889. size_t nb3,
  890. size_t offset);
  891. // b -> view(a,offset,nb1,nb2,3), return view(a)
  892. GGML_API struct ggml_tensor * ggml_set_inplace(
  893. struct ggml_context * ctx,
  894. struct ggml_tensor * a,
  895. struct ggml_tensor * b,
  896. size_t nb1,
  897. size_t nb2,
  898. size_t nb3,
  899. size_t offset);
  900. GGML_API struct ggml_tensor * ggml_set_1d(
  901. struct ggml_context * ctx,
  902. struct ggml_tensor * a,
  903. struct ggml_tensor * b,
  904. size_t offset);
  905. GGML_API struct ggml_tensor * ggml_set_1d_inplace(
  906. struct ggml_context * ctx,
  907. struct ggml_tensor * a,
  908. struct ggml_tensor * b,
  909. size_t offset);
  910. // b -> view(a,offset,nb1,nb2,3), return modified a
  911. GGML_API struct ggml_tensor * ggml_set_2d(
  912. struct ggml_context * ctx,
  913. struct ggml_tensor * a,
  914. struct ggml_tensor * b,
  915. size_t nb1,
  916. size_t offset);
  917. // b -> view(a,offset,nb1,nb2,3), return view(a)
  918. GGML_API struct ggml_tensor * ggml_set_2d_inplace(
  919. struct ggml_context * ctx,
  920. struct ggml_tensor * a,
  921. struct ggml_tensor * b,
  922. size_t nb1,
  923. size_t offset);
  924. // a -> b, return view(b)
  925. GGML_API struct ggml_tensor * ggml_cpy(
  926. struct ggml_context * ctx,
  927. struct ggml_tensor * a,
  928. struct ggml_tensor * b);
  929. // a -> b, in-place, return view(b)
  930. GGML_API struct ggml_tensor * ggml_cpy_inplace(
  931. struct ggml_context * ctx,
  932. struct ggml_tensor * a,
  933. struct ggml_tensor * b);
  934. // make contiguous
  935. GGML_API struct ggml_tensor * ggml_cont(
  936. struct ggml_context * ctx,
  937. struct ggml_tensor * a);
  938. // make contiguous, in-place
  939. GGML_API struct ggml_tensor * ggml_cont_inplace(
  940. struct ggml_context * ctx,
  941. struct ggml_tensor * a);
  942. // make contiguous, with new shape
  943. GGML_API struct ggml_tensor * ggml_cont_1d(
  944. struct ggml_context * ctx,
  945. struct ggml_tensor * a,
  946. int64_t ne0);
  947. GGML_API struct ggml_tensor * ggml_cont_2d(
  948. struct ggml_context * ctx,
  949. struct ggml_tensor * a,
  950. int64_t ne0,
  951. int64_t ne1);
  952. GGML_API struct ggml_tensor * ggml_cont_3d(
  953. struct ggml_context * ctx,
  954. struct ggml_tensor * a,
  955. int64_t ne0,
  956. int64_t ne1,
  957. int64_t ne2);
  958. GGML_API struct ggml_tensor * ggml_cont_4d(
  959. struct ggml_context * ctx,
  960. struct ggml_tensor * a,
  961. int64_t ne0,
  962. int64_t ne1,
  963. int64_t ne2,
  964. int64_t ne3);
  965. // return view(a), b specifies the new shape
  966. // TODO: when we start computing gradient, make a copy instead of view
  967. GGML_API struct ggml_tensor * ggml_reshape(
  968. struct ggml_context * ctx,
  969. struct ggml_tensor * a,
  970. struct ggml_tensor * b);
  971. // return view(a)
  972. // TODO: when we start computing gradient, make a copy instead of view
  973. GGML_API struct ggml_tensor * ggml_reshape_1d(
  974. struct ggml_context * ctx,
  975. struct ggml_tensor * a,
  976. int64_t ne0);
  977. GGML_API struct ggml_tensor * ggml_reshape_2d(
  978. struct ggml_context * ctx,
  979. struct ggml_tensor * a,
  980. int64_t ne0,
  981. int64_t ne1);
  982. // return view(a)
  983. // TODO: when we start computing gradient, make a copy instead of view
  984. GGML_API struct ggml_tensor * ggml_reshape_3d(
  985. struct ggml_context * ctx,
  986. struct ggml_tensor * a,
  987. int64_t ne0,
  988. int64_t ne1,
  989. int64_t ne2);
  990. GGML_API struct ggml_tensor * ggml_reshape_4d(
  991. struct ggml_context * ctx,
  992. struct ggml_tensor * a,
  993. int64_t ne0,
  994. int64_t ne1,
  995. int64_t ne2,
  996. int64_t ne3);
  997. // offset in bytes
  998. GGML_API struct ggml_tensor * ggml_view_1d(
  999. struct ggml_context * ctx,
  1000. struct ggml_tensor * a,
  1001. int64_t ne0,
  1002. size_t offset);
  1003. GGML_API struct ggml_tensor * ggml_view_2d(
  1004. struct ggml_context * ctx,
  1005. struct ggml_tensor * a,
  1006. int64_t ne0,
  1007. int64_t ne1,
  1008. size_t nb1, // row stride in bytes
  1009. size_t offset);
  1010. GGML_API struct ggml_tensor * ggml_view_3d(
  1011. struct ggml_context * ctx,
  1012. struct ggml_tensor * a,
  1013. int64_t ne0,
  1014. int64_t ne1,
  1015. int64_t ne2,
  1016. size_t nb1, // row stride in bytes
  1017. size_t nb2, // slice stride in bytes
  1018. size_t offset);
  1019. GGML_API struct ggml_tensor * ggml_view_4d(
  1020. struct ggml_context * ctx,
  1021. struct ggml_tensor * a,
  1022. int64_t ne0,
  1023. int64_t ne1,
  1024. int64_t ne2,
  1025. int64_t ne3,
  1026. size_t nb1, // row stride in bytes
  1027. size_t nb2, // slice stride in bytes
  1028. size_t nb3,
  1029. size_t offset);
  1030. GGML_API struct ggml_tensor * ggml_permute(
  1031. struct ggml_context * ctx,
  1032. struct ggml_tensor * a,
  1033. int axis0,
  1034. int axis1,
  1035. int axis2,
  1036. int axis3);
  1037. // alias for ggml_permute(ctx, a, 1, 0, 2, 3)
  1038. GGML_API struct ggml_tensor * ggml_transpose(
  1039. struct ggml_context * ctx,
  1040. struct ggml_tensor * a);
  1041. GGML_API struct ggml_tensor * ggml_get_rows(
  1042. struct ggml_context * ctx,
  1043. struct ggml_tensor * a,
  1044. struct ggml_tensor * b);
  1045. GGML_API struct ggml_tensor * ggml_get_rows_back(
  1046. struct ggml_context * ctx,
  1047. struct ggml_tensor * a,
  1048. struct ggml_tensor * b,
  1049. struct ggml_tensor * c);
  1050. GGML_API struct ggml_tensor * ggml_diag(
  1051. struct ggml_context * ctx,
  1052. struct ggml_tensor * a);
  1053. // set elements above the diagonal to -INF
  1054. GGML_API struct ggml_tensor * ggml_diag_mask_inf(
  1055. struct ggml_context * ctx,
  1056. struct ggml_tensor * a,
  1057. int n_past);
  1058. // in-place, returns view(a)
  1059. GGML_API struct ggml_tensor * ggml_diag_mask_inf_inplace(
  1060. struct ggml_context * ctx,
  1061. struct ggml_tensor * a,
  1062. int n_past);
  1063. // set elements above the diagonal to 0
  1064. GGML_API struct ggml_tensor * ggml_diag_mask_zero(
  1065. struct ggml_context * ctx,
  1066. struct ggml_tensor * a,
  1067. int n_past);
  1068. // in-place, returns view(a)
  1069. GGML_API struct ggml_tensor * ggml_diag_mask_zero_inplace(
  1070. struct ggml_context * ctx,
  1071. struct ggml_tensor * a,
  1072. int n_past);
  1073. GGML_API struct ggml_tensor * ggml_soft_max(
  1074. struct ggml_context * ctx,
  1075. struct ggml_tensor * a);
  1076. // in-place, returns view(a)
  1077. GGML_API struct ggml_tensor * ggml_soft_max_inplace(
  1078. struct ggml_context * ctx,
  1079. struct ggml_tensor * a);
  1080. GGML_API struct ggml_tensor * ggml_soft_max_back(
  1081. struct ggml_context * ctx,
  1082. struct ggml_tensor * a,
  1083. struct ggml_tensor * b);
  1084. // in-place, returns view(a)
  1085. GGML_API struct ggml_tensor * ggml_soft_max_back_inplace(
  1086. struct ggml_context * ctx,
  1087. struct ggml_tensor * a,
  1088. struct ggml_tensor * b);
  1089. // rotary position embedding
  1090. // if mode & 1 == 1, skip n_past elements (DEPRECATED)
  1091. // if mode & 2 == 1, GPT-NeoX style
  1092. // if mode & 4 == 1, ChatGLM style
  1093. //
  1094. // b is an int32 vector with size a->ne[2], it contains the positions
  1095. GGML_API struct ggml_tensor * ggml_rope(
  1096. struct ggml_context * ctx,
  1097. struct ggml_tensor * a,
  1098. struct ggml_tensor * b,
  1099. int n_dims,
  1100. int mode,
  1101. int n_ctx);
  1102. // in-place, returns view(a)
  1103. GGML_API struct ggml_tensor * ggml_rope_inplace(
  1104. struct ggml_context * ctx,
  1105. struct ggml_tensor * a,
  1106. struct ggml_tensor * b,
  1107. int n_dims,
  1108. int mode,
  1109. int n_ctx);
  1110. // custom RoPE
  1111. GGML_API struct ggml_tensor * ggml_rope_custom(
  1112. struct ggml_context * ctx,
  1113. struct ggml_tensor * a,
  1114. struct ggml_tensor * b,
  1115. int n_dims,
  1116. int mode,
  1117. int n_ctx,
  1118. int n_orig_ctx,
  1119. float freq_base,
  1120. float freq_scale,
  1121. float ext_factor,
  1122. float attn_factor,
  1123. float beta_fast,
  1124. float beta_slow);
  1125. // in-place, returns view(a)
  1126. GGML_API struct ggml_tensor * ggml_rope_custom_inplace(
  1127. struct ggml_context * ctx,
  1128. struct ggml_tensor * a,
  1129. struct ggml_tensor * b,
  1130. int n_dims,
  1131. int mode,
  1132. int n_ctx,
  1133. int n_orig_ctx,
  1134. float freq_base,
  1135. float freq_scale,
  1136. float ext_factor,
  1137. float attn_factor,
  1138. float beta_fast,
  1139. float beta_slow);
  1140. // compute correction dims for YaRN RoPE scaling
  1141. void ggml_rope_yarn_corr_dims(
  1142. int n_dims, int n_orig_ctx, float freq_base, float beta_fast, float beta_slow, float dims[2]);
  1143. // xPos RoPE, in-place, returns view(a)
  1144. GGML_API struct ggml_tensor * ggml_rope_xpos_inplace(
  1145. struct ggml_context * ctx,
  1146. struct ggml_tensor * a,
  1147. struct ggml_tensor * b,
  1148. int n_dims,
  1149. float base,
  1150. bool down);
  1151. // rotary position embedding backward, i.e compute dx from dy
  1152. // a - dy
  1153. GGML_API struct ggml_tensor * ggml_rope_back(
  1154. struct ggml_context * ctx,
  1155. struct ggml_tensor * a,
  1156. struct ggml_tensor * b,
  1157. int n_dims,
  1158. int mode,
  1159. int n_ctx,
  1160. int n_orig_ctx,
  1161. float freq_base,
  1162. float freq_scale,
  1163. float ext_factor,
  1164. float attn_factor,
  1165. float beta_fast,
  1166. float beta_slow,
  1167. float xpos_base,
  1168. bool xpos_down);
  1169. // alibi position embedding
  1170. // in-place, returns view(a)
  1171. GGML_API struct ggml_tensor * ggml_alibi(
  1172. struct ggml_context * ctx,
  1173. struct ggml_tensor * a,
  1174. int n_past,
  1175. int n_head,
  1176. float bias_max);
  1177. // clamp
  1178. // in-place, returns view(a)
  1179. GGML_API struct ggml_tensor * ggml_clamp(
  1180. struct ggml_context * ctx,
  1181. struct ggml_tensor * a,
  1182. float min,
  1183. float max);
  1184. GGML_API struct ggml_tensor * ggml_conv_1d(
  1185. struct ggml_context * ctx,
  1186. struct ggml_tensor * a,
  1187. struct ggml_tensor * b,
  1188. int s0, // stride
  1189. int p0, // padding
  1190. int d0); // dilation
  1191. // conv_1d with padding = half
  1192. // alias for ggml_conv_1d(a, b, s, a->ne[0]/2, d)
  1193. GGML_API struct ggml_tensor* ggml_conv_1d_ph(
  1194. struct ggml_context * ctx,
  1195. struct ggml_tensor * a,
  1196. struct ggml_tensor * b,
  1197. int s,
  1198. int d);
  1199. GGML_API struct ggml_tensor * ggml_conv_transpose_1d(
  1200. struct ggml_context * ctx,
  1201. struct ggml_tensor * a,
  1202. struct ggml_tensor * b,
  1203. int s0,
  1204. int p0,
  1205. int d0);
  1206. GGML_API struct ggml_tensor * ggml_conv_2d(
  1207. struct ggml_context * ctx,
  1208. struct ggml_tensor * a,
  1209. struct ggml_tensor * b,
  1210. int s0,
  1211. int s1,
  1212. int p0,
  1213. int p1,
  1214. int d0,
  1215. int d1);
  1216. // kernel size is a->ne[0] x a->ne[1]
  1217. // stride is equal to kernel size
  1218. // padding is zero
  1219. // example:
  1220. // a: 16 16 3 768
  1221. // b: 1024 1024 3 1
  1222. // res: 64 64 768 1
  1223. // used in sam
  1224. GGML_API struct ggml_tensor * ggml_conv_2d_sk_p0(
  1225. struct ggml_context * ctx,
  1226. struct ggml_tensor * a,
  1227. struct ggml_tensor * b);
  1228. // kernel size is a->ne[0] x a->ne[1]
  1229. // stride is 1
  1230. // padding is half
  1231. // example:
  1232. // a: 3 3 256 256
  1233. // b: 64 64 256 1
  1234. // res: 64 64 256 1
  1235. // used in sam
  1236. GGML_API struct ggml_tensor * ggml_conv_2d_s1_ph(
  1237. struct ggml_context * ctx,
  1238. struct ggml_tensor * a,
  1239. struct ggml_tensor * b);
  1240. GGML_API struct ggml_tensor * ggml_conv_transpose_2d_p0(
  1241. struct ggml_context * ctx,
  1242. struct ggml_tensor * a,
  1243. struct ggml_tensor * b,
  1244. int stride);
  1245. enum ggml_op_pool {
  1246. GGML_OP_POOL_MAX,
  1247. GGML_OP_POOL_AVG,
  1248. GGML_OP_POOL_COUNT,
  1249. };
  1250. GGML_API struct ggml_tensor * ggml_pool_1d(
  1251. struct ggml_context * ctx,
  1252. struct ggml_tensor * a,
  1253. enum ggml_op_pool op,
  1254. int k0, // kernel size
  1255. int s0, // stride
  1256. int p0); // padding
  1257. // the result will have 2*p0 padding for the first dimension
  1258. // and 2*p1 padding for the second dimension
  1259. GGML_API struct ggml_tensor * ggml_pool_2d(
  1260. struct ggml_context * ctx,
  1261. struct ggml_tensor * a,
  1262. enum ggml_op_pool op,
  1263. int k0,
  1264. int k1,
  1265. int s0,
  1266. int s1,
  1267. float p0,
  1268. float p1);
  1269. // nearest interpolate
  1270. // used in stable-diffusion
  1271. GGML_API struct ggml_tensor * ggml_upscale(
  1272. struct ggml_context * ctx,
  1273. struct ggml_tensor * a,
  1274. int scale_factor);
  1275. GGML_API struct ggml_tensor * ggml_flash_attn(
  1276. struct ggml_context * ctx,
  1277. struct ggml_tensor * q,
  1278. struct ggml_tensor * k,
  1279. struct ggml_tensor * v,
  1280. bool masked);
  1281. GGML_API struct ggml_tensor * ggml_flash_attn_back(
  1282. struct ggml_context * ctx,
  1283. struct ggml_tensor * q,
  1284. struct ggml_tensor * k,
  1285. struct ggml_tensor * v,
  1286. struct ggml_tensor * d,
  1287. bool masked);
  1288. GGML_API struct ggml_tensor * ggml_flash_ff(
  1289. struct ggml_context * ctx,
  1290. struct ggml_tensor * a,
  1291. struct ggml_tensor * b0,
  1292. struct ggml_tensor * b1,
  1293. struct ggml_tensor * c0,
  1294. struct ggml_tensor * c1);
  1295. // partition into non-overlapping windows with padding if needed
  1296. // example:
  1297. // a: 768 64 64 1
  1298. // w: 14
  1299. // res: 768 14 14 25
  1300. // used in sam
  1301. GGML_API struct ggml_tensor * ggml_win_part(
  1302. struct ggml_context * ctx,
  1303. struct ggml_tensor * a,
  1304. int w);
  1305. // reverse of ggml_win_part
  1306. // used in sam
  1307. GGML_API struct ggml_tensor * ggml_win_unpart(
  1308. struct ggml_context * ctx,
  1309. struct ggml_tensor * a,
  1310. int w0,
  1311. int h0,
  1312. int w);
  1313. GGML_API struct ggml_tensor * ggml_unary(
  1314. struct ggml_context * ctx,
  1315. struct ggml_tensor * a,
  1316. enum ggml_unary_op op);
  1317. GGML_API struct ggml_tensor * ggml_unary_inplace(
  1318. struct ggml_context * ctx,
  1319. struct ggml_tensor * a,
  1320. enum ggml_unary_op op);
  1321. // used in sam
  1322. GGML_API struct ggml_tensor * ggml_get_rel_pos(
  1323. struct ggml_context * ctx,
  1324. struct ggml_tensor * a,
  1325. int qh,
  1326. int kh);
  1327. // used in sam
  1328. GGML_API struct ggml_tensor * ggml_add_rel_pos(
  1329. struct ggml_context * ctx,
  1330. struct ggml_tensor * a,
  1331. struct ggml_tensor * pw,
  1332. struct ggml_tensor * ph);
  1333. GGML_API struct ggml_tensor * ggml_add_rel_pos_inplace(
  1334. struct ggml_context * ctx,
  1335. struct ggml_tensor * a,
  1336. struct ggml_tensor * pw,
  1337. struct ggml_tensor * ph);
  1338. // custom operators
  1339. typedef void (*ggml_unary_op_f32_t) (const int, float *, const float *);
  1340. typedef void (*ggml_binary_op_f32_t)(const int, float *, const float *, const float *);
  1341. typedef void (*ggml_custom1_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *);
  1342. typedef void (*ggml_custom2_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1343. typedef void (*ggml_custom3_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1344. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_f32(
  1345. struct ggml_context * ctx,
  1346. struct ggml_tensor * a,
  1347. ggml_unary_op_f32_t fun),
  1348. "use ggml_map_custom1 instead");
  1349. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_inplace_f32(
  1350. struct ggml_context * ctx,
  1351. struct ggml_tensor * a,
  1352. ggml_unary_op_f32_t fun),
  1353. "use ggml_map_custom1_inplace instead");
  1354. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_f32(
  1355. struct ggml_context * ctx,
  1356. struct ggml_tensor * a,
  1357. struct ggml_tensor * b,
  1358. ggml_binary_op_f32_t fun),
  1359. "use ggml_map_custom2 instead");
  1360. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_inplace_f32(
  1361. struct ggml_context * ctx,
  1362. struct ggml_tensor * a,
  1363. struct ggml_tensor * b,
  1364. ggml_binary_op_f32_t fun),
  1365. "use ggml_map_custom2_inplace instead");
  1366. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_f32(
  1367. struct ggml_context * ctx,
  1368. struct ggml_tensor * a,
  1369. ggml_custom1_op_f32_t fun),
  1370. "use ggml_map_custom1 instead");
  1371. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_inplace_f32(
  1372. struct ggml_context * ctx,
  1373. struct ggml_tensor * a,
  1374. ggml_custom1_op_f32_t fun),
  1375. "use ggml_map_custom1_inplace instead");
  1376. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_f32(
  1377. struct ggml_context * ctx,
  1378. struct ggml_tensor * a,
  1379. struct ggml_tensor * b,
  1380. ggml_custom2_op_f32_t fun),
  1381. "use ggml_map_custom2 instead");
  1382. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_inplace_f32(
  1383. struct ggml_context * ctx,
  1384. struct ggml_tensor * a,
  1385. struct ggml_tensor * b,
  1386. ggml_custom2_op_f32_t fun),
  1387. "use ggml_map_custom2_inplace instead");
  1388. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_f32(
  1389. struct ggml_context * ctx,
  1390. struct ggml_tensor * a,
  1391. struct ggml_tensor * b,
  1392. struct ggml_tensor * c,
  1393. ggml_custom3_op_f32_t fun),
  1394. "use ggml_map_custom3 instead");
  1395. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_inplace_f32(
  1396. struct ggml_context * ctx,
  1397. struct ggml_tensor * a,
  1398. struct ggml_tensor * b,
  1399. struct ggml_tensor * c,
  1400. ggml_custom3_op_f32_t fun),
  1401. "use ggml_map_custom3_inplace instead");
  1402. // custom operators v2
  1403. typedef void (*ggml_custom1_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, int ith, int nth, void * userdata);
  1404. 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);
  1405. 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);
  1406. #define GGML_N_TASKS_MAX -1
  1407. GGML_API struct ggml_tensor * ggml_map_custom1(
  1408. struct ggml_context * ctx,
  1409. struct ggml_tensor * a,
  1410. ggml_custom1_op_t fun,
  1411. int n_tasks,
  1412. void * userdata);
  1413. GGML_API struct ggml_tensor * ggml_map_custom1_inplace(
  1414. struct ggml_context * ctx,
  1415. struct ggml_tensor * a,
  1416. ggml_custom1_op_t fun,
  1417. int n_tasks,
  1418. void * userdata);
  1419. GGML_API struct ggml_tensor * ggml_map_custom2(
  1420. struct ggml_context * ctx,
  1421. struct ggml_tensor * a,
  1422. struct ggml_tensor * b,
  1423. ggml_custom2_op_t fun,
  1424. int n_tasks,
  1425. void * userdata);
  1426. GGML_API struct ggml_tensor * ggml_map_custom2_inplace(
  1427. struct ggml_context * ctx,
  1428. struct ggml_tensor * a,
  1429. struct ggml_tensor * b,
  1430. ggml_custom2_op_t fun,
  1431. int n_tasks,
  1432. void * userdata);
  1433. GGML_API struct ggml_tensor * ggml_map_custom3(
  1434. struct ggml_context * ctx,
  1435. struct ggml_tensor * a,
  1436. struct ggml_tensor * b,
  1437. struct ggml_tensor * c,
  1438. ggml_custom3_op_t fun,
  1439. int n_tasks,
  1440. void * userdata);
  1441. GGML_API struct ggml_tensor * ggml_map_custom3_inplace(
  1442. struct ggml_context * ctx,
  1443. struct ggml_tensor * a,
  1444. struct ggml_tensor * b,
  1445. struct ggml_tensor * c,
  1446. ggml_custom3_op_t fun,
  1447. int n_tasks,
  1448. void * userdata);
  1449. // loss function
  1450. GGML_API struct ggml_tensor * ggml_cross_entropy_loss(
  1451. struct ggml_context * ctx,
  1452. struct ggml_tensor * a,
  1453. struct ggml_tensor * b);
  1454. GGML_API struct ggml_tensor * ggml_cross_entropy_loss_back(
  1455. struct ggml_context * ctx,
  1456. struct ggml_tensor * a,
  1457. struct ggml_tensor * b,
  1458. struct ggml_tensor * c);
  1459. //
  1460. // automatic differentiation
  1461. //
  1462. GGML_API void ggml_set_param(
  1463. struct ggml_context * ctx,
  1464. struct ggml_tensor * tensor);
  1465. GGML_API void ggml_build_forward_expand (struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1466. GGML_API void ggml_build_backward_expand(struct ggml_context * ctx, struct ggml_cgraph * gf, struct ggml_cgraph * gb, bool keep);
  1467. // graph allocation in a context
  1468. GGML_API struct ggml_cgraph * ggml_new_graph (struct ggml_context * ctx); // size = GGML_DEFAULT_GRAPH_SIZE, grads = false
  1469. GGML_API struct ggml_cgraph * ggml_new_graph_custom (struct ggml_context * ctx, size_t size, bool grads);
  1470. GGML_API struct ggml_cgraph * ggml_graph_dup (struct ggml_context * ctx, struct ggml_cgraph * cgraph);
  1471. GGML_API struct ggml_cgraph * ggml_graph_view (struct ggml_context * ctx, struct ggml_cgraph * cgraph, int i0, int i1);
  1472. GGML_API void ggml_graph_cpy (struct ggml_cgraph * src, struct ggml_cgraph * dst);
  1473. GGML_API void ggml_graph_reset (struct ggml_cgraph * cgraph); // zero grads
  1474. GGML_API void ggml_graph_clear (struct ggml_cgraph * cgraph);
  1475. GGML_API size_t ggml_graph_overhead(void);
  1476. GGML_API size_t ggml_graph_overhead_custom(size_t size, bool grads);
  1477. // ggml_graph_plan() has to be called before ggml_graph_compute()
  1478. // when plan.work_size > 0, caller must allocate memory for plan.work_data
  1479. GGML_API struct ggml_cplan ggml_graph_plan (struct ggml_cgraph * cgraph, int n_threads /*= GGML_DEFAULT_N_THREADS*/);
  1480. GGML_API int ggml_graph_compute(struct ggml_cgraph * cgraph, struct ggml_cplan * cplan);
  1481. // same as ggml_graph_compute() but the work data is allocated as a part of the context
  1482. // note: the drawback of this API is that you must have ensured that the context has enough memory for the work data
  1483. GGML_API void ggml_graph_compute_with_ctx(struct ggml_context * ctx, struct ggml_cgraph * cgraph, int n_threads);
  1484. GGML_API struct ggml_tensor * ggml_graph_get_tensor(struct ggml_cgraph * cgraph, const char * name);
  1485. GGML_API void ggml_graph_export(const struct ggml_cgraph * cgraph, const char * fname);
  1486. GGML_API struct ggml_cgraph * ggml_graph_import(const char * fname, struct ggml_context ** ctx_data, struct ggml_context ** ctx_eval);
  1487. // print info and performance information for the graph
  1488. GGML_API void ggml_graph_print(const struct ggml_cgraph * cgraph);
  1489. // dump the graph into a file using the dot format
  1490. GGML_API void ggml_graph_dump_dot(const struct ggml_cgraph * gb, const struct ggml_cgraph * gf, const char * filename);
  1491. // build gradient checkpointing backward graph gb for gf using provided checkpoints
  1492. // gb_tmp will contain original backward graph with rewritten backward process nodes,
  1493. // but without the second forward pass nodes.
  1494. GGML_API void ggml_build_backward_gradient_checkpointing(
  1495. struct ggml_context * ctx,
  1496. struct ggml_cgraph * gf,
  1497. struct ggml_cgraph * gb,
  1498. struct ggml_cgraph * gb_tmp,
  1499. struct ggml_tensor * * checkpoints,
  1500. int n_checkpoints);
  1501. //
  1502. // optimization
  1503. //
  1504. // optimization methods
  1505. enum ggml_opt_type {
  1506. GGML_OPT_ADAM,
  1507. GGML_OPT_LBFGS,
  1508. };
  1509. // linesearch methods
  1510. enum ggml_linesearch {
  1511. GGML_LINESEARCH_DEFAULT = 1,
  1512. GGML_LINESEARCH_BACKTRACKING_ARMIJO = 0,
  1513. GGML_LINESEARCH_BACKTRACKING_WOLFE = 1,
  1514. GGML_LINESEARCH_BACKTRACKING_STRONG_WOLFE = 2,
  1515. };
  1516. // optimization return values
  1517. enum ggml_opt_result {
  1518. GGML_OPT_OK = 0,
  1519. GGML_OPT_DID_NOT_CONVERGE,
  1520. GGML_OPT_NO_CONTEXT,
  1521. GGML_OPT_INVALID_WOLFE,
  1522. GGML_OPT_FAIL,
  1523. GGML_OPT_CANCEL,
  1524. GGML_LINESEARCH_FAIL = -128,
  1525. GGML_LINESEARCH_MINIMUM_STEP,
  1526. GGML_LINESEARCH_MAXIMUM_STEP,
  1527. GGML_LINESEARCH_MAXIMUM_ITERATIONS,
  1528. GGML_LINESEARCH_INVALID_PARAMETERS,
  1529. };
  1530. typedef void (*ggml_opt_callback)(void * data, int accum_step, float * sched, bool * cancel);
  1531. typedef void (*ggml_log_callback)(enum ggml_log_level level, const char * text, void * user_data);
  1532. // optimization parameters
  1533. //
  1534. // see ggml.c (ggml_opt_default_params) for default values
  1535. //
  1536. struct ggml_opt_params {
  1537. enum ggml_opt_type type;
  1538. size_t graph_size;
  1539. int n_threads;
  1540. // delta-based convergence test
  1541. //
  1542. // if past == 0 - disabled
  1543. // if past > 0:
  1544. // stop if |f(x) - f(x_past)| < delta * max(1, |f(x)|)
  1545. //
  1546. int past;
  1547. float delta;
  1548. // maximum number of iterations without improvement
  1549. //
  1550. // if 0 - disabled
  1551. // if > 0:
  1552. // assume convergence if no cost improvement in this number of iterations
  1553. //
  1554. int max_no_improvement;
  1555. bool print_forward_graph;
  1556. bool print_backward_graph;
  1557. int n_gradient_accumulation;
  1558. // ADAM parameters
  1559. struct {
  1560. int n_iter;
  1561. float sched; // schedule multiplier (fixed, decay or warmup)
  1562. float decay; // weight decay for AdamW, use 0.0f to disable
  1563. int decay_min_ndim; // minimum number of tensor dimension to apply weight decay
  1564. float alpha; // learning rate
  1565. float beta1;
  1566. float beta2;
  1567. float eps; // epsilon for numerical stability
  1568. float eps_f; // epsilon for convergence test
  1569. float eps_g; // epsilon for convergence test
  1570. float gclip; // gradient clipping
  1571. } adam;
  1572. // LBFGS parameters
  1573. struct {
  1574. int m; // number of corrections to approximate the inv. Hessian
  1575. int n_iter;
  1576. int max_linesearch;
  1577. float eps; // convergence tolerance
  1578. float ftol; // line search tolerance
  1579. float wolfe;
  1580. float min_step;
  1581. float max_step;
  1582. enum ggml_linesearch linesearch;
  1583. } lbfgs;
  1584. };
  1585. struct ggml_opt_context {
  1586. struct ggml_context * ctx;
  1587. struct ggml_opt_params params;
  1588. int iter;
  1589. int64_t nx; // number of parameter elements
  1590. bool just_initialized;
  1591. float loss_before;
  1592. float loss_after;
  1593. struct {
  1594. struct ggml_tensor * g; // current gradient
  1595. struct ggml_tensor * m; // first moment
  1596. struct ggml_tensor * v; // second moment
  1597. struct ggml_tensor * pf; // past function values
  1598. float fx_best;
  1599. float fx_prev;
  1600. int n_no_improvement;
  1601. } adam;
  1602. struct {
  1603. struct ggml_tensor * x; // current parameters
  1604. struct ggml_tensor * xp; // previous parameters
  1605. struct ggml_tensor * g; // current gradient
  1606. struct ggml_tensor * gp; // previous gradient
  1607. struct ggml_tensor * d; // search direction
  1608. struct ggml_tensor * pf; // past function values
  1609. struct ggml_tensor * lmal; // the L-BFGS memory alpha
  1610. struct ggml_tensor * lmys; // the L-BFGS memory ys
  1611. struct ggml_tensor * lms; // the L-BFGS memory s
  1612. struct ggml_tensor * lmy; // the L-BFGS memory y
  1613. float fx_best;
  1614. float step;
  1615. int j;
  1616. int k;
  1617. int end;
  1618. int n_no_improvement;
  1619. } lbfgs;
  1620. };
  1621. GGML_API struct ggml_opt_params ggml_opt_default_params(enum ggml_opt_type type);
  1622. // optimize the function defined by the tensor f
  1623. GGML_API enum ggml_opt_result ggml_opt(
  1624. struct ggml_context * ctx,
  1625. struct ggml_opt_params params,
  1626. struct ggml_tensor * f);
  1627. // initialize optimizer context
  1628. GGML_API void ggml_opt_init(
  1629. struct ggml_context * ctx,
  1630. struct ggml_opt_context * opt,
  1631. struct ggml_opt_params params,
  1632. int64_t nx);
  1633. // continue optimizing the function defined by the tensor f
  1634. GGML_API enum ggml_opt_result ggml_opt_resume(
  1635. struct ggml_context * ctx,
  1636. struct ggml_opt_context * opt,
  1637. struct ggml_tensor * f);
  1638. // continue optimizing the function defined by the tensor f
  1639. GGML_API enum ggml_opt_result ggml_opt_resume_g(
  1640. struct ggml_context * ctx,
  1641. struct ggml_opt_context * opt,
  1642. struct ggml_tensor * f,
  1643. struct ggml_cgraph * gf,
  1644. struct ggml_cgraph * gb,
  1645. ggml_opt_callback callback,
  1646. void * callback_data);
  1647. //
  1648. // quantization
  1649. //
  1650. // TODO: these would probably get removed in favor of the more general ggml_quantize_chunk
  1651. GGML_API size_t ggml_quantize_q4_0(const float * src, void * dst, int n, int k, int64_t * hist);
  1652. GGML_API size_t ggml_quantize_q4_1(const float * src, void * dst, int n, int k, int64_t * hist);
  1653. GGML_API size_t ggml_quantize_q5_0(const float * src, void * dst, int n, int k, int64_t * hist);
  1654. GGML_API size_t ggml_quantize_q5_1(const float * src, void * dst, int n, int k, int64_t * hist);
  1655. GGML_API size_t ggml_quantize_q8_0(const float * src, void * dst, int n, int k, int64_t * hist);
  1656. GGML_API size_t ggml_quantize_q2_K(const float * src, void * dst, int n, int k, int64_t * hist);
  1657. GGML_API size_t ggml_quantize_q3_K(const float * src, void * dst, int n, int k, int64_t * hist);
  1658. GGML_API size_t ggml_quantize_q4_K(const float * src, void * dst, int n, int k, int64_t * hist);
  1659. GGML_API size_t ggml_quantize_q5_K(const float * src, void * dst, int n, int k, int64_t * hist);
  1660. GGML_API size_t ggml_quantize_q6_K(const float * src, void * dst, int n, int k, int64_t * hist);
  1661. GGML_API size_t ggml_quantize_chunk(enum ggml_type type, const float * src, void * dst, int start, int n, int64_t * hist);
  1662. //
  1663. // gguf
  1664. //
  1665. enum gguf_type {
  1666. GGUF_TYPE_UINT8 = 0,
  1667. GGUF_TYPE_INT8 = 1,
  1668. GGUF_TYPE_UINT16 = 2,
  1669. GGUF_TYPE_INT16 = 3,
  1670. GGUF_TYPE_UINT32 = 4,
  1671. GGUF_TYPE_INT32 = 5,
  1672. GGUF_TYPE_FLOAT32 = 6,
  1673. GGUF_TYPE_BOOL = 7,
  1674. GGUF_TYPE_STRING = 8,
  1675. GGUF_TYPE_ARRAY = 9,
  1676. GGUF_TYPE_UINT64 = 10,
  1677. GGUF_TYPE_INT64 = 11,
  1678. GGUF_TYPE_FLOAT64 = 12,
  1679. GGUF_TYPE_COUNT, // marks the end of the enum
  1680. };
  1681. struct gguf_context;
  1682. struct gguf_init_params {
  1683. bool no_alloc;
  1684. // if not NULL, create a ggml_context and allocate the tensor data in it
  1685. struct ggml_context ** ctx;
  1686. };
  1687. GGML_API struct gguf_context * gguf_init_empty(void);
  1688. GGML_API struct gguf_context * gguf_init_from_file(const char * fname, struct gguf_init_params params);
  1689. //GGML_API struct gguf_context * gguf_init_from_buffer(..);
  1690. GGML_API void gguf_free(struct gguf_context * ctx);
  1691. GGML_API const char * gguf_type_name(enum gguf_type type);
  1692. GGML_API int gguf_get_version (const struct gguf_context * ctx);
  1693. GGML_API size_t gguf_get_alignment (const struct gguf_context * ctx);
  1694. GGML_API size_t gguf_get_data_offset(const struct gguf_context * ctx);
  1695. GGML_API void * gguf_get_data (const struct gguf_context * ctx);
  1696. GGML_API int gguf_get_n_kv(const struct gguf_context * ctx);
  1697. GGML_API int gguf_find_key(const struct gguf_context * ctx, const char * key);
  1698. GGML_API const char * gguf_get_key (const struct gguf_context * ctx, int key_id);
  1699. GGML_API enum gguf_type gguf_get_kv_type (const struct gguf_context * ctx, int key_id);
  1700. GGML_API enum gguf_type gguf_get_arr_type(const struct gguf_context * ctx, int key_id);
  1701. // will abort if the wrong type is used for the key
  1702. GGML_API uint8_t gguf_get_val_u8 (const struct gguf_context * ctx, int key_id);
  1703. GGML_API int8_t gguf_get_val_i8 (const struct gguf_context * ctx, int key_id);
  1704. GGML_API uint16_t gguf_get_val_u16 (const struct gguf_context * ctx, int key_id);
  1705. GGML_API int16_t gguf_get_val_i16 (const struct gguf_context * ctx, int key_id);
  1706. GGML_API uint32_t gguf_get_val_u32 (const struct gguf_context * ctx, int key_id);
  1707. GGML_API int32_t gguf_get_val_i32 (const struct gguf_context * ctx, int key_id);
  1708. GGML_API float gguf_get_val_f32 (const struct gguf_context * ctx, int key_id);
  1709. GGML_API uint64_t gguf_get_val_u64 (const struct gguf_context * ctx, int key_id);
  1710. GGML_API int64_t gguf_get_val_i64 (const struct gguf_context * ctx, int key_id);
  1711. GGML_API double gguf_get_val_f64 (const struct gguf_context * ctx, int key_id);
  1712. GGML_API bool gguf_get_val_bool(const struct gguf_context * ctx, int key_id);
  1713. GGML_API const char * gguf_get_val_str (const struct gguf_context * ctx, int key_id);
  1714. GGML_API int gguf_get_arr_n (const struct gguf_context * ctx, int key_id);
  1715. GGML_API const void * gguf_get_arr_data(const struct gguf_context * ctx, int key_id);
  1716. GGML_API const char * gguf_get_arr_str (const struct gguf_context * ctx, int key_id, int i);
  1717. GGML_API int gguf_get_n_tensors (const struct gguf_context * ctx);
  1718. GGML_API int gguf_find_tensor (const struct gguf_context * ctx, const char * name);
  1719. GGML_API size_t gguf_get_tensor_offset(const struct gguf_context * ctx, int i);
  1720. GGML_API char * gguf_get_tensor_name (const struct gguf_context * ctx, int i);
  1721. // overrides existing values or adds a new one
  1722. GGML_API void gguf_set_val_u8 (struct gguf_context * ctx, const char * key, uint8_t val);
  1723. GGML_API void gguf_set_val_i8 (struct gguf_context * ctx, const char * key, int8_t val);
  1724. GGML_API void gguf_set_val_u16 (struct gguf_context * ctx, const char * key, uint16_t val);
  1725. GGML_API void gguf_set_val_i16 (struct gguf_context * ctx, const char * key, int16_t val);
  1726. GGML_API void gguf_set_val_u32 (struct gguf_context * ctx, const char * key, uint32_t val);
  1727. GGML_API void gguf_set_val_i32 (struct gguf_context * ctx, const char * key, int32_t val);
  1728. GGML_API void gguf_set_val_f32 (struct gguf_context * ctx, const char * key, float val);
  1729. GGML_API void gguf_set_val_u64 (struct gguf_context * ctx, const char * key, uint64_t val);
  1730. GGML_API void gguf_set_val_i64 (struct gguf_context * ctx, const char * key, int64_t val);
  1731. GGML_API void gguf_set_val_f64 (struct gguf_context * ctx, const char * key, double val);
  1732. GGML_API void gguf_set_val_bool(struct gguf_context * ctx, const char * key, bool val);
  1733. GGML_API void gguf_set_val_str (struct gguf_context * ctx, const char * key, const char * val);
  1734. GGML_API void gguf_set_arr_data(struct gguf_context * ctx, const char * key, enum gguf_type type, const void * data, int n);
  1735. GGML_API void gguf_set_arr_str (struct gguf_context * ctx, const char * key, const char ** data, int n);
  1736. // set or add KV pairs from another context
  1737. GGML_API void gguf_set_kv(struct gguf_context * ctx, struct gguf_context * src);
  1738. // manage tensor info
  1739. GGML_API void gguf_add_tensor(struct gguf_context * ctx, const struct ggml_tensor * tensor);
  1740. GGML_API void gguf_set_tensor_type(struct gguf_context * ctx, const char * name, enum ggml_type type);
  1741. GGML_API void gguf_set_tensor_data(struct gguf_context * ctx, const char * name, const void * data, size_t size);
  1742. // writing gguf files can be done in 2 ways:
  1743. //
  1744. // - write the entire gguf_context to a binary file in a single pass:
  1745. //
  1746. // gguf_write_to_file(ctx, fname);
  1747. //
  1748. // - first prepare a file with a placeholder for the meta data, write the tensor data, then write the meta data:
  1749. //
  1750. // FILE * f = fopen(fname, "wb");
  1751. // fseek(f, gguf_get_meta_size(ctx), SEEK_SET);
  1752. // fwrite(f, ...);
  1753. // void * data = gguf_meta_get_meta_data(ctx);
  1754. // fseek(f, 0, SEEK_SET);
  1755. // fwrite(f, data, gguf_get_meta_size(ctx));
  1756. // free(data);
  1757. // fclose(f);
  1758. //
  1759. // write the entire context to a binary file
  1760. GGML_API void gguf_write_to_file(const struct gguf_context * ctx, const char * fname, bool only_meta);
  1761. // get the size in bytes of the meta data (header, kv pairs, tensor info) including padding
  1762. GGML_API size_t gguf_get_meta_size(const struct gguf_context * ctx);
  1763. GGML_API void gguf_get_meta_data(const struct gguf_context * ctx, void * data);
  1764. //
  1765. // system info
  1766. //
  1767. GGML_API int ggml_cpu_has_avx (void);
  1768. GGML_API int ggml_cpu_has_avx2 (void);
  1769. GGML_API int ggml_cpu_has_avx512 (void);
  1770. GGML_API int ggml_cpu_has_avx512_vbmi(void);
  1771. GGML_API int ggml_cpu_has_avx512_vnni(void);
  1772. GGML_API int ggml_cpu_has_fma (void);
  1773. GGML_API int ggml_cpu_has_neon (void);
  1774. GGML_API int ggml_cpu_has_arm_fma (void);
  1775. GGML_API int ggml_cpu_has_metal (void);
  1776. GGML_API int ggml_cpu_has_f16c (void);
  1777. GGML_API int ggml_cpu_has_fp16_va (void);
  1778. GGML_API int ggml_cpu_has_wasm_simd (void);
  1779. GGML_API int ggml_cpu_has_blas (void);
  1780. GGML_API int ggml_cpu_has_cublas (void);
  1781. GGML_API int ggml_cpu_has_clblast (void);
  1782. GGML_API int ggml_cpu_has_gpublas (void);
  1783. GGML_API int ggml_cpu_has_sse3 (void);
  1784. GGML_API int ggml_cpu_has_ssse3 (void);
  1785. GGML_API int ggml_cpu_has_vsx (void);
  1786. //
  1787. // Internal types and functions exposed for tests and benchmarks
  1788. //
  1789. #ifdef __cplusplus
  1790. // restrict not standard in C++
  1791. #define GGML_RESTRICT
  1792. #else
  1793. #define GGML_RESTRICT restrict
  1794. #endif
  1795. typedef void (*ggml_to_float_t) (const void * GGML_RESTRICT x, float * GGML_RESTRICT y, int k);
  1796. typedef void (*ggml_from_float_t)(const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int k);
  1797. typedef void (*ggml_vec_dot_t) (const int n, float * GGML_RESTRICT s, const void * GGML_RESTRICT x, const void * GGML_RESTRICT y);
  1798. typedef struct {
  1799. const char * type_name;
  1800. int blck_size;
  1801. size_t type_size;
  1802. bool is_quantized;
  1803. ggml_to_float_t to_float;
  1804. ggml_from_float_t from_float;
  1805. ggml_from_float_t from_float_reference;
  1806. ggml_vec_dot_t vec_dot;
  1807. enum ggml_type vec_dot_type;
  1808. } ggml_type_traits_t;
  1809. GGML_API ggml_type_traits_t ggml_internal_get_type_traits(enum ggml_type type);
  1810. #ifdef __cplusplus
  1811. }
  1812. #endif