ggml.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826
  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(ctx0, &gf);
  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. // struct ggml_tensor * a = ggml_new_tensor_2d(ctx, GGML_TYPE_F32, 2, 3);
  133. //
  134. // // a[1, 2] = 1.0f;
  135. // *(float *) ((char *) a->data + 2*a->nb[1] + 1*a->nb[0]) = 1.0f;
  136. //
  137. // // a[2, 0] = 2.0f;
  138. // *(float *) ((char *) a->data + 0*a->nb[1] + 2*a->nb[0]) = 2.0f;
  139. //
  140. // ...
  141. // }
  142. //
  143. // Alternatively, there are helper functions, such as ggml_get_f32_1d() and ggml_set_f32_1d() that can be used.
  144. //
  145. // ## The matrix multiplication operator (ggml_mul_mat)
  146. //
  147. // TODO
  148. //
  149. //
  150. // ## Multi-threading
  151. //
  152. // TODO
  153. //
  154. //
  155. // ## Overview of ggml.c
  156. //
  157. // TODO
  158. //
  159. //
  160. // ## SIMD optimizations
  161. //
  162. // TODO
  163. //
  164. //
  165. // ## Debugging ggml
  166. //
  167. // TODO
  168. //
  169. //
  170. #ifdef __cplusplus
  171. extern "C" {
  172. #endif
  173. #include <stdint.h>
  174. #include <stddef.h>
  175. #include <stdbool.h>
  176. #define GGML_MAX_DIMS 4
  177. #define GGML_MAX_NODES 4096
  178. #define GGML_MAX_PARAMS 16
  179. #define GGML_MAX_CONTEXTS 64
  180. #define GGML_MAX_OPT 4
  181. #define GGML_DEFAULT_N_THREADS 4
  182. #ifdef __ARM_NEON
  183. // we use the built-in 16-bit float type
  184. typedef __fp16 ggml_fp16_t;
  185. #else
  186. typedef uint16_t ggml_fp16_t;
  187. #endif
  188. // convert FP16 <-> FP32
  189. float ggml_fp16_to_fp32(ggml_fp16_t x);
  190. ggml_fp16_t ggml_fp32_to_fp16(float x);
  191. struct ggml_object;
  192. struct ggml_context;
  193. enum ggml_type {
  194. // explicitly numbered values are used in llama.cpp files
  195. GGML_TYPE_F32 = 0,
  196. GGML_TYPE_F16 = 1,
  197. GGML_TYPE_Q4_0 = 2,
  198. GGML_TYPE_Q4_1 = 3,
  199. GGML_TYPE_I8,
  200. GGML_TYPE_I16,
  201. GGML_TYPE_I32,
  202. GGML_TYPE_COUNT,
  203. };
  204. // available tensor operations:
  205. enum ggml_op {
  206. GGML_OP_NONE = 0,
  207. GGML_OP_DUP,
  208. GGML_OP_ADD,
  209. GGML_OP_SUB,
  210. GGML_OP_MUL,
  211. GGML_OP_DIV,
  212. GGML_OP_SQR,
  213. GGML_OP_SQRT,
  214. GGML_OP_SUM,
  215. GGML_OP_MEAN,
  216. GGML_OP_REPEAT,
  217. GGML_OP_ABS,
  218. GGML_OP_SGN,
  219. GGML_OP_NEG,
  220. GGML_OP_STEP,
  221. GGML_OP_RELU,
  222. GGML_OP_GELU,
  223. GGML_OP_SILU,
  224. GGML_OP_NORM, // normalize
  225. GGML_OP_RMS_NORM,
  226. GGML_OP_MUL_MAT,
  227. GGML_OP_SCALE,
  228. GGML_OP_CPY,
  229. GGML_OP_CONT,
  230. GGML_OP_RESHAPE,
  231. GGML_OP_VIEW,
  232. GGML_OP_PERMUTE,
  233. GGML_OP_TRANSPOSE,
  234. GGML_OP_GET_ROWS,
  235. GGML_OP_DIAG_MASK_INF,
  236. GGML_OP_SOFT_MAX,
  237. GGML_OP_ROPE,
  238. GGML_OP_CONV_1D_1S,
  239. GGML_OP_CONV_1D_2S,
  240. GGML_OP_FLASH_ATTN,
  241. GGML_OP_FLASH_FF,
  242. GGML_OP_COUNT,
  243. };
  244. // ggml object
  245. struct ggml_object {
  246. size_t offs;
  247. size_t size;
  248. struct ggml_object * next;
  249. char padding[8];
  250. };
  251. static const size_t GGML_OBJECT_SIZE = sizeof(struct ggml_object);
  252. // n-dimensional tensor
  253. struct ggml_tensor {
  254. enum ggml_type type;
  255. int n_dims;
  256. int64_t ne[GGML_MAX_DIMS]; // number of elements
  257. size_t nb[GGML_MAX_DIMS]; // stride in bytes:
  258. // nb[0] = sizeof(type)
  259. // nb[1] = nb[0] * ne[0] + padding
  260. // nb[i] = nb[i-1] * ne[i-1]
  261. // compute data
  262. enum ggml_op op;
  263. bool is_param;
  264. struct ggml_tensor * grad;
  265. struct ggml_tensor * src0;
  266. struct ggml_tensor * src1;
  267. struct ggml_tensor * opt[GGML_MAX_OPT];
  268. // thread scheduling
  269. int n_tasks;
  270. // performance
  271. int perf_runs;
  272. int64_t perf_cycles;
  273. int64_t perf_time_us;
  274. void * data;
  275. char padding[8];
  276. };
  277. // computation graph
  278. struct ggml_cgraph {
  279. int n_nodes;
  280. int n_leafs;
  281. int n_threads;
  282. size_t work_size;
  283. struct ggml_tensor * work;
  284. struct ggml_tensor * nodes[GGML_MAX_NODES];
  285. struct ggml_tensor * grads[GGML_MAX_NODES];
  286. struct ggml_tensor * leafs[GGML_MAX_NODES];
  287. // performance
  288. int perf_runs;
  289. int64_t perf_cycles;
  290. int64_t perf_time_us;
  291. };
  292. // scratch buffer
  293. struct ggml_scratch {
  294. size_t offs;
  295. size_t size;
  296. void * data;
  297. };
  298. struct ggml_init_params {
  299. // memory pool
  300. size_t mem_size; // bytes
  301. void * mem_buffer; // if NULL, memory will be allocated internally
  302. bool no_alloc; // don't allocate memory for the tensor data
  303. };
  304. void ggml_time_init(void); // call this once at the beginning of the program
  305. int64_t ggml_time_ms(void);
  306. int64_t ggml_time_us(void);
  307. int64_t ggml_cycles(void);
  308. int64_t ggml_cycles_per_ms(void);
  309. void ggml_print_object (const struct ggml_object * obj);
  310. void ggml_print_objects(const struct ggml_context * ctx);
  311. int64_t ggml_nelements(const struct ggml_tensor * tensor);
  312. size_t ggml_nbytes (const struct ggml_tensor * tensor);
  313. int ggml_blck_size (enum ggml_type type);
  314. size_t ggml_type_size (enum ggml_type type); // size in bytes for all elements in a block
  315. float ggml_type_sizef(enum ggml_type type); // ggml_type_size()/ggml_blck_size() as float
  316. size_t ggml_element_size(const struct ggml_tensor * tensor);
  317. struct ggml_context * ggml_init(struct ggml_init_params params);
  318. void ggml_free(struct ggml_context * ctx);
  319. size_t ggml_used_mem(const struct ggml_context * ctx);
  320. size_t ggml_set_scratch(struct ggml_context * ctx, struct ggml_scratch scratch);
  321. struct ggml_tensor * ggml_new_tensor(
  322. struct ggml_context * ctx,
  323. enum ggml_type type,
  324. int n_dims,
  325. const int64_t *ne);
  326. struct ggml_tensor * ggml_new_tensor_1d(
  327. struct ggml_context * ctx,
  328. enum ggml_type type,
  329. int64_t ne0);
  330. struct ggml_tensor * ggml_new_tensor_2d(
  331. struct ggml_context * ctx,
  332. enum ggml_type type,
  333. int64_t ne0,
  334. int64_t ne1);
  335. struct ggml_tensor * ggml_new_tensor_3d(
  336. struct ggml_context * ctx,
  337. enum ggml_type type,
  338. int64_t ne0,
  339. int64_t ne1,
  340. int64_t ne2);
  341. struct ggml_tensor * ggml_new_tensor_4d(
  342. struct ggml_context * ctx,
  343. enum ggml_type type,
  344. int64_t ne0,
  345. int64_t ne1,
  346. int64_t ne2,
  347. int64_t ne3);
  348. struct ggml_tensor * ggml_new_i32(struct ggml_context * ctx, int32_t value);
  349. struct ggml_tensor * ggml_new_f32(struct ggml_context * ctx, float value);
  350. struct ggml_tensor * ggml_dup_tensor (struct ggml_context * ctx, const struct ggml_tensor * src);
  351. struct ggml_tensor * ggml_view_tensor(struct ggml_context * ctx, const struct ggml_tensor * src);
  352. struct ggml_tensor * ggml_set_zero(struct ggml_tensor * tensor);
  353. struct ggml_tensor * ggml_set_i32 (struct ggml_tensor * tensor, int32_t value);
  354. struct ggml_tensor * ggml_set_f32 (struct ggml_tensor * tensor, float value);
  355. int32_t ggml_get_i32_1d(const struct ggml_tensor * tensor, int i);
  356. void ggml_set_i32_1d(const struct ggml_tensor * tensor, int i, int32_t value);
  357. float ggml_get_f32_1d(const struct ggml_tensor * tensor, int i);
  358. void ggml_set_f32_1d(const struct ggml_tensor * tensor, int i, float value);
  359. void * ggml_get_data (const struct ggml_tensor * tensor);
  360. float * ggml_get_data_f32(const struct ggml_tensor * tensor);
  361. //
  362. // operations on tensors with backpropagation
  363. //
  364. struct ggml_tensor * ggml_dup(
  365. struct ggml_context * ctx,
  366. struct ggml_tensor * a);
  367. struct ggml_tensor * ggml_add(
  368. struct ggml_context * ctx,
  369. struct ggml_tensor * a,
  370. struct ggml_tensor * b);
  371. struct ggml_tensor * ggml_sub(
  372. struct ggml_context * ctx,
  373. struct ggml_tensor * a,
  374. struct ggml_tensor * b);
  375. struct ggml_tensor * ggml_mul(
  376. struct ggml_context * ctx,
  377. struct ggml_tensor * a,
  378. struct ggml_tensor * b);
  379. struct ggml_tensor * ggml_div(
  380. struct ggml_context * ctx,
  381. struct ggml_tensor * a,
  382. struct ggml_tensor * b);
  383. struct ggml_tensor * ggml_sqr(
  384. struct ggml_context * ctx,
  385. struct ggml_tensor * a);
  386. struct ggml_tensor * ggml_sqrt(
  387. struct ggml_context * ctx,
  388. struct ggml_tensor * a);
  389. // return scalar
  390. // TODO: compute sum along rows
  391. struct ggml_tensor * ggml_sum(
  392. struct ggml_context * ctx,
  393. struct ggml_tensor * a);
  394. // mean along rows
  395. struct ggml_tensor * ggml_mean(
  396. struct ggml_context * ctx,
  397. struct ggml_tensor * a);
  398. // if a is the same shape as b, and a is not parameter, return a
  399. // otherwise, return a new tensor: repeat(a) to fit in b
  400. struct ggml_tensor * ggml_repeat(
  401. struct ggml_context * ctx,
  402. struct ggml_tensor * a,
  403. struct ggml_tensor * b);
  404. struct ggml_tensor * ggml_abs(
  405. struct ggml_context * ctx,
  406. struct ggml_tensor * a);
  407. struct ggml_tensor * ggml_sgn(
  408. struct ggml_context * ctx,
  409. struct ggml_tensor * a);
  410. struct ggml_tensor * ggml_neg(
  411. struct ggml_context * ctx,
  412. struct ggml_tensor * a);
  413. struct ggml_tensor * ggml_step(
  414. struct ggml_context * ctx,
  415. struct ggml_tensor * a);
  416. struct ggml_tensor * ggml_relu(
  417. struct ggml_context * ctx,
  418. struct ggml_tensor * a);
  419. // TODO: double-check this computation is correct
  420. struct ggml_tensor * ggml_gelu(
  421. struct ggml_context * ctx,
  422. struct ggml_tensor * a);
  423. struct ggml_tensor * ggml_silu(
  424. struct ggml_context * ctx,
  425. struct ggml_tensor * a);
  426. // normalize along rows
  427. // TODO: eps is hardcoded to 1e-5 for now
  428. struct ggml_tensor * ggml_norm(
  429. struct ggml_context * ctx,
  430. struct ggml_tensor * a);
  431. struct ggml_tensor * ggml_rms_norm(
  432. struct ggml_context * ctx,
  433. struct ggml_tensor * a);
  434. // A: m rows, n columns
  435. // B: p rows, n columns (i.e. we transpose it internally)
  436. // result is m columns, p rows
  437. struct ggml_tensor * ggml_mul_mat(
  438. struct ggml_context * ctx,
  439. struct ggml_tensor * a,
  440. struct ggml_tensor * b);
  441. //
  442. // operations on tensors without backpropagation
  443. //
  444. // in-place, returns view(a)
  445. struct ggml_tensor * ggml_scale(
  446. struct ggml_context * ctx,
  447. struct ggml_tensor * a,
  448. struct ggml_tensor * b);
  449. // a -> b, return view(b)
  450. struct ggml_tensor * ggml_cpy(
  451. struct ggml_context * ctx,
  452. struct ggml_tensor * a,
  453. struct ggml_tensor * b);
  454. // make contiguous
  455. struct ggml_tensor * ggml_cont(
  456. struct ggml_context * ctx,
  457. struct ggml_tensor * a);
  458. // return view(a), b specifies the new shape
  459. // TODO: when we start computing gradient, make a copy instead of view
  460. struct ggml_tensor * ggml_reshape(
  461. struct ggml_context * ctx,
  462. struct ggml_tensor * a,
  463. struct ggml_tensor * b);
  464. // return view(a)
  465. // TODO: when we start computing gradient, make a copy instead of view
  466. struct ggml_tensor * ggml_reshape_2d(
  467. struct ggml_context * ctx,
  468. struct ggml_tensor * a,
  469. int64_t ne0,
  470. int64_t ne1);
  471. // return view(a)
  472. // TODO: when we start computing gradient, make a copy instead of view
  473. struct ggml_tensor * ggml_reshape_3d(
  474. struct ggml_context * ctx,
  475. struct ggml_tensor * a,
  476. int64_t ne0,
  477. int64_t ne1,
  478. int64_t ne2);
  479. // offset in bytes
  480. struct ggml_tensor * ggml_view_1d(
  481. struct ggml_context * ctx,
  482. struct ggml_tensor * a,
  483. int64_t ne0,
  484. size_t offset);
  485. struct ggml_tensor * ggml_view_2d(
  486. struct ggml_context * ctx,
  487. struct ggml_tensor * a,
  488. int64_t ne0,
  489. int64_t ne1,
  490. size_t nb1, // row stride in bytes
  491. size_t offset);
  492. struct ggml_tensor * ggml_view_3d(
  493. struct ggml_context * ctx,
  494. struct ggml_tensor * a,
  495. int64_t ne0,
  496. int64_t ne1,
  497. int64_t ne2,
  498. size_t nb1, // row stride in bytes
  499. size_t nb2, // slice stride in bytes
  500. size_t offset);
  501. struct ggml_tensor * ggml_permute(
  502. struct ggml_context * ctx,
  503. struct ggml_tensor * a,
  504. int axis0,
  505. int axis1,
  506. int axis2,
  507. int axis3);
  508. // alias for ggml_permute(ctx, a, 1, 0, 2, 3)
  509. struct ggml_tensor * ggml_transpose(
  510. struct ggml_context * ctx,
  511. struct ggml_tensor * a);
  512. struct ggml_tensor * ggml_get_rows(
  513. struct ggml_context * ctx,
  514. struct ggml_tensor * a,
  515. struct ggml_tensor * b);
  516. // set elements above the diagonal to -INF
  517. // in-place, returns view(a)
  518. struct ggml_tensor * ggml_diag_mask_inf(
  519. struct ggml_context * ctx,
  520. struct ggml_tensor * a,
  521. int n_past);
  522. // in-place, returns view(a)
  523. struct ggml_tensor * ggml_soft_max(
  524. struct ggml_context * ctx,
  525. struct ggml_tensor * a);
  526. // rotary position embedding
  527. // in-place, returns view(a)
  528. // if mode == 1, skip n_past elements
  529. // TODO: avoid creating a new tensor every time
  530. struct ggml_tensor * ggml_rope(
  531. struct ggml_context * ctx,
  532. struct ggml_tensor * a,
  533. int n_past,
  534. int n_dims,
  535. int mode);
  536. // padding = 1
  537. // TODO: we don't support extra parameters for now
  538. // that's why we are hard-coding the stride, padding, and dilation
  539. // not great ..
  540. struct ggml_tensor * ggml_conv_1d_1s(
  541. struct ggml_context * ctx,
  542. struct ggml_tensor * a,
  543. struct ggml_tensor * b);
  544. struct ggml_tensor * ggml_conv_1d_2s(
  545. struct ggml_context * ctx,
  546. struct ggml_tensor * a,
  547. struct ggml_tensor * b);
  548. struct ggml_tensor * ggml_flash_attn(
  549. struct ggml_context * ctx,
  550. struct ggml_tensor * q,
  551. struct ggml_tensor * k,
  552. struct ggml_tensor * v,
  553. bool masked);
  554. struct ggml_tensor * ggml_flash_ff(
  555. struct ggml_context * ctx,
  556. struct ggml_tensor * a,
  557. struct ggml_tensor * b0,
  558. struct ggml_tensor * b1,
  559. struct ggml_tensor * c0,
  560. struct ggml_tensor * c1);
  561. //
  562. // automatic differentiation
  563. //
  564. void ggml_set_param(
  565. struct ggml_context * ctx,
  566. struct ggml_tensor * tensor);
  567. void ggml_build_forward_expand(struct ggml_cgraph * cgraph, struct ggml_tensor * tensor);
  568. struct ggml_cgraph ggml_build_forward (struct ggml_tensor * tensor);
  569. struct ggml_cgraph ggml_build_backward(struct ggml_context * ctx, struct ggml_cgraph * gf, bool keep);
  570. void ggml_graph_compute(struct ggml_context * ctx, struct ggml_cgraph * cgraph);
  571. void ggml_graph_reset (struct ggml_cgraph * cgraph);
  572. // print info and performance information for the graph
  573. void ggml_graph_print(const struct ggml_cgraph * cgraph);
  574. // dump the graph into a file using the dot format
  575. void ggml_graph_dump_dot(const struct ggml_cgraph * gb, const struct ggml_cgraph * gf, const char * filename);
  576. //
  577. // optimization
  578. //
  579. // optimization methods
  580. enum ggml_opt_type {
  581. GGML_OPT_ADAM,
  582. GGML_OPT_LBFGS,
  583. };
  584. // linesearch methods
  585. enum ggml_linesearch {
  586. GGML_LINESEARCH_DEFAULT = 1,
  587. GGML_LINESEARCH_BACKTRACKING_ARMIJO = 0,
  588. GGML_LINESEARCH_BACKTRACKING_WOLFE = 1,
  589. GGML_LINESEARCH_BACKTRACKING_STRONG_WOLFE = 2,
  590. };
  591. // optimization return values
  592. enum ggml_opt_result {
  593. GGML_OPT_OK = 0,
  594. GGML_OPT_DID_NOT_CONVERGE,
  595. GGML_OPT_NO_CONTEXT,
  596. GGML_OPT_INVALID_WOLFE,
  597. GGML_OPT_FAIL,
  598. GGML_LINESEARCH_FAIL = -128,
  599. GGML_LINESEARCH_MINIMUM_STEP,
  600. GGML_LINESEARCH_MAXIMUM_STEP,
  601. GGML_LINESEARCH_MAXIMUM_ITERATIONS,
  602. GGML_LINESEARCH_INVALID_PARAMETERS,
  603. };
  604. // optimization parameters
  605. //
  606. // see ggml.c (ggml_opt_default_params) for default values
  607. //
  608. struct ggml_opt_params {
  609. enum ggml_opt_type type;
  610. int n_threads;
  611. // delta-based convergence test
  612. //
  613. // if past == 0 - disabled
  614. // if past > 0:
  615. // stop if |f(x) - f(x_past)| < delta * max(1, |f(x)|)
  616. //
  617. int past;
  618. float delta;
  619. // maximum number of iterations without improvement
  620. //
  621. // if 0 - disabled
  622. // if > 0:
  623. // assume convergence if no cost improvement in this number of iterations
  624. //
  625. int max_no_improvement;
  626. bool print_forward_graph;
  627. bool print_backward_graph;
  628. // ADAM parameters
  629. struct {
  630. int n_iter;
  631. float alpha; // learning rate
  632. float beta1;
  633. float beta2;
  634. float eps; // epsilon for numerical stability
  635. float eps_f; // epsilon for convergence test
  636. float eps_g; // epsilon for convergence test
  637. } adam;
  638. // LBFGS parameters
  639. struct {
  640. int m; // number of corrections to approximate the inv. Hessian
  641. int n_iter;
  642. int max_linesearch;
  643. float eps; // convergence tolerance
  644. float ftol; // line search tolerance
  645. float wolfe;
  646. float min_step;
  647. float max_step;
  648. enum ggml_linesearch linesearch;
  649. } lbfgs;
  650. };
  651. struct ggml_opt_params ggml_opt_default_params(enum ggml_opt_type type);
  652. // optimize the function defined by the tensor f
  653. enum ggml_opt_result ggml_opt(
  654. struct ggml_context * ctx,
  655. struct ggml_opt_params params,
  656. struct ggml_tensor * f);
  657. //
  658. // quantization
  659. //
  660. size_t ggml_quantize_q4_0(const float * src, void * dst, int n, int k, int64_t * hist);
  661. size_t ggml_quantize_q4_1(const float * src, void * dst, int n, int k, int64_t * hist);
  662. //
  663. // system info
  664. //
  665. int ggml_cpu_has_avx(void);
  666. int ggml_cpu_has_avx2(void);
  667. int ggml_cpu_has_avx512(void);
  668. int ggml_cpu_has_fma(void);
  669. int ggml_cpu_has_neon(void);
  670. int ggml_cpu_has_arm_fma(void);
  671. int ggml_cpu_has_f16c(void);
  672. int ggml_cpu_has_fp16_va(void);
  673. int ggml_cpu_has_wasm_simd(void);
  674. int ggml_cpu_has_blas(void);
  675. int ggml_cpu_has_sse3(void);
  676. int ggml_cpu_has_vsx(void);
  677. //
  678. // Internal types and functions exposed for tests and benchmarks
  679. //
  680. #ifdef __cplusplus
  681. // restrict not standard in C++
  682. #define GGML_RESTRICT
  683. #else
  684. #define GGML_RESTRICT restrict
  685. #endif
  686. typedef void (*dequantize_row_q_t)(const void * GGML_RESTRICT x, float * GGML_RESTRICT y, int k);
  687. typedef void (*quantize_row_q_t)(const float * GGML_RESTRICT x, void * GGML_RESTRICT y, int k);
  688. typedef void (*vec_dot_q_t)(const int n, float * GGML_RESTRICT s, const void * GGML_RESTRICT x, const void * GGML_RESTRICT y);
  689. typedef struct {
  690. dequantize_row_q_t dequantize_row_q;
  691. quantize_row_q_t quantize_row_q;
  692. quantize_row_q_t quantize_row_q_reference;
  693. vec_dot_q_t vec_dot_q;
  694. } quantize_fns_t;
  695. quantize_fns_t ggml_internal_get_quantize_fn(size_t i);
  696. #ifdef __cplusplus
  697. }
  698. #endif