convert.go 3.29 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
9
10
11
	"log/slog"
	"os"
	"path/filepath"

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

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

Michael Yang's avatar
Michael Yang committed
20
21
22
23
24
25
26
27
28
29
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,
	}
30

Michael Yang's avatar
Michael Yang committed
31
32
33
	if t.Template != "" {
		kv["tokenizer.chat_template"] = t.Template
	}
34

Michael Yang's avatar
Michael Yang committed
35
36
37
38
	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
	}
39

Michael Yang's avatar
Michael Yang committed
40
	return kv
41
42
}

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

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

Michael Yang's avatar
Michael Yang committed
53
54
55
56
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
57
	Tensors([]Tensor) []llm.Tensor
Michael Yang's avatar
Michael Yang committed
58
59
60

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

Michael Yang's avatar
Michael Yang committed
66
67
68
69
70
71
// 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.
func Convert(path string, ws io.WriteSeeker) error {
	bts, err := os.ReadFile(filepath.Join(path, "config.json"))
72
	if err != nil {
Michael Yang's avatar
Michael Yang committed
73
		return err
74
75
	}

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

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

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

Michael Yang's avatar
Michael Yang committed
97
	if err := json.Unmarshal(bts, conv); err != nil {
Michael Yang's avatar
Michael Yang committed
98
		return err
99
100
	}

Michael Yang's avatar
Michael Yang committed
101
	t, err := parseTokenizer(path, conv.specialTokenTypes())
Michael Yang's avatar
Michael Yang committed
102
103
	if err != nil {
		return err
104
105
	}

Michael Yang's avatar
Michael Yang committed
106
107
108
109
110
111
	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)
112
		}
Michael Yang's avatar
Michael Yang committed
113
114
	} else {
		slog.Debug("vocabulary", "size", len(t.Vocabulary.Tokens))
115
	}
Michael Yang's avatar
Michael Yang committed
116

Michael Yang's avatar
Michael Yang committed
117
	ts, err := parseTensors(path)
Michael Yang's avatar
Michael Yang committed
118
119
	if err != nil {
		return err
120
121
	}

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