ggml.go 23.1 KB
Newer Older
Michael Yang's avatar
Michael Yang committed
1
2
package ggml

3
4
5
6
7
8
// #cgo CPPFLAGS: -I${SRCDIR}/ggml/include
// #include <stdlib.h>
// #include <stdint.h>
// #include "ggml.h"
// #include "ggml-cpu.h"
// #include "ggml-backend.h"
Michael Yang's avatar
Michael Yang committed
9
10
11
import "C"

import (
12
	"errors"
Michael Yang's avatar
Michael Yang committed
13
14
15
	"fmt"
	"io"
	"log/slog"
16
	"maps"
Michael Yang's avatar
Michael Yang committed
17
	"os"
18
19
20
21
	"slices"
	"strconv"
	"strings"
	"unicode"
Michael Yang's avatar
Michael Yang committed
22
23
24
25
26
	"unsafe"

	"github.com/ollama/ollama/format"
	fs "github.com/ollama/ollama/fs/ggml"
	"github.com/ollama/ollama/ml"
27
	ggml "github.com/ollama/ollama/ml/backend/ggml/ggml/src"
Michael Yang's avatar
Michael Yang committed
28
29
30
	"golang.org/x/sync/errgroup"
)

Michael Yang's avatar
Michael Yang committed
31
32
33
34
35
func devices() []*C.struct_ggml_backend_device {
	ggml.OnceLoad()
	ds := make([]*C.struct_ggml_backend_device, C.ggml_backend_dev_count())
	for i := range ds {
		ds[i] = C.ggml_backend_dev_get(C.size_t(i))
Michael Yang's avatar
Michael Yang committed
36
	}
Michael Yang's avatar
Michael Yang committed
37
38

	return ds
39
}
Michael Yang's avatar
Michael Yang committed
40
41

type Backend struct {
42
43
44
	meta    *fs.GGML
	sched   *C.struct_ggml_backend_sched
	tensors map[string]*C.struct_ggml_tensor
Michael Yang's avatar
Michael Yang committed
45
46
47
48
49
50
51
52
53

	// input is the backend used for inputs
	input *C.struct_ggml_backend

	// output is the backend used for outputs
	output *C.struct_ggml_backend

	// layers is the backend used for repeating layers
	layers map[int]*C.struct_ggml_backend
54

55
	flashAttention bool
Michael Yang's avatar
Michael Yang committed
56
57
58

	// maxGraphNodes is the maximum allowed number of graph nodes in this scheduler
	maxGraphNodes int
Michael Yang's avatar
Michael Yang committed
59
60
}

61
func New(r *os.File, params ml.BackendParams) (ml.Backend, error) {
Michael Yang's avatar
Michael Yang committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
	meta, n, err := fs.Decode(r, -1)
	if err != nil {
		return nil, err
	}

	slog.Info(
		"",
		"architecture", meta.KV().Architecture(),
		"file_type", meta.KV().FileType(),
		"name", meta.KV().String("general.name"),
		"description", meta.KV().String("general.description"),
		"num_tensors", len(meta.Tensors().Items()),
		"num_key_values", len(meta.KV()),
	)

77
	type deviceBufferType struct {
78
79
80
81
82
		d   *C.struct_ggml_backend_device
		bts []*C.struct_ggml_backend_buffer_type
	}

	var cpus, accels, gpus []*C.struct_ggml_backend_device
Michael Yang's avatar
Michael Yang committed
83
	for _, d := range devices() {
84
85
86
87
88
		switch C.ggml_backend_dev_type(d) {
		case C.GGML_BACKEND_DEVICE_TYPE_CPU:
			cpus = append(cpus, d)
		case C.GGML_BACKEND_DEVICE_TYPE_ACCEL:
			accels = append(accels, d)
Michael Yang's avatar
Michael Yang committed
89
		case C.GGML_BACKEND_DEVICE_TYPE_GPU:
90
			gpus = append(gpus, d)
Michael Yang's avatar
Michael Yang committed
91
92
93
		}
	}

Michael Yang's avatar
Michael Yang committed
94
	// create list of buffer types for the cpu
Michael Yang's avatar
Michael Yang committed
95
	cpuDeviceBufferType := deviceBufferType{d: C.ggml_backend_dev_by_type(C.GGML_BACKEND_DEVICE_TYPE_CPU)}
96
97
98
99
	for _, d := range append(accels, append(gpus, cpus...)...) {
		switch C.ggml_backend_dev_type(d) {
		case C.GGML_BACKEND_DEVICE_TYPE_CPU,
			C.GGML_BACKEND_DEVICE_TYPE_ACCEL:
Michael Yang's avatar
Michael Yang committed
100
			cpuDeviceBufferType.bts = append(cpuDeviceBufferType.bts, C.ggml_backend_dev_buffer_type(d))
Michael Yang's avatar
Michael Yang committed
101
		}
102
103
	}

Michael Yang's avatar
Michael Yang committed
104
	// create list of buffer types for each gpu
105
	var gpuDeviceBufferTypes []deviceBufferType
106
107
	for _, d := range gpus {
		bt := C.ggml_backend_dev_buffer_type(d)
108
		gpuDeviceBufferTypes = append(gpuDeviceBufferTypes, deviceBufferType{
109
			d:   d,
Michael Yang's avatar
Michael Yang committed
110
			bts: append([]*C.struct_ggml_backend_buffer_type{bt}, cpuDeviceBufferType.bts...),
111
		})
Michael Yang's avatar
Michael Yang committed
112
113
	}

Michael Yang's avatar
Michael Yang committed
114
115
116
117
118
	useDefaultSplit := true
	for _, s := range params.TensorSplit {
		if s != 0 {
			useDefaultSplit = false
			break
119
		}
Michael Yang's avatar
Michael Yang committed
120
	}
121

Michael Yang's avatar
Michael Yang committed
122
123
124
125
	// calculate splits
	splits := make([]float32, len(gpus))
	if useDefaultSplit {
		// default: split on free memory
126
127
128
129
130
		for i := range splits {
			var free, total C.size_t
			C.ggml_backend_dev_memory(gpus[i], &free, &total)
			splits[i] = float32(free)
		}
Michael Yang's avatar
Michael Yang committed
131
132
	} else {
		splits = params.TensorSplit
133
134
135
	}

	var sum float32
Michael Yang's avatar
Michael Yang committed
136
	// cumulative sum of all splits
137
138
139
140
141
	for i := range splits {
		sum += splits[i]
		splits[i] = sum
	}

Michael Yang's avatar
Michael Yang committed
142
	// normalize splits
143
	for i := range splits {
144
		splits[i] /= sum
145
146
	}

Michael Yang's avatar
Michael Yang committed
147
	// inputs always use cpu
Michael Yang's avatar
Michael Yang committed
148
	input := cpuDeviceBufferType
149

150
	blocks := int(meta.KV().BlockCount())
Michael Yang's avatar
Michael Yang committed
151
152
153
154

	// define a range of gpu layers. anything outside of this range is assigned to the cpu
	gpuRangeStart := max(0, blocks-params.NumGPULayers)
	gpuRangeStop := min(gpuRangeStart+params.NumGPULayers, blocks+1)
Michael Yang's avatar
Michael Yang committed
155
	assignLayer := func(i int) deviceBufferType {
Michael Yang's avatar
Michael Yang committed
156
		if i < gpuRangeStart || i >= gpuRangeStop {
Michael Yang's avatar
Michael Yang committed
157
			return cpuDeviceBufferType
158
		}
159

Michael Yang's avatar
Michael Yang committed
160
		index := slices.IndexFunc(splits, func(f float32) bool { return float32(i-gpuRangeStart)/float32(gpuRangeStop-gpuRangeStart) < f })
161
		if index < 0 || index >= len(gpuDeviceBufferTypes) {
Michael Yang's avatar
Michael Yang committed
162
			return cpuDeviceBufferType
163
164
165
		}

		return gpuDeviceBufferTypes[index]
166
167
	}

Michael Yang's avatar
Michael Yang committed
168
	// repeating layers are assigned based on their index in reverse order, e.g. i / (block_count + 1)
169
	layers := make([]deviceBufferType, blocks)
170
	for i := range layers {
171
		layers[i] = assignLayer(i)
172
173
	}

Michael Yang's avatar
Michael Yang committed
174
	// outputs are assigned iff allowed by splits and configured number of gpu layers
175
	output := assignLayer(blocks)
176
177
178

	maxTensors := len(meta.Tensors().Items())
	maxTensors += 1
Michael Yang's avatar
Michael Yang committed
179
	// each layer has at most 2 extra tensors for rope operations
180
181
	maxTensors += blocks * 2

182
183
184
185
186
	type tensor struct {
		source *fs.Tensor
		target string
	}

Michael Yang's avatar
Michael Yang committed
187
	// some tensors are mapped to different names so keep a list
188
189
	targets := make(map[string][]string)

Michael Yang's avatar
Michael Yang committed
190
	// contexts are shared by tensors of the same buffer type
191
	ctxs := make(map[*C.struct_ggml_backend_buffer_type]*C.struct_ggml_context)
192
	createTensor := func(t tensor, bts []*C.struct_ggml_backend_buffer_type) *C.struct_ggml_tensor {
193
194
195
196
197
198
199
		for _, bt := range bts {
			if _, ok := ctxs[bt]; !ok {
				ctxs[bt] = C.ggml_init(C.struct_ggml_init_params{
					mem_size: C.ggml_tensor_overhead() * C.size_t(maxTensors),
					no_alloc: true,
				})
			}
Michael Yang's avatar
Michael Yang committed
200

201
202
203
204
205
206
207
208
			targets[t.source.Name] = append(targets[t.source.Name], t.target)

			name := t.source.Name
			if t.target != "" {
				name = t.target
			}

			cname := C.CString(name)
Michael Yang's avatar
Michael Yang committed
209
			defer C.free(unsafe.Pointer(cname))
210
211
212
213
			if tt := C.ggml_get_tensor(ctxs[bt], cname); tt != nil {
				return tt
			}

214
			tt := C.ggml_new_tensor(ctxs[bt], t.source.Kind, C.int(len(t.source.Shape)), (*C.int64_t)(unsafe.Pointer(&t.source.Shape[0])))
Michael Yang's avatar
Michael Yang committed
215
216
			C.ggml_set_name(tt, cname)

217
			slog.Debug("created tensor", "name", name, "shape", t.source.Shape, "dtype", t.source.Kind, "buffer_type", C.GoString(C.ggml_backend_buft_name(bt)))
218
219
220
221
222
			//nolint:staticcheck // TODO: check if buffer type supports this tensor
			return tt
		}

		return nil
Michael Yang's avatar
Michael Yang committed
223
224
	}

225
	contains := func(s string, parts ...string) bool {
226
227
228
229
230
231
232
233
		split := strings.Split(s, ".")
		for _, part := range parts {
			if slices.Contains(split, part) {
				return true
			}
		}

		return false
Michael Yang's avatar
Michael Yang committed
234
235
	}

236
237
	for _, t := range meta.Tensors().Items() {
		switch {
238
		case contains(t.Name, "position_embd", "token_embd", "token_norm_embd", "token_types"):
239
			createTensor(tensor{source: t}, input.bts)
240
		case contains(t.Name, "cls", "output", "output_norm"):
241
			createTensor(tensor{source: t}, output.bts)
242
		case strings.HasPrefix(t.Name, "v.") || strings.HasPrefix(t.Name, "mm."):
Michael Yang's avatar
Michael Yang committed
243
			// TODO: assign vision tensors to the gpu if possible
244
			createTensor(tensor{source: t}, input.bts)
245
		default:
Michael Yang's avatar
Michael Yang committed
246
247
248
249
			layerIndex := -1
			if fields := strings.FieldsFunc(t.Name, func(r rune) bool { return !unicode.IsNumber(r) }); len(fields) > 0 {
				if i, err := strconv.Atoi(fields[0]); err == nil {
					layerIndex = i
250
				}
Michael Yang's avatar
Michael Yang committed
251
			}
252

Michael Yang's avatar
Michael Yang committed
253
254
			if layerIndex >= 0 {
				createTensor(tensor{source: t}, layers[layerIndex].bts)
255
			} else {
Michael Yang's avatar
Michael Yang committed
256
257
				// this is a repeating tensor that doesn't explicitly associated with a layer so
				// duplicate it for each layer
258
259
260
261
262
				for i, layer := range layers {
					createTensor(tensor{
						source: t,
						target: "blk." + strconv.Itoa(i) + "." + t.Name,
					}, layer.bts)
263
264
265
266
				}
			}
		}
	}
Michael Yang's avatar
Michael Yang committed
267

Michael Yang's avatar
Michael Yang committed
268
269
	// allocate buffers for each context
	bbs := make(map[*C.struct_ggml_context]*C.struct_ggml_backend_buffer, len(ctxs))
270
271
272
273
274
275
276
	for bt, c := range ctxs {
		if C.ggml_get_first_tensor(c) == nil {
			continue
		}

		b := C.ggml_backend_alloc_ctx_tensors_from_buft(c, bt)
		C.ggml_backend_buffer_set_usage(b, C.GGML_BACKEND_BUFFER_USAGE_WEIGHTS)
Michael Yang's avatar
Michael Yang committed
277
		bbs[c] = b
278
279
280
	}

	for bs := range maps.Values(bbs) {
Michael Yang's avatar
Michael Yang committed
281
		slog.Info("model weights", "buffer", C.GoString(C.ggml_backend_buffer_name(bs)), "size", format.HumanBytes2(uint64(C.ggml_backend_buffer_get_size(bs))))
282
283
	}

Michael Yang's avatar
Michael Yang committed
284
	// map tensor names to tensors for easy lookup later
285
286
287
288
289
290
291
	tensors := make(map[string]*C.struct_ggml_tensor)
	for _, c := range ctxs {
		for t := C.ggml_get_first_tensor(c); t != nil; t = C.ggml_get_next_tensor(c, t) {
			tensors[C.GoString(C.ggml_get_name(t))] = t
		}
	}

Michael Yang's avatar
Michael Yang committed
292
	// concurrently read in tensor data. uses a section reader which is safe for concurrent reads
293
	sr := io.NewSectionReader(r, int64(meta.Tensors().Offset), n-int64(meta.Tensors().Offset))
Michael Yang's avatar
Michael Yang committed
294
	var g errgroup.Group
295
	for _, t := range meta.Tensors().Items() {
296
297
298
299
300
		for _, target := range targets[t.Name] {
			g.Go(func() error {
				if target == "" {
					target = t.Name
				}
301

302
303
304
305
				tt, ok := tensors[target]
				if !ok {
					return fmt.Errorf("unassigned tensor: %s", t.Name)
				}
Michael Yang's avatar
Michael Yang committed
306

307
308
309
310
311
				bts := make([]byte, t.Size())
				n, err := io.ReadFull(io.NewSectionReader(sr, int64(t.Offset), int64(t.Size())), bts)
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
312

313
314
315
				if n != len(bts) {
					return errors.New("short read")
				}
Michael Yang's avatar
Michael Yang committed
316

317
318
319
320
				C.ggml_backend_tensor_set(tt, unsafe.Pointer(&bts[0]), 0, C.size_t(t.Size()))
				return nil
			})
		}
Michael Yang's avatar
Michael Yang committed
321
322
	}

323
	if g.Wait() != nil {
Michael Yang's avatar
Michael Yang committed
324
325
326
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
327
	// map devices to backends so tensors created post initialization can be assigned to the correct device
328
	deviceBackends := make(map[*C.struct_ggml_backend_device]*C.struct_ggml_backend)
Michael Yang's avatar
Michael Yang committed
329
330
331
332

	// create backends and buffer types used for the compute graph scheduler
	var schedBackends []*C.struct_ggml_backend
	var schedBufts []*C.struct_ggml_backend_buffer_type
333
334
	for _, d := range append(gpus, append(accels, cpus...)...) {
		b := C.ggml_backend_dev_init(d, nil)
Michael Yang's avatar
Michael Yang committed
335
		schedBackends = append(schedBackends, b)
336
		deviceBackends[d] = b
337
338

		bt := C.ggml_backend_get_default_buffer_type(b)
Michael Yang's avatar
Michael Yang committed
339
		// use the first gpu host buffer type for gpu if possible
340
341
342
343
344
345
		if d := C.ggml_backend_get_device(b); C.ggml_backend_dev_type(d) == C.GGML_BACKEND_DEVICE_TYPE_CPU && len(gpus) > 0 {
			if hbt := C.ggml_backend_dev_host_buffer_type(d); hbt != nil {
				bt = hbt
			}
		}

Michael Yang's avatar
Michael Yang committed
346
		schedBufts = append(schedBufts, bt)
347

348
		slog.Info("compute graph", "backend", C.GoString(C.ggml_backend_name(b)), "buffer_type", C.GoString(C.ggml_backend_buft_name(bt)))
349
350

		if C.ggml_backend_is_cpu(b) {
Michael Yang's avatar
Michael Yang committed
351
			// set number of threads for cpu backend
352
353
			C.ggml_backend_cpu_set_n_threads(b, C.int(params.NumThreads))
		}
354
355
	}

Michael Yang's avatar
Michael Yang committed
356
	maxGraphNodes := max(8192, len(meta.Tensors().Items())*5)
Michael Yang's avatar
Michael Yang committed
357
	return &Backend{
358
		flashAttention: params.FlashAttention,
359
360
		meta:           meta,
		tensors:        tensors,
361
		sched: C.ggml_backend_sched_new(
Michael Yang's avatar
Michael Yang committed
362
363
364
365
			(*C.ggml_backend_t)(unsafe.Pointer(&schedBackends[0])),
			(*C.ggml_backend_buffer_type_t)(unsafe.Pointer(&schedBufts[0])),
			C.int(len(schedBackends)),
			C.size_t(maxGraphNodes),
366
367
			true,
		),
368
369
370
371
372
373
374
375
376
		input:  deviceBackends[input.d],
		output: deviceBackends[output.d],
		layers: func() map[int]*C.struct_ggml_backend {
			m := make(map[int]*C.struct_ggml_backend)
			for i, layer := range layers {
				m[i] = deviceBackends[layer.d]
			}
			return m
		}(),
Michael Yang's avatar
Michael Yang committed
377
		maxGraphNodes: maxGraphNodes,
Michael Yang's avatar
Michael Yang committed
378
379
380
381
382
383
384
385
386
387
388
389
	}, nil
}

func init() {
	ml.RegisterBackend("ggml", New)
}

func (b *Backend) Config() ml.Config {
	return b.meta.KV()
}

func (b *Backend) Get(name string) ml.Tensor {
390
391
	if t, ok := b.tensors[name]; ok {
		return &Tensor{b: b, t: t}
Michael Yang's avatar
Michael Yang committed
392
393
394
395
396
397
	}

	return nil
}

func (b *Backend) NewContext() ml.Context {
Michael Yang's avatar
Michael Yang committed
398
	return b.NewContextSize(b.maxGraphNodes)
399
400
401
}

func (b *Backend) NewContextSize(n int) ml.Context {
Michael Yang's avatar
Michael Yang committed
402
	n = min(n, b.maxGraphNodes)
Michael Yang's avatar
Michael Yang committed
403
	return &Context{
404
		b: b,
405
		ctx: C.ggml_init(C.struct_ggml_init_params{
406
			mem_size: C.size_t(n)*C.ggml_tensor_overhead() + C.ggml_graph_overhead_custom(C.size_t(n), false),
407
408
			no_alloc: true,
		}),
409
		backend:       C.ggml_backend_sched_get_backend(b.sched, 0),
410
		maxGraphNodes: n,
Michael Yang's avatar
Michael Yang committed
411
412
413
	}
}

414
func (b *Backend) CacheConfig() ml.CacheConfig {
415
416
417
418
419
	if b.flashAttention {
		return ml.CacheConfig{CachePadding: 256, MaskDType: ml.DTypeF16, MaskBatchPadding: C.GGML_KQ_MASK_PAD}
	} else {
		return ml.CacheConfig{CachePadding: 32, PermutedV: true}
	}
420
421
}

Michael Yang's avatar
Michael Yang committed
422
type Context struct {
423
	b *Backend
Michael Yang's avatar
Michael Yang committed
424

425
	ctx   *C.struct_ggml_context
Michael Yang's avatar
Michael Yang committed
426
	graph *C.struct_ggml_cgraph
427
428

	// backend is the backend used for new tensors
429
	backend *C.struct_ggml_backend
430

Michael Yang's avatar
Michael Yang committed
431
	// maxGraphNodes is the maximum allowed number of graph nodes in this context
432
	maxGraphNodes int
Michael Yang's avatar
Michael Yang committed
433
434
}

Michael Yang's avatar
Michael Yang committed
435
436
func (c Context) Input() ml.Context {
	if c.b.input != nil {
437
438
439
		return &Context{
			b:             c.b,
			ctx:           c.ctx,
Michael Yang's avatar
Michael Yang committed
440
			backend:       c.b.input,
441
442
443
444
			maxGraphNodes: c.maxGraphNodes,
		}
	}

Michael Yang's avatar
Michael Yang committed
445
	return &c
446
447
}

Michael Yang's avatar
Michael Yang committed
448
449
func (c Context) Output() ml.Context {
	if c.b.output != nil {
450
451
452
		return &Context{
			b:             c.b,
			ctx:           c.ctx,
Michael Yang's avatar
Michael Yang committed
453
			backend:       c.b.output,
454
455
456
457
			maxGraphNodes: c.maxGraphNodes,
		}
	}

Michael Yang's avatar
Michael Yang committed
458
	return &c
459
460
}

Michael Yang's avatar
Michael Yang committed
461
462
func (c Context) Layer(i int) ml.Context {
	if backend, ok := c.b.layers[i]; ok {
463
464
465
466
467
468
469
470
		return &Context{
			b:             c.b,
			ctx:           c.ctx,
			backend:       backend,
			maxGraphNodes: c.maxGraphNodes,
		}
	}

Michael Yang's avatar
Michael Yang committed
471
	return &c
472
473
}

474
func (c *Context) Forward(tensors ...ml.Tensor) ml.Context {
Michael Yang's avatar
Michael Yang committed
475
	if c.graph == nil {
476
		c.graph = C.ggml_new_graph_custom(c.ctx, C.size_t(c.maxGraphNodes), false)
Michael Yang's avatar
Michael Yang committed
477
478
	}

479
480
481
482
483
	for _, tensor := range tensors {
		C.ggml_build_forward_expand(c.graph, tensor.(*Tensor).t)
	}

	return c
Michael Yang's avatar
Michael Yang committed
484
485
}

Michael Yang's avatar
Michael Yang committed
486
func (c Context) Compute(tensors ...ml.Tensor) {
487
	C.ggml_backend_sched_graph_compute_async(c.b.sched, c.graph)
Michael Yang's avatar
Michael Yang committed
488
	C.ggml_backend_sched_reset(c.b.sched)
Michael Yang's avatar
Michael Yang committed
489

490
491
492
	needSync := true
	sync := func() {
		if needSync {
493
			C.ggml_backend_sched_synchronize(c.b.sched)
494
495
496
			needSync = false
		}
	}
Michael Yang's avatar
Michael Yang committed
497

498
499
500
	for _, t := range tensors {
		if C.ggml_nbytes(t.(*Tensor).t) > 0 {
			t.(*Tensor).sync = sync
501
502
		}
	}
Michael Yang's avatar
Michael Yang committed
503
504
}

Michael Yang's avatar
Michael Yang committed
505
func (c Context) MaxGraphNodes() int {
506
	return c.maxGraphNodes
Jesse Gross's avatar
Jesse Gross committed
507
508
}

509
510
511
func shapeToGGML(shape []int) *C.int64_t {
	sh := make([]C.int64_t, len(shape))
	for i, s := range shape {
512
		sh[i] = C.int64_t(s)
513
514
515
516
517
	}

	return &sh[0]
}

518
func (c Context) newTensor(dtype ml.DType, shape []int) ml.Tensor {
Michael Yang's avatar
Michael Yang committed
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
	var cdtype uint32
	switch dtype {
	case ml.DTypeF32:
		cdtype = C.GGML_TYPE_F32
	case ml.DTypeF16:
		cdtype = C.GGML_TYPE_F16
	case ml.DTypeI32:
		cdtype = C.GGML_TYPE_I32
	default:
		panic("unsupported dtype")
	}

	if len(shape) < 1 {
		var shape C.int64_t = 0
		return &Tensor{b: c.b, t: C.ggml_new_tensor(c.ctx, cdtype, 1, &shape)}
	} else if len(shape) > 4 {
Michael Yang's avatar
Michael Yang committed
535
536
537
538
539
540
541
542
543
		panic("unsupported number of dimensions")
	}

	for _, dim := range shape {
		if dim < 1 {
			panic("invalid shape")
		}
	}

Michael Yang's avatar
Michael Yang committed
544
	t := C.ggml_new_tensor(c.ctx, cdtype, C.int(len(shape)), shapeToGGML(shape))
545
	b := C.ggml_backend_alloc_buffer(c.backend, C.ggml_nbytes(t))
Michael Yang's avatar
Michael Yang committed
546
	C.ggml_backend_tensor_alloc(b, t, C.ggml_backend_buffer_get_base(b))
547
	return &Tensor{b: c.b, t: t}
548
549
550
}

func (c Context) Empty(dtype ml.DType, shape ...int) ml.Tensor {
551
	return c.newTensor(dtype, shape)
552
553
554
}

func (c Context) Zeros(dtype ml.DType, shape ...int) ml.Tensor {
555
	t := c.newTensor(dtype, shape)
556
557
	C.ggml_set_zero(t.(*Tensor).t)
	return t
Michael Yang's avatar
Michael Yang committed
558
559
}

560
func checkShape[S ~[]E, E any](s S, shape ...int) error {
Michael Yang's avatar
Michael Yang committed
561
562
563
564
565
566
	n := len(s)
	for _, v := range shape {
		n /= v
	}

	if n != 1 {
567
		return fmt.Errorf("invalid shape: %v", shape)
Michael Yang's avatar
Michael Yang committed
568
569
	}

570
	return nil
Michael Yang's avatar
Michael Yang committed
571
572
573
}

func (c Context) FromFloatSlice(s []float32, shape ...int) (ml.Tensor, error) {
Michael Yang's avatar
Michael Yang committed
574
	if err := checkShape(s, shape...); err != nil && len(shape) > 0 {
575
576
577
578
579
580
		return nil, err
	}

	t := c.newTensor(ml.DTypeF32, shape)
	C.ggml_backend_tensor_set(t.(*Tensor).t, unsafe.Pointer(&s[0]), 0, C.ggml_nbytes(t.(*Tensor).t))
	return t, nil
Michael Yang's avatar
Michael Yang committed
581
582
583
}

func (c Context) FromIntSlice(s []int32, shape ...int) (ml.Tensor, error) {
Michael Yang's avatar
Michael Yang committed
584
	if err := checkShape(s, shape...); err != nil && len(shape) > 0 {
585
586
587
588
589
590
		return nil, err
	}

	t := c.newTensor(ml.DTypeI32, shape)
	C.ggml_backend_tensor_set(t.(*Tensor).t, unsafe.Pointer(&s[0]), 0, C.ggml_nbytes(t.(*Tensor).t))
	return t, nil
Michael Yang's avatar
Michael Yang committed
591
592
}

Michael Yang's avatar
Michael Yang committed
593
594
func (c *Context) Close() {
	if c != nil {
595
596
		C.ggml_free(c.ctx)
	}
Michael Yang's avatar
Michael Yang committed
597
598
599
}

type Tensor struct {
600
	b    *Backend
Michael Yang's avatar
Michael Yang committed
601
	t    *C.struct_ggml_tensor
602
	sync func()
Michael Yang's avatar
Michael Yang committed
603
604
605
606
607
608
609
610
611
612
}

func (t *Tensor) LogValue() slog.Value {
	return slog.GroupValue(
		slog.String("name", C.GoString(C.ggml_get_name(t.t))),
		slog.String("type", C.GoString(C.ggml_type_name(t.t._type))),
		slog.Any("shape", t.Shape()),
	)
}

613
614
func (t *Tensor) Dim(n int) int {
	return int(t.t.ne[n])
Michael Yang's avatar
Michael Yang committed
615
616
}

617
618
func (t *Tensor) Stride(n int) int {
	return int(t.t.nb[n])
Michael Yang's avatar
Michael Yang committed
619
620
}

621
622
func (t *Tensor) Shape() []int {
	shape := make([]int, C.ggml_n_dims(t.t))
Michael Yang's avatar
Michael Yang committed
623
624
625
626
627
628
629
	for i := range shape {
		shape[i] = t.Dim(i)
	}

	return shape
}

630
631
632
633
634
635
636
637
638
func (t *Tensor) Bytes() (data []byte) {
	if t.sync != nil {
		data = make([]byte, C.ggml_nbytes(t.t))

		t.sync()
		C.ggml_backend_tensor_get(t.t, unsafe.Pointer(&data[0]), 0, C.ggml_nbytes(t.t))
	}

	return
Michael Yang's avatar
Michael Yang committed
639
640
}

641
642
643
644
645
646
func (t *Tensor) Floats() (data []float32) {
	if t.sync != nil {
		data = make([]float32, C.ggml_nelements(t.t))

		t.sync()
		C.ggml_backend_tensor_get(t.t, unsafe.Pointer(&data[0]), 0, C.ggml_nbytes(t.t))
Michael Yang's avatar
Michael Yang committed
647
648
649
650
651
652
653
654
655
	}

	return
}

func (t *Tensor) DType() ml.DType {
	switch t.t._type {
	case C.GGML_TYPE_F32:
		return ml.DTypeF32
Jesse Gross's avatar
Jesse Gross committed
656
657
	case C.GGML_TYPE_F16:
		return ml.DTypeF16
Michael Yang's avatar
Michael Yang committed
658
659
660
661
662
663
664
665
666
	case C.GGML_TYPE_I32:
		return ml.DTypeI32
	default:
		return ml.DTypeOther
	}
}

func (t *Tensor) Add(ctx ml.Context, t2 ml.Tensor) ml.Tensor {
	return &Tensor{
667
		b: t.b,
Michael Yang's avatar
Michael Yang committed
668
669
670
671
672
673
674
675
676
677
678
679
680
681
		t: C.ggml_add(ctx.(*Context).ctx, t.t, t2.(*Tensor).t),
	}
}

func (t *Tensor) Stack(ctx ml.Context, dim int, s ...ml.Tensor) ml.Tensor {
	if len(s) > 0 {
		return t.Concat(ctx, s[0].Stack(ctx, dim, s[1:]...), dim)
	}

	return t
}

func (t *Tensor) Concat(ctx ml.Context, t2 ml.Tensor, dim int) ml.Tensor {
	return &Tensor{
682
		b: t.b,
Michael Yang's avatar
Michael Yang committed
683
684
685
686
687
688
		t: C.ggml_concat(ctx.(*Context).ctx, t.t, t2.(*Tensor).t, C.int(dim)),
	}
}

func (t *Tensor) Contiguous(ctx ml.Context) ml.Tensor {
	return &Tensor{
689
		b: t.b,
Michael Yang's avatar
Michael Yang committed
690
691
692
693
694
695
		t: C.ggml_cont(ctx.(*Context).ctx, t.t),
	}
}

func (t *Tensor) Mul(ctx ml.Context, t2 ml.Tensor) ml.Tensor {
	return &Tensor{
696
		b: t.b,
Michael Yang's avatar
Michael Yang committed
697
698
699
700
701
702
		t: C.ggml_mul(ctx.(*Context).ctx, t.t, t2.(*Tensor).t),
	}
}

func (t *Tensor) Mulmat(ctx ml.Context, t2 ml.Tensor) ml.Tensor {
	return &Tensor{
703
		b: t.b,
Michael Yang's avatar
Michael Yang committed
704
705
706
707
		t: C.ggml_mul_mat(ctx.(*Context).ctx, t.t, t2.(*Tensor).t),
	}
}

708
709
710
711
712
func (t *Tensor) MulmatFullPrec(ctx ml.Context, t2 ml.Tensor) ml.Tensor {
	mul := C.ggml_mul_mat(ctx.(*Context).ctx, t.t, t2.(*Tensor).t)
	C.ggml_mul_mat_set_prec(mul, C.GGML_PREC_F32)

	return &Tensor{
713
		b: t.b,
714
715
716
717
		t: mul,
	}
}

Michael Yang's avatar
Michael Yang committed
718
func (t *Tensor) LayerNorm(ctx ml.Context, w, b ml.Tensor, eps float32) ml.Tensor {
719
	tt := (&Tensor{b: t.b, t: C.ggml_norm(ctx.(*Context).ctx, t.t, C.float(eps))}).Mul(ctx, w)
Michael Yang's avatar
Michael Yang committed
720
721
722
723
724
725
726
727
	if b != nil {
		tt = tt.Add(ctx, b)
	}

	return tt
}

func (t *Tensor) RMSNorm(ctx ml.Context, w ml.Tensor, eps float32) ml.Tensor {
728
	return (&Tensor{b: t.b, t: C.ggml_rms_norm(ctx.(*Context).ctx, t.t, C.float(eps))}).Mul(ctx, w)
Michael Yang's avatar
Michael Yang committed
729
730
}

731
func (t *Tensor) Pad(ctx ml.Context, shape ...int) ml.Tensor {
Michael Yang's avatar
Michael Yang committed
732
733
734
735
736
	if len(shape) != 4 {
		panic("expected 4 dimensions")
	}

	return &Tensor{
737
		b: t.b,
Michael Yang's avatar
Michael Yang committed
738
739
740
741
742
743
744
745
746
747
		t: C.ggml_pad(ctx.(*Context).ctx, t.t, C.int(shape[0]), C.int(shape[1]), C.int(shape[2]), C.int(shape[3])),
	}
}

func (t *Tensor) Permute(ctx ml.Context, shape ...int) ml.Tensor {
	if len(shape) != 4 {
		panic("expected 4 dimensions")
	}

	return &Tensor{
748
		b: t.b,
Michael Yang's avatar
Michael Yang committed
749
750
751
752
753
754
		t: C.ggml_permute(ctx.(*Context).ctx, t.t, C.int(shape[0]), C.int(shape[1]), C.int(shape[2]), C.int(shape[3])),
	}
}

func (t *Tensor) Rows(ctx ml.Context, t2 ml.Tensor) ml.Tensor {
	return &Tensor{
755
		b: t.b,
Michael Yang's avatar
Michael Yang committed
756
757
758
759
760
761
		t: C.ggml_get_rows(ctx.(*Context).ctx, t.t, t2.(*Tensor).t),
	}
}

func (t *Tensor) Copy(ctx ml.Context, t2 ml.Tensor) ml.Tensor {
	return &Tensor{
762
		b: t.b,
Michael Yang's avatar
Michael Yang committed
763
764
765
766
		t: C.ggml_cpy(ctx.(*Context).ctx, t.t, t2.(*Tensor).t),
	}
}

767
func (t *Tensor) Reshape(ctx ml.Context, shape ...int) ml.Tensor {
Michael Yang's avatar
Michael Yang committed
768
769
770
	switch len(shape) {
	case 1:
		return &Tensor{
771
			b: t.b,
Michael Yang's avatar
Michael Yang committed
772
773
774
775
			t: C.ggml_reshape_1d(ctx.(*Context).ctx, t.t, C.int64_t(shape[0])),
		}
	case 2:
		return &Tensor{
776
			b: t.b,
Michael Yang's avatar
Michael Yang committed
777
778
779
780
			t: C.ggml_reshape_2d(ctx.(*Context).ctx, t.t, C.int64_t(shape[0]), C.int64_t(shape[1])),
		}
	case 3:
		return &Tensor{
781
			b: t.b,
Michael Yang's avatar
Michael Yang committed
782
783
784
785
			t: C.ggml_reshape_3d(ctx.(*Context).ctx, t.t, C.int64_t(shape[0]), C.int64_t(shape[1]), C.int64_t(shape[2])),
		}
	case 4:
		return &Tensor{
786
			b: t.b,
Michael Yang's avatar
Michael Yang committed
787
788
789
790
791
792
793
794
795
			t: C.ggml_reshape_4d(ctx.(*Context).ctx, t.t, C.int64_t(shape[0]), C.int64_t(shape[1]), C.int64_t(shape[2]), C.int64_t(shape[3])),
		}
	default:
		panic("unsupported number of dimensions")
	}
}

func (t *Tensor) Scale(ctx ml.Context, s float64) ml.Tensor {
	return &Tensor{
796
		b: t.b,
Michael Yang's avatar
Michael Yang committed
797
798
799
800
801
802
		t: C.ggml_scale(ctx.(*Context).ctx, t.t, (C.float)(s)),
	}
}

func (t *Tensor) Softmax(ctx ml.Context) ml.Tensor {
	return &Tensor{
803
		b: t.b,
Michael Yang's avatar
Michael Yang committed
804
805
806
807
808
809
		t: C.ggml_soft_max(ctx.(*Context).ctx, t.t),
	}
}

func (t *Tensor) Tanh(ctx ml.Context) ml.Tensor {
	return &Tensor{
810
		b: t.b,
Michael Yang's avatar
Michael Yang committed
811
812
813
814
		t: C.ggml_tanh_inplace(ctx.(*Context).ctx, t.t),
	}
}

815
func (t *Tensor) Unpad(ctx ml.Context, shape ...int) ml.Tensor {
Michael Yang's avatar
Michael Yang committed
816
817
818
819
820
	if len(shape) != 4 {
		panic("expected 4 dimensions")
	}

	return &Tensor{
821
		b: t.b,
Michael Yang's avatar
Michael Yang committed
822
823
824
825
826
827
828
829
		t: C.ggml_unpad(ctx.(*Context).ctx, t.t, C.int(shape[0]), C.int(shape[1]), C.int(shape[2]), C.int(shape[3])),
	}
}

func (t *Tensor) View(ctx ml.Context, offset int, shape ...int) ml.Tensor {
	switch len(shape) {
	case 1:
		return &Tensor{
830
			b: t.b,
Michael Yang's avatar
Michael Yang committed
831
832
833
834
			t: C.ggml_view_1d(ctx.(*Context).ctx, t.t, C.int64_t(shape[0]), C.size_t(offset)),
		}
	case 3:
		return &Tensor{
835
			b: t.b,
Michael Yang's avatar
Michael Yang committed
836
837
838
839
840
841
842
			t: C.ggml_view_2d(ctx.(*Context).ctx, t.t,
				C.int64_t(shape[0]), C.int64_t(shape[2]),
				C.size_t(shape[1]),
				C.size_t(offset)),
		}
	case 5:
		return &Tensor{
843
			b: t.b,
Michael Yang's avatar
Michael Yang committed
844
845
846
847
848
849
850
			t: C.ggml_view_3d(ctx.(*Context).ctx, t.t,
				C.int64_t(shape[0]), C.int64_t(shape[2]), C.int64_t(shape[4]),
				C.size_t(shape[1]), C.size_t(shape[3]),
				C.size_t(offset)),
		}
	case 7:
		return &Tensor{
851
			b: t.b,
Michael Yang's avatar
Michael Yang committed
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
			t: C.ggml_view_4d(ctx.(*Context).ctx, t.t,
				C.int64_t(shape[0]), C.int64_t(shape[2]), C.int64_t(shape[4]), C.int64_t(shape[6]),
				C.size_t(shape[1]), C.size_t(shape[3]), C.size_t(shape[5]),
				C.size_t(offset)),
		}
	default:
		panic("unsupported number of dimensions")
	}
}

const (
	ropeTypeNorm C.int = iota
)

func (t *Tensor) RoPE(ctx ml.Context, positionIDs, ropeFactors ml.Tensor, ropeDim uint32, ropeBase, ropeScale float32) ml.Tensor {
	if ropeFactors == nil {
868
		ropeFactors = &Tensor{b: t.b}
Michael Yang's avatar
Michael Yang committed
869
870
	}

Jesse Gross's avatar
Jesse Gross committed
871
872
873
874
875
	dequant := t.t
	if C.ggml_is_quantized(t.t._type) {
		dequant = C.ggml_cast(ctx.(*Context).ctx, t.t, C.GGML_TYPE_F32)
	}

Michael Yang's avatar
Michael Yang committed
876
	return &Tensor{
877
		b: t.b,
Michael Yang's avatar
Michael Yang committed
878
		t: C.ggml_rope_ext(
Jesse Gross's avatar
Jesse Gross committed
879
			ctx.(*Context).ctx, dequant, positionIDs.(*Tensor).t, ropeFactors.(*Tensor).t,
Michael Yang's avatar
Michael Yang committed
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
			C.int(ropeDim),
			131072,       // YaRN n_ctx_train
			ropeTypeNorm, // ROPE_TYPE_NORM
			C.float(ropeBase),
			C.float(ropeScale),
			0.,  // YaRN ext_factor
			1.,  // YaRN attn_factor
			32., // YaRN beta_fast
			1.,  // YaRN beta_slow
		),
	}
}

func (t *Tensor) GELU(ctx ml.Context) ml.Tensor {
	return &Tensor{
895
		b: t.b,
Michael Yang's avatar
Michael Yang committed
896
897
898
899
900
901
		t: C.ggml_gelu_inplace(ctx.(*Context).ctx, t.t),
	}
}

func (t *Tensor) SILU(ctx ml.Context) ml.Tensor {
	return &Tensor{
902
		b: t.b,
Michael Yang's avatar
Michael Yang committed
903
904
905
906
907
908
		t: C.ggml_silu_inplace(ctx.(*Context).ctx, t.t),
	}
}

func (t *Tensor) Conv2D(ctx ml.Context, t2 ml.Tensor, s0, s1, p0, p1, d0, d1 int) ml.Tensor {
	return &Tensor{
909
		b: t.b,
Michael Yang's avatar
Michael Yang committed
910
911
912
		t: C.ggml_conv_2d(ctx.(*Context).ctx, t.t, t2.(*Tensor).t, C.int(s0), C.int(s1), C.int(p0), C.int(p1), C.int(d0), C.int(d1)),
	}
}
913

914
915
916
917
918
919
func (t *Tensor) ScaledDotProductAttention(ctx ml.Context, key, value, mask ml.Tensor, scale float64) ml.Tensor {
	var kqMask *C.struct_ggml_tensor
	if mask != nil {
		kqMask = mask.(*Tensor).t
	}

920
921
922
	query := t.Permute(ctx, 0, 2, 1, 3)
	key = key.Permute(ctx, 0, 2, 1, 3)

923
924
	if t.b.flashAttention {
		value = value.Permute(ctx, 0, 2, 1, 3)
925

926
927
928
929
930
931
932
933
934
935
936
937
938
		kqv := C.ggml_flash_attn_ext(ctx.(*Context).ctx, query.(*Tensor).t, key.(*Tensor).t, value.(*Tensor).t, kqMask, C.float(scale), 0, 0)
		C.ggml_flash_attn_ext_set_prec(kqv, C.GGML_PREC_F32)
		return &Tensor{b: t.b, t: kqv}
	} else {
		kq := key.MulmatFullPrec(ctx, query)
		kq = &Tensor{
			b: t.b,
			t: C.ggml_soft_max_ext(ctx.(*Context).ctx, kq.(*Tensor).t, kqMask, C.float(scale), 0),
		}

		kqv := value.Mulmat(ctx, kq)
		return kqv.Permute(ctx, 0, 2, 1, 3).Contiguous(ctx)
	}
939
}