ggml.h 71 KB

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