ggml.h 77 KB

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