gguf.go 19.5 KB
Newer Older
Bruce MacDonald's avatar
Bruce MacDonald committed
1
2
3
4
5
6
7
package llm

import (
	"bytes"
	"encoding/binary"
	"fmt"
	"io"
8
9
10
11
12
13
14
15
	"log/slog"
	"os"
	"regexp"

	"github.com/d4l3k/go-bfloat16"
	"github.com/pdevine/tensor"
	"github.com/pdevine/tensor/native"
	"github.com/x448/float16"
16
17

	"github.com/jmorganca/ollama/format"
Bruce MacDonald's avatar
Bruce MacDonald committed
18
19
)

20
21
type ContainerGGUF struct {
	ByteOrder binary.ByteOrder
Michael Yang's avatar
ggufv3  
Michael Yang committed
22

Bruce MacDonald's avatar
Bruce MacDonald committed
23
24
25
26
27
28
29
30
31
32
33
	Version uint32

	V1 struct {
		NumTensor uint32
		NumKV     uint32
	}

	V2 struct {
		NumTensor uint64
		NumKV     uint64
	}
34
35
36
37
38

	V3 struct {
		NumTensor uint64
		NumKV     uint64
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
39
40
}

41
func (c *ContainerGGUF) Name() string {
Bruce MacDonald's avatar
Bruce MacDonald committed
42
43
44
	return "gguf"
}

Michael Yang's avatar
Michael Yang committed
45
46
func (c *ContainerGGUF) Decode(rs io.ReadSeeker) (model, error) {
	binary.Read(rs, c.ByteOrder, &c.Version)
Bruce MacDonald's avatar
Bruce MacDonald committed
47
48
49

	switch c.Version {
	case 1:
Michael Yang's avatar
Michael Yang committed
50
		binary.Read(rs, c.ByteOrder, &c.V1)
Bruce MacDonald's avatar
Bruce MacDonald committed
51
	default:
Michael Yang's avatar
Michael Yang committed
52
		binary.Read(rs, c.ByteOrder, &c.V2)
Bruce MacDonald's avatar
Bruce MacDonald committed
53
54
	}

55
	model := NewGGUFModel(c)
Michael Yang's avatar
Michael Yang committed
56
	if err := model.Decode(rs); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
57
58
59
60
61
62
63
		return nil, err
	}

	return model, nil
}

const (
64
65
66
67
68
69
70
	_ uint32 = iota
	GGUFTokenNormal
	GGUFTokenUnknown
	GGUFTokenControl
	GGUFTokenUserDefined
	GGUFTokenUnused
	GGUFTokenByte
Bruce MacDonald's avatar
Bruce MacDonald committed
71
72
)

73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
const (
	GGUFTypeUint8 uint32 = iota
	GGUFTypeInt8
	GGUFTypeUint16
	GGUFTypeInt16
	GGUFTypeUint32
	GGUFTypeInt32
	GGUFTypeFloat32
	GGUFTypeBool
	GGUFTypeString
	GGUFTypeArray
	GGUFTypeUint64
	GGUFTypeInt64
	GGUFTypeFloat64
)
Bruce MacDonald's avatar
Bruce MacDonald committed
88

89
90
91
92
93
94
type KV map[string]any

type Tensor struct {
	Name   string
	Kind   uint32
	Offset uint64
95
96

	// shape is the number of elements in each dimension
Michael Yang's avatar
Michael Yang committed
97
	Shape []uint64
98
99
100
101

	FileName      string
	OffsetPadding uint64
	FileOffsets   []uint64
102
103
}

104
func (t Tensor) BlockSize() uint64 {
Michael Yang's avatar
Michael Yang committed
105
	switch {
106
	case t.Kind < 2:
Michael Yang's avatar
Michael Yang committed
107
		return 1
108
	case t.Kind < 10:
Michael Yang's avatar
Michael Yang committed
109
110
111
112
113
114
		return 32
	default:
		return 256
	}
}

115
116
func (t Tensor) TypeSize() uint64 {
	blockSize := t.BlockSize()
Michael Yang's avatar
Michael Yang committed
117

118
	switch t.Kind {
Michael Yang's avatar
Michael Yang committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
	case 0: // FP32
		return 4
	case 1: // FP16
		return 2
	case 2: // Q4_0
		return 2 + blockSize/2
	case 3: // Q4_1
		return 2 + 2 + blockSize/2
	case 6: // Q5_0
		return 2 + 4 + blockSize/2
	case 7: // Q5_1
		return 2 + 2 + 4 + blockSize/2
	case 8: // Q8_0
		return 2 + blockSize
	case 9: // Q8_1
		return 4 + 4 + blockSize
	case 10: // Q2_K
		return blockSize/16 + blockSize/4 + 2 + 2
	case 11: // Q3_K
		return blockSize/8 + blockSize/4 + 12 + 2
	case 12: // Q4_K
		return 2 + 2 + 12 + blockSize/2
	case 13: // Q5_K
		return 2 + 2 + 12 + blockSize/8 + blockSize/2
	case 14: // Q6_K
		return blockSize/2 + blockSize/4 + blockSize/16 + 2
Michael Yang's avatar
Michael Yang committed
145
146
147
148
149
150
151
152
	case 15: // Q8_K
		return 2 + blockSize + 2*blockSize/16
	case 16: // IQ2_XXS
		return 2 + 2*blockSize/8
	case 17: // IQ2_XS
		return 2 + 2*blockSize/8 + blockSize/32
	case 18: // IQ3_XXS
		return 2 + 3*blockSize/8
Michael Yang's avatar
Michael Yang committed
153
154
155
156
157
	default:
		return 0
	}
}

158
func (t Tensor) Parameters() uint64 {
Michael Yang's avatar
Michael Yang committed
159
160
161
162
163
	var count uint64 = 1
	for _, n := range t.Shape {
		count *= n
	}
	return count
Michael Yang's avatar
Michael Yang committed
164
165
}

166
167
func (t Tensor) Size() uint64 {
	return t.Parameters() * t.TypeSize() / t.BlockSize()
Michael Yang's avatar
Michael Yang committed
168
169
}

170
171
172
173
174
175
176
177
func (t Tensor) Repack(data []uint16, heads int) ([]uint16, error) {
	n := tensor.New(tensor.WithShape(int(t.Shape[0]), int(t.Shape[1])), tensor.WithBacking(data))
	origShape := n.Shape().Clone()

	// reshape the tensor and swap axes 1 and 2 to unpack the layer for gguf
	if err := n.Reshape(heads, 2, origShape[0]/heads/2, origShape[1]); err != nil {
		return []uint16{}, err
	}
178

179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
	if err := n.T(0, 2, 1, 3); err != nil {
		return []uint16{}, err
	}

	if err := n.Reshape(origShape...); err != nil {
		return []uint16{}, err
	}

	if err := n.Transpose(); err != nil {
		return []uint16{}, err
	}
	newN, err := native.SelectU16(n, 1)
	if err != nil {
		return []uint16{}, err
	}

	var fullTensor []uint16
	for _, v := range newN {
		fullTensor = append(fullTensor, v...)
	}
	return fullTensor, nil
}

type GGUFModel struct {
	*ContainerGGUF

	KV
	Tensors []Tensor
207
208

	parameters uint64
Bruce MacDonald's avatar
Bruce MacDonald committed
209
210
}

211
212
213
214
func NewGGUFModel(container *ContainerGGUF) *GGUFModel {
	return &GGUFModel{
		ContainerGGUF: container,
		KV:            make(KV),
Bruce MacDonald's avatar
Bruce MacDonald committed
215
216
217
	}
}

218
func (llm *GGUFModel) NumTensor() uint64 {
219
220
221
222
223
224
225
	if llm.Version == 1 {
		return uint64(llm.V1.NumTensor)
	}

	return llm.V2.NumTensor
}

226
func (llm *GGUFModel) NumKV() uint64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
227
228
229
230
231
232
233
	if llm.Version == 1 {
		return uint64(llm.V1.NumKV)
	}

	return llm.V2.NumKV
}

234
235
func (llm *GGUFModel) ModelFamily() string {
	if t, ok := llm.KV["general.architecture"].(string); ok {
Michael Yang's avatar
Michael Yang committed
236
		return t
Bruce MacDonald's avatar
Bruce MacDonald committed
237
238
	}

Michael Yang's avatar
Michael Yang committed
239
	return "unknown"
Bruce MacDonald's avatar
Bruce MacDonald committed
240
241
}

242
func (llm *GGUFModel) ModelType() string {
243
244
245
246
	if llm.parameters > 0 {
		return format.HumanNumber(llm.parameters)
	}

Michael Yang's avatar
Michael Yang committed
247
	return "unknown"
Bruce MacDonald's avatar
Bruce MacDonald committed
248
249
}

250
251
func (llm *GGUFModel) FileType() string {
	if t, ok := llm.KV["general.file_type"].(uint32); ok {
Michael Yang's avatar
Michael Yang committed
252
		return fileType(t)
Bruce MacDonald's avatar
Bruce MacDonald committed
253
254
	}

Michael Yang's avatar
Michael Yang committed
255
	return "unknown"
Bruce MacDonald's avatar
Bruce MacDonald committed
256
257
}

258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
func (llm *GGUFModel) Encode(f *os.File) error {
	// this mimics the order of the llama.cpp convert script
	kOrder := []string{
		"general.architecture",
		"general.name",
		"llama.context_length",
		"llama.embedding_length",
		"llama.block_count",
		"llama.feed_forward_length",
		"llama.rope.dimension_count",
		"llama.attention.head_count",
		"llama.attention.head_count_kv",
		"llama.attention.layer_norm_rms_epsilon",
		"llama.rope.freq_base",
		"general.file_type",
		"tokenizer.ggml.model",
		"tokenizer.ggml.tokens",
		"tokenizer.ggml.scores",
		"tokenizer.ggml.token_type",
		"tokenizer.ggml.bos_token_id",
		"tokenizer.ggml.eos_token_id",
		"tokenizer.ggml.unknown_token_id",
		"tokenizer.ggml.add_bos_token",
		"tokenizer.ggml.add_eos_token",
		"tokenizer.chat_template",
	}

	if err := binary.Write(f, llm.ByteOrder, []byte("GGUF")); err != nil {
		return err
	}

	if err := binary.Write(f, llm.ByteOrder, uint32(3)); err != nil {
		return err
	}

	if err := binary.Write(f, llm.ByteOrder, uint64(llm.V3.NumTensor)); err != nil {
		return err
	}

	if err := binary.Write(f, llm.ByteOrder, uint64(llm.V3.NumKV)); err != nil {
		return err
	}

	for _, k := range kOrder {
		val, ok := llm.KV[k]
		if !ok {
			continue
		}

		if err := binary.Write(f, llm.ByteOrder, uint64(len(k))); err != nil {
			return err
		}
		if err := binary.Write(f, llm.ByteOrder, []byte(k)); err != nil {
			return err
		}

		switch v := val.(type) {
		case uint32:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeUint32); err != nil {
				return err
			}

			if err := llm.writeUint32(f, v); err != nil {
				return err
			}
		case float32:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeFloat32); err != nil {
				return err
			}

			if err := llm.writeF32(f, v); err != nil {
				return err
			}
		case bool:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeBool); err != nil {
				return err
			}

			if err := llm.writeBool(f, v); err != nil {
				return err
			}
		case string:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeString); err != nil {
				return err
			}

			if err := llm.writeString(f, v); err != nil {
				return err
			}
		case []int32:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeArray); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, GGUFTypeInt32); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, uint64(len(v))); err != nil {
				return err
			}
			for _, i := range v {
				if err := llm.writeInt32(f, i); err != nil {
					return err
				}
			}
		case []uint32:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeArray); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, GGUFTypeUint32); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, uint64(len(v))); err != nil {
				return err
			}
			for _, i := range v {
				if err := llm.writeUint32(f, i); err != nil {
					return err
				}
			}
		case []float32:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeArray); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, GGUFTypeFloat32); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, uint64(len(v))); err != nil {
				return err
			}
			for _, fl := range v {
				if err := llm.writeF32(f, fl); err != nil {
					return err
				}
			}
		case []string:
			if err := binary.Write(f, llm.ByteOrder, GGUFTypeArray); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, GGUFTypeString); err != nil {
				return err
			}

			if err := binary.Write(f, llm.ByteOrder, uint64(len(v))); err != nil {
				return err
			}

			for _, s := range v {
				if err := llm.writeString(f, s); err != nil {
					return err
				}
			}
		}
	}

	// write layer metadata
	for _, t := range llm.Tensors {
		if err := llm.writeString(f, t.Name); err != nil {
			return err
		}

		// the dimensions of the tensor
		dims := 1
		if t.Shape[1] > 0 {
			dims = 2
		}

		if err := binary.Write(f, llm.ByteOrder, uint32(dims)); err != nil {
			return err
		}

		for i := 0; i < dims; i++ {
			if err := binary.Write(f, llm.ByteOrder, uint64(t.Shape[dims-1-i])); err != nil {
				return err
			}
		}

		if err := binary.Write(f, llm.ByteOrder, uint32(t.Kind)); err != nil {
			return err
		}

		if err := binary.Write(f, llm.ByteOrder, uint64(t.Offset)); err != nil {
			return err
		}
	}

	offset, terr := f.Seek(0, io.SeekCurrent)
	if terr != nil {
		return terr
	}
	slog.Debug(fmt.Sprintf("tensors offset = %x", offset))

	if err := llm.writePadding(f, 32); err != nil {
		return err
	}

	var dataFile *os.File
	var currentFile string
	var err error
	for _, t := range llm.Tensors {
		if currentFile != t.FileName {
			if f != nil {
				dataFile.Close()
			}
			currentFile = t.FileName
			dataFile, err = os.Open(t.FileName)
			if err != nil {
				fmt.Println(err)
				return err
			}
		}

		dataFile.Seek(int64(t.OffsetPadding+t.FileOffsets[0]), 0)

		pattern := `^blk\.[0-9]+\.attn_(?P<layer>q|k)\.weight$`
		re, err := regexp.Compile(pattern)
		if err != nil {
			return err
		}

		matches := re.FindAllStringSubmatch(t.Name, -1)
		if len(matches) > 0 {
			layerSize := t.FileOffsets[1] - t.FileOffsets[0]

			var err error
			tData := make([]uint16, layerSize/2)
			if err = binary.Read(dataFile, llm.ByteOrder, tData); err != nil {
				return err
			}

			layerType := matches[0][re.SubexpIndex("layer")]
			var heads uint32
			switch layerType {
			case "q":
				heads = llm.KV["llama.attention.head_count"].(uint32)
			case "k":
				heads = llm.KV["llama.attention.head_count_kv"].(uint32)
				if heads == 0 {
					heads = llm.KV["llama.attention.head_count"].(uint32)
				}
			}

			tData, err = t.Repack(tData, int(heads))
			if err != nil {
				return err
			}

			var buf []byte
			for _, n := range tData {
				buf = binary.LittleEndian.AppendUint16(buf, n)
			}

			tempBuf := make([]uint16, len(tData))
			tDataF32 := bfloat16.DecodeFloat32(buf)
			for cnt, v := range tDataF32 {
				tDataF16 := float16.Fromfloat32(v)
				tempBuf[cnt] = uint16(tDataF16)
			}

			if err = binary.Write(f, llm.ByteOrder, tempBuf); err != nil {
				return err
			}

			if err := llm.writePadding(f, 32); err != nil {
				return err
			}
			continue
		}

		remaining := t.FileOffsets[1] - t.FileOffsets[0]

		bufSize := uint64(10240)
		var finished bool
		for {
			data := make([]byte, min(bufSize, remaining))

			b, err := io.ReadFull(dataFile, data)
			remaining -= uint64(b)

			if err == io.EOF || remaining <= 0 {
				finished = true
			} else if err != nil {
				return err
			}

			// convert bfloat16 -> ieee float32
			tDataF32 := bfloat16.DecodeFloat32(data)

			switch t.Kind {
			case 0:
				if err := binary.Write(f, llm.ByteOrder, tDataF32); err != nil {
					return err
				}
			case 1:
				// convert float32 -> float16
				tempBuf := make([]uint16, len(data)/2)
				for cnt, v := range tDataF32 {
					tDataF16 := float16.Fromfloat32(v)
					tempBuf[cnt] = uint16(tDataF16)
				}
				if err := binary.Write(f, llm.ByteOrder, tempBuf); err != nil {
					return err
				}
			}
			if finished {
				break
			}
		}

		if err := llm.writePadding(f, 32); err != nil {
			return err
		}
	}
	f.Close()

	return nil
}

func (llm *GGUFModel) writePadding(f *os.File, align int64) error {
	// gguf file padding is defined in https://github.com/ggerganov/ggml/blob/master/docs/gguf.md#file-structure
	offset, err := f.Seek(0, io.SeekCurrent)
	if err != nil {
		return err
	}
	padding := ((offset + align - 1) / align) * align
	buf := make([]byte, padding-offset)
	if err := binary.Write(f, llm.ByteOrder, buf); err != nil {
		return err
	}

	return nil
}

func (llm *GGUFModel) writeInt32(f *os.File, v int32) error {
	if err := binary.Write(f, llm.ByteOrder, v); err != nil {
		return err
	}
	return nil
}

func (llm *GGUFModel) writeUint32(f *os.File, v uint32) error {
	if err := binary.Write(f, llm.ByteOrder, v); err != nil {
		return err
	}
	return nil
}

func (llm *GGUFModel) writeF32(f *os.File, v float32) error {
	if err := binary.Write(f, llm.ByteOrder, v); err != nil {
		return err
	}
	return nil
}

func (llm *GGUFModel) writeBool(f *os.File, b bool) error {
	if err := binary.Write(f, llm.ByteOrder, b); err != nil {
		return err
	}
	return nil
}

func (llm *GGUFModel) writeString(f *os.File, s string) error {
	if err := binary.Write(f, llm.ByteOrder, uint64(len(s))); err != nil {
		return err
	}

	if err := binary.Write(f, llm.ByteOrder, []byte(s)); err != nil {
		return err
	}
	return nil
}

Michael Yang's avatar
Michael Yang committed
636
func (llm *GGUFModel) Decode(rs io.ReadSeeker) error {
637
	// decode key-values
Bruce MacDonald's avatar
Bruce MacDonald committed
638
	for i := 0; uint64(i) < llm.NumKV(); i++ {
Michael Yang's avatar
Michael Yang committed
639
		k, err := llm.readString(rs)
Bruce MacDonald's avatar
Bruce MacDonald committed
640
641
642
643
		if err != nil {
			return err
		}

Michael Yang's avatar
Michael Yang committed
644
		vtype := llm.readU32(rs)
Bruce MacDonald's avatar
Bruce MacDonald committed
645
646
647

		var v any
		switch vtype {
648
		case GGUFTypeUint8:
Michael Yang's avatar
Michael Yang committed
649
			v = llm.readU8(rs)
650
		case GGUFTypeInt8:
Michael Yang's avatar
Michael Yang committed
651
			v = llm.readI8(rs)
652
		case GGUFTypeUint16:
Michael Yang's avatar
Michael Yang committed
653
			v = llm.readU16(rs)
654
		case GGUFTypeInt16:
Michael Yang's avatar
Michael Yang committed
655
			v = llm.readI16(rs)
656
		case GGUFTypeUint32:
Michael Yang's avatar
Michael Yang committed
657
			v = llm.readU32(rs)
658
		case GGUFTypeInt32:
Michael Yang's avatar
Michael Yang committed
659
			v = llm.readI32(rs)
660
		case GGUFTypeUint64:
Michael Yang's avatar
Michael Yang committed
661
			v = llm.readU64(rs)
662
		case GGUFTypeInt64:
Michael Yang's avatar
Michael Yang committed
663
			v = llm.readI64(rs)
664
		case GGUFTypeFloat32:
Michael Yang's avatar
Michael Yang committed
665
			v = llm.readF32(rs)
666
		case GGUFTypeFloat64:
Michael Yang's avatar
Michael Yang committed
667
			v = llm.readF64(rs)
668
		case GGUFTypeBool:
Michael Yang's avatar
Michael Yang committed
669
			v = llm.readBool(rs)
670
		case GGUFTypeString:
Michael Yang's avatar
Michael Yang committed
671
			s, err := llm.readString(rs)
Bruce MacDonald's avatar
Bruce MacDonald committed
672
673
674
675
676
			if err != nil {
				return err
			}

			v = s
677
		case GGUFTypeArray:
Michael Yang's avatar
Michael Yang committed
678
			a, err := llm.readArray(rs)
Bruce MacDonald's avatar
Bruce MacDonald committed
679
680
681
682
683
684
685
686
687
			if err != nil {
				return err
			}

			v = a
		default:
			return fmt.Errorf("invalid type: %d", vtype)
		}

688
		llm.KV[k] = v
Bruce MacDonald's avatar
Bruce MacDonald committed
689
690
	}

691
692
	// decode tensors
	for i := 0; uint64(i) < llm.NumTensor(); i++ {
Michael Yang's avatar
Michael Yang committed
693
		name, err := llm.readString(rs)
694
		if err != nil {
695
696
697
			return err
		}

Michael Yang's avatar
Michael Yang committed
698
		// dims is the number of dimensions in the tensor
Michael Yang's avatar
Michael Yang committed
699
		dims := llm.readU32(rs)
700
701
702

		shape := [4]uint64{1, 1, 1, 1}
		for i := 0; uint32(i) < dims; i++ {
Michael Yang's avatar
Michael Yang committed
703
			shape[i] = llm.readU64(rs)
704
705
		}

706
707
		tensor := Tensor{
			Name:   name,
Michael Yang's avatar
Michael Yang committed
708
709
			Kind:   llm.readU32(rs),
			Offset: llm.readU64(rs),
Michael Yang's avatar
Michael Yang committed
710
			Shape:  shape[:],
Michael Yang's avatar
Michael Yang committed
711
		}
712

713
714
		llm.Tensors = append(llm.Tensors, tensor)
		llm.parameters += tensor.Parameters()
715
716
	}

717
	alignment, ok := llm.KV["general.alignment"].(uint32)
718
719
720
	if !ok {
		alignment = 32
	}
721

Michael Yang's avatar
Michael Yang committed
722
723
724
725
726
727
728
729
730
	offset, err := rs.Seek(0, io.SeekCurrent)
	if err != nil {
		return err
	}

	if _, err := rs.Seek(int64(alignment)-offset%int64(alignment), io.SeekCurrent); err != nil {
		return err
	}

731
732
	for _, tensor := range llm.Tensors {
		padded := (int64(tensor.Size()) + int64(alignment) - 1) & ^(int64(alignment) - 1)
Michael Yang's avatar
Michael Yang committed
733
734
735
		if _, err := rs.Seek(padded, io.SeekCurrent); err != nil {
			return err
		}
736
737
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
738
739
740
	return nil
}

741
742
func (llm *GGUFModel) NumLayers() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.block_count", llm.ModelFamily())]
743
744
745
746
	if !exists {
		return 0
	}

747
748
749
	return value.(uint32)
}

750
751
func (llm *GGUFModel) NumHead() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.attention.head_count", llm.ModelFamily())]
752
753
754
755
756
757
758
	if !exists {
		return 0
	}

	return value.(uint32)
}

759
760
func (llm *GGUFModel) NumEmbed() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.embedding_length", llm.ModelFamily())]
761
762
763
764
765
766
767
	if !exists {
		return 0
	}

	return value.(uint32)
}

768
769
func (llm *GGUFModel) NumHeadKv() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.attention.head_count_kv", llm.ModelFamily())]
770
771
772
773
774
775
776
	if !exists {
		return 0
	}

	return value.(uint32)
}

777
778
func (llm *GGUFModel) NumCtx() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.context_length", llm.ModelFamily())]
Michael Yang's avatar
Michael Yang committed
779
780
781
782
783
784
785
	if !exists {
		return 0
	}

	return value.(uint32)
}

786
func (llm *GGUFModel) NumGQA() uint32 {
787
788
789
790
791
792
	numHeadKv := llm.NumHeadKv()
	if numHeadKv == 0 {
		return 0
	}

	return llm.NumHead() / numHeadKv
793
794
}

795
func (llm GGUFModel) readU8(r io.Reader) uint8 {
Bruce MacDonald's avatar
Bruce MacDonald committed
796
	var u8 uint8
797
	binary.Read(r, llm.ByteOrder, &u8)
Bruce MacDonald's avatar
Bruce MacDonald committed
798
799
800
	return u8
}

801
func (llm GGUFModel) readI8(r io.Reader) int8 {
Bruce MacDonald's avatar
Bruce MacDonald committed
802
	var i8 int8
803
	binary.Read(r, llm.ByteOrder, &i8)
Bruce MacDonald's avatar
Bruce MacDonald committed
804
805
806
	return i8
}

807
func (llm GGUFModel) readU16(r io.Reader) uint16 {
Bruce MacDonald's avatar
Bruce MacDonald committed
808
	var u16 uint16
809
	binary.Read(r, llm.ByteOrder, &u16)
Bruce MacDonald's avatar
Bruce MacDonald committed
810
811
812
	return u16
}

813
func (llm GGUFModel) readI16(r io.Reader) int16 {
Bruce MacDonald's avatar
Bruce MacDonald committed
814
	var i16 int16
815
	binary.Read(r, llm.ByteOrder, &i16)
Bruce MacDonald's avatar
Bruce MacDonald committed
816
817
818
	return i16
}

819
func (llm GGUFModel) readU32(r io.Reader) uint32 {
Bruce MacDonald's avatar
Bruce MacDonald committed
820
	var u32 uint32
821
	binary.Read(r, llm.ByteOrder, &u32)
Bruce MacDonald's avatar
Bruce MacDonald committed
822
823
824
	return u32
}

825
func (llm GGUFModel) readI32(r io.Reader) int32 {
Bruce MacDonald's avatar
Bruce MacDonald committed
826
	var i32 int32
827
	binary.Read(r, llm.ByteOrder, &i32)
Bruce MacDonald's avatar
Bruce MacDonald committed
828
829
830
	return i32
}

831
func (llm GGUFModel) readU64(r io.Reader) uint64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
832
	var u64 uint64
833
	binary.Read(r, llm.ByteOrder, &u64)
Bruce MacDonald's avatar
Bruce MacDonald committed
834
835
836
	return u64
}

837
func (llm GGUFModel) readI64(r io.Reader) int64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
838
	var i64 int64
839
	binary.Read(r, llm.ByteOrder, &i64)
Bruce MacDonald's avatar
Bruce MacDonald committed
840
841
842
	return i64
}

843
func (llm GGUFModel) readF32(r io.Reader) float32 {
Bruce MacDonald's avatar
Bruce MacDonald committed
844
	var f32 float32
845
	binary.Read(r, llm.ByteOrder, &f32)
Bruce MacDonald's avatar
Bruce MacDonald committed
846
847
848
	return f32
}

849
func (llm GGUFModel) readF64(r io.Reader) float64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
850
	var f64 float64
851
	binary.Read(r, llm.ByteOrder, &f64)
Bruce MacDonald's avatar
Bruce MacDonald committed
852
853
854
	return f64
}

855
func (llm GGUFModel) readBool(r io.Reader) bool {
Bruce MacDonald's avatar
Bruce MacDonald committed
856
	var b bool
857
	binary.Read(r, llm.ByteOrder, &b)
Bruce MacDonald's avatar
Bruce MacDonald committed
858
859
860
	return b
}

861
func (llm GGUFModel) readStringV1(r io.Reader) (string, error) {
Bruce MacDonald's avatar
Bruce MacDonald committed
862
	var nameLength uint32
863
	binary.Read(r, llm.ByteOrder, &nameLength)
Bruce MacDonald's avatar
Bruce MacDonald committed
864
865
866
867
868
869
870
871
872
873
874
875

	var b bytes.Buffer
	if _, err := io.CopyN(&b, r, int64(nameLength)); err != nil {
		return "", err
	}

	// gguf v1 strings are null-terminated
	b.Truncate(b.Len() - 1)

	return b.String(), nil
}

876
func (llm GGUFModel) readString(r io.Reader) (string, error) {
877
878
879
880
	if llm.Version == 1 {
		return llm.readStringV1(r)
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
881
	var nameLength uint64
882
	binary.Read(r, llm.ByteOrder, &nameLength)
Bruce MacDonald's avatar
Bruce MacDonald committed
883
884
885
886
887
888
889
890
891

	var b bytes.Buffer
	if _, err := io.CopyN(&b, r, int64(nameLength)); err != nil {
		return "", err
	}

	return b.String(), nil
}

892
func (llm *GGUFModel) readArrayV1(r io.Reader) (arr []any, err error) {
Bruce MacDonald's avatar
Bruce MacDonald committed
893
894
895
896
897
	atype := llm.readU32(r)
	n := llm.readU32(r)

	for i := 0; uint32(i) < n; i++ {
		switch atype {
898
		case GGUFTypeUint8:
Bruce MacDonald's avatar
Bruce MacDonald committed
899
			arr = append(arr, llm.readU8(r))
900
		case GGUFTypeInt8:
Michael Yang's avatar
Michael Yang committed
901
			arr = append(arr, llm.readI8(r))
902
		case GGUFTypeUint16:
Bruce MacDonald's avatar
Bruce MacDonald committed
903
			arr = append(arr, llm.readU16(r))
904
		case GGUFTypeInt16:
Bruce MacDonald's avatar
Bruce MacDonald committed
905
			arr = append(arr, llm.readI16(r))
906
		case GGUFTypeUint32:
Bruce MacDonald's avatar
Bruce MacDonald committed
907
			arr = append(arr, llm.readU32(r))
908
		case GGUFTypeInt32:
Bruce MacDonald's avatar
Bruce MacDonald committed
909
			arr = append(arr, llm.readI32(r))
910
		case GGUFTypeFloat32:
Bruce MacDonald's avatar
Bruce MacDonald committed
911
			arr = append(arr, llm.readF32(r))
912
		case GGUFTypeBool:
Bruce MacDonald's avatar
Bruce MacDonald committed
913
			arr = append(arr, llm.readBool(r))
914
		case GGUFTypeString:
Bruce MacDonald's avatar
Bruce MacDonald committed
915
916
917
918
919
920
921
922
923
924
925
926
927
928
			s, err := llm.readStringV1(r)
			if err != nil {
				return nil, err
			}

			arr = append(arr, s)
		default:
			return nil, fmt.Errorf("invalid array type: %d", atype)
		}
	}

	return
}

929
func (llm *GGUFModel) readArray(r io.Reader) (arr []any, err error) {
930
931
932
933
	if llm.Version == 1 {
		return llm.readArrayV1(r)
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
934
935
936
937
938
	atype := llm.readU32(r)
	n := llm.readU64(r)

	for i := 0; uint64(i) < n; i++ {
		switch atype {
939
		case GGUFTypeUint8:
Bruce MacDonald's avatar
Bruce MacDonald committed
940
			arr = append(arr, llm.readU8(r))
941
		case GGUFTypeInt8:
Michael Yang's avatar
Michael Yang committed
942
			arr = append(arr, llm.readI8(r))
943
		case GGUFTypeUint16:
Bruce MacDonald's avatar
Bruce MacDonald committed
944
			arr = append(arr, llm.readU16(r))
945
		case GGUFTypeInt16:
Bruce MacDonald's avatar
Bruce MacDonald committed
946
			arr = append(arr, llm.readI16(r))
947
		case GGUFTypeUint32:
Bruce MacDonald's avatar
Bruce MacDonald committed
948
			arr = append(arr, llm.readU32(r))
949
		case GGUFTypeInt32:
Bruce MacDonald's avatar
Bruce MacDonald committed
950
			arr = append(arr, llm.readI32(r))
951
		case GGUFTypeUint64:
Bruce MacDonald's avatar
Bruce MacDonald committed
952
			arr = append(arr, llm.readU64(r))
953
		case GGUFTypeInt64:
Bruce MacDonald's avatar
Bruce MacDonald committed
954
			arr = append(arr, llm.readI64(r))
955
		case GGUFTypeFloat32:
Bruce MacDonald's avatar
Bruce MacDonald committed
956
			arr = append(arr, llm.readF32(r))
957
		case GGUFTypeFloat64:
Bruce MacDonald's avatar
Bruce MacDonald committed
958
			arr = append(arr, llm.readF64(r))
959
		case GGUFTypeBool:
Bruce MacDonald's avatar
Bruce MacDonald committed
960
			arr = append(arr, llm.readBool(r))
961
		case GGUFTypeString:
Bruce MacDonald's avatar
Bruce MacDonald committed
962
963
964
965
966
967
968
969
970
971
972
973
974
			s, err := llm.readString(r)
			if err != nil {
				return nil, err
			}

			arr = append(arr, s)
		default:
			return nil, fmt.Errorf("invalid array type: %d", atype)
		}
	}

	return
}