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

import (
	"bytes"
	"encoding/binary"
6
	"errors"
Bruce MacDonald's avatar
Bruce MacDonald committed
7
8
	"fmt"
	"io"
9
10
11
12
13
14
15
16
	"log/slog"
	"os"
	"regexp"

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

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

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

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

	V1 struct {
		NumTensor uint32
		NumKV     uint32
	}

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

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

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

46
47
func (c *ContainerGGUF) Decode(rso *readSeekOffset) (model, error) {
	binary.Read(rso, c.ByteOrder, &c.Version)
Bruce MacDonald's avatar
Bruce MacDonald committed
48
49
50

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

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

	return model, nil
}

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

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

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

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

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

	FileName      string
	OffsetPadding uint64
	FileOffsets   []uint64
103
104
}

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

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

119
	switch t.Kind {
Michael Yang's avatar
Michael Yang committed
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
145
	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
146
147
148
149
150
151
152
153
	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
154
155
156
157
158
	default:
		return 0
	}
}

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

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

171
172
173
174
175
176
177
178
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
	}
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
207
	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
208
209

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

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

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

	return llm.V2.NumTensor
}

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

	return llm.V2.NumKV
}

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
256
	return "unknown"
Bruce MacDonald's avatar
Bruce MacDonald committed
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
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)

544
			if errors.Is(err, io.EOF) || remaining <= 0 {
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
636
637
				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
}

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

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

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

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

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

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

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

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

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

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

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

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

Michael Yang's avatar
Michael Yang committed
723
	rso.Seek(int64(alignment)-rso.offset%int64(alignment), io.SeekCurrent)
724
725
	for _, tensor := range llm.Tensors {
		padded := (int64(tensor.Size()) + int64(alignment) - 1) & ^(int64(alignment) - 1)
Michael Yang's avatar
Michael Yang committed
726
		rso.Seek(padded, io.SeekCurrent)
727
728
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
729
730
731
	return nil
}

732
733
func (llm *GGUFModel) NumLayers() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.block_count", llm.ModelFamily())]
734
735
736
737
	if !exists {
		return 0
	}

738
739
740
	return value.(uint32)
}

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

	return value.(uint32)
}

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

	return value.(uint32)
}

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

	return value.(uint32)
}

768
769
func (llm *GGUFModel) NumCtx() uint32 {
	value, exists := llm.KV[fmt.Sprintf("%s.context_length", llm.ModelFamily())]
Michael Yang's avatar
Michael Yang committed
770
771
772
773
774
775
776
	if !exists {
		return 0
	}

	return value.(uint32)
}

777
func (llm *GGUFModel) NumGQA() uint32 {
778
779
780
781
782
783
	numHeadKv := llm.NumHeadKv()
	if numHeadKv == 0 {
		return 0
	}

	return llm.NumHead() / numHeadKv
784
785
}

786
func (llm GGUFModel) readU8(r io.Reader) uint8 {
Bruce MacDonald's avatar
Bruce MacDonald committed
787
	var u8 uint8
788
	binary.Read(r, llm.ByteOrder, &u8)
Bruce MacDonald's avatar
Bruce MacDonald committed
789
790
791
	return u8
}

792
func (llm GGUFModel) readI8(r io.Reader) int8 {
Bruce MacDonald's avatar
Bruce MacDonald committed
793
	var i8 int8
794
	binary.Read(r, llm.ByteOrder, &i8)
Bruce MacDonald's avatar
Bruce MacDonald committed
795
796
797
	return i8
}

798
func (llm GGUFModel) readU16(r io.Reader) uint16 {
Bruce MacDonald's avatar
Bruce MacDonald committed
799
	var u16 uint16
800
	binary.Read(r, llm.ByteOrder, &u16)
Bruce MacDonald's avatar
Bruce MacDonald committed
801
802
803
	return u16
}

804
func (llm GGUFModel) readI16(r io.Reader) int16 {
Bruce MacDonald's avatar
Bruce MacDonald committed
805
	var i16 int16
806
	binary.Read(r, llm.ByteOrder, &i16)
Bruce MacDonald's avatar
Bruce MacDonald committed
807
808
809
	return i16
}

810
func (llm GGUFModel) readU32(r io.Reader) uint32 {
Bruce MacDonald's avatar
Bruce MacDonald committed
811
	var u32 uint32
812
	binary.Read(r, llm.ByteOrder, &u32)
Bruce MacDonald's avatar
Bruce MacDonald committed
813
814
815
	return u32
}

816
func (llm GGUFModel) readI32(r io.Reader) int32 {
Bruce MacDonald's avatar
Bruce MacDonald committed
817
	var i32 int32
818
	binary.Read(r, llm.ByteOrder, &i32)
Bruce MacDonald's avatar
Bruce MacDonald committed
819
820
821
	return i32
}

822
func (llm GGUFModel) readU64(r io.Reader) uint64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
823
	var u64 uint64
824
	binary.Read(r, llm.ByteOrder, &u64)
Bruce MacDonald's avatar
Bruce MacDonald committed
825
826
827
	return u64
}

828
func (llm GGUFModel) readI64(r io.Reader) int64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
829
	var i64 int64
830
	binary.Read(r, llm.ByteOrder, &i64)
Bruce MacDonald's avatar
Bruce MacDonald committed
831
832
833
	return i64
}

834
func (llm GGUFModel) readF32(r io.Reader) float32 {
Bruce MacDonald's avatar
Bruce MacDonald committed
835
	var f32 float32
836
	binary.Read(r, llm.ByteOrder, &f32)
Bruce MacDonald's avatar
Bruce MacDonald committed
837
838
839
	return f32
}

840
func (llm GGUFModel) readF64(r io.Reader) float64 {
Bruce MacDonald's avatar
Bruce MacDonald committed
841
	var f64 float64
842
	binary.Read(r, llm.ByteOrder, &f64)
Bruce MacDonald's avatar
Bruce MacDonald committed
843
844
845
	return f64
}

846
func (llm GGUFModel) readBool(r io.Reader) bool {
Bruce MacDonald's avatar
Bruce MacDonald committed
847
	var b bool
848
	binary.Read(r, llm.ByteOrder, &b)
Bruce MacDonald's avatar
Bruce MacDonald committed
849
850
851
	return b
}

852
func (llm GGUFModel) readStringV1(r io.Reader) (string, error) {
Bruce MacDonald's avatar
Bruce MacDonald committed
853
	var nameLength uint32
854
	binary.Read(r, llm.ByteOrder, &nameLength)
Bruce MacDonald's avatar
Bruce MacDonald committed
855
856
857
858
859
860
861
862
863
864
865
866

	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
}

867
func (llm GGUFModel) readString(r io.Reader) (string, error) {
868
869
870
871
	if llm.Version == 1 {
		return llm.readStringV1(r)
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
872
	var nameLength uint64
873
	binary.Read(r, llm.ByteOrder, &nameLength)
Bruce MacDonald's avatar
Bruce MacDonald committed
874
875
876
877
878
879
880
881
882

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

	return b.String(), nil
}

883
func (llm *GGUFModel) readArrayV1(r io.Reader) (arr []any, err error) {
Bruce MacDonald's avatar
Bruce MacDonald committed
884
885
886
887
888
	atype := llm.readU32(r)
	n := llm.readU32(r)

	for i := 0; uint32(i) < n; i++ {
		switch atype {
889
		case GGUFTypeUint8:
Bruce MacDonald's avatar
Bruce MacDonald committed
890
			arr = append(arr, llm.readU8(r))
891
		case GGUFTypeInt8:
Michael Yang's avatar
Michael Yang committed
892
			arr = append(arr, llm.readI8(r))
893
		case GGUFTypeUint16:
Bruce MacDonald's avatar
Bruce MacDonald committed
894
			arr = append(arr, llm.readU16(r))
895
		case GGUFTypeInt16:
Bruce MacDonald's avatar
Bruce MacDonald committed
896
			arr = append(arr, llm.readI16(r))
897
		case GGUFTypeUint32:
Bruce MacDonald's avatar
Bruce MacDonald committed
898
			arr = append(arr, llm.readU32(r))
899
		case GGUFTypeInt32:
Bruce MacDonald's avatar
Bruce MacDonald committed
900
			arr = append(arr, llm.readI32(r))
901
		case GGUFTypeFloat32:
Bruce MacDonald's avatar
Bruce MacDonald committed
902
			arr = append(arr, llm.readF32(r))
903
		case GGUFTypeBool:
Bruce MacDonald's avatar
Bruce MacDonald committed
904
			arr = append(arr, llm.readBool(r))
905
		case GGUFTypeString:
Bruce MacDonald's avatar
Bruce MacDonald committed
906
907
908
909
910
911
912
913
914
915
916
917
918
919
			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
}

920
func (llm *GGUFModel) readArray(r io.Reader) (arr []any, err error) {
921
922
923
924
	if llm.Version == 1 {
		return llm.readArrayV1(r)
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
925
926
927
928
929
	atype := llm.readU32(r)
	n := llm.readU64(r)

	for i := 0; uint64(i) < n; i++ {
		switch atype {
930
		case GGUFTypeUint8:
Bruce MacDonald's avatar
Bruce MacDonald committed
931
			arr = append(arr, llm.readU8(r))
932
		case GGUFTypeInt8:
Michael Yang's avatar
Michael Yang committed
933
			arr = append(arr, llm.readI8(r))
934
		case GGUFTypeUint16:
Bruce MacDonald's avatar
Bruce MacDonald committed
935
			arr = append(arr, llm.readU16(r))
936
		case GGUFTypeInt16:
Bruce MacDonald's avatar
Bruce MacDonald committed
937
			arr = append(arr, llm.readI16(r))
938
		case GGUFTypeUint32:
Bruce MacDonald's avatar
Bruce MacDonald committed
939
			arr = append(arr, llm.readU32(r))
940
		case GGUFTypeInt32:
Bruce MacDonald's avatar
Bruce MacDonald committed
941
			arr = append(arr, llm.readI32(r))
942
		case GGUFTypeUint64:
Bruce MacDonald's avatar
Bruce MacDonald committed
943
			arr = append(arr, llm.readU64(r))
944
		case GGUFTypeInt64:
Bruce MacDonald's avatar
Bruce MacDonald committed
945
			arr = append(arr, llm.readI64(r))
946
		case GGUFTypeFloat32:
Bruce MacDonald's avatar
Bruce MacDonald committed
947
			arr = append(arr, llm.readF32(r))
948
		case GGUFTypeFloat64:
Bruce MacDonald's avatar
Bruce MacDonald committed
949
			arr = append(arr, llm.readF64(r))
950
		case GGUFTypeBool:
Bruce MacDonald's avatar
Bruce MacDonald committed
951
			arr = append(arr, llm.readBool(r))
952
		case GGUFTypeString:
Bruce MacDonald's avatar
Bruce MacDonald committed
953
954
955
956
957
958
959
960
961
962
963
964
965
			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
}