convert.go 3.37 KB
Newer Older
1
2
3
4
package convert

import (
	"encoding/json"
Michael Yang's avatar
Michael Yang committed
5
	"errors"
6
	"fmt"
Michael Yang's avatar
Michael Yang committed
7
	"io"
8
	"io/fs"
9
10
	"log/slog"

11
	"github.com/ollama/ollama/llm"
12
13
)

Michael Yang's avatar
Michael Yang committed
14
15
16
type Parameters struct {
	Architectures []string `json:"architectures"`
	VocabSize     uint32   `json:"vocab_size"`
17
18
}

Michael Yang's avatar
Michael Yang committed
19
20
21
22
23
24
25
26
27
28
func (Parameters) KV(t *Tokenizer) llm.KV {
	kv := llm.KV{
		"general.file_type":            uint32(1),
		"general.quantization_version": uint32(2),
		"tokenizer.ggml.pre":           t.Pre,
		"tokenizer.ggml.model":         t.Vocabulary.Model,
		"tokenizer.ggml.tokens":        t.Vocabulary.Tokens,
		"tokenizer.ggml.scores":        t.Vocabulary.Scores,
		"tokenizer.ggml.token_type":    t.Vocabulary.Types,
	}
29

30
31
32
33
	if len(t.Merges) > 0 {
		kv["tokenizer.ggml.merges"] = t.Merges
	}

Michael Yang's avatar
Michael Yang committed
34
35
36
	if t.Template != "" {
		kv["tokenizer.chat_template"] = t.Template
	}
37

Michael Yang's avatar
Michael Yang committed
38
39
40
41
	for _, sv := range t.SpecialVocabulary {
		kv[fmt.Sprintf("tokenizer.ggml.%s_token_id", sv.Key())] = uint32(sv.ID)
		kv[fmt.Sprintf("tokenizer.ggml.add_%s_token", sv.Key())] = sv.AddToken
	}
42

Michael Yang's avatar
Michael Yang committed
43
	return kv
44
45
}

Michael Yang's avatar
Michael Yang committed
46
func (Parameters) specialTokenTypes() []string {
Michael Yang's avatar
Michael Yang committed
47
48
	return []string{
		"bos", "eos", "unk", "sep", "pad", "cls", "mask",
49
	}
Michael Yang's avatar
Michael Yang committed
50
}
51

Michael Yang's avatar
Michael Yang committed
52
func (Parameters) writeFile(ws io.WriteSeeker, kv llm.KV, ts []llm.Tensor) error {
Michael Yang's avatar
Michael Yang committed
53
	return llm.WriteGGUF(ws, kv, ts)
54
55
}

Michael Yang's avatar
Michael Yang committed
56
57
58
59
type Converter interface {
	// KV maps parameters to LLM key-values
	KV(*Tokenizer) llm.KV
	// Tensors maps input tensors to LLM tensors. Model specific modifications can be done here.
Michael Yang's avatar
Michael Yang committed
60
	Tensors([]Tensor) []llm.Tensor
Michael Yang's avatar
Michael Yang committed
61
62
63

	// tensorName returns the LLM tensor name for a specific input name
	tensorName(string) string
Michael Yang's avatar
Michael Yang committed
64
65
66
	// specialTokenTypes returns any special token types the model uses
	specialTokenTypes() []string
	writeFile(io.WriteSeeker, llm.KV, []llm.Tensor) error
67
68
}

Michael Yang's avatar
Michael Yang committed
69
70
71
72
// Convert writes an Ollama compatible model to the provided io.WriteSeeker based on configurations
// and files it finds in the input path.
// Supported input model formats include safetensors.
// Supported input tokenizers files include tokenizer.json (preferred) and tokenizer.model.
73
74
func Convert(fsys fs.FS, ws io.WriteSeeker) error {
	bts, err := fs.ReadFile(fsys, "config.json")
75
	if err != nil {
Michael Yang's avatar
Michael Yang committed
76
		return err
77
78
	}

Michael Yang's avatar
Michael Yang committed
79
	var p Parameters
Michael Yang's avatar
Michael Yang committed
80
	if err := json.Unmarshal(bts, &p); err != nil {
Michael Yang's avatar
Michael Yang committed
81
		return err
82
83
	}

Michael Yang's avatar
Michael Yang committed
84
85
	if len(p.Architectures) < 1 {
		return errors.New("unknown architecture")
86
87
	}

Michael Yang's avatar
Michael Yang committed
88
	var conv Converter
Michael Yang's avatar
Michael Yang committed
89
90
	switch p.Architectures[0] {
	case "LlamaForCausalLM", "MistralForCausalLM":
Michael Yang's avatar
Michael Yang committed
91
		conv = &llama{}
Michael Yang's avatar
Michael Yang committed
92
	case "MixtralForCausalLM":
Michael Yang's avatar
Michael Yang committed
93
		conv = &mixtral{}
Michael Yang's avatar
Michael Yang committed
94
	case "GemmaForCausalLM":
Michael Yang's avatar
Michael Yang committed
95
		conv = &gemma{}
96
97
	case "Phi3ForCausalLM":
		conv = &phi3{}
Michael Yang's avatar
Michael Yang committed
98
99
	default:
		return errors.New("unsupported architecture")
100
101
	}

Michael Yang's avatar
Michael Yang committed
102
	if err := json.Unmarshal(bts, conv); err != nil {
Michael Yang's avatar
Michael Yang committed
103
		return err
104
105
	}

106
	t, err := parseTokenizer(fsys, conv.specialTokenTypes())
Michael Yang's avatar
Michael Yang committed
107
108
	if err != nil {
		return err
109
110
	}

Michael Yang's avatar
Michael Yang committed
111
112
113
114
115
116
	if vocabSize := int(p.VocabSize); vocabSize > len(t.Vocabulary.Tokens) {
		slog.Warn("vocabulary is smaller than expected, padding with dummy tokens", "expect", p.VocabSize, "actual", len(t.Vocabulary.Tokens))
		for i := range vocabSize - len(t.Vocabulary.Tokens) {
			t.Vocabulary.Tokens = append(t.Vocabulary.Tokens, fmt.Sprintf("[PAD%d]", i))
			t.Vocabulary.Scores = append(t.Vocabulary.Scores, -1)
			t.Vocabulary.Types = append(t.Vocabulary.Types, tokenTypeUserDefined)
117
		}
Michael Yang's avatar
Michael Yang committed
118
119
	} else {
		slog.Debug("vocabulary", "size", len(t.Vocabulary.Tokens))
120
	}
Michael Yang's avatar
Michael Yang committed
121

122
	ts, err := parseTensors(fsys)
Michael Yang's avatar
Michael Yang committed
123
124
	if err != nil {
		return err
125
126
	}

Michael Yang's avatar
Michael Yang committed
127
	return conv.writeFile(ws, conv.KV(t), conv.Tensors(ts))
128
}