ggml.h 97 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562
  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 <stdbool.h>
  203. #include <stddef.h>
  204. #include <stdint.h>
  205. #include <stdio.h>
  206. #define GGML_FILE_MAGIC 0x67676d6c // "ggml"
  207. #define GGML_FILE_VERSION 2
  208. #define GGML_QNT_VERSION 2 // bump this on quantization format changes
  209. #define GGML_QNT_VERSION_FACTOR 1000 // do not change this
  210. #define GGML_MAX_DIMS 4
  211. #define GGML_MAX_PARAMS 2048
  212. #define GGML_MAX_SRC 10
  213. #define GGML_MAX_N_THREADS 512
  214. #define GGML_MAX_OP_PARAMS 64
  215. #ifndef GGML_MAX_NAME
  216. # define GGML_MAX_NAME 64
  217. #endif
  218. #define GGML_DEFAULT_N_THREADS 4
  219. #define GGML_DEFAULT_GRAPH_SIZE 2048
  220. #if UINTPTR_MAX == 0xFFFFFFFF
  221. #define GGML_MEM_ALIGN 4
  222. #else
  223. #define GGML_MEM_ALIGN 16
  224. #endif
  225. #define GGML_EXIT_SUCCESS 0
  226. #define GGML_EXIT_ABORTED 1
  227. #define GGML_ROPE_TYPE_NEOX 2
  228. #define GGUF_MAGIC "GGUF"
  229. #define GGUF_VERSION 3
  230. #define GGUF_DEFAULT_ALIGNMENT 32
  231. #define GGML_UNUSED(x) (void)(x)
  232. #define GGML_PAD(x, n) (((x) + (n) - 1) & ~((n) - 1))
  233. #ifndef NDEBUG
  234. # define GGML_UNREACHABLE() do { fprintf(stderr, "statement should be unreachable\n"); abort(); } while(0)
  235. #elif defined(__GNUC__)
  236. # define GGML_UNREACHABLE() __builtin_unreachable()
  237. #elif defined(_MSC_VER)
  238. # define GGML_UNREACHABLE() __assume(0)
  239. #else
  240. # define GGML_UNREACHABLE() ((void) 0)
  241. #endif
  242. #ifdef __cplusplus
  243. # define GGML_NORETURN [[noreturn]]
  244. #elif defined(_MSC_VER)
  245. # define GGML_NORETURN __declspec(noreturn)
  246. #else
  247. # define GGML_NORETURN _Noreturn
  248. #endif
  249. #define GGML_ABORT(...) ggml_abort(__FILE__, __LINE__, __VA_ARGS__)
  250. #define GGML_ASSERT(x) if (!(x)) GGML_ABORT("GGML_ASSERT(%s) failed", #x)
  251. // used to copy the number of elements and stride in bytes of tensors into local variables.
  252. // main purpose is to reduce code duplication and improve readability.
  253. //
  254. // example:
  255. //
  256. // GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne);
  257. // GGML_TENSOR_LOCALS(size_t, nb1, src1, nb);
  258. //
  259. #define GGML_TENSOR_LOCALS_1(type, prefix, pointer, array) \
  260. const type prefix##0 = (pointer)->array[0]; \
  261. GGML_UNUSED(prefix##0);
  262. #define GGML_TENSOR_LOCALS_2(type, prefix, pointer, array) \
  263. GGML_TENSOR_LOCALS_1 (type, prefix, pointer, array) \
  264. const type prefix##1 = (pointer)->array[1]; \
  265. GGML_UNUSED(prefix##1);
  266. #define GGML_TENSOR_LOCALS_3(type, prefix, pointer, array) \
  267. GGML_TENSOR_LOCALS_2 (type, prefix, pointer, array) \
  268. const type prefix##2 = (pointer)->array[2]; \
  269. GGML_UNUSED(prefix##2);
  270. #define GGML_TENSOR_LOCALS(type, prefix, pointer, array) \
  271. GGML_TENSOR_LOCALS_3 (type, prefix, pointer, array) \
  272. const type prefix##3 = (pointer)->array[3]; \
  273. GGML_UNUSED(prefix##3);
  274. #define GGML_TENSOR_UNARY_OP_LOCALS \
  275. GGML_TENSOR_LOCALS(int64_t, ne0, src0, ne) \
  276. GGML_TENSOR_LOCALS(size_t, nb0, src0, nb) \
  277. GGML_TENSOR_LOCALS(int64_t, ne, dst, ne) \
  278. GGML_TENSOR_LOCALS(size_t, nb, dst, nb)
  279. #define GGML_TENSOR_BINARY_OP_LOCALS \
  280. GGML_TENSOR_LOCALS(int64_t, ne0, src0, ne) \
  281. GGML_TENSOR_LOCALS(size_t, nb0, src0, nb) \
  282. GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne) \
  283. GGML_TENSOR_LOCALS(size_t, nb1, src1, nb) \
  284. GGML_TENSOR_LOCALS(int64_t, ne, dst, ne) \
  285. GGML_TENSOR_LOCALS(size_t, nb, dst, nb)
  286. #define GGML_TENSOR_BINARY_OP_LOCALS01 \
  287. GGML_TENSOR_LOCALS(int64_t, ne0, src0, ne) \
  288. GGML_TENSOR_LOCALS(size_t, nb0, src0, nb) \
  289. GGML_TENSOR_LOCALS(int64_t, ne1, src1, ne) \
  290. GGML_TENSOR_LOCALS(size_t, nb1, src1, nb)
  291. #ifdef __cplusplus
  292. extern "C" {
  293. #endif
  294. GGML_NORETURN GGML_ATTRIBUTE_FORMAT(3, 4)
  295. GGML_API void ggml_abort(const char * file, int line, const char * fmt, ...);
  296. enum ggml_status {
  297. GGML_STATUS_ALLOC_FAILED = -2,
  298. GGML_STATUS_FAILED = -1,
  299. GGML_STATUS_SUCCESS = 0,
  300. GGML_STATUS_ABORTED = 1,
  301. };
  302. // get ggml_status name string
  303. GGML_API const char * ggml_status_to_string(enum ggml_status status);
  304. // ieee 754-2008 half-precision float16
  305. // todo: make this not an integral type
  306. typedef uint16_t ggml_fp16_t;
  307. GGML_API float ggml_fp16_to_fp32(ggml_fp16_t);
  308. GGML_API ggml_fp16_t ggml_fp32_to_fp16(float);
  309. GGML_API void ggml_fp16_to_fp32_row(const ggml_fp16_t *, float *, int64_t);
  310. GGML_API void ggml_fp32_to_fp16_row(const float *, ggml_fp16_t *, int64_t);
  311. // google brain half-precision bfloat16
  312. typedef struct { uint16_t bits; } ggml_bf16_t;
  313. GGML_API ggml_bf16_t ggml_fp32_to_bf16(float);
  314. GGML_API float ggml_bf16_to_fp32(ggml_bf16_t); // consider just doing << 16
  315. GGML_API void ggml_bf16_to_fp32_row(const ggml_bf16_t *, float *, int64_t);
  316. GGML_API void ggml_fp32_to_bf16_row_ref(const float *, ggml_bf16_t *, int64_t);
  317. GGML_API void ggml_fp32_to_bf16_row(const float *, ggml_bf16_t *, int64_t);
  318. struct ggml_object;
  319. struct ggml_context;
  320. struct ggml_cgraph;
  321. // NOTE: always add types at the end of the enum to keep backward compatibility
  322. enum ggml_type {
  323. GGML_TYPE_F32 = 0,
  324. GGML_TYPE_F16 = 1,
  325. GGML_TYPE_Q4_0 = 2,
  326. GGML_TYPE_Q4_1 = 3,
  327. // GGML_TYPE_Q4_2 = 4, support has been removed
  328. // GGML_TYPE_Q4_3 = 5, support has been removed
  329. GGML_TYPE_Q5_0 = 6,
  330. GGML_TYPE_Q5_1 = 7,
  331. GGML_TYPE_Q8_0 = 8,
  332. GGML_TYPE_Q8_1 = 9,
  333. GGML_TYPE_Q2_K = 10,
  334. GGML_TYPE_Q3_K = 11,
  335. GGML_TYPE_Q4_K = 12,
  336. GGML_TYPE_Q5_K = 13,
  337. GGML_TYPE_Q6_K = 14,
  338. GGML_TYPE_Q8_K = 15,
  339. GGML_TYPE_IQ2_XXS = 16,
  340. GGML_TYPE_IQ2_XS = 17,
  341. GGML_TYPE_IQ3_XXS = 18,
  342. GGML_TYPE_IQ1_S = 19,
  343. GGML_TYPE_IQ4_NL = 20,
  344. GGML_TYPE_IQ3_S = 21,
  345. GGML_TYPE_IQ2_S = 22,
  346. GGML_TYPE_IQ4_XS = 23,
  347. GGML_TYPE_I8 = 24,
  348. GGML_TYPE_I16 = 25,
  349. GGML_TYPE_I32 = 26,
  350. GGML_TYPE_I64 = 27,
  351. GGML_TYPE_F64 = 28,
  352. GGML_TYPE_IQ1_M = 29,
  353. GGML_TYPE_BF16 = 30,
  354. GGML_TYPE_Q4_0_4_4 = 31,
  355. GGML_TYPE_Q4_0_4_8 = 32,
  356. GGML_TYPE_Q4_0_8_8 = 33,
  357. GGML_TYPE_TQ1_0 = 34,
  358. GGML_TYPE_TQ2_0 = 35,
  359. GGML_TYPE_COUNT,
  360. };
  361. // precision
  362. enum ggml_prec {
  363. GGML_PREC_DEFAULT,
  364. GGML_PREC_F32,
  365. };
  366. enum ggml_backend_type {
  367. GGML_BACKEND_TYPE_CPU = 0,
  368. GGML_BACKEND_TYPE_GPU = 10,
  369. GGML_BACKEND_TYPE_GPU_SPLIT = 20,
  370. };
  371. // model file types
  372. enum ggml_ftype {
  373. GGML_FTYPE_UNKNOWN = -1,
  374. GGML_FTYPE_ALL_F32 = 0,
  375. GGML_FTYPE_MOSTLY_F16 = 1, // except 1d tensors
  376. GGML_FTYPE_MOSTLY_Q4_0 = 2, // except 1d tensors
  377. GGML_FTYPE_MOSTLY_Q4_1 = 3, // except 1d tensors
  378. GGML_FTYPE_MOSTLY_Q4_1_SOME_F16 = 4, // tok_embeddings.weight and output.weight are F16
  379. GGML_FTYPE_MOSTLY_Q8_0 = 7, // except 1d tensors
  380. GGML_FTYPE_MOSTLY_Q5_0 = 8, // except 1d tensors
  381. GGML_FTYPE_MOSTLY_Q5_1 = 9, // except 1d tensors
  382. GGML_FTYPE_MOSTLY_Q2_K = 10, // except 1d tensors
  383. GGML_FTYPE_MOSTLY_Q3_K = 11, // except 1d tensors
  384. GGML_FTYPE_MOSTLY_Q4_K = 12, // except 1d tensors
  385. GGML_FTYPE_MOSTLY_Q5_K = 13, // except 1d tensors
  386. GGML_FTYPE_MOSTLY_Q6_K = 14, // except 1d tensors
  387. GGML_FTYPE_MOSTLY_IQ2_XXS = 15, // except 1d tensors
  388. GGML_FTYPE_MOSTLY_IQ2_XS = 16, // except 1d tensors
  389. GGML_FTYPE_MOSTLY_IQ3_XXS = 17, // except 1d tensors
  390. GGML_FTYPE_MOSTLY_IQ1_S = 18, // except 1d tensors
  391. GGML_FTYPE_MOSTLY_IQ4_NL = 19, // except 1d tensors
  392. GGML_FTYPE_MOSTLY_IQ3_S = 20, // except 1d tensors
  393. GGML_FTYPE_MOSTLY_IQ2_S = 21, // except 1d tensors
  394. GGML_FTYPE_MOSTLY_IQ4_XS = 22, // except 1d tensors
  395. GGML_FTYPE_MOSTLY_IQ1_M = 23, // except 1d tensors
  396. GGML_FTYPE_MOSTLY_BF16 = 24, // except 1d tensors
  397. GGML_FTYPE_MOSTLY_Q4_0_4_4 = 25, // except 1d tensors
  398. GGML_FTYPE_MOSTLY_Q4_0_4_8 = 26, // except 1d tensors
  399. GGML_FTYPE_MOSTLY_Q4_0_8_8 = 27, // except 1d tensors
  400. };
  401. // available tensor operations:
  402. enum ggml_op {
  403. GGML_OP_NONE = 0,
  404. GGML_OP_DUP,
  405. GGML_OP_ADD,
  406. GGML_OP_ADD1,
  407. GGML_OP_ACC,
  408. GGML_OP_SUB,
  409. GGML_OP_MUL,
  410. GGML_OP_DIV,
  411. GGML_OP_SQR,
  412. GGML_OP_SQRT,
  413. GGML_OP_LOG,
  414. GGML_OP_SIN,
  415. GGML_OP_COS,
  416. GGML_OP_SUM,
  417. GGML_OP_SUM_ROWS,
  418. GGML_OP_MEAN,
  419. GGML_OP_ARGMAX,
  420. GGML_OP_COUNT_EQUAL,
  421. GGML_OP_REPEAT,
  422. GGML_OP_REPEAT_BACK,
  423. GGML_OP_CONCAT,
  424. GGML_OP_SILU_BACK,
  425. GGML_OP_NORM, // normalize
  426. GGML_OP_RMS_NORM,
  427. GGML_OP_RMS_NORM_BACK,
  428. GGML_OP_GROUP_NORM,
  429. GGML_OP_MUL_MAT,
  430. GGML_OP_MUL_MAT_ID,
  431. GGML_OP_OUT_PROD,
  432. GGML_OP_SCALE,
  433. GGML_OP_SET,
  434. GGML_OP_CPY,
  435. GGML_OP_CONT,
  436. GGML_OP_RESHAPE,
  437. GGML_OP_VIEW,
  438. GGML_OP_PERMUTE,
  439. GGML_OP_TRANSPOSE,
  440. GGML_OP_GET_ROWS,
  441. GGML_OP_GET_ROWS_BACK,
  442. GGML_OP_DIAG,
  443. GGML_OP_DIAG_MASK_INF,
  444. GGML_OP_DIAG_MASK_ZERO,
  445. GGML_OP_SOFT_MAX,
  446. GGML_OP_SOFT_MAX_BACK,
  447. GGML_OP_ROPE,
  448. GGML_OP_ROPE_BACK,
  449. GGML_OP_CLAMP,
  450. GGML_OP_CONV_TRANSPOSE_1D,
  451. GGML_OP_IM2COL,
  452. GGML_OP_IM2COL_BACK,
  453. GGML_OP_CONV_TRANSPOSE_2D,
  454. GGML_OP_POOL_1D,
  455. GGML_OP_POOL_2D,
  456. GGML_OP_POOL_2D_BACK,
  457. GGML_OP_UPSCALE, // nearest interpolate
  458. GGML_OP_PAD,
  459. GGML_OP_ARANGE,
  460. GGML_OP_TIMESTEP_EMBEDDING,
  461. GGML_OP_ARGSORT,
  462. GGML_OP_LEAKY_RELU,
  463. GGML_OP_FLASH_ATTN_EXT,
  464. GGML_OP_FLASH_ATTN_BACK,
  465. GGML_OP_SSM_CONV,
  466. GGML_OP_SSM_SCAN,
  467. GGML_OP_WIN_PART,
  468. GGML_OP_WIN_UNPART,
  469. GGML_OP_GET_REL_POS,
  470. GGML_OP_ADD_REL_POS,
  471. GGML_OP_RWKV_WKV,
  472. GGML_OP_UNARY,
  473. GGML_OP_MAP_UNARY,
  474. GGML_OP_MAP_BINARY,
  475. GGML_OP_MAP_CUSTOM1_F32,
  476. GGML_OP_MAP_CUSTOM2_F32,
  477. GGML_OP_MAP_CUSTOM3_F32,
  478. GGML_OP_MAP_CUSTOM1,
  479. GGML_OP_MAP_CUSTOM2,
  480. GGML_OP_MAP_CUSTOM3,
  481. GGML_OP_CROSS_ENTROPY_LOSS,
  482. GGML_OP_CROSS_ENTROPY_LOSS_BACK,
  483. GGML_OP_OPT_STEP_ADAMW,
  484. GGML_OP_COUNT,
  485. };
  486. enum ggml_unary_op {
  487. GGML_UNARY_OP_ABS,
  488. GGML_UNARY_OP_SGN,
  489. GGML_UNARY_OP_NEG,
  490. GGML_UNARY_OP_STEP,
  491. GGML_UNARY_OP_TANH,
  492. GGML_UNARY_OP_ELU,
  493. GGML_UNARY_OP_RELU,
  494. GGML_UNARY_OP_SIGMOID,
  495. GGML_UNARY_OP_GELU,
  496. GGML_UNARY_OP_GELU_QUICK,
  497. GGML_UNARY_OP_SILU,
  498. GGML_UNARY_OP_HARDSWISH,
  499. GGML_UNARY_OP_HARDSIGMOID,
  500. GGML_UNARY_OP_EXP,
  501. GGML_UNARY_OP_COUNT,
  502. };
  503. enum ggml_object_type {
  504. GGML_OBJECT_TYPE_TENSOR,
  505. GGML_OBJECT_TYPE_GRAPH,
  506. GGML_OBJECT_TYPE_WORK_BUFFER
  507. };
  508. enum ggml_log_level {
  509. GGML_LOG_LEVEL_NONE = 0,
  510. GGML_LOG_LEVEL_INFO = 1,
  511. GGML_LOG_LEVEL_WARN = 2,
  512. GGML_LOG_LEVEL_ERROR = 3,
  513. GGML_LOG_LEVEL_DEBUG = 4,
  514. GGML_LOG_LEVEL_CONT = 5, // continue previous log
  515. };
  516. // this tensor...
  517. enum ggml_tensor_flag {
  518. GGML_TENSOR_FLAG_INPUT = 1, // ...is an input for the GGML compute graph
  519. GGML_TENSOR_FLAG_OUTPUT = 2, // ...is an output for the GGML compute graph
  520. GGML_TENSOR_FLAG_PARAM = 4, // ...contains trainable parameters
  521. GGML_TENSOR_FLAG_LOSS = 8, // ...defines loss for numerical optimization (multiple loss tensors add up)
  522. };
  523. // n-dimensional tensor
  524. struct ggml_tensor {
  525. enum ggml_type type;
  526. GGML_DEPRECATED(enum ggml_backend_type backend, "use the buffer type to find the storage location of the tensor");
  527. struct ggml_backend_buffer * buffer;
  528. int64_t ne[GGML_MAX_DIMS]; // number of elements
  529. size_t nb[GGML_MAX_DIMS]; // stride in bytes:
  530. // nb[0] = ggml_type_size(type)
  531. // nb[1] = nb[0] * (ne[0] / ggml_blck_size(type)) + padding
  532. // nb[i] = nb[i-1] * ne[i-1]
  533. // compute data
  534. enum ggml_op op;
  535. // op params - allocated as int32_t for alignment
  536. int32_t op_params[GGML_MAX_OP_PARAMS / sizeof(int32_t)];
  537. int32_t flags;
  538. struct ggml_tensor * grad;
  539. struct ggml_tensor * src[GGML_MAX_SRC];
  540. // source tensor and offset for views
  541. struct ggml_tensor * view_src;
  542. size_t view_offs;
  543. void * data;
  544. char name[GGML_MAX_NAME];
  545. void * extra; // extra things e.g. for ggml-cuda.cu
  546. // char padding[4];
  547. };
  548. static const size_t GGML_TENSOR_SIZE = sizeof(struct ggml_tensor);
  549. // Abort callback
  550. // If not NULL, called before ggml computation
  551. // If it returns true, the computation is aborted
  552. typedef bool (*ggml_abort_callback)(void * data);
  553. // Scheduling priorities
  554. enum ggml_sched_priority {
  555. GGML_SCHED_PRIO_NORMAL,
  556. GGML_SCHED_PRIO_MEDIUM,
  557. GGML_SCHED_PRIO_HIGH,
  558. GGML_SCHED_PRIO_REALTIME
  559. };
  560. // Threadpool params
  561. // Use ggml_threadpool_params_default() or ggml_threadpool_params_init() to populate the defaults
  562. struct ggml_threadpool_params {
  563. bool cpumask[GGML_MAX_N_THREADS]; // mask of cpu cores (all-zeros means use default affinity settings)
  564. int n_threads; // number of threads
  565. enum ggml_sched_priority prio; // thread priority
  566. uint32_t poll; // polling level (0 - no polling, 100 - aggressive polling)
  567. bool strict_cpu; // strict cpu placement
  568. bool paused; // start in paused state
  569. };
  570. struct ggml_threadpool; // forward declaration, see ggml.c
  571. typedef struct ggml_threadpool * ggml_threadpool_t;
  572. // the compute plan that needs to be prepared for ggml_graph_compute()
  573. // since https://github.com/ggerganov/ggml/issues/287
  574. struct ggml_cplan {
  575. size_t work_size; // size of work buffer, calculated by `ggml_graph_plan()`
  576. uint8_t * work_data; // work buffer, to be allocated by caller before calling to `ggml_graph_compute()`
  577. int n_threads;
  578. struct ggml_threadpool * threadpool;
  579. // abort ggml_graph_compute when true
  580. ggml_abort_callback abort_callback;
  581. void * abort_callback_data;
  582. };
  583. // scratch buffer
  584. // TODO: deprecate and remove
  585. struct ggml_scratch {
  586. size_t offs;
  587. size_t size;
  588. void * data;
  589. };
  590. struct ggml_init_params {
  591. // memory pool
  592. size_t mem_size; // bytes
  593. void * mem_buffer; // if NULL, memory will be allocated internally
  594. bool no_alloc; // don't allocate memory for the tensor data
  595. };
  596. // numa strategies
  597. enum ggml_numa_strategy {
  598. GGML_NUMA_STRATEGY_DISABLED = 0,
  599. GGML_NUMA_STRATEGY_DISTRIBUTE = 1,
  600. GGML_NUMA_STRATEGY_ISOLATE = 2,
  601. GGML_NUMA_STRATEGY_NUMACTL = 3,
  602. GGML_NUMA_STRATEGY_MIRROR = 4,
  603. GGML_NUMA_STRATEGY_COUNT
  604. };
  605. //
  606. // GUID
  607. //
  608. // GUID types
  609. typedef uint8_t ggml_guid[16];
  610. typedef ggml_guid * ggml_guid_t;
  611. GGML_API bool ggml_guid_matches(ggml_guid_t guid_a, ggml_guid_t guid_b);
  612. // misc
  613. GGML_API void ggml_time_init(void); // call this once at the beginning of the program
  614. GGML_API int64_t ggml_time_ms(void);
  615. GGML_API int64_t ggml_time_us(void);
  616. GGML_API int64_t ggml_cycles(void);
  617. GGML_API int64_t ggml_cycles_per_ms(void);
  618. // accepts a UTF-8 path, even on Windows
  619. GGML_API FILE * ggml_fopen(const char * fname, const char * mode);
  620. GGML_API void ggml_numa_init(enum ggml_numa_strategy numa); // call once for better performance on NUMA systems
  621. GGML_API bool ggml_is_numa(void); // true if init detected that system has >1 NUMA node
  622. GGML_API void ggml_print_object (const struct ggml_object * obj);
  623. GGML_API void ggml_print_objects(const struct ggml_context * ctx);
  624. GGML_API int64_t ggml_nelements (const struct ggml_tensor * tensor);
  625. GGML_API int64_t ggml_nrows (const struct ggml_tensor * tensor);
  626. GGML_API size_t ggml_nbytes (const struct ggml_tensor * tensor);
  627. GGML_API size_t ggml_nbytes_pad(const struct ggml_tensor * tensor); // same as ggml_nbytes() but padded to GGML_MEM_ALIGN
  628. GGML_API int64_t ggml_blck_size(enum ggml_type type);
  629. GGML_API size_t ggml_type_size(enum ggml_type type); // size in bytes for all elements in a block
  630. GGML_API size_t ggml_row_size (enum ggml_type type, int64_t ne); // size in bytes for all elements in a row
  631. GGML_DEPRECATED(
  632. GGML_API double ggml_type_sizef(enum ggml_type type), // ggml_type_size()/ggml_blck_size() as float
  633. "use ggml_row_size() instead");
  634. GGML_API const char * ggml_type_name(enum ggml_type type);
  635. GGML_API const char * ggml_op_name (enum ggml_op op);
  636. GGML_API const char * ggml_op_symbol(enum ggml_op op);
  637. GGML_API const char * ggml_unary_op_name(enum ggml_unary_op op);
  638. GGML_API const char * ggml_op_desc(const struct ggml_tensor * t); // unary or op name
  639. GGML_API size_t ggml_element_size(const struct ggml_tensor * tensor);
  640. GGML_API bool ggml_is_quantized(enum ggml_type type);
  641. // TODO: temporary until model loading of ggml examples is refactored
  642. GGML_API enum ggml_type ggml_ftype_to_ggml_type(enum ggml_ftype ftype);
  643. GGML_API bool ggml_is_transposed(const struct ggml_tensor * tensor);
  644. GGML_API bool ggml_is_permuted (const struct ggml_tensor * tensor);
  645. GGML_API bool ggml_is_empty (const struct ggml_tensor * tensor);
  646. GGML_API bool ggml_is_scalar (const struct ggml_tensor * tensor);
  647. GGML_API bool ggml_is_vector (const struct ggml_tensor * tensor);
  648. GGML_API bool ggml_is_matrix (const struct ggml_tensor * tensor);
  649. GGML_API bool ggml_is_3d (const struct ggml_tensor * tensor);
  650. GGML_API int ggml_n_dims (const struct ggml_tensor * tensor); // returns 1 for scalars
  651. GGML_API bool ggml_is_contiguous (const struct ggml_tensor * tensor);
  652. GGML_API bool ggml_is_contiguous_0(const struct ggml_tensor * tensor); // same as ggml_is_contiguous()
  653. GGML_API bool ggml_is_contiguous_1(const struct ggml_tensor * tensor); // contiguous for dims >= 1
  654. GGML_API bool ggml_is_contiguous_2(const struct ggml_tensor * tensor); // contiguous for dims >= 2
  655. GGML_API bool ggml_are_same_shape (const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  656. GGML_API bool ggml_are_same_stride(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  657. GGML_API bool ggml_can_repeat(const struct ggml_tensor * t0, const struct ggml_tensor * t1);
  658. // use this to compute the memory overhead of a tensor
  659. GGML_API size_t ggml_tensor_overhead(void);
  660. GGML_API bool ggml_validate_row_data(enum ggml_type type, const void * data, size_t nbytes);
  661. // main
  662. GGML_API struct ggml_context * ggml_init (struct ggml_init_params params);
  663. GGML_API void ggml_reset(struct ggml_context * ctx);
  664. GGML_API void ggml_free (struct ggml_context * ctx);
  665. GGML_API size_t ggml_used_mem(const struct ggml_context * ctx);
  666. GGML_API size_t ggml_set_scratch (struct ggml_context * ctx, struct ggml_scratch scratch);
  667. GGML_API bool ggml_get_no_alloc(struct ggml_context * ctx);
  668. GGML_API void ggml_set_no_alloc(struct ggml_context * ctx, bool no_alloc);
  669. GGML_API void * ggml_get_mem_buffer (const struct ggml_context * ctx);
  670. GGML_API size_t ggml_get_mem_size (const struct ggml_context * ctx);
  671. GGML_API size_t ggml_get_max_tensor_size(const struct ggml_context * ctx);
  672. GGML_API struct ggml_tensor * ggml_new_tensor(
  673. struct ggml_context * ctx,
  674. enum ggml_type type,
  675. int n_dims,
  676. const int64_t *ne);
  677. GGML_API struct ggml_tensor * ggml_new_tensor_1d(
  678. struct ggml_context * ctx,
  679. enum ggml_type type,
  680. int64_t ne0);
  681. GGML_API struct ggml_tensor * ggml_new_tensor_2d(
  682. struct ggml_context * ctx,
  683. enum ggml_type type,
  684. int64_t ne0,
  685. int64_t ne1);
  686. GGML_API struct ggml_tensor * ggml_new_tensor_3d(
  687. struct ggml_context * ctx,
  688. enum ggml_type type,
  689. int64_t ne0,
  690. int64_t ne1,
  691. int64_t ne2);
  692. GGML_API struct ggml_tensor * ggml_new_tensor_4d(
  693. struct ggml_context * ctx,
  694. enum ggml_type type,
  695. int64_t ne0,
  696. int64_t ne1,
  697. int64_t ne2,
  698. int64_t ne3);
  699. GGML_API struct ggml_tensor * ggml_new_i32(struct ggml_context * ctx, int32_t value);
  700. GGML_API struct ggml_tensor * ggml_new_f32(struct ggml_context * ctx, float value);
  701. GGML_API struct ggml_tensor * ggml_dup_tensor (struct ggml_context * ctx, const struct ggml_tensor * src);
  702. GGML_API struct ggml_tensor * ggml_view_tensor(struct ggml_context * ctx, struct ggml_tensor * src);
  703. // Context tensor enumeration and lookup
  704. GGML_API struct ggml_tensor * ggml_get_first_tensor(const struct ggml_context * ctx);
  705. GGML_API struct ggml_tensor * ggml_get_next_tensor (const struct ggml_context * ctx, struct ggml_tensor * tensor);
  706. GGML_API struct ggml_tensor * ggml_get_tensor(struct ggml_context * ctx, const char * name);
  707. GGML_API struct ggml_tensor * ggml_set_zero(struct ggml_tensor * tensor);
  708. GGML_API struct ggml_tensor * ggml_set_i32 (struct ggml_tensor * tensor, int32_t value);
  709. GGML_API struct ggml_tensor * ggml_set_f32 (struct ggml_tensor * tensor, float value);
  710. // Converts a flat index into coordinates
  711. 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);
  712. GGML_API int32_t ggml_get_i32_1d(const struct ggml_tensor * tensor, int i);
  713. GGML_API void ggml_set_i32_1d(const struct ggml_tensor * tensor, int i, int32_t value);
  714. GGML_API int32_t ggml_get_i32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3);
  715. GGML_API void ggml_set_i32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3, int32_t value);
  716. GGML_API float ggml_get_f32_1d(const struct ggml_tensor * tensor, int i);
  717. GGML_API void ggml_set_f32_1d(const struct ggml_tensor * tensor, int i, float value);
  718. GGML_API float ggml_get_f32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3);
  719. GGML_API void ggml_set_f32_nd(const struct ggml_tensor * tensor, int i0, int i1, int i2, int i3, float value);
  720. GGML_API void * ggml_get_data (const struct ggml_tensor * tensor);
  721. GGML_API float * ggml_get_data_f32(const struct ggml_tensor * tensor);
  722. GGML_API enum ggml_unary_op ggml_get_unary_op(const struct ggml_tensor * tensor);
  723. GGML_API const char * ggml_get_name (const struct ggml_tensor * tensor);
  724. GGML_API struct ggml_tensor * ggml_set_name ( struct ggml_tensor * tensor, const char * name);
  725. GGML_ATTRIBUTE_FORMAT(2, 3)
  726. GGML_API struct ggml_tensor * ggml_format_name( struct ggml_tensor * tensor, const char * fmt, ...);
  727. //
  728. // operations on tensors with backpropagation
  729. //
  730. GGML_API struct ggml_tensor * ggml_dup(
  731. struct ggml_context * ctx,
  732. struct ggml_tensor * a);
  733. // in-place, returns view(a)
  734. GGML_API struct ggml_tensor * ggml_dup_inplace(
  735. struct ggml_context * ctx,
  736. struct ggml_tensor * a);
  737. GGML_API struct ggml_tensor * ggml_add(
  738. struct ggml_context * ctx,
  739. struct ggml_tensor * a,
  740. struct ggml_tensor * b);
  741. GGML_API struct ggml_tensor * ggml_add_inplace(
  742. struct ggml_context * ctx,
  743. struct ggml_tensor * a,
  744. struct ggml_tensor * b);
  745. GGML_API struct ggml_tensor * ggml_add_cast(
  746. struct ggml_context * ctx,
  747. struct ggml_tensor * a,
  748. struct ggml_tensor * b,
  749. enum ggml_type type);
  750. GGML_API struct ggml_tensor * ggml_add1(
  751. struct ggml_context * ctx,
  752. struct ggml_tensor * a,
  753. struct ggml_tensor * b);
  754. GGML_API struct ggml_tensor * ggml_add1_inplace(
  755. struct ggml_context * ctx,
  756. struct ggml_tensor * a,
  757. struct ggml_tensor * b);
  758. // dst = a
  759. // view(dst, nb1, nb2, nb3, offset) += b
  760. // return dst
  761. GGML_API struct ggml_tensor * ggml_acc(
  762. struct ggml_context * ctx,
  763. struct ggml_tensor * a,
  764. struct ggml_tensor * b,
  765. size_t nb1,
  766. size_t nb2,
  767. size_t nb3,
  768. size_t offset);
  769. GGML_API struct ggml_tensor * ggml_acc_inplace(
  770. struct ggml_context * ctx,
  771. struct ggml_tensor * a,
  772. struct ggml_tensor * b,
  773. size_t nb1,
  774. size_t nb2,
  775. size_t nb3,
  776. size_t offset);
  777. GGML_API struct ggml_tensor * ggml_sub(
  778. struct ggml_context * ctx,
  779. struct ggml_tensor * a,
  780. struct ggml_tensor * b);
  781. GGML_API struct ggml_tensor * ggml_sub_inplace(
  782. struct ggml_context * ctx,
  783. struct ggml_tensor * a,
  784. struct ggml_tensor * b);
  785. GGML_API struct ggml_tensor * ggml_mul(
  786. struct ggml_context * ctx,
  787. struct ggml_tensor * a,
  788. struct ggml_tensor * b);
  789. GGML_API struct ggml_tensor * ggml_mul_inplace(
  790. struct ggml_context * ctx,
  791. struct ggml_tensor * a,
  792. struct ggml_tensor * b);
  793. GGML_API struct ggml_tensor * ggml_div(
  794. struct ggml_context * ctx,
  795. struct ggml_tensor * a,
  796. struct ggml_tensor * b);
  797. GGML_API struct ggml_tensor * ggml_div_inplace(
  798. struct ggml_context * ctx,
  799. struct ggml_tensor * a,
  800. struct ggml_tensor * b);
  801. GGML_API struct ggml_tensor * ggml_sqr(
  802. struct ggml_context * ctx,
  803. struct ggml_tensor * a);
  804. GGML_API struct ggml_tensor * ggml_sqr_inplace(
  805. struct ggml_context * ctx,
  806. struct ggml_tensor * a);
  807. GGML_API struct ggml_tensor * ggml_sqrt(
  808. struct ggml_context * ctx,
  809. struct ggml_tensor * a);
  810. GGML_API struct ggml_tensor * ggml_sqrt_inplace(
  811. struct ggml_context * ctx,
  812. struct ggml_tensor * a);
  813. GGML_API struct ggml_tensor * ggml_log(
  814. struct ggml_context * ctx,
  815. struct ggml_tensor * a);
  816. GGML_API struct ggml_tensor * ggml_log_inplace(
  817. struct ggml_context * ctx,
  818. struct ggml_tensor * a);
  819. GGML_API struct ggml_tensor * ggml_sin(
  820. struct ggml_context * ctx,
  821. struct ggml_tensor * a);
  822. GGML_API struct ggml_tensor * ggml_sin_inplace(
  823. struct ggml_context * ctx,
  824. struct ggml_tensor * a);
  825. GGML_API struct ggml_tensor * ggml_cos(
  826. struct ggml_context * ctx,
  827. struct ggml_tensor * a);
  828. GGML_API struct ggml_tensor * ggml_cos_inplace(
  829. struct ggml_context * ctx,
  830. struct ggml_tensor * a);
  831. // return scalar
  832. GGML_API struct ggml_tensor * ggml_sum(
  833. struct ggml_context * ctx,
  834. struct ggml_tensor * a);
  835. // sums along rows, with input shape [a,b,c,d] return shape [1,b,c,d]
  836. GGML_API struct ggml_tensor * ggml_sum_rows(
  837. struct ggml_context * ctx,
  838. struct ggml_tensor * a);
  839. // mean along rows
  840. GGML_API struct ggml_tensor * ggml_mean(
  841. struct ggml_context * ctx,
  842. struct ggml_tensor * a);
  843. // argmax along rows
  844. GGML_API struct ggml_tensor * ggml_argmax(
  845. struct ggml_context * ctx,
  846. struct ggml_tensor * a);
  847. // count number of equal elements in a and b
  848. GGML_API struct ggml_tensor * ggml_count_equal(
  849. struct ggml_context * ctx,
  850. struct ggml_tensor * a,
  851. struct ggml_tensor * b);
  852. // if a is the same shape as b, and a is not parameter, return a
  853. // otherwise, return a new tensor: repeat(a) to fit in b
  854. GGML_API struct ggml_tensor * ggml_repeat(
  855. struct ggml_context * ctx,
  856. struct ggml_tensor * a,
  857. struct ggml_tensor * b);
  858. // sums repetitions in a into shape of b
  859. GGML_API struct ggml_tensor * ggml_repeat_back(
  860. struct ggml_context * ctx,
  861. struct ggml_tensor * a,
  862. struct ggml_tensor * b);
  863. // concat a and b along dim
  864. // used in stable-diffusion
  865. GGML_API struct ggml_tensor * ggml_concat(
  866. struct ggml_context * ctx,
  867. struct ggml_tensor * a,
  868. struct ggml_tensor * b,
  869. int dim);
  870. GGML_API struct ggml_tensor * ggml_abs(
  871. struct ggml_context * ctx,
  872. struct ggml_tensor * a);
  873. GGML_API struct ggml_tensor * ggml_abs_inplace(
  874. struct ggml_context * ctx,
  875. struct ggml_tensor * a);
  876. GGML_API struct ggml_tensor * ggml_sgn(
  877. struct ggml_context * ctx,
  878. struct ggml_tensor * a);
  879. GGML_API struct ggml_tensor * ggml_sgn_inplace(
  880. struct ggml_context * ctx,
  881. struct ggml_tensor * a);
  882. GGML_API struct ggml_tensor * ggml_neg(
  883. struct ggml_context * ctx,
  884. struct ggml_tensor * a);
  885. GGML_API struct ggml_tensor * ggml_neg_inplace(
  886. struct ggml_context * ctx,
  887. struct ggml_tensor * a);
  888. GGML_API struct ggml_tensor * ggml_step(
  889. struct ggml_context * ctx,
  890. struct ggml_tensor * a);
  891. GGML_API struct ggml_tensor * ggml_step_inplace(
  892. struct ggml_context * ctx,
  893. struct ggml_tensor * a);
  894. GGML_API struct ggml_tensor * ggml_tanh(
  895. struct ggml_context * ctx,
  896. struct ggml_tensor * a);
  897. GGML_API struct ggml_tensor * ggml_tanh_inplace(
  898. struct ggml_context * ctx,
  899. struct ggml_tensor * a);
  900. GGML_API struct ggml_tensor * ggml_elu(
  901. struct ggml_context * ctx,
  902. struct ggml_tensor * a);
  903. GGML_API struct ggml_tensor * ggml_elu_inplace(
  904. struct ggml_context * ctx,
  905. struct ggml_tensor * a);
  906. GGML_API struct ggml_tensor * ggml_relu(
  907. struct ggml_context * ctx,
  908. struct ggml_tensor * a);
  909. GGML_API struct ggml_tensor * ggml_leaky_relu(
  910. struct ggml_context * ctx,
  911. struct ggml_tensor * a, float negative_slope, bool inplace);
  912. GGML_API struct ggml_tensor * ggml_relu_inplace(
  913. struct ggml_context * ctx,
  914. struct ggml_tensor * a);
  915. GGML_API struct ggml_tensor * ggml_sigmoid(
  916. struct ggml_context * ctx,
  917. struct ggml_tensor * a);
  918. GGML_API struct ggml_tensor * ggml_sigmoid_inplace(
  919. struct ggml_context * ctx,
  920. struct ggml_tensor * a);
  921. GGML_API struct ggml_tensor * ggml_gelu(
  922. struct ggml_context * ctx,
  923. struct ggml_tensor * a);
  924. GGML_API struct ggml_tensor * ggml_gelu_inplace(
  925. struct ggml_context * ctx,
  926. struct ggml_tensor * a);
  927. GGML_API struct ggml_tensor * ggml_gelu_quick(
  928. struct ggml_context * ctx,
  929. struct ggml_tensor * a);
  930. GGML_API struct ggml_tensor * ggml_gelu_quick_inplace(
  931. struct ggml_context * ctx,
  932. struct ggml_tensor * a);
  933. GGML_API struct ggml_tensor * ggml_silu(
  934. struct ggml_context * ctx,
  935. struct ggml_tensor * a);
  936. GGML_API struct ggml_tensor * ggml_silu_inplace(
  937. struct ggml_context * ctx,
  938. struct ggml_tensor * a);
  939. // a - x
  940. // b - dy
  941. GGML_API struct ggml_tensor * ggml_silu_back(
  942. struct ggml_context * ctx,
  943. struct ggml_tensor * a,
  944. struct ggml_tensor * b);
  945. // hardswish(x) = x * relu6(x + 3) / 6
  946. GGML_API struct ggml_tensor * ggml_hardswish(
  947. struct ggml_context * ctx,
  948. struct ggml_tensor * a);
  949. // hardsigmoid(x) = relu6(x + 3) / 6
  950. GGML_API struct ggml_tensor * ggml_hardsigmoid(
  951. struct ggml_context * ctx,
  952. struct ggml_tensor * a);
  953. GGML_API struct ggml_tensor * ggml_exp(
  954. struct ggml_context * ctx,
  955. struct ggml_tensor * a);
  956. GGML_API struct ggml_tensor * ggml_exp_inplace(
  957. struct ggml_context * ctx,
  958. struct ggml_tensor * a);
  959. // normalize along rows
  960. GGML_API struct ggml_tensor * ggml_norm(
  961. struct ggml_context * ctx,
  962. struct ggml_tensor * a,
  963. float eps);
  964. GGML_API struct ggml_tensor * ggml_norm_inplace(
  965. struct ggml_context * ctx,
  966. struct ggml_tensor * a,
  967. float eps);
  968. GGML_API struct ggml_tensor * ggml_rms_norm(
  969. struct ggml_context * ctx,
  970. struct ggml_tensor * a,
  971. float eps);
  972. GGML_API struct ggml_tensor * ggml_rms_norm_inplace(
  973. struct ggml_context * ctx,
  974. struct ggml_tensor * a,
  975. float eps);
  976. // group normalize along ne0*ne1*n_groups
  977. // used in stable-diffusion
  978. GGML_API struct ggml_tensor * ggml_group_norm(
  979. struct ggml_context * ctx,
  980. struct ggml_tensor * a,
  981. int n_groups,
  982. float eps);
  983. GGML_API struct ggml_tensor * ggml_group_norm_inplace(
  984. struct ggml_context * ctx,
  985. struct ggml_tensor * a,
  986. int n_groups,
  987. float eps);
  988. // a - x
  989. // b - dy
  990. GGML_API struct ggml_tensor * ggml_rms_norm_back(
  991. struct ggml_context * ctx,
  992. struct ggml_tensor * a,
  993. struct ggml_tensor * b,
  994. float eps);
  995. // A: k columns, n rows => [ne03, ne02, n, k]
  996. // B: k columns, m rows (i.e. we transpose it internally) => [ne03 * x, ne02 * y, m, k]
  997. // result is n columns, m rows => [ne03 * x, ne02 * y, m, n]
  998. GGML_API struct ggml_tensor * ggml_mul_mat(
  999. struct ggml_context * ctx,
  1000. struct ggml_tensor * a,
  1001. struct ggml_tensor * b);
  1002. // change the precision of a matrix multiplication
  1003. // set to GGML_PREC_F32 for higher precision (useful for phi-2)
  1004. GGML_API void ggml_mul_mat_set_prec(
  1005. struct ggml_tensor * a,
  1006. enum ggml_prec prec);
  1007. // indirect matrix multiplication
  1008. GGML_API struct ggml_tensor * ggml_mul_mat_id(
  1009. struct ggml_context * ctx,
  1010. struct ggml_tensor * as,
  1011. struct ggml_tensor * b,
  1012. struct ggml_tensor * ids);
  1013. // A: m columns, n rows,
  1014. // B: p columns, n rows,
  1015. // result is m columns, p rows
  1016. GGML_API struct ggml_tensor * ggml_out_prod(
  1017. struct ggml_context * ctx,
  1018. struct ggml_tensor * a,
  1019. struct ggml_tensor * b);
  1020. //
  1021. // operations on tensors without backpropagation
  1022. //
  1023. GGML_API struct ggml_tensor * ggml_scale(
  1024. struct ggml_context * ctx,
  1025. struct ggml_tensor * a,
  1026. float s);
  1027. // in-place, returns view(a)
  1028. GGML_API struct ggml_tensor * ggml_scale_inplace(
  1029. struct ggml_context * ctx,
  1030. struct ggml_tensor * a,
  1031. float s);
  1032. // b -> view(a,offset,nb1,nb2,3), return modified a
  1033. GGML_API struct ggml_tensor * ggml_set(
  1034. struct ggml_context * ctx,
  1035. struct ggml_tensor * a,
  1036. struct ggml_tensor * b,
  1037. size_t nb1,
  1038. size_t nb2,
  1039. size_t nb3,
  1040. size_t offset); // in bytes
  1041. // b -> view(a,offset,nb1,nb2,3), return view(a)
  1042. GGML_API struct ggml_tensor * ggml_set_inplace(
  1043. struct ggml_context * ctx,
  1044. struct ggml_tensor * a,
  1045. struct ggml_tensor * b,
  1046. size_t nb1,
  1047. size_t nb2,
  1048. size_t nb3,
  1049. size_t offset); // in bytes
  1050. GGML_API struct ggml_tensor * ggml_set_1d(
  1051. struct ggml_context * ctx,
  1052. struct ggml_tensor * a,
  1053. struct ggml_tensor * b,
  1054. size_t offset); // in bytes
  1055. GGML_API struct ggml_tensor * ggml_set_1d_inplace(
  1056. struct ggml_context * ctx,
  1057. struct ggml_tensor * a,
  1058. struct ggml_tensor * b,
  1059. size_t offset); // in bytes
  1060. // b -> view(a,offset,nb1,nb2,3), return modified a
  1061. GGML_API struct ggml_tensor * ggml_set_2d(
  1062. struct ggml_context * ctx,
  1063. struct ggml_tensor * a,
  1064. struct ggml_tensor * b,
  1065. size_t nb1,
  1066. size_t offset); // in bytes
  1067. // b -> view(a,offset,nb1,nb2,3), return view(a)
  1068. GGML_API struct ggml_tensor * ggml_set_2d_inplace(
  1069. struct ggml_context * ctx,
  1070. struct ggml_tensor * a,
  1071. struct ggml_tensor * b,
  1072. size_t nb1,
  1073. size_t offset); // in bytes
  1074. // a -> b, return view(b)
  1075. GGML_API struct ggml_tensor * ggml_cpy(
  1076. struct ggml_context * ctx,
  1077. struct ggml_tensor * a,
  1078. struct ggml_tensor * b);
  1079. GGML_API struct ggml_tensor * ggml_cast(
  1080. struct ggml_context * ctx,
  1081. struct ggml_tensor * a,
  1082. enum ggml_type type);
  1083. // make contiguous
  1084. GGML_API struct ggml_tensor * ggml_cont(
  1085. struct ggml_context * ctx,
  1086. struct ggml_tensor * a);
  1087. // make contiguous, with new shape
  1088. GGML_API struct ggml_tensor * ggml_cont_1d(
  1089. struct ggml_context * ctx,
  1090. struct ggml_tensor * a,
  1091. int64_t ne0);
  1092. GGML_API struct ggml_tensor * ggml_cont_2d(
  1093. struct ggml_context * ctx,
  1094. struct ggml_tensor * a,
  1095. int64_t ne0,
  1096. int64_t ne1);
  1097. GGML_API struct ggml_tensor * ggml_cont_3d(
  1098. struct ggml_context * ctx,
  1099. struct ggml_tensor * a,
  1100. int64_t ne0,
  1101. int64_t ne1,
  1102. int64_t ne2);
  1103. GGML_API struct ggml_tensor * ggml_cont_4d(
  1104. struct ggml_context * ctx,
  1105. struct ggml_tensor * a,
  1106. int64_t ne0,
  1107. int64_t ne1,
  1108. int64_t ne2,
  1109. int64_t ne3);
  1110. // return view(a), b specifies the new shape
  1111. // TODO: when we start computing gradient, make a copy instead of view
  1112. GGML_API struct ggml_tensor * ggml_reshape(
  1113. struct ggml_context * ctx,
  1114. struct ggml_tensor * a,
  1115. struct ggml_tensor * b);
  1116. // return view(a)
  1117. // TODO: when we start computing gradient, make a copy instead of view
  1118. GGML_API struct ggml_tensor * ggml_reshape_1d(
  1119. struct ggml_context * ctx,
  1120. struct ggml_tensor * a,
  1121. int64_t ne0);
  1122. GGML_API struct ggml_tensor * ggml_reshape_2d(
  1123. struct ggml_context * ctx,
  1124. struct ggml_tensor * a,
  1125. int64_t ne0,
  1126. int64_t ne1);
  1127. // return view(a)
  1128. // TODO: when we start computing gradient, make a copy instead of view
  1129. GGML_API struct ggml_tensor * ggml_reshape_3d(
  1130. struct ggml_context * ctx,
  1131. struct ggml_tensor * a,
  1132. int64_t ne0,
  1133. int64_t ne1,
  1134. int64_t ne2);
  1135. GGML_API struct ggml_tensor * ggml_reshape_4d(
  1136. struct ggml_context * ctx,
  1137. struct ggml_tensor * a,
  1138. int64_t ne0,
  1139. int64_t ne1,
  1140. int64_t ne2,
  1141. int64_t ne3);
  1142. // offset in bytes
  1143. GGML_API struct ggml_tensor * ggml_view_1d(
  1144. struct ggml_context * ctx,
  1145. struct ggml_tensor * a,
  1146. int64_t ne0,
  1147. size_t offset);
  1148. GGML_API struct ggml_tensor * ggml_view_2d(
  1149. struct ggml_context * ctx,
  1150. struct ggml_tensor * a,
  1151. int64_t ne0,
  1152. int64_t ne1,
  1153. size_t nb1, // row stride in bytes
  1154. size_t offset);
  1155. GGML_API struct ggml_tensor * ggml_view_3d(
  1156. struct ggml_context * ctx,
  1157. struct ggml_tensor * a,
  1158. int64_t ne0,
  1159. int64_t ne1,
  1160. int64_t ne2,
  1161. size_t nb1, // row stride in bytes
  1162. size_t nb2, // slice stride in bytes
  1163. size_t offset);
  1164. GGML_API struct ggml_tensor * ggml_view_4d(
  1165. struct ggml_context * ctx,
  1166. struct ggml_tensor * a,
  1167. int64_t ne0,
  1168. int64_t ne1,
  1169. int64_t ne2,
  1170. int64_t ne3,
  1171. size_t nb1, // row stride in bytes
  1172. size_t nb2, // slice stride in bytes
  1173. size_t nb3,
  1174. size_t offset);
  1175. GGML_API struct ggml_tensor * ggml_permute(
  1176. struct ggml_context * ctx,
  1177. struct ggml_tensor * a,
  1178. int axis0,
  1179. int axis1,
  1180. int axis2,
  1181. int axis3);
  1182. // alias for ggml_permute(ctx, a, 1, 0, 2, 3)
  1183. GGML_API struct ggml_tensor * ggml_transpose(
  1184. struct ggml_context * ctx,
  1185. struct ggml_tensor * a);
  1186. // supports 3D: a->ne[2] == b->ne[1]
  1187. GGML_API struct ggml_tensor * ggml_get_rows(
  1188. struct ggml_context * ctx,
  1189. struct ggml_tensor * a, // data
  1190. struct ggml_tensor * b); // row indices
  1191. GGML_API struct ggml_tensor * ggml_get_rows_back(
  1192. struct ggml_context * ctx,
  1193. struct ggml_tensor * a, // gradients of ggml_get_rows result
  1194. struct ggml_tensor * b, // row indices
  1195. struct ggml_tensor * c); // data for ggml_get_rows, only used for its shape
  1196. GGML_API struct ggml_tensor * ggml_diag(
  1197. struct ggml_context * ctx,
  1198. struct ggml_tensor * a);
  1199. // set elements above the diagonal to -INF
  1200. GGML_API struct ggml_tensor * ggml_diag_mask_inf(
  1201. struct ggml_context * ctx,
  1202. struct ggml_tensor * a,
  1203. int n_past);
  1204. // in-place, returns view(a)
  1205. GGML_API struct ggml_tensor * ggml_diag_mask_inf_inplace(
  1206. struct ggml_context * ctx,
  1207. struct ggml_tensor * a,
  1208. int n_past);
  1209. // set elements above the diagonal to 0
  1210. GGML_API struct ggml_tensor * ggml_diag_mask_zero(
  1211. struct ggml_context * ctx,
  1212. struct ggml_tensor * a,
  1213. int n_past);
  1214. // in-place, returns view(a)
  1215. GGML_API struct ggml_tensor * ggml_diag_mask_zero_inplace(
  1216. struct ggml_context * ctx,
  1217. struct ggml_tensor * a,
  1218. int n_past);
  1219. GGML_API struct ggml_tensor * ggml_soft_max(
  1220. struct ggml_context * ctx,
  1221. struct ggml_tensor * a);
  1222. // in-place, returns view(a)
  1223. GGML_API struct ggml_tensor * ggml_soft_max_inplace(
  1224. struct ggml_context * ctx,
  1225. struct ggml_tensor * a);
  1226. // fused soft_max(a*scale + mask*(ALiBi slope))
  1227. // mask is optional
  1228. // max_bias = 0.0f for no ALiBi
  1229. GGML_API struct ggml_tensor * ggml_soft_max_ext(
  1230. struct ggml_context * ctx,
  1231. struct ggml_tensor * a,
  1232. struct ggml_tensor * mask,
  1233. float scale,
  1234. float max_bias);
  1235. GGML_API struct ggml_tensor * ggml_soft_max_back(
  1236. struct ggml_context * ctx,
  1237. struct ggml_tensor * a,
  1238. struct ggml_tensor * b);
  1239. // in-place, returns view(a)
  1240. GGML_API struct ggml_tensor * ggml_soft_max_back_inplace(
  1241. struct ggml_context * ctx,
  1242. struct ggml_tensor * a,
  1243. struct ggml_tensor * b);
  1244. // rotary position embedding
  1245. // if (mode & 1) - skip n_past elements (NOT SUPPORTED)
  1246. // if (mode & GGML_ROPE_TYPE_NEOX) - GPT-NeoX style
  1247. //
  1248. // b is an int32 vector with size a->ne[2], it contains the positions
  1249. GGML_API struct ggml_tensor * ggml_rope(
  1250. struct ggml_context * ctx,
  1251. struct ggml_tensor * a,
  1252. struct ggml_tensor * b,
  1253. int n_dims,
  1254. int mode);
  1255. // in-place, returns view(a)
  1256. GGML_API struct ggml_tensor * ggml_rope_inplace(
  1257. struct ggml_context * ctx,
  1258. struct ggml_tensor * a,
  1259. struct ggml_tensor * b,
  1260. int n_dims,
  1261. int mode);
  1262. // custom RoPE
  1263. // c is freq factors (e.g. phi3-128k), (optional)
  1264. GGML_API struct ggml_tensor * ggml_rope_ext(
  1265. struct ggml_context * ctx,
  1266. struct ggml_tensor * a,
  1267. struct ggml_tensor * b,
  1268. struct ggml_tensor * c,
  1269. int n_dims,
  1270. int mode,
  1271. int n_ctx_orig,
  1272. float freq_base,
  1273. float freq_scale,
  1274. float ext_factor,
  1275. float attn_factor,
  1276. float beta_fast,
  1277. float beta_slow);
  1278. // in-place, returns view(a)
  1279. GGML_API struct ggml_tensor * ggml_rope_ext_inplace(
  1280. struct ggml_context * ctx,
  1281. struct ggml_tensor * a,
  1282. struct ggml_tensor * b,
  1283. struct ggml_tensor * c,
  1284. int n_dims,
  1285. int mode,
  1286. int n_ctx_orig,
  1287. float freq_base,
  1288. float freq_scale,
  1289. float ext_factor,
  1290. float attn_factor,
  1291. float beta_fast,
  1292. float beta_slow);
  1293. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_rope_custom(
  1294. struct ggml_context * ctx,
  1295. struct ggml_tensor * a,
  1296. struct ggml_tensor * b,
  1297. int n_dims,
  1298. int mode,
  1299. int n_ctx_orig,
  1300. float freq_base,
  1301. float freq_scale,
  1302. float ext_factor,
  1303. float attn_factor,
  1304. float beta_fast,
  1305. float beta_slow),
  1306. "use ggml_rope_ext instead");
  1307. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_rope_custom_inplace(
  1308. struct ggml_context * ctx,
  1309. struct ggml_tensor * a,
  1310. struct ggml_tensor * b,
  1311. int n_dims,
  1312. int mode,
  1313. int n_ctx_orig,
  1314. float freq_base,
  1315. float freq_scale,
  1316. float ext_factor,
  1317. float attn_factor,
  1318. float beta_fast,
  1319. float beta_slow),
  1320. "use ggml_rope_ext_inplace instead");
  1321. // compute correction dims for YaRN RoPE scaling
  1322. void ggml_rope_yarn_corr_dims(
  1323. int n_dims, int n_ctx_orig, float freq_base, float beta_fast, float beta_slow, float dims[2]);
  1324. // rotary position embedding backward, i.e compute dx from dy
  1325. // a - dy
  1326. GGML_API struct ggml_tensor * ggml_rope_back(
  1327. struct ggml_context * ctx,
  1328. struct ggml_tensor * a, // gradients of ggml_rope result
  1329. struct ggml_tensor * b, // positions
  1330. struct ggml_tensor * c, // freq factors
  1331. int n_dims,
  1332. int mode,
  1333. int n_ctx_orig,
  1334. float freq_base,
  1335. float freq_scale,
  1336. float ext_factor,
  1337. float attn_factor,
  1338. float beta_fast,
  1339. float beta_slow);
  1340. // clamp
  1341. // in-place, returns view(a)
  1342. GGML_API struct ggml_tensor * ggml_clamp(
  1343. struct ggml_context * ctx,
  1344. struct ggml_tensor * a,
  1345. float min,
  1346. float max);
  1347. // im2col
  1348. // converts data into a format that effectively results in a convolution when combined with matrix multiplication
  1349. GGML_API struct ggml_tensor * ggml_im2col(
  1350. struct ggml_context * ctx,
  1351. struct ggml_tensor * a, // convolution kernel
  1352. struct ggml_tensor * b, // data
  1353. int s0, // stride dimension 0
  1354. int s1, // stride dimension 1
  1355. int p0, // padding dimension 0
  1356. int p1, // padding dimension 1
  1357. int d0, // dilation dimension 0
  1358. int d1, // dilation dimension 1
  1359. bool is_2D,
  1360. enum ggml_type dst_type);
  1361. GGML_API struct ggml_tensor * ggml_im2col_back(
  1362. struct ggml_context * ctx,
  1363. struct ggml_tensor * a, // convolution kernel
  1364. struct ggml_tensor * b, // gradient of im2col output
  1365. int64_t * ne, // shape of im2col input
  1366. int s0, // stride dimension 0
  1367. int s1, // stride dimension 1
  1368. int p0, // padding dimension 0
  1369. int p1, // padding dimension 1
  1370. int d0, // dilation dimension 0
  1371. int d1, // dilation dimension 1
  1372. bool is_2D);
  1373. GGML_API struct ggml_tensor * ggml_conv_depthwise_2d(
  1374. struct ggml_context * ctx,
  1375. struct ggml_tensor * a, // convolution kernel
  1376. struct ggml_tensor * b, // data
  1377. int s0, // stride dimension 0
  1378. int s1, // stride dimension 1
  1379. int p0, // padding dimension 0
  1380. int p1, // padding dimension 1
  1381. int d0, // dilation dimension 0
  1382. int d1); // dilation dimension 1
  1383. GGML_API struct ggml_tensor * ggml_conv_1d(
  1384. struct ggml_context * ctx,
  1385. struct ggml_tensor * a, // convolution kernel
  1386. struct ggml_tensor * b, // data
  1387. int s0, // stride
  1388. int p0, // padding
  1389. int d0); // dilation
  1390. // conv_1d with padding = half
  1391. // alias for ggml_conv_1d(a, b, s, a->ne[0]/2, d)
  1392. GGML_API struct ggml_tensor* ggml_conv_1d_ph(
  1393. struct ggml_context * ctx,
  1394. struct ggml_tensor * a, // convolution kernel
  1395. struct ggml_tensor * b, // data
  1396. int s, // stride
  1397. int d); // dilation
  1398. GGML_API struct ggml_tensor * ggml_conv_transpose_1d(
  1399. struct ggml_context * ctx,
  1400. struct ggml_tensor * a, // convolution kernel
  1401. struct ggml_tensor * b, // data
  1402. int s0, // stride
  1403. int p0, // padding
  1404. int d0); // dilation
  1405. GGML_API struct ggml_tensor * ggml_conv_2d(
  1406. struct ggml_context * ctx,
  1407. struct ggml_tensor * a, // convolution kernel
  1408. struct ggml_tensor * b, // data
  1409. int s0, // stride dimension 0
  1410. int s1, // stride dimension 1
  1411. int p0, // padding dimension 0
  1412. int p1, // padding dimension 1
  1413. int d0, // dilation dimension 0
  1414. int d1); // dilation dimension 1
  1415. // kernel size is a->ne[0] x a->ne[1]
  1416. // stride is equal to kernel size
  1417. // padding is zero
  1418. // example:
  1419. // a: 16 16 3 768
  1420. // b: 1024 1024 3 1
  1421. // res: 64 64 768 1
  1422. // used in sam
  1423. GGML_API struct ggml_tensor * ggml_conv_2d_sk_p0(
  1424. struct ggml_context * ctx,
  1425. struct ggml_tensor * a,
  1426. struct ggml_tensor * b);
  1427. // kernel size is a->ne[0] x a->ne[1]
  1428. // stride is 1
  1429. // padding is half
  1430. // example:
  1431. // a: 3 3 256 256
  1432. // b: 64 64 256 1
  1433. // res: 64 64 256 1
  1434. // used in sam
  1435. GGML_API struct ggml_tensor * ggml_conv_2d_s1_ph(
  1436. struct ggml_context * ctx,
  1437. struct ggml_tensor * a,
  1438. struct ggml_tensor * b);
  1439. GGML_API struct ggml_tensor * ggml_conv_transpose_2d_p0(
  1440. struct ggml_context * ctx,
  1441. struct ggml_tensor * a,
  1442. struct ggml_tensor * b,
  1443. int stride);
  1444. enum ggml_op_pool {
  1445. GGML_OP_POOL_MAX,
  1446. GGML_OP_POOL_AVG,
  1447. GGML_OP_POOL_COUNT,
  1448. };
  1449. GGML_API struct ggml_tensor * ggml_pool_1d(
  1450. struct ggml_context * ctx,
  1451. struct ggml_tensor * a,
  1452. enum ggml_op_pool op,
  1453. int k0, // kernel size
  1454. int s0, // stride
  1455. int p0); // padding
  1456. // the result will have 2*p0 padding for the first dimension
  1457. // and 2*p1 padding for the second dimension
  1458. GGML_API struct ggml_tensor * ggml_pool_2d(
  1459. struct ggml_context * ctx,
  1460. struct ggml_tensor * a,
  1461. enum ggml_op_pool op,
  1462. int k0,
  1463. int k1,
  1464. int s0,
  1465. int s1,
  1466. float p0,
  1467. float p1);
  1468. GGML_API struct ggml_tensor * ggml_pool_2d_back(
  1469. struct ggml_context * ctx,
  1470. struct ggml_tensor * a,
  1471. struct ggml_tensor * af, // "a"/input used in forward pass
  1472. enum ggml_op_pool op,
  1473. int k0,
  1474. int k1,
  1475. int s0,
  1476. int s1,
  1477. float p0,
  1478. float p1);
  1479. // nearest interpolate
  1480. // multiplies ne0 and ne1 by scale factor
  1481. // used in stable-diffusion
  1482. GGML_API struct ggml_tensor * ggml_upscale(
  1483. struct ggml_context * ctx,
  1484. struct ggml_tensor * a,
  1485. int scale_factor);
  1486. // nearest interpolate
  1487. // nearest interpolate to specified dimensions
  1488. // used in tortoise.cpp
  1489. GGML_API struct ggml_tensor * ggml_upscale_ext(
  1490. struct ggml_context * ctx,
  1491. struct ggml_tensor * a,
  1492. int ne0,
  1493. int ne1,
  1494. int ne2,
  1495. int ne3);
  1496. // pad each dimension with zeros: [x, ..., x] -> [x, ..., x, 0, ..., 0]
  1497. GGML_API struct ggml_tensor * ggml_pad(
  1498. struct ggml_context * ctx,
  1499. struct ggml_tensor * a,
  1500. int p0,
  1501. int p1,
  1502. int p2,
  1503. int p3);
  1504. // Ref: https://github.com/CompVis/stable-diffusion/blob/main/ldm/modules/diffusionmodules/util.py#L151
  1505. // timesteps: [N,]
  1506. // return: [N, dim]
  1507. GGML_API struct ggml_tensor * ggml_timestep_embedding(
  1508. struct ggml_context * ctx,
  1509. struct ggml_tensor * timesteps,
  1510. int dim,
  1511. int max_period);
  1512. // sort rows
  1513. enum ggml_sort_order {
  1514. GGML_SORT_ORDER_ASC,
  1515. GGML_SORT_ORDER_DESC,
  1516. };
  1517. GGML_API struct ggml_tensor * ggml_argsort(
  1518. struct ggml_context * ctx,
  1519. struct ggml_tensor * a,
  1520. enum ggml_sort_order order);
  1521. GGML_API struct ggml_tensor * ggml_arange(
  1522. struct ggml_context * ctx,
  1523. float start,
  1524. float stop,
  1525. float step);
  1526. // top k elements per row
  1527. GGML_API struct ggml_tensor * ggml_top_k(
  1528. struct ggml_context * ctx,
  1529. struct ggml_tensor * a,
  1530. int k);
  1531. #define GGML_KQ_MASK_PAD 32
  1532. // q: [n_embd, n_batch, n_head, 1]
  1533. // k: [n_embd, n_kv, n_head_kv, 1]
  1534. // v: [n_embd, n_kv, n_head_kv, 1] !! not transposed !!
  1535. // mask: [n_kv, n_batch_pad, 1, 1] !! n_batch_pad = GGML_PAD(n_batch, GGML_KQ_MASK_PAD) !!
  1536. // res: [n_embd, n_head, n_batch, 1] !! permuted !!
  1537. GGML_API struct ggml_tensor * ggml_flash_attn_ext(
  1538. struct ggml_context * ctx,
  1539. struct ggml_tensor * q,
  1540. struct ggml_tensor * k,
  1541. struct ggml_tensor * v,
  1542. struct ggml_tensor * mask,
  1543. float scale,
  1544. float max_bias,
  1545. float logit_softcap);
  1546. GGML_API void ggml_flash_attn_ext_set_prec(
  1547. struct ggml_tensor * a,
  1548. enum ggml_prec prec);
  1549. // TODO: needs to be adapted to ggml_flash_attn_ext
  1550. GGML_API struct ggml_tensor * ggml_flash_attn_back(
  1551. struct ggml_context * ctx,
  1552. struct ggml_tensor * q,
  1553. struct ggml_tensor * k,
  1554. struct ggml_tensor * v,
  1555. struct ggml_tensor * d,
  1556. bool masked);
  1557. GGML_API struct ggml_tensor * ggml_ssm_conv(
  1558. struct ggml_context * ctx,
  1559. struct ggml_tensor * sx,
  1560. struct ggml_tensor * c);
  1561. GGML_API struct ggml_tensor * ggml_ssm_scan(
  1562. struct ggml_context * ctx,
  1563. struct ggml_tensor * s,
  1564. struct ggml_tensor * x,
  1565. struct ggml_tensor * dt,
  1566. struct ggml_tensor * A,
  1567. struct ggml_tensor * B,
  1568. struct ggml_tensor * C);
  1569. // partition into non-overlapping windows with padding if needed
  1570. // example:
  1571. // a: 768 64 64 1
  1572. // w: 14
  1573. // res: 768 14 14 25
  1574. // used in sam
  1575. GGML_API struct ggml_tensor * ggml_win_part(
  1576. struct ggml_context * ctx,
  1577. struct ggml_tensor * a,
  1578. int w);
  1579. // reverse of ggml_win_part
  1580. // used in sam
  1581. GGML_API struct ggml_tensor * ggml_win_unpart(
  1582. struct ggml_context * ctx,
  1583. struct ggml_tensor * a,
  1584. int w0,
  1585. int h0,
  1586. int w);
  1587. GGML_API struct ggml_tensor * ggml_unary(
  1588. struct ggml_context * ctx,
  1589. struct ggml_tensor * a,
  1590. enum ggml_unary_op op);
  1591. GGML_API struct ggml_tensor * ggml_unary_inplace(
  1592. struct ggml_context * ctx,
  1593. struct ggml_tensor * a,
  1594. enum ggml_unary_op op);
  1595. // used in sam
  1596. GGML_API struct ggml_tensor * ggml_get_rel_pos(
  1597. struct ggml_context * ctx,
  1598. struct ggml_tensor * a,
  1599. int qh,
  1600. int kh);
  1601. // used in sam
  1602. GGML_API struct ggml_tensor * ggml_add_rel_pos(
  1603. struct ggml_context * ctx,
  1604. struct ggml_tensor * a,
  1605. struct ggml_tensor * pw,
  1606. struct ggml_tensor * ph);
  1607. GGML_API struct ggml_tensor * ggml_add_rel_pos_inplace(
  1608. struct ggml_context * ctx,
  1609. struct ggml_tensor * a,
  1610. struct ggml_tensor * pw,
  1611. struct ggml_tensor * ph);
  1612. GGML_API struct ggml_tensor * ggml_rwkv_wkv(
  1613. struct ggml_context * ctx,
  1614. struct ggml_tensor * k,
  1615. struct ggml_tensor * v,
  1616. struct ggml_tensor * r,
  1617. struct ggml_tensor * tf,
  1618. struct ggml_tensor * td,
  1619. struct ggml_tensor * state);
  1620. // custom operators
  1621. typedef void (*ggml_unary_op_f32_t) (const int, float *, const float *);
  1622. typedef void (*ggml_binary_op_f32_t)(const int, float *, const float *, const float *);
  1623. typedef void (*ggml_custom1_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *);
  1624. typedef void (*ggml_custom2_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1625. typedef void (*ggml_custom3_op_f32_t)(struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *, const struct ggml_tensor *);
  1626. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_f32(
  1627. struct ggml_context * ctx,
  1628. struct ggml_tensor * a,
  1629. ggml_unary_op_f32_t fun),
  1630. "use ggml_map_custom1 instead");
  1631. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_unary_inplace_f32(
  1632. struct ggml_context * ctx,
  1633. struct ggml_tensor * a,
  1634. ggml_unary_op_f32_t fun),
  1635. "use ggml_map_custom1_inplace instead");
  1636. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_f32(
  1637. struct ggml_context * ctx,
  1638. struct ggml_tensor * a,
  1639. struct ggml_tensor * b,
  1640. ggml_binary_op_f32_t fun),
  1641. "use ggml_map_custom2 instead");
  1642. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_binary_inplace_f32(
  1643. struct ggml_context * ctx,
  1644. struct ggml_tensor * a,
  1645. struct ggml_tensor * b,
  1646. ggml_binary_op_f32_t fun),
  1647. "use ggml_map_custom2_inplace instead");
  1648. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_f32(
  1649. struct ggml_context * ctx,
  1650. struct ggml_tensor * a,
  1651. ggml_custom1_op_f32_t fun),
  1652. "use ggml_map_custom1 instead");
  1653. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom1_inplace_f32(
  1654. struct ggml_context * ctx,
  1655. struct ggml_tensor * a,
  1656. ggml_custom1_op_f32_t fun),
  1657. "use ggml_map_custom1_inplace instead");
  1658. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_f32(
  1659. struct ggml_context * ctx,
  1660. struct ggml_tensor * a,
  1661. struct ggml_tensor * b,
  1662. ggml_custom2_op_f32_t fun),
  1663. "use ggml_map_custom2 instead");
  1664. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom2_inplace_f32(
  1665. struct ggml_context * ctx,
  1666. struct ggml_tensor * a,
  1667. struct ggml_tensor * b,
  1668. ggml_custom2_op_f32_t fun),
  1669. "use ggml_map_custom2_inplace instead");
  1670. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_f32(
  1671. struct ggml_context * ctx,
  1672. struct ggml_tensor * a,
  1673. struct ggml_tensor * b,
  1674. struct ggml_tensor * c,
  1675. ggml_custom3_op_f32_t fun),
  1676. "use ggml_map_custom3 instead");
  1677. GGML_DEPRECATED(GGML_API struct ggml_tensor * ggml_map_custom3_inplace_f32(
  1678. struct ggml_context * ctx,
  1679. struct ggml_tensor * a,
  1680. struct ggml_tensor * b,
  1681. struct ggml_tensor * c,
  1682. ggml_custom3_op_f32_t fun),
  1683. "use ggml_map_custom3_inplace instead");
  1684. // custom operators v2
  1685. typedef void (*ggml_custom1_op_t)(struct ggml_tensor * dst , const struct ggml_tensor * a, int ith, int nth, void * userdata);
  1686. 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);
  1687. 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);
  1688. #define GGML_N_TASKS_MAX (-1)
  1689. // n_tasks == GGML_N_TASKS_MAX means to use max number of tasks
  1690. GGML_API struct ggml_tensor * ggml_map_custom1(
  1691. struct ggml_context * ctx,
  1692. struct ggml_tensor * a,
  1693. ggml_custom1_op_t fun,
  1694. int n_tasks,
  1695. void * userdata);
  1696. GGML_API struct ggml_tensor * ggml_map_custom1_inplace(
  1697. struct ggml_context * ctx,
  1698. struct ggml_tensor * a,
  1699. ggml_custom1_op_t fun,
  1700. int n_tasks,
  1701. void * userdata);
  1702. GGML_API struct ggml_tensor * ggml_map_custom2(
  1703. struct ggml_context * ctx,
  1704. struct ggml_tensor * a,
  1705. struct ggml_tensor * b,
  1706. ggml_custom2_op_t fun,
  1707. int n_tasks,
  1708. void * userdata);
  1709. GGML_API struct ggml_tensor * ggml_map_custom2_inplace(
  1710. struct ggml_context * ctx,
  1711. struct ggml_tensor * a,
  1712. struct ggml_tensor * b,
  1713. ggml_custom2_op_t fun,
  1714. int n_tasks,
  1715. void * userdata);
  1716. GGML_API struct ggml_tensor * ggml_map_custom3(
  1717. struct ggml_context * ctx,
  1718. struct ggml_tensor * a,
  1719. struct ggml_tensor * b,
  1720. struct ggml_tensor * c,
  1721. ggml_custom3_op_t fun,
  1722. int n_tasks,
  1723. void * userdata);
  1724. GGML_API struct ggml_tensor * ggml_map_custom3_inplace(
  1725. struct ggml_context * ctx,
  1726. struct ggml_tensor * a,
  1727. struct ggml_tensor * b,
  1728. struct ggml_tensor * c,
  1729. ggml_custom3_op_t fun,
  1730. int n_tasks,
  1731. void * userdata);
  1732. // loss function
  1733. GGML_API struct ggml_tensor * ggml_cross_entropy_loss(
  1734. struct ggml_context * ctx,
  1735. struct ggml_tensor * a, // logits
  1736. struct ggml_tensor * b); // labels
  1737. GGML_API struct ggml_tensor * ggml_cross_entropy_loss_back(
  1738. struct ggml_context * ctx,
  1739. struct ggml_tensor * a, // logits
  1740. struct ggml_tensor * b, // labels
  1741. struct ggml_tensor * c); // gradients of cross_entropy_loss result
  1742. // AdamW optimizer step
  1743. // Paper: https://arxiv.org/pdf/1711.05101v3.pdf
  1744. // PyTorch: https://pytorch.org/docs/stable/generated/torch.optim.AdamW.html
  1745. GGML_API struct ggml_tensor * ggml_opt_step_adamw(
  1746. struct ggml_context * ctx,
  1747. struct ggml_tensor * a,
  1748. struct ggml_tensor * grad,
  1749. float alpha,
  1750. float beta1,
  1751. float beta2,
  1752. float eps,
  1753. float wd); // weight decay
  1754. //
  1755. // automatic differentiation
  1756. //
  1757. GGML_API void ggml_set_param(struct ggml_context * ctx, struct ggml_tensor * tensor);
  1758. GGML_API void ggml_set_loss(struct ggml_tensor * tensor);
  1759. GGML_API void ggml_build_forward_expand (struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1760. GGML_API void ggml_build_backward_expand(struct ggml_context * ctx, struct ggml_cgraph * gf, struct ggml_cgraph * gb, bool accumulate);
  1761. GGML_API void ggml_build_opt_adamw(
  1762. struct ggml_context * ctx,
  1763. struct ggml_cgraph * gf,
  1764. struct ggml_cgraph * gb,
  1765. float alpha,
  1766. float beta1,
  1767. float beta2,
  1768. float eps,
  1769. float wd); // weight decay
  1770. // graph allocation in a context
  1771. GGML_API struct ggml_cgraph * ggml_new_graph (struct ggml_context * ctx); // size = GGML_DEFAULT_GRAPH_SIZE, grads = false
  1772. GGML_API struct ggml_cgraph * ggml_new_graph_custom(struct ggml_context * ctx, size_t size, bool grads);
  1773. GGML_API struct ggml_cgraph * ggml_graph_dup (struct ggml_context * ctx, struct ggml_cgraph * cgraph);
  1774. GGML_API void ggml_graph_cpy (struct ggml_cgraph * src, struct ggml_cgraph * dst);
  1775. GGML_API void ggml_graph_reset (struct ggml_cgraph * cgraph); // set regular grads + optimizer momenta to 0, set loss grad to 1
  1776. GGML_API void ggml_graph_clear (struct ggml_cgraph * cgraph);
  1777. GGML_API int ggml_graph_size (struct ggml_cgraph * cgraph);
  1778. GGML_API struct ggml_tensor * ggml_graph_node (struct ggml_cgraph * cgraph, int i); // if i < 0, returns nodes[n_nodes + i]
  1779. GGML_API struct ggml_tensor ** ggml_graph_nodes (struct ggml_cgraph * cgraph);
  1780. GGML_API int ggml_graph_n_nodes(struct ggml_cgraph * cgraph);
  1781. GGML_API void ggml_graph_add_node(struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  1782. GGML_API size_t ggml_graph_overhead(void);
  1783. GGML_API size_t ggml_graph_overhead_custom(size_t size, bool grads);
  1784. GGML_API struct ggml_threadpool_params ggml_threadpool_params_default(int n_threads);
  1785. GGML_API void ggml_threadpool_params_init (struct ggml_threadpool_params * p, int n_threads);
  1786. GGML_API bool ggml_threadpool_params_match (const struct ggml_threadpool_params * p0, const struct ggml_threadpool_params * p1);
  1787. GGML_API struct ggml_threadpool * ggml_threadpool_new (struct ggml_threadpool_params * params);
  1788. GGML_API void ggml_threadpool_free (struct ggml_threadpool * threadpool);
  1789. GGML_API int ggml_threadpool_get_n_threads(struct ggml_threadpool * threadpool);
  1790. GGML_API void ggml_threadpool_pause (struct ggml_threadpool * threadpool);
  1791. GGML_API void ggml_threadpool_resume (struct ggml_threadpool * threadpool);
  1792. // ggml_graph_plan() has to be called before ggml_graph_compute()
  1793. // when plan.work_size > 0, caller must allocate memory for plan.work_data
  1794. GGML_API struct ggml_cplan ggml_graph_plan(
  1795. const struct ggml_cgraph * cgraph,
  1796. int n_threads, /* = GGML_DEFAULT_N_THREADS */
  1797. struct ggml_threadpool * threadpool /* = NULL */ );
  1798. GGML_API enum ggml_status ggml_graph_compute(struct ggml_cgraph * cgraph, struct ggml_cplan * cplan);
  1799. // same as ggml_graph_compute() but the work data is allocated as a part of the context
  1800. // note: the drawback of this API is that you must have ensured that the context has enough memory for the work data
  1801. GGML_API enum ggml_status ggml_graph_compute_with_ctx(struct ggml_context * ctx, struct ggml_cgraph * cgraph, int n_threads);
  1802. GGML_API struct ggml_tensor * ggml_graph_get_tensor(struct ggml_cgraph * cgraph, const char * name);
  1803. GGML_API void ggml_graph_export(const struct ggml_cgraph * cgraph, const char * fname);
  1804. GGML_API struct ggml_cgraph * ggml_graph_import(const char * fname, struct ggml_context ** ctx_data, struct ggml_context ** ctx_eval);
  1805. // print info and performance information for the graph
  1806. GGML_API void ggml_graph_print(const struct ggml_cgraph * cgraph);
  1807. // dump the graph into a file using the dot format
  1808. GGML_API void ggml_graph_dump_dot(const struct ggml_cgraph * gb, const struct ggml_cgraph * gf, const char * filename);
  1809. // build gradient checkpointing backward graph gb for gf using provided checkpoints
  1810. // gb_tmp will contain original backward graph with rewritten backward process nodes,
  1811. // but without the second forward pass nodes.
  1812. GGML_API void ggml_build_backward_gradient_checkpointing(
  1813. struct ggml_context * ctx,
  1814. struct ggml_cgraph * gf,
  1815. struct ggml_cgraph * gb,
  1816. struct ggml_cgraph * gb_tmp,
  1817. struct ggml_tensor * * checkpoints,
  1818. int n_checkpoints);
  1819. //
  1820. // optimization
  1821. //
  1822. // optimization methods
  1823. enum ggml_opt_type {
  1824. GGML_OPT_TYPE_ADAM,
  1825. GGML_OPT_TYPE_LBFGS,
  1826. };
  1827. // linesearch methods
  1828. enum ggml_linesearch {
  1829. GGML_LINESEARCH_DEFAULT = 1,
  1830. GGML_LINESEARCH_BACKTRACKING_ARMIJO = 0,
  1831. GGML_LINESEARCH_BACKTRACKING_WOLFE = 1,
  1832. GGML_LINESEARCH_BACKTRACKING_STRONG_WOLFE = 2,
  1833. };
  1834. // optimization return values
  1835. enum ggml_opt_result {
  1836. GGML_OPT_RESULT_OK = 0,
  1837. GGML_OPT_RESULT_DID_NOT_CONVERGE,
  1838. GGML_OPT_RESULT_NO_CONTEXT,
  1839. GGML_OPT_RESULT_INVALID_WOLFE,
  1840. GGML_OPT_RESULT_FAIL,
  1841. GGML_OPT_RESULT_CANCEL,
  1842. GGML_LINESEARCH_FAIL = -128,
  1843. GGML_LINESEARCH_MINIMUM_STEP,
  1844. GGML_LINESEARCH_MAXIMUM_STEP,
  1845. GGML_LINESEARCH_MAXIMUM_ITERATIONS,
  1846. GGML_LINESEARCH_INVALID_PARAMETERS,
  1847. };
  1848. typedef void (*ggml_opt_callback)(void * data, int accum_step, float * sched, bool * cancel);
  1849. typedef void (*ggml_log_callback)(enum ggml_log_level level, const char * text, void * user_data);
  1850. // Set callback for all future logging events.
  1851. // If this is not called, or NULL is supplied, everything is output on stderr.
  1852. GGML_API void ggml_log_set(ggml_log_callback log_callback, void * user_data);
  1853. // optimization parameters
  1854. //
  1855. // see ggml.c (ggml_opt_default_params) for default values
  1856. //
  1857. struct ggml_opt_params {
  1858. enum ggml_opt_type type;
  1859. size_t graph_size;
  1860. int n_threads;
  1861. // delta-based convergence test
  1862. //
  1863. // if past == 0 - disabled
  1864. // if past > 0:
  1865. // stop if |f(x) - f(x_past)| < delta * max(1, |f(x)|)
  1866. //
  1867. int past;
  1868. float delta;
  1869. // maximum number of iterations without improvement
  1870. //
  1871. // if 0 - disabled
  1872. // if > 0:
  1873. // assume convergence if no cost improvement in this number of iterations
  1874. //
  1875. int max_no_improvement;
  1876. bool print_forward_graph;
  1877. bool print_backward_graph;
  1878. int n_gradient_accumulation;
  1879. // ADAM parameters
  1880. struct {
  1881. int n_iter;
  1882. float sched; // schedule multiplier (fixed, decay or warmup)
  1883. float decay; // weight decay for AdamW, use 0.0f to disable
  1884. int decay_min_ndim; // minimum number of tensor dimension to apply weight decay
  1885. float alpha; // learning rate
  1886. float beta1;
  1887. float beta2;
  1888. float eps; // epsilon for numerical stability
  1889. float eps_f; // epsilon for convergence test
  1890. float eps_g; // epsilon for convergence test
  1891. float gclip; // gradient clipping
  1892. } adam;
  1893. // LBFGS parameters
  1894. struct {
  1895. int m; // number of corrections to approximate the inv. Hessian
  1896. int n_iter;
  1897. int max_linesearch;
  1898. float eps; // convergence tolerance
  1899. float ftol; // line search tolerance
  1900. float wolfe;
  1901. float min_step;
  1902. float max_step;
  1903. enum ggml_linesearch linesearch;
  1904. } lbfgs;
  1905. };
  1906. struct ggml_opt_context {
  1907. struct ggml_context * ctx;
  1908. struct ggml_opt_params params;
  1909. int iter;
  1910. int64_t nx; // number of parameter elements
  1911. bool just_initialized;
  1912. float loss_before;
  1913. float loss_after;
  1914. struct {
  1915. struct ggml_tensor * g; // current gradient
  1916. struct ggml_tensor * m; // first moment
  1917. struct ggml_tensor * v; // second moment
  1918. struct ggml_tensor * pf; // past function values
  1919. float fx_best;
  1920. float fx_prev;
  1921. int n_no_improvement;
  1922. } adam;
  1923. struct {
  1924. struct ggml_tensor * x; // current parameters
  1925. struct ggml_tensor * xp; // previous parameters
  1926. struct ggml_tensor * g; // current gradient
  1927. struct ggml_tensor * gp; // previous gradient
  1928. struct ggml_tensor * d; // search direction
  1929. struct ggml_tensor * pf; // past function values
  1930. struct ggml_tensor * lmal; // the L-BFGS memory alpha
  1931. struct ggml_tensor * lmys; // the L-BFGS memory ys
  1932. struct ggml_tensor * lms; // the L-BFGS memory s
  1933. struct ggml_tensor * lmy; // the L-BFGS memory y
  1934. float fx_best;
  1935. float step;
  1936. int j;
  1937. int k;
  1938. int end;
  1939. int n_no_improvement;
  1940. } lbfgs;
  1941. };
  1942. GGML_API struct ggml_opt_params ggml_opt_default_params(enum ggml_opt_type type);
  1943. // optimize the function defined by the tensor f
  1944. GGML_API enum ggml_opt_result ggml_opt(
  1945. struct ggml_context * ctx,
  1946. struct ggml_opt_params params,
  1947. struct ggml_tensor * f);
  1948. // initialize optimizer context
  1949. GGML_API void ggml_opt_init(
  1950. struct ggml_context * ctx,
  1951. struct ggml_opt_context * opt,
  1952. struct ggml_opt_params params,
  1953. int64_t nx);
  1954. // continue optimizing the function defined by the tensor f
  1955. GGML_API enum ggml_opt_result ggml_opt_resume(
  1956. struct ggml_context * ctx,
  1957. struct ggml_opt_context * opt,
  1958. struct ggml_tensor * f);
  1959. // continue optimizing the function defined by the tensor f
  1960. GGML_API enum ggml_opt_result ggml_opt_resume_g(
  1961. struct ggml_context * ctx,
  1962. struct ggml_opt_context * opt,
  1963. struct ggml_tensor * f,
  1964. struct ggml_cgraph * gf,
  1965. struct ggml_cgraph * gb,
  1966. ggml_opt_callback callback,
  1967. void * callback_data);
  1968. //
  1969. // tensor flags
  1970. //
  1971. GGML_API void ggml_set_input(struct ggml_tensor * tensor);
  1972. GGML_API void ggml_set_output(struct ggml_tensor * tensor);
  1973. //
  1974. // quantization
  1975. //
  1976. // - ggml_quantize_init can be called multiple times with the same type
  1977. // it will only initialize the quantization tables for the first call or after ggml_quantize_free
  1978. // automatically called by ggml_quantize_chunk for convenience
  1979. //
  1980. // - ggml_quantize_free will free any memory allocated by ggml_quantize_init
  1981. // call this at the end of the program to avoid memory leaks
  1982. //
  1983. // note: these are thread-safe
  1984. //
  1985. GGML_API void ggml_quantize_init(enum ggml_type type);
  1986. GGML_API void ggml_quantize_free(void);
  1987. // some quantization type cannot be used without an importance matrix
  1988. GGML_API bool ggml_quantize_requires_imatrix(enum ggml_type type);
  1989. // calls ggml_quantize_init internally (i.e. can allocate memory)
  1990. GGML_API size_t ggml_quantize_chunk(
  1991. enum ggml_type type,
  1992. const float * src,
  1993. void * dst,
  1994. int64_t start,
  1995. int64_t nrows,
  1996. int64_t n_per_row,
  1997. const float * imatrix);
  1998. //
  1999. // gguf
  2000. //
  2001. enum gguf_type {
  2002. GGUF_TYPE_UINT8 = 0,
  2003. GGUF_TYPE_INT8 = 1,
  2004. GGUF_TYPE_UINT16 = 2,
  2005. GGUF_TYPE_INT16 = 3,
  2006. GGUF_TYPE_UINT32 = 4,
  2007. GGUF_TYPE_INT32 = 5,
  2008. GGUF_TYPE_FLOAT32 = 6,
  2009. GGUF_TYPE_BOOL = 7,
  2010. GGUF_TYPE_STRING = 8,
  2011. GGUF_TYPE_ARRAY = 9,
  2012. GGUF_TYPE_UINT64 = 10,
  2013. GGUF_TYPE_INT64 = 11,
  2014. GGUF_TYPE_FLOAT64 = 12,
  2015. GGUF_TYPE_COUNT, // marks the end of the enum
  2016. };
  2017. struct gguf_context;
  2018. struct gguf_init_params {
  2019. bool no_alloc;
  2020. // if not NULL, create a ggml_context and allocate the tensor data in it
  2021. struct ggml_context ** ctx;
  2022. };
  2023. GGML_API struct gguf_context * gguf_init_empty(void);
  2024. GGML_API struct gguf_context * gguf_init_from_file(const char * fname, struct gguf_init_params params);
  2025. //GGML_API struct gguf_context * gguf_init_from_buffer(..);
  2026. GGML_API void gguf_free(struct gguf_context * ctx);
  2027. GGML_API const char * gguf_type_name(enum gguf_type type);
  2028. GGML_API int gguf_get_version (const struct gguf_context * ctx);
  2029. GGML_API size_t gguf_get_alignment (const struct gguf_context * ctx);
  2030. GGML_API size_t gguf_get_data_offset(const struct gguf_context * ctx);
  2031. GGML_API void * gguf_get_data (const struct gguf_context * ctx);
  2032. GGML_API int gguf_get_n_kv(const struct gguf_context * ctx);
  2033. GGML_API int gguf_find_key(const struct gguf_context * ctx, const char * key);
  2034. GGML_API const char * gguf_get_key (const struct gguf_context * ctx, int key_id);
  2035. GGML_API enum gguf_type gguf_get_kv_type (const struct gguf_context * ctx, int key_id);
  2036. GGML_API enum gguf_type gguf_get_arr_type(const struct gguf_context * ctx, int key_id);
  2037. // will abort if the wrong type is used for the key
  2038. GGML_API uint8_t gguf_get_val_u8 (const struct gguf_context * ctx, int key_id);
  2039. GGML_API int8_t gguf_get_val_i8 (const struct gguf_context * ctx, int key_id);
  2040. GGML_API uint16_t gguf_get_val_u16 (const struct gguf_context * ctx, int key_id);
  2041. GGML_API int16_t gguf_get_val_i16 (const struct gguf_context * ctx, int key_id);
  2042. GGML_API uint32_t gguf_get_val_u32 (const struct gguf_context * ctx, int key_id);
  2043. GGML_API int32_t gguf_get_val_i32 (const struct gguf_context * ctx, int key_id);
  2044. GGML_API float gguf_get_val_f32 (const struct gguf_context * ctx, int key_id);
  2045. GGML_API uint64_t gguf_get_val_u64 (const struct gguf_context * ctx, int key_id);
  2046. GGML_API int64_t gguf_get_val_i64 (const struct gguf_context * ctx, int key_id);
  2047. GGML_API double gguf_get_val_f64 (const struct gguf_context * ctx, int key_id);
  2048. GGML_API bool gguf_get_val_bool(const struct gguf_context * ctx, int key_id);
  2049. GGML_API const char * gguf_get_val_str (const struct gguf_context * ctx, int key_id);
  2050. GGML_API const void * gguf_get_val_data(const struct gguf_context * ctx, int key_id);
  2051. GGML_API int gguf_get_arr_n (const struct gguf_context * ctx, int key_id);
  2052. GGML_API const void * gguf_get_arr_data(const struct gguf_context * ctx, int key_id);
  2053. GGML_API const char * gguf_get_arr_str (const struct gguf_context * ctx, int key_id, int i);
  2054. GGML_API int gguf_get_n_tensors (const struct gguf_context * ctx);
  2055. GGML_API int gguf_find_tensor (const struct gguf_context * ctx, const char * name);
  2056. GGML_API size_t gguf_get_tensor_offset(const struct gguf_context * ctx, int i);
  2057. GGML_API char * gguf_get_tensor_name (const struct gguf_context * ctx, int i);
  2058. GGML_API enum ggml_type gguf_get_tensor_type (const struct gguf_context * ctx, int i);
  2059. // removes key if it exists
  2060. GGML_API void gguf_remove_key(struct gguf_context * ctx, const char * key);
  2061. // overrides existing values or adds a new one
  2062. GGML_API void gguf_set_val_u8 (struct gguf_context * ctx, const char * key, uint8_t val);
  2063. GGML_API void gguf_set_val_i8 (struct gguf_context * ctx, const char * key, int8_t val);
  2064. GGML_API void gguf_set_val_u16 (struct gguf_context * ctx, const char * key, uint16_t val);
  2065. GGML_API void gguf_set_val_i16 (struct gguf_context * ctx, const char * key, int16_t val);
  2066. GGML_API void gguf_set_val_u32 (struct gguf_context * ctx, const char * key, uint32_t val);
  2067. GGML_API void gguf_set_val_i32 (struct gguf_context * ctx, const char * key, int32_t val);
  2068. GGML_API void gguf_set_val_f32 (struct gguf_context * ctx, const char * key, float val);
  2069. GGML_API void gguf_set_val_u64 (struct gguf_context * ctx, const char * key, uint64_t val);
  2070. GGML_API void gguf_set_val_i64 (struct gguf_context * ctx, const char * key, int64_t val);
  2071. GGML_API void gguf_set_val_f64 (struct gguf_context * ctx, const char * key, double val);
  2072. GGML_API void gguf_set_val_bool(struct gguf_context * ctx, const char * key, bool val);
  2073. GGML_API void gguf_set_val_str (struct gguf_context * ctx, const char * key, const char * val);
  2074. GGML_API void gguf_set_arr_data(struct gguf_context * ctx, const char * key, enum gguf_type type, const void * data, int n);
  2075. GGML_API void gguf_set_arr_str (struct gguf_context * ctx, const char * key, const char ** data, int n);
  2076. // set or add KV pairs from another context
  2077. GGML_API void gguf_set_kv(struct gguf_context * ctx, struct gguf_context * src);
  2078. // manage tensor info
  2079. GGML_API void gguf_add_tensor(struct gguf_context * ctx, const struct ggml_tensor * tensor);
  2080. GGML_API void gguf_set_tensor_type(struct gguf_context * ctx, const char * name, enum ggml_type type);
  2081. GGML_API void gguf_set_tensor_data(struct gguf_context * ctx, const char * name, const void * data, size_t size);
  2082. // writing gguf files can be done in 2 ways:
  2083. //
  2084. // - write the entire gguf_context to a binary file in a single pass:
  2085. //
  2086. // gguf_write_to_file(ctx, fname);
  2087. //
  2088. // - first prepare a file with a placeholder for the meta data, write the tensor data, then write the meta data:
  2089. //
  2090. // FILE * f = fopen(fname, "wb");
  2091. // fseek(f, gguf_get_meta_size(ctx), SEEK_SET);
  2092. // fwrite(f, ...);
  2093. // void * data = gguf_meta_get_meta_data(ctx);
  2094. // fseek(f, 0, SEEK_SET);
  2095. // fwrite(f, data, gguf_get_meta_size(ctx));
  2096. // free(data);
  2097. // fclose(f);
  2098. //
  2099. // write the entire context to a binary file
  2100. GGML_API void gguf_write_to_file(const struct gguf_context * ctx, const char * fname, bool only_meta);
  2101. // get the size in bytes of the meta data (header, kv pairs, tensor info) including padding
  2102. GGML_API size_t gguf_get_meta_size(const struct gguf_context * ctx);
  2103. GGML_API void gguf_get_meta_data(const struct gguf_context * ctx, void * data);
  2104. //
  2105. // system info
  2106. //
  2107. GGML_API int ggml_cpu_has_avx (void);
  2108. GGML_API int ggml_cpu_has_avx_vnni (void);
  2109. GGML_API int ggml_cpu_has_avx2 (void);
  2110. GGML_API int ggml_cpu_has_avx512 (void);
  2111. GGML_API int ggml_cpu_has_avx512_vbmi(void);
  2112. GGML_API int ggml_cpu_has_avx512_vnni(void);
  2113. GGML_API int ggml_cpu_has_avx512_bf16(void);
  2114. GGML_API int ggml_cpu_has_amx_int8 (void);
  2115. GGML_API int ggml_cpu_has_fma (void);
  2116. GGML_API int ggml_cpu_has_neon (void);
  2117. GGML_API int ggml_cpu_has_sve (void);
  2118. GGML_API int ggml_cpu_has_arm_fma (void);
  2119. GGML_API int ggml_cpu_has_metal (void);
  2120. GGML_API int ggml_cpu_has_f16c (void);
  2121. GGML_API int ggml_cpu_has_fp16_va (void);
  2122. GGML_API int ggml_cpu_has_wasm_simd (void);
  2123. GGML_API int ggml_cpu_has_blas (void);
  2124. GGML_API int ggml_cpu_has_cuda (void);
  2125. GGML_API int ggml_cpu_has_vulkan (void);
  2126. GGML_API int ggml_cpu_has_kompute (void);
  2127. GGML_API int ggml_cpu_has_gpublas (void);
  2128. GGML_API int ggml_cpu_has_sse3 (void);
  2129. GGML_API int ggml_cpu_has_ssse3 (void);
  2130. GGML_API int ggml_cpu_has_riscv_v (void);
  2131. GGML_API int ggml_cpu_has_sycl (void);
  2132. GGML_API int ggml_cpu_has_rpc (void);
  2133. GGML_API int ggml_cpu_has_vsx (void);
  2134. GGML_API int ggml_cpu_has_matmul_int8(void);
  2135. GGML_API int ggml_cpu_has_cann (void);
  2136. GGML_API int ggml_cpu_has_llamafile (void);
  2137. // get the sve vector length in bytes
  2138. GGML_API int ggml_cpu_get_sve_cnt(void);
  2139. //
  2140. // Internal types and functions exposed for tests and benchmarks
  2141. //
  2142. #ifdef __cplusplus
  2143. // restrict not standard in C++
  2144. #define GGML_RESTRICT
  2145. #else
  2146. #define GGML_RESTRICT restrict
  2147. #endif
  2148. typedef void (*ggml_to_float_t) (const void * GGML_RESTRICT x, float * GGML_RESTRICT y, int64_t k);
  2149. typedef void (*ggml_from_float_t)(const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int64_t k);
  2150. typedef void (*ggml_from_float_to_mat_t)
  2151. (const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int64_t nr, int64_t k, int64_t bs);
  2152. typedef void (*ggml_vec_dot_t) (int n, float * GGML_RESTRICT s, size_t bs, const void * GGML_RESTRICT x, size_t bx,
  2153. const void * GGML_RESTRICT y, size_t by, int nrc);
  2154. typedef void (*ggml_gemv_t) (int n, float * GGML_RESTRICT s, size_t bs, const void * GGML_RESTRICT x,
  2155. const void * GGML_RESTRICT y, int nr, int nc);
  2156. typedef void (*ggml_gemm_t) (int n, float * GGML_RESTRICT s, size_t bs, const void * GGML_RESTRICT x,
  2157. const void * GGML_RESTRICT y, int nr, int nc);
  2158. struct ggml_type_traits {
  2159. const char * type_name;
  2160. int64_t blck_size;
  2161. int64_t blck_size_interleave; // interleave elements in blocks
  2162. size_t type_size;
  2163. bool is_quantized;
  2164. ggml_to_float_t to_float;
  2165. ggml_from_float_t from_float;
  2166. ggml_from_float_t from_float_ref;
  2167. ggml_from_float_to_mat_t from_float_to_mat;
  2168. ggml_vec_dot_t vec_dot;
  2169. enum ggml_type vec_dot_type;
  2170. int64_t nrows; // number of rows to process simultaneously
  2171. int64_t ncols; // number of columns to process simultaneously
  2172. ggml_gemv_t gemv;
  2173. ggml_gemm_t gemm;
  2174. };
  2175. GGML_API const struct ggml_type_traits * ggml_get_type_traits(enum ggml_type type);
  2176. #ifdef __cplusplus
  2177. }
  2178. #endif