gguf.go 13.3 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
	"strings"
9
10

	"log/slog"
Bruce MacDonald's avatar
Bruce MacDonald committed
11
12
)

13
type containerGGUF struct {
14
	ByteOrder binary.ByteOrder
Michael Yang's avatar
ggufv3  
Michael Yang committed
15

Bruce MacDonald's avatar
Bruce MacDonald committed
16
17
18
19
20
21
22
23
24
25
26
	Version uint32

	V1 struct {
		NumTensor uint32
		NumKV     uint32
	}

	V2 struct {
		NumTensor uint64
		NumKV     uint64
	}
27
28
29
30
31

	V3 struct {
		NumTensor uint64
		NumKV     uint64
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
32
33
}

34
func (c *containerGGUF) Name() string {
Bruce MacDonald's avatar
Bruce MacDonald committed
35
36
37
	return "gguf"
}

38
func (c *containerGGUF) Decode(rs io.ReadSeeker) (model, error) {
Michael Yang's avatar
Michael Yang committed
39
40
	var version [4]byte
	if err := binary.Read(rs, c.ByteOrder, &version); err != nil {
41
42
		return nil, err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
43

Michael Yang's avatar
Michael Yang committed
44
45
46
47
48
49
50
51
52
53
54
55
	// if the lower 16 bits are 0, the byte order is probably wrong
	if c.ByteOrder.Uint32(version[:])&1<<4 == 0 {
		switch c.ByteOrder {
		case binary.LittleEndian:
			c.ByteOrder = binary.BigEndian
		case binary.BigEndian:
			c.ByteOrder = binary.LittleEndian
		}
	}

	c.Version = c.ByteOrder.Uint32(version[:])

56
	var err error
Bruce MacDonald's avatar
Bruce MacDonald committed
57
58
	switch c.Version {
	case 1:
59
60
61
		err = binary.Read(rs, c.ByteOrder, &c.V1)
	case 2:
		err = binary.Read(rs, c.ByteOrder, &c.V2)
Bruce MacDonald's avatar
Bruce MacDonald committed
62
	default:
63
64
65
66
		err = binary.Read(rs, c.ByteOrder, &c.V3)
	}
	if err != nil {
		return nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
67
68
	}

69
	model := newGGUF(c)
70
	slog.Debug(fmt.Sprintf("model = %#v", model))
Michael Yang's avatar
Michael Yang committed
71
	if err := model.Decode(rs); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
72
73
74
75
76
77
		return nil, err
	}

	return model, nil
}

78
const (
79
80
81
82
83
84
85
86
87
88
89
90
91
	ggufTypeUint8 uint32 = iota
	ggufTypeInt8
	ggufTypeUint16
	ggufTypeInt16
	ggufTypeUint32
	ggufTypeInt32
	ggufTypeFloat32
	ggufTypeBool
	ggufTypeString
	ggufTypeArray
	ggufTypeUint64
	ggufTypeInt64
	ggufTypeFloat64
92
)
Bruce MacDonald's avatar
Bruce MacDonald committed
93

94
95
type gguf struct {
	*containerGGUF
96

Michael Yang's avatar
Michael Yang committed
97
98
	kv      KV
	tensors []*Tensor
99
100

	parameters uint64
Bruce MacDonald's avatar
Bruce MacDonald committed
101
102
}

103
104
105
func newGGUF(container *containerGGUF) *gguf {
	return &gguf{
		containerGGUF: container,
Michael Yang's avatar
Michael Yang committed
106
		kv:            make(KV),
Bruce MacDonald's avatar
Bruce MacDonald committed
107
108
109
	}
}

110
111
112
113
func NewGGUFV3(bo binary.ByteOrder) *gguf {
	return newGGUF(&containerGGUF{ByteOrder: bo, Version: 3})
}

Michael Yang's avatar
Michael Yang committed
114
115
116
117
func (llm *gguf) KV() KV {
	return llm.kv
}

Michael Yang's avatar
Michael Yang committed
118
func (llm *gguf) Tensors() Tensors {
Michael Yang's avatar
Michael Yang committed
119
120
121
	return llm.tensors
}

122
123
124
func (llm *gguf) numTensor() uint64 {
	switch llm.Version {
	case 1:
125
		return uint64(llm.V1.NumTensor)
126
127
128
129
	case 2:
		return llm.V2.NumTensor
	default:
		return llm.V3.NumTensor
130
131
132
	}
}

133
134
135
func (llm *gguf) numKV() uint64 {
	switch llm.Version {
	case 1:
Bruce MacDonald's avatar
Bruce MacDonald committed
136
		return uint64(llm.V1.NumKV)
137
138
139
140
	case 2:
		return llm.V2.NumKV
	default:
		return llm.V3.NumKV
Bruce MacDonald's avatar
Bruce MacDonald committed
141
142
143
	}
}

144
145
146
147
148
func (llm *gguf) Decode(rs io.ReadSeeker) error {
	// decode key-values
	for i := 0; uint64(i) < llm.numKV(); i++ {
		k, err := readGGUFString(llm, rs)
		if err != nil {
149
150
151
			return err
		}

152
153
		t, err := readGGUF[uint32](llm, rs)
		if err != nil {
154
155
156
			return err
		}

157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
		var v any
		switch t {
		case ggufTypeUint8:
			v, err = readGGUF[uint8](llm, rs)
		case ggufTypeInt8:
			v, err = readGGUF[int8](llm, rs)
		case ggufTypeUint16:
			v, err = readGGUF[uint16](llm, rs)
		case ggufTypeInt16:
			v, err = readGGUF[int16](llm, rs)
		case ggufTypeUint32:
			v, err = readGGUF[uint32](llm, rs)
		case ggufTypeInt32:
			v, err = readGGUF[int32](llm, rs)
		case ggufTypeUint64:
			v, err = readGGUF[uint64](llm, rs)
		case ggufTypeInt64:
			v, err = readGGUF[int64](llm, rs)
		case ggufTypeFloat32:
			v, err = readGGUF[float32](llm, rs)
		case ggufTypeFloat64:
			v, err = readGGUF[float64](llm, rs)
		case ggufTypeBool:
			v, err = readGGUF[bool](llm, rs)
		case ggufTypeString:
			v, err = readGGUFString(llm, rs)
		case ggufTypeArray:
			v, err = readGGUFArray(llm, rs)
		default:
			return fmt.Errorf("invalid type: %d", t)
187
188
		}

189
		if err != nil {
190
191
192
			return err
		}

Michael Yang's avatar
Michael Yang committed
193
		llm.kv[k] = v
194
195
	}

196
197
198
	// decode tensors
	for i := 0; uint64(i) < llm.numTensor(); i++ {
		name, err := readGGUFString(llm, rs)
199
200
201
202
		if err != nil {
			return err
		}

203
204
		// dims is the number of dimensions in the tensor
		dims, err := readGGUF[uint32](llm, rs)
Bruce MacDonald's avatar
Bruce MacDonald committed
205
206
207
208
		if err != nil {
			return err
		}

209
210
211
		shape := [4]uint64{1, 1, 1, 1}
		for i := 0; uint32(i) < dims; i++ {
			shape[i], err = readGGUF[uint64](llm, rs)
Bruce MacDonald's avatar
Bruce MacDonald committed
212
213
214
215
216
			if err != nil {
				return err
			}
		}

217
		kind, err := readGGUF[uint32](llm, rs)
218
		if err != nil {
219
220
221
			return err
		}

222
223
224
		offset, err := readGGUF[uint64](llm, rs)
		if err != nil {
			return err
225
226
		}

227
228
		tensor := Tensor{
			Name:   name,
229
230
			Kind:   kind,
			Offset: offset,
Michael Yang's avatar
Michael Yang committed
231
			Shape:  shape[:],
Michael Yang's avatar
Michael Yang committed
232
		}
233

Michael Yang's avatar
Michael Yang committed
234
		llm.tensors = append(llm.tensors, &tensor)
235
		llm.parameters += tensor.parameters()
236
237
	}

Michael Yang's avatar
Michael Yang committed
238
239
240
241
	// patch KV with parameter count
	llm.kv["general.parameter_count"] = llm.parameters

	alignment, ok := llm.kv["general.alignment"].(uint32)
242
243
244
	if !ok {
		alignment = 32
	}
245

Michael Yang's avatar
Michael Yang committed
246
247
248
249
250
	offset, err := rs.Seek(0, io.SeekCurrent)
	if err != nil {
		return err
	}

251
	padding := llm.padding(offset, int64(alignment))
252
	if _, err := rs.Seek(padding, io.SeekCurrent); err != nil {
Michael Yang's avatar
Michael Yang committed
253
254
255
		return err
	}

Michael Yang's avatar
Michael Yang committed
256
	for _, tensor := range llm.tensors {
Michael Yang's avatar
Michael Yang committed
257
		if _, err := rs.Seek(int64(tensor.Size()), io.SeekCurrent); err != nil {
258
259
260
			return err
		}

Michael Yang's avatar
Michael Yang committed
261
		padding := llm.padding(int64(tensor.Size()), int64(alignment))
262
		if _, err := rs.Seek(padding, io.SeekCurrent); err != nil {
Michael Yang's avatar
Michael Yang committed
263
264
			return err
		}
265
266
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
267
268
269
	return nil
}

270
271
272
273
func readGGUF[T any](llm *gguf, r io.Reader) (T, error) {
	var t T
	err := binary.Read(r, llm.ByteOrder, &t)
	return t, err
Bruce MacDonald's avatar
Bruce MacDonald committed
274
275
}

276
277
278
279
func writeGGUF[V any](llm *gguf, w io.Writer, t uint32, v V) error {
	if err := binary.Write(w, llm.ByteOrder, t); err != nil {
		return err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
280

281
	return binary.Write(w, llm.ByteOrder, v)
Bruce MacDonald's avatar
Bruce MacDonald committed
282
283
}

284
285
286
287
288
func readGGUFV1String(llm *gguf, r io.Reader) (string, error) {
	var length uint64
	if err := binary.Read(r, llm.ByteOrder, &length); err != nil {
		return "", err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
289
290

	var b bytes.Buffer
291
	if _, err := io.CopyN(&b, r, int64(length)); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
292
293
294
295
296
297
298
299
300
		return "", err
	}

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

	return b.String(), nil
}

301
func readGGUFString(llm *gguf, r io.Reader) (string, error) {
302
	if llm.Version == 1 {
303
		return readGGUFV1String(llm, r)
304
305
	}

306
307
308
309
	var length uint64
	if err := binary.Read(r, llm.ByteOrder, &length); err != nil {
		return "", err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
310
311

	var b bytes.Buffer
312
	if _, err := io.CopyN(&b, r, int64(length)); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
313
314
315
316
317
318
		return "", err
	}

	return b.String(), nil
}

319
320
321
322
func writeGGUFString(llm *gguf, w io.Writer, s string) error {
	if err := binary.Write(w, llm.ByteOrder, ggufTypeString); err != nil {
		return err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
323

324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
	if err := binary.Write(w, llm.ByteOrder, uint64(len(s))); err != nil {
		return err
	}

	_, err := io.Copy(w, strings.NewReader(s))
	return err
}

func readGGUFV1Array(llm *gguf, r io.Reader) (a []any, err error) {
	t, err := readGGUF[uint32](llm, r)
	if err != nil {
		return nil, err
	}

	n, err := readGGUF[uint32](llm, r)
	if err != nil {
		return nil, err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
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
	for i := 0; uint32(i) < n; i++ {
		var e any
		switch t {
		case ggufTypeUint8:
			e, err = readGGUF[uint8](llm, r)
		case ggufTypeInt8:
			e, err = readGGUF[int8](llm, r)
		case ggufTypeUint16:
			e, err = readGGUF[uint16](llm, r)
		case ggufTypeInt16:
			e, err = readGGUF[int16](llm, r)
		case ggufTypeUint32:
			e, err = readGGUF[uint32](llm, r)
		case ggufTypeInt32:
			e, err = readGGUF[int32](llm, r)
		case ggufTypeUint64:
			e, err = readGGUF[uint64](llm, r)
		case ggufTypeInt64:
			e, err = readGGUF[int64](llm, r)
		case ggufTypeFloat32:
			e, err = readGGUF[float32](llm, r)
		case ggufTypeFloat64:
			e, err = readGGUF[float64](llm, r)
		case ggufTypeBool:
			e, err = readGGUF[bool](llm, r)
		case ggufTypeString:
			e, err = readGGUFV1String(llm, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
370
		default:
371
			return nil, fmt.Errorf("invalid array type: %d", t)
Bruce MacDonald's avatar
Bruce MacDonald committed
372
		}
373
374
375
376
377
		if err != nil {
			return nil, err
		}

		a = append(a, e)
Bruce MacDonald's avatar
Bruce MacDonald committed
378
379
380
381
382
	}

	return
}

383
func readGGUFArray(llm *gguf, r io.Reader) (a []any, err error) {
384
	if llm.Version == 1 {
385
		return readGGUFV1Array(llm, r)
386
387
	}

388
389
390
391
	t, err := readGGUF[uint32](llm, r)
	if err != nil {
		return nil, err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
392

393
394
395
396
	n, err := readGGUF[uint64](llm, r)
	if err != nil {
		return nil, err
	}
Bruce MacDonald's avatar
Bruce MacDonald committed
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
	for i := 0; uint64(i) < n; i++ {
		var e any
		switch t {
		case ggufTypeUint8:
			e, err = readGGUF[uint8](llm, r)
		case ggufTypeInt8:
			e, err = readGGUF[int8](llm, r)
		case ggufTypeUint16:
			e, err = readGGUF[uint16](llm, r)
		case ggufTypeInt16:
			e, err = readGGUF[int16](llm, r)
		case ggufTypeUint32:
			e, err = readGGUF[uint32](llm, r)
		case ggufTypeInt32:
			e, err = readGGUF[int32](llm, r)
		case ggufTypeUint64:
			e, err = readGGUF[uint64](llm, r)
		case ggufTypeInt64:
			e, err = readGGUF[int64](llm, r)
		case ggufTypeFloat32:
			e, err = readGGUF[float32](llm, r)
		case ggufTypeFloat64:
			e, err = readGGUF[float64](llm, r)
		case ggufTypeBool:
			e, err = readGGUF[bool](llm, r)
		case ggufTypeString:
			e, err = readGGUFString(llm, r)
Bruce MacDonald's avatar
Bruce MacDonald committed
425
		default:
426
			return nil, fmt.Errorf("invalid array type: %d", t)
Bruce MacDonald's avatar
Bruce MacDonald committed
427
		}
428
429
430
431
432
		if err != nil {
			return nil, err
		}

		a = append(a, e)
Bruce MacDonald's avatar
Bruce MacDonald committed
433
434
435
436
	}

	return
}
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

func writeGGUFArray[S ~[]E, E any](llm *gguf, w io.Writer, t uint32, s S) error {
	if err := binary.Write(w, llm.ByteOrder, ggufTypeArray); err != nil {
		return err
	}

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

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

	for _, e := range s {
		if err := binary.Write(w, llm.ByteOrder, e); err != nil {
			return err
		}
	}

	return nil
}

var ggufKVOrder = map[string][]string{
	"llama": {
		"general.architecture",
		"general.name",
464
		"llama.vocab_size",
465
466
467
468
469
470
471
472
		"llama.context_length",
		"llama.embedding_length",
		"llama.block_count",
		"llama.feed_forward_length",
		"llama.attention.head_count",
		"llama.attention.head_count_kv",
		"llama.attention.layer_norm_rms_epsilon",
		"llama.rope.freq_base",
Patrick Devine's avatar
Patrick Devine committed
473
474
475
		"llama.rope.dimension_count",
		"llama.expert_count",
		"llama.expert_used_count",
476
477
478
479
480
481
482
483
484
485
		"gemma.context_length",
		"gemma.embedding_length",
		"gemma.block_count",
		"gemma.feed_forward_length",
		"gemma.attention.head_count",
		"gemma.attention.head_count_kv",
		"gemma.attention.layer_norm_rms_epsilon",
		"gemma.attention.key_length",
		"gemma.attention.value_length",
		"general.file_type",
Michael Yang's avatar
Michael Yang committed
486
		"tokenizer.ggml.pre",
487
488
489
		"tokenizer.ggml.model",
		"tokenizer.ggml.tokens",
		"tokenizer.ggml.scores",
Patrick Devine's avatar
Patrick Devine committed
490
		"tokenizer.ggml.merges",
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
		"tokenizer.ggml.token_type",
		"tokenizer.ggml.bos_token_id",
		"tokenizer.ggml.eos_token_id",
		"tokenizer.ggml.unknown_token_id",
		"tokenizer.ggml.padding_token_id",
		"tokenizer.ggml.add_bos_token",
		"tokenizer.ggml.add_eos_token",
		"tokenizer.chat_template",
	},
}

func (llm *gguf) Encode(ws io.WriteSeeker, kv KV, tensors []Tensor) error {
	switch llm.Version {
	case 3:
		llm.V3.NumTensor = uint64(len(tensors))
		llm.V3.NumKV = uint64(len(kv))
	default:
		return fmt.Errorf("not implemented: ggufv%d", llm.Version)
	}

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

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

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

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

527
528
529
530
531
	kvCheck := make(map[string]bool)
	for k := range kv {
		kvCheck[k] = false
	}

532
533
534
535
536
	for _, k := range ggufKVOrder["llama"] {
		v, ok := kv[k]
		if !ok {
			continue
		}
537
		kvCheck[k] = true
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

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

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

		var err error
		switch v := v.(type) {
		case uint32:
			err = writeGGUF(llm, ws, ggufTypeUint32, v)
		case float32:
			err = writeGGUF(llm, ws, ggufTypeFloat32, v)
		case bool:
			err = writeGGUF(llm, ws, ggufTypeBool, v)
		case string:
			err = writeGGUFString(llm, ws, v)
		case []int32:
			err = writeGGUFArray(llm, ws, ggufTypeInt32, v)
		case []uint32:
			err = writeGGUFArray(llm, ws, ggufTypeUint32, v)
		case []float32:
			err = writeGGUFArray(llm, ws, ggufTypeFloat32, v)
		case []string:
			if err := binary.Write(ws, llm.ByteOrder, ggufTypeArray); err != nil {
				return err
			}

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

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

			for _, e := range v {
				if err := binary.Write(ws, llm.ByteOrder, uint64(len(e))); err != nil {
					return err
				}

				if err := binary.Write(ws, llm.ByteOrder, []byte(e)); err != nil {
					return err
				}
			}
Patrick Devine's avatar
Patrick Devine committed
585
586
		default:
			return fmt.Errorf("improper type for '%s'", k)
587
588
589
590
591
592
		}
		if err != nil {
			return err
		}
	}

593
594
595
596
597
598
	for k, v := range kvCheck {
		if !v {
			return fmt.Errorf("Didn't know how to write kv %s", k)
		}
	}

599
600
601
602
603
604
605
606
607
	for _, tensor := range tensors {
		if err := binary.Write(ws, llm.ByteOrder, uint64(len(tensor.Name))); err != nil {
			return err
		}

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

Michael Yang's avatar
lint  
Michael Yang committed
608
609
		var dims int
		for cnt := range len(tensor.Shape) {
Patrick Devine's avatar
Patrick Devine committed
610
611
612
			if tensor.Shape[cnt] > 0 {
				dims++
			}
613
614
615
616
617
618
		}

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

Michael Yang's avatar
lint  
Michael Yang committed
619
620
		for i := range dims {
			if err := binary.Write(ws, llm.ByteOrder, tensor.Shape[dims-1-i]); err != nil {
621
622
623
624
625
626
627
628
629
630
631
632
633
				return err
			}
		}

		if err := binary.Write(ws, llm.ByteOrder, tensor.Kind); err != nil {
			return err
		}

		if err := binary.Write(ws, llm.ByteOrder, tensor.Offset); err != nil {
			return err
		}
	}

634
	var alignment int64 = 32
635
636
637
638
639
640
	for _, tensor := range tensors {
		offset, err := ws.Seek(0, io.SeekCurrent)
		if err != nil {
			return err
		}

641
642
		padding := llm.padding(offset, alignment)
		if err := binary.Write(ws, llm.ByteOrder, bytes.Repeat([]byte{0}, int(padding))); err != nil {
643
644
			return err
		}
645
646
647
648

		if _, err := tensor.WriteTo(ws); err != nil {
			return err
		}
649
650
651
652
653
654
	}

	return nil
}

func (gguf) padding(offset, align int64) int64 {
655
	return (align - offset%align) % align
656
}