images.go 27.2 KB
Newer Older
1
2
3
4
package server

import (
	"bytes"
5
	"context"
6
	"crypto/sha256"
Patrick Devine's avatar
Patrick Devine committed
7
	"encoding/hex"
8
9
10
11
12
13
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"log"
	"net/http"
Michael Yang's avatar
Michael Yang committed
14
	"net/url"
15
16
	"os"
	"path/filepath"
Michael Yang's avatar
Michael Yang committed
17
	"runtime"
18
19
	"strconv"
	"strings"
Quinn Slack's avatar
Quinn Slack committed
20
	"text/template"
21

Michael Yang's avatar
Michael Yang committed
22
23
	"golang.org/x/exp/slices"

24
	"github.com/jmorganca/ollama/api"
25
	"github.com/jmorganca/ollama/llm"
26
	"github.com/jmorganca/ollama/parser"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/jmorganca/ollama/version"
28
29
)

30
31
32
33
type RegistryOptions struct {
	Insecure bool
	Username string
	Password string
Patrick Devine's avatar
Patrick Devine committed
34
	Token    string
35
36
}

37
type Model struct {
Michael Yang's avatar
Michael Yang committed
38
	Name           string `json:"name"`
39
	Config         ConfigV2
Michael Yang's avatar
Michael Yang committed
40
41
42
43
44
45
46
47
48
	ShortName      string
	ModelPath      string
	OriginalModel  string
	AdapterPaths   []string
	ProjectorPaths []string
	Template       string
	System         string
	License        []string
	Digest         string
Patrick Devine's avatar
Patrick Devine committed
49
	Size           int64
Michael Yang's avatar
Michael Yang committed
50
	Options        map[string]interface{}
51
52
}

Bruce MacDonald's avatar
Bruce MacDonald committed
53
54
55
56
57
58
type PromptVars struct {
	System   string
	Prompt   string
	Response string
	First    bool
}
59

Bruce MacDonald's avatar
Bruce MacDonald committed
60
61
func (m *Model) Prompt(p PromptVars) (string, error) {
	var prompt strings.Builder
62
63
	// Use the "missingkey=zero" option to handle missing variables without panicking
	tmpl, err := template.New("").Option("missingkey=zero").Parse(m.Template)
64
65
66
67
	if err != nil {
		return "", err
	}

68
	if p.System == "" {
69
		// use the default system message for this model if one is not specified
70
71
72
		p.System = m.System
	}

73
74
75
76
77
	vars := map[string]any{
		"System":   p.System,
		"Prompt":   p.Prompt,
		"Response": p.Response,
		"First":    p.First,
78
79
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
80
	var sb strings.Builder
81
	if err := tmpl.Execute(&sb, vars); err != nil {
Bruce MacDonald's avatar
Bruce MacDonald committed
82
83
84
85
86
87
		return "", err
	}
	prompt.WriteString(sb.String())
	prompt.WriteString(p.Response)
	return prompt.String(), nil
}
88

89
func (m *Model) ChatPrompt(msgs []api.Message) (string, []api.ImageData, error) {
Bruce MacDonald's avatar
Bruce MacDonald committed
90
91
	// build the prompt from the list of messages
	var prompt strings.Builder
92
	var currentImages []api.ImageData
Bruce MacDonald's avatar
Bruce MacDonald committed
93
94
	currentVars := PromptVars{
		First: true,
Bruce MacDonald's avatar
Bruce MacDonald committed
95
96
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
97
98
99
100
101
102
103
104
105
106
107
	writePrompt := func() error {
		p, err := m.Prompt(currentVars)
		if err != nil {
			return err
		}
		prompt.WriteString(p)
		currentVars = PromptVars{}
		return nil
	}

	for _, msg := range msgs {
108
		switch strings.ToLower(msg.Role) {
Bruce MacDonald's avatar
Bruce MacDonald committed
109
		case "system":
110
			if currentVars.System != "" {
Bruce MacDonald's avatar
Bruce MacDonald committed
111
				if err := writePrompt(); err != nil {
112
					return "", nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
113
114
115
116
				}
			}
			currentVars.System = msg.Content
		case "user":
117
			if currentVars.Prompt != "" {
Bruce MacDonald's avatar
Bruce MacDonald committed
118
				if err := writePrompt(); err != nil {
119
					return "", nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
120
121
122
				}
			}
			currentVars.Prompt = msg.Content
123
			currentImages = msg.Images
Bruce MacDonald's avatar
Bruce MacDonald committed
124
125
126
		case "assistant":
			currentVars.Response = msg.Content
			if err := writePrompt(); err != nil {
127
				return "", nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
128
129
			}
		default:
130
			return "", nil, fmt.Errorf("invalid role: %s, role must be one of [system, user, assistant]", msg.Role)
Bruce MacDonald's avatar
Bruce MacDonald committed
131
		}
132
133
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
134
135
136
	// Append the last set of vars if they are non-empty
	if currentVars.Prompt != "" || currentVars.System != "" {
		if err := writePrompt(); err != nil {
137
			return "", nil, err
Bruce MacDonald's avatar
Bruce MacDonald committed
138
139
140
		}
	}

141
	return prompt.String(), currentImages, nil
142
143
}

144
145
146
type ManifestV2 struct {
	SchemaVersion int      `json:"schemaVersion"`
	MediaType     string   `json:"mediaType"`
Michael Yang's avatar
Michael Yang committed
147
	Config        *Layer   `json:"config"`
148
149
150
151
	Layers        []*Layer `json:"layers"`
}

type ConfigV2 struct {
152
153
154
155
156
157
	ModelFormat   string   `json:"model_format"`
	ModelFamily   string   `json:"model_family"`
	ModelFamilies []string `json:"model_families"`
	ModelType     string   `json:"model_type"`
	FileType      string   `json:"file_type"`

158
	// required by spec
159
160
	Architecture string `json:"architecture"`
	OS           string `json:"os"`
161
	RootFS       RootFS `json:"rootfs"`
162
163
}

Michael Yang's avatar
Michael Yang committed
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
func (c *ConfigV2) SetModelFormat(format string) {
	if c.ModelFormat == "" {
		c.ModelFormat = format
	}
}

func (c *ConfigV2) SetModelFamily(families ...string) {
	for _, family := range families {
		if c.ModelFamily == "" {
			c.ModelFamily = family
		}

		if !slices.Contains(c.ModelFamilies, family) {
			c.ModelFamilies = append(c.ModelFamilies, family)
		}
	}
}

func (c *ConfigV2) SetModelType(modelType string) {
	if c.ModelType == "" {
		c.ModelType = modelType
	}
}

func (c *ConfigV2) SetFileType(fileType string) {
	if c.FileType == "" {
		c.FileType = fileType
	}
}

194
195
196
197
198
type RootFS struct {
	Type    string   `json:"type"`
	DiffIDs []string `json:"diff_ids"`
}

Michael Yang's avatar
Michael Yang committed
199
func (m *ManifestV2) GetTotalSize() (total int64) {
Patrick Devine's avatar
Patrick Devine committed
200
201
202
	for _, layer := range m.Layers {
		total += layer.Size
	}
Michael Yang's avatar
Michael Yang committed
203

Patrick Devine's avatar
Patrick Devine committed
204
205
206
207
	total += m.Config.Size
	return total
}

Patrick Devine's avatar
Patrick Devine committed
208
func GetManifest(mp ModelPath) (*ManifestV2, string, error) {
209
	fp, err := mp.GetManifestPath()
210
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
211
		return nil, "", err
212
	}
213

214
	if _, err = os.Stat(fp); err != nil {
Patrick Devine's avatar
Patrick Devine committed
215
		return nil, "", err
216
217
218
219
	}

	var manifest *ManifestV2

220
	bts, err := os.ReadFile(fp)
221
	if err != nil {
Patrick Devine's avatar
Patrick Devine committed
222
		return nil, "", fmt.Errorf("couldn't open file '%s'", fp)
223
224
	}

Patrick Devine's avatar
Patrick Devine committed
225
226
227
	shaSum := sha256.Sum256(bts)
	shaStr := hex.EncodeToString(shaSum[:])

228
	if err := json.Unmarshal(bts, &manifest); err != nil {
Patrick Devine's avatar
Patrick Devine committed
229
		return nil, "", err
230
231
	}

Patrick Devine's avatar
Patrick Devine committed
232
	return manifest, shaStr, nil
233
234
235
}

func GetModel(name string) (*Model, error) {
236
	mp := ParseModelPath(name)
Patrick Devine's avatar
Patrick Devine committed
237
	manifest, digest, err := GetManifest(mp)
238
239
240
241
242
	if err != nil {
		return nil, err
	}

	model := &Model{
243
244
245
246
247
		Name:      mp.GetFullTagname(),
		ShortName: mp.GetShortTagname(),
		Digest:    digest,
		Template:  "{{ .Prompt }}",
		License:   []string{},
Patrick Devine's avatar
Patrick Devine committed
248
		Size:      manifest.GetTotalSize(),
249
250
	}

251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
	filename, err := GetBlobsPath(manifest.Config.Digest)
	if err != nil {
		return nil, err
	}

	configFile, err := os.Open(filename)
	if err != nil {
		return nil, err
	}
	defer configFile.Close()

	if err := json.NewDecoder(configFile).Decode(&model.Config); err != nil {
		return nil, err
	}

266
	for _, layer := range manifest.Layers {
Patrick Devine's avatar
Patrick Devine committed
267
		filename, err := GetBlobsPath(layer.Digest)
268
269
270
271
		if err != nil {
			return nil, err
		}

272
273
274
		switch layer.MediaType {
		case "application/vnd.ollama.image.model":
			model.ModelPath = filename
Patrick Devine's avatar
Patrick Devine committed
275
			model.OriginalModel = layer.From
276
		case "application/vnd.ollama.image.embed":
277
278
279
			// Deprecated in versions  > 0.1.2
			// TODO: remove this warning in a future version
			log.Print("WARNING: model contains embeddings, but embeddings in modelfiles have been deprecated and will be ignored.")
280
281
		case "application/vnd.ollama.image.adapter":
			model.AdapterPaths = append(model.AdapterPaths, filename)
Michael Yang's avatar
Michael Yang committed
282
283
		case "application/vnd.ollama.image.projector":
			model.ProjectorPaths = append(model.ProjectorPaths, filename)
284
285
286
287
288
289
290
291
292
		case "application/vnd.ollama.image.template":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
		case "application/vnd.ollama.image.system":
			bts, err := os.ReadFile(filename)
293
294
295
			if err != nil {
				return nil, err
			}
296
297

			model.System = string(bts)
298
299
300
301
302
303
304
		case "application/vnd.ollama.image.prompt":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}

			model.Template = string(bts)
305
		case "application/vnd.ollama.image.params":
Michael Yang's avatar
Michael Yang committed
306
307
308
309
310
			params, err := os.Open(filename)
			if err != nil {
				return nil, err
			}
			defer params.Close()
311

312
			// parse model options parameters into a map so that we can see which fields have been specified explicitly
313
			if err = json.NewDecoder(params).Decode(&model.Options); err != nil {
314
315
				return nil, err
			}
Patrick Devine's avatar
Patrick Devine committed
316
317
318
319
320
321
		case "application/vnd.ollama.image.license":
			bts, err := os.ReadFile(filename)
			if err != nil {
				return nil, err
			}
			model.License = append(model.License, string(bts))
322
323
324
325
326
327
		}
	}

	return model, nil
}

328
329
func realpath(mfDir, from string) string {
	abspath, err := filepath.Abs(from)
Michael Yang's avatar
Michael Yang committed
330
	if err != nil {
331
		return from
332
333
	}

Michael Yang's avatar
Michael Yang committed
334
	home, err := os.UserHomeDir()
335
	if err != nil {
Michael Yang's avatar
Michael Yang committed
336
		return abspath
337
338
	}

339
	if from == "~" {
Michael Yang's avatar
Michael Yang committed
340
		return home
341
342
343
344
345
346
347
	} else if strings.HasPrefix(from, "~/") {
		return filepath.Join(home, from[2:])
	}

	if _, err := os.Stat(filepath.Join(mfDir, from)); err == nil {
		// this is a file relative to the Modelfile
		return filepath.Join(mfDir, from)
348
349
	}

Michael Yang's avatar
Michael Yang committed
350
351
352
	return abspath
}

353
func CreateModel(ctx context.Context, name, modelFileDir string, commands []parser.Command, fn func(resp api.ProgressResponse)) error {
354
355
	config := ConfigV2{
		OS:           "linux",
Michael Yang's avatar
Michael Yang committed
356
		Architecture: "amd64",
Michael Yang's avatar
Michael Yang committed
357
358
359
		RootFS: RootFS{
			Type: "layers",
		},
360
361
	}

Michael Yang's avatar
Michael Yang committed
362
363
	deleteMap := make(map[string]struct{})

Michael Yang's avatar
Michael Yang committed
364
	var layers Layers
Michael Yang's avatar
Michael Yang committed
365

366
	params := make(map[string][]string)
Michael Yang's avatar
Michael Yang committed
367
368
	fromParams := make(map[string]any)

369
	for _, c := range commands {
Michael Yang's avatar
Michael Yang committed
370
371
372
		log.Printf("[%s] - %s", c.Name, c.Args)
		mediatype := fmt.Sprintf("application/vnd.ollama.image.%s", c.Name)

373
374
		switch c.Name {
		case "model":
Michael Yang's avatar
Michael Yang committed
375
376
377
378
379
380
381
382
383
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}

384
			bin, err := os.Open(realpath(modelFileDir, c.Args))
385
			if err != nil {
Michael Yang's avatar
Michael Yang committed
386
387
388
389
390
391
392
				// not a file on disk so must be a model reference
				modelpath := ParseModelPath(c.Args)
				manifest, _, err := GetManifest(modelpath)
				switch {
				case errors.Is(err, os.ErrNotExist):
					fn(api.ProgressResponse{Status: "pulling model"})
					if err := PullModel(ctx, c.Args, &RegistryOptions{}, fn); err != nil {
393
394
395
						return err
					}

Michael Yang's avatar
Michael Yang committed
396
					manifest, _, err = GetManifest(modelpath)
397
398
399
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
400
401
				case err != nil:
					return err
402
				}
403

404
				fn(api.ProgressResponse{Status: "reading model metadata"})
Michael Yang's avatar
Michael Yang committed
405
				fromConfigPath, err := GetBlobsPath(manifest.Config.Digest)
Michael Yang's avatar
Michael Yang committed
406
407
408
409
				if err != nil {
					return err
				}

Michael Yang's avatar
Michael Yang committed
410
				fromConfigFile, err := os.Open(fromConfigPath)
Michael Yang's avatar
Michael Yang committed
411
412
413
				if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
414
				defer fromConfigFile.Close()
Michael Yang's avatar
Michael Yang committed
415

Michael Yang's avatar
Michael Yang committed
416
417
				var fromConfig ConfigV2
				if err := json.NewDecoder(fromConfigFile).Decode(&fromConfig); err != nil {
Michael Yang's avatar
Michael Yang committed
418
419
420
					return err
				}

Michael Yang's avatar
Michael Yang committed
421
422
423
424
				config.SetModelFormat(fromConfig.ModelFormat)
				config.SetModelFamily(append(fromConfig.ModelFamilies, fromConfig.ModelFamily)...)
				config.SetModelType(fromConfig.ModelType)
				config.SetFileType(fromConfig.FileType)
Michael Yang's avatar
Michael Yang committed
425

Michael Yang's avatar
Michael Yang committed
426
427
428
429
				for _, layer := range manifest.Layers {
					deleteMap[layer.Digest] = struct{}{}
					if layer.MediaType == "application/vnd.ollama.image.params" {
						fromParamsPath, err := GetBlobsPath(layer.Digest)
Michael Yang's avatar
Michael Yang committed
430
431
432
433
						if err != nil {
							return err
						}

Michael Yang's avatar
Michael Yang committed
434
						fromParamsFile, err := os.Open(fromParamsPath)
Michael Yang's avatar
Michael Yang committed
435
436
437
						if err != nil {
							return err
						}
Michael Yang's avatar
Michael Yang committed
438
						defer fromParamsFile.Close()
Michael Yang's avatar
Michael Yang committed
439

Michael Yang's avatar
Michael Yang committed
440
						if err := json.NewDecoder(fromParamsFile).Decode(&fromParams); err != nil {
Michael Yang's avatar
Michael Yang committed
441
442
443
444
							return err
						}
					}

Michael Yang's avatar
Michael Yang committed
445
					layer, err := NewLayerFromLayer(layer.Digest, layer.MediaType, modelpath.GetShortTagname())
446
447
448
					if err != nil {
						return err
					}
Michael Yang's avatar
Michael Yang committed
449

Michael Yang's avatar
Michael Yang committed
450
					layers.Add(layer)
451
				}
Michael Yang's avatar
Michael Yang committed
452
453
454

				deleteMap[manifest.Config.Digest] = struct{}{}
				continue
455
			}
Michael Yang's avatar
Michael Yang committed
456
			defer bin.Close()
457

458
459
460
			var offset int64
			for {
				fn(api.ProgressResponse{Status: "creating model layer"})
461

462
463
464
465
466
467
468
				bin.Seek(offset, io.SeekStart)
				ggml, err := llm.DecodeGGML(bin)
				if errors.Is(err, io.EOF) {
					break
				} else if err != nil {
					return err
				}
Michael Yang's avatar
Michael Yang committed
469

Michael Yang's avatar
Michael Yang committed
470
471
472
473
				config.SetModelFormat(ggml.Name())
				config.SetModelFamily(ggml.ModelFamily())
				config.SetModelType(ggml.ModelType())
				config.SetFileType(ggml.FileType())
474

475
476
477
478
				mediatype := mediatype
				if ggml.ModelFamily() == "clip" {
					mediatype = "application/vnd.ollama.image.projector"
				}
479

480
481
482
483
484
485
486
487
488
489
				sr := io.NewSectionReader(bin, offset, ggml.Size)
				layer, err := NewLayer(sr, mediatype)
				if err != nil {
					return err
				}

				layers.Add(layer)

				offset += ggml.Size
			}
Michael Yang's avatar
Michael Yang committed
490
		case "adapter":
491
492
493
494
495
496
497
498
			if strings.HasPrefix(c.Args, "@") {
				blobPath, err := GetBlobsPath(strings.TrimPrefix(c.Args, "@"))
				if err != nil {
					return err
				}

				c.Args = blobPath
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
499

Michael Yang's avatar
Michael Yang committed
500
			fn(api.ProgressResponse{Status: "creating adapter layer"})
501
			bin, err := os.Open(realpath(modelFileDir, c.Args))
502
			if err != nil {
Michael Yang's avatar
Michael Yang committed
503
				return err
504
			}
Michael Yang's avatar
Michael Yang committed
505
			defer bin.Close()
506

Michael Yang's avatar
Michael Yang committed
507
			layer, err := NewLayer(bin, mediatype)
508
			if err != nil {
Michael Yang's avatar
Michael Yang committed
509
				return err
510
			}
Bruce MacDonald's avatar
Bruce MacDonald committed
511

Michael Yang's avatar
Michael Yang committed
512
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
513
514
		case "license":
			fn(api.ProgressResponse{Status: "creating license layer"})
Michael Yang's avatar
Michael Yang committed
515
516
517

			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
Bruce MacDonald's avatar
Bruce MacDonald committed
518
519
520
521
			if err != nil {
				return err
			}

Michael Yang's avatar
Michael Yang committed
522
			layers.Add(layer)
Michael Yang's avatar
Michael Yang committed
523
524
525
		case "template", "system":
			fn(api.ProgressResponse{Status: fmt.Sprintf("creating %s layer", c.Name)})

Michael Yang's avatar
Michael Yang committed
526
527
			bin := strings.NewReader(c.Args)
			layer, err := NewLayer(bin, mediatype)
528
			if err != nil {
529
				return err
530
			}
531

Michael Yang's avatar
Michael Yang committed
532
			layers.Replace(layer)
533
		default:
534
			params[c.Name] = append(params[c.Name], c.Args)
535
536
537
		}
	}

Michael Yang's avatar
Michael Yang committed
538
	if len(params) > 0 {
Michael Yang's avatar
Michael Yang committed
539
		fn(api.ProgressResponse{Status: "creating parameters layer"})
Michael Yang's avatar
Michael Yang committed
540

541
		formattedParams, err := api.FormatParams(params)
542
		if err != nil {
Michael Yang's avatar
Michael Yang committed
543
			return err
544
		}
545

Michael Yang's avatar
Michael Yang committed
546
		for k, v := range fromParams {
Michael Yang's avatar
Michael Yang committed
547
548
549
550
551
			if _, ok := formattedParams[k]; !ok {
				formattedParams[k] = v
			}
		}

Patrick Devine's avatar
Patrick Devine committed
552
		// xxx - can this be removed?
Michael Yang's avatar
Michael Yang committed
553
		if config.ModelType == "65B" {
Michael Yang's avatar
Michael Yang committed
554
			if gqa, ok := formattedParams["gqa"].(int); ok && gqa == 8 {
Michael Yang's avatar
Michael Yang committed
555
556
557
558
				config.ModelType = "70B"
			}
		}

Michael Yang's avatar
Michael Yang committed
559
560
		var b bytes.Buffer
		if err := json.NewEncoder(&b).Encode(formattedParams); err != nil {
561
562
563
			return err
		}

Michael Yang's avatar
Michael Yang committed
564
		fn(api.ProgressResponse{Status: "creating config layer"})
Michael Yang's avatar
Michael Yang committed
565
		layer, err := NewLayer(&b, "application/vnd.ollama.image.params")
566
		if err != nil {
Michael Yang's avatar
Michael Yang committed
567
			return err
568
		}
Michael Yang's avatar
Michael Yang committed
569

Michael Yang's avatar
Michael Yang committed
570
		layers.Replace(layer)
571
572
	}

Michael Yang's avatar
Michael Yang committed
573
574
575
	digests := make([]string, len(layers.items))
	for i, layer := range layers.items {
		digests[i] = layer.Digest
576
577
	}

Michael Yang's avatar
Michael Yang committed
578
	config.RootFS.DiffIDs = digests
Michael Yang's avatar
Michael Yang committed
579

Michael Yang's avatar
Michael Yang committed
580
581
	var b bytes.Buffer
	if err := json.NewEncoder(&b).Encode(config); err != nil {
582
583
584
		return err
	}

Michael Yang's avatar
Michael Yang committed
585
586
	configLayer, err := NewLayer(&b, "application/vnd.docker.container.image.v1+json")
	if err != nil {
587
588
589
		return err
	}

Michael Yang's avatar
Michael Yang committed
590
	delete(deleteMap, configLayer.Digest)
591

Michael Yang's avatar
Michael Yang committed
592
593
	for _, layer := range append(layers.items, configLayer) {
		committed, err := layer.Commit()
594
595
596
		if err != nil {
			return err
		}
597

Michael Yang's avatar
Michael Yang committed
598
599
600
		status := "writing layer"
		if !committed {
			status = "using already created layer"
601
602
		}

Michael Yang's avatar
Michael Yang committed
603
		fn(api.ProgressResponse{Status: fmt.Sprintf("%s %s", status, layer.Digest)})
604

Michael Yang's avatar
Michael Yang committed
605
		delete(deleteMap, layer.Digest)
606
607
	}

Michael Yang's avatar
Michael Yang committed
608
609
	fn(api.ProgressResponse{Status: "writing manifest"})
	if err := WriteManifest(name, configLayer, layers.items); err != nil {
610
611
		return err
	}
612

Michael Yang's avatar
Michael Yang committed
613
614
615
	if noprune := os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		if err := deleteUnusedLayers(nil, deleteMap, false); err != nil {
			return err
616
617
618
		}
	}

Michael Yang's avatar
Michael Yang committed
619
620
	fn(api.ProgressResponse{Status: "success"})
	return nil
621
622
}

Patrick Devine's avatar
Patrick Devine committed
623
func CopyModel(src, dest string) error {
624
	srcModelPath := ParseModelPath(src)
625
	srcPath, err := srcModelPath.GetManifestPath()
626
627
628
629
	if err != nil {
		return err
	}

630
	destModelPath := ParseModelPath(dest)
631
	destPath, err := destModelPath.GetManifestPath()
Patrick Devine's avatar
Patrick Devine committed
632
633
634
	if err != nil {
		return err
	}
635
636
637
	if err := os.MkdirAll(filepath.Dir(destPath), 0o755); err != nil {
		return err
	}
Patrick Devine's avatar
Patrick Devine committed
638
639

	// copy the file
Michael Yang's avatar
Michael Yang committed
640
	input, err := os.ReadFile(srcPath)
Patrick Devine's avatar
Patrick Devine committed
641
642
643
644
645
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

Michael Yang's avatar
Michael Yang committed
646
	err = os.WriteFile(destPath, input, 0o644)
Patrick Devine's avatar
Patrick Devine committed
647
648
649
650
651
652
653
654
	if err != nil {
		fmt.Println("Error reading file:", err)
		return err
	}

	return nil
}

Michael Yang's avatar
Michael Yang committed
655
func deleteUnusedLayers(skipModelPath *ModelPath, deleteMap map[string]struct{}, dryRun bool) error {
656
657
658
659
	fp, err := GetManifestPath()
	if err != nil {
		return err
	}
Michael Yang's avatar
Michael Yang committed
660
661
662
663

	walkFunc := func(path string, info os.FileInfo, _ error) error {
		if info.IsDir() {
			return nil
664
665
		}

Michael Yang's avatar
Michael Yang committed
666
667
668
669
		dir, file := filepath.Split(path)
		dir = strings.Trim(strings.TrimPrefix(dir, fp), string(os.PathSeparator))
		tag := strings.Join([]string{dir, file}, ":")
		fmp := ParseModelPath(tag)
670

Michael Yang's avatar
Michael Yang committed
671
		// skip the manifest we're trying to delete
672
		if skipModelPath != nil && skipModelPath.GetFullTagname() == fmp.GetFullTagname() {
Michael Yang's avatar
Michael Yang committed
673
			return nil
674
		}
Michael Yang's avatar
Michael Yang committed
675
676
677
678
679
680
681
682
683
684
685
686

		// save (i.e. delete from the deleteMap) any files used in other manifests
		manifest, _, err := GetManifest(fmp)
		if err != nil {
			return nil
		}

		for _, layer := range manifest.Layers {
			delete(deleteMap, layer.Digest)
		}

		delete(deleteMap, manifest.Config.Digest)
687
		return nil
Michael Yang's avatar
Michael Yang committed
688
689
690
	}

	if err := filepath.Walk(fp, walkFunc); err != nil {
Michael Yang's avatar
Michael Yang committed
691
692
		return err
	}
693
694

	// only delete the files which are still in the deleteMap
Michael Yang's avatar
Michael Yang committed
695
696
697
698
699
700
701
702
703
	for k := range deleteMap {
		fp, err := GetBlobsPath(k)
		if err != nil {
			log.Printf("couldn't get file path for '%s': %v", k, err)
			continue
		}
		if !dryRun {
			if err := os.Remove(fp); err != nil {
				log.Printf("couldn't remove file '%s': %v", fp, err)
704
705
				continue
			}
Michael Yang's avatar
Michael Yang committed
706
707
		} else {
			log.Printf("wanted to remove: %s", fp)
708
709
710
		}
	}

711
712
713
714
	return nil
}

func PruneLayers() error {
Michael Yang's avatar
Michael Yang committed
715
	deleteMap := make(map[string]struct{})
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
	p, err := GetBlobsPath("")
	if err != nil {
		return err
	}

	blobs, err := os.ReadDir(p)
	if err != nil {
		log.Printf("couldn't read dir '%s': %v", p, err)
		return err
	}

	for _, blob := range blobs {
		name := blob.Name()
		if runtime.GOOS == "windows" {
			name = strings.ReplaceAll(name, "-", ":")
		}
Michael Yang's avatar
Michael Yang committed
732
733
734
		if strings.HasPrefix(name, "sha256:") {
			deleteMap[name] = struct{}{}
		}
735
736
737
738
739
740
741
742
743
744
745
746
747
748
	}

	log.Printf("total blobs: %d", len(deleteMap))

	err = deleteUnusedLayers(nil, deleteMap, false)
	if err != nil {
		return err
	}

	log.Printf("total unused blobs removed: %d", len(deleteMap))

	return nil
}

Michael Yang's avatar
Michael Yang committed
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
func PruneDirectory(path string) error {
	info, err := os.Lstat(path)
	if err != nil {
		return err
	}

	if info.IsDir() && info.Mode()&os.ModeSymlink == 0 {
		entries, err := os.ReadDir(path)
		if err != nil {
			return err
		}

		for _, entry := range entries {
			if err := PruneDirectory(filepath.Join(path, entry.Name())); err != nil {
				return err
			}
		}

		entries, err = os.ReadDir(path)
		if err != nil {
			return err
		}

		if len(entries) > 0 {
			return nil
		}

		return os.Remove(path)
	}

	return nil
}

782
783
784
785
786
787
788
func DeleteModel(name string) error {
	mp := ParseModelPath(name)
	manifest, _, err := GetManifest(mp)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
789
	deleteMap := make(map[string]struct{})
790
	for _, layer := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
791
		deleteMap[layer.Digest] = struct{}{}
792
	}
Michael Yang's avatar
Michael Yang committed
793
	deleteMap[manifest.Config.Digest] = struct{}{}
794
795
796
797
798
799

	err = deleteUnusedLayers(&mp, deleteMap, false)
	if err != nil {
		return err
	}

800
	fp, err := mp.GetManifestPath()
801
802
803
804
805
806
807
808
809
810
811
812
	if err != nil {
		return err
	}
	err = os.Remove(fp)
	if err != nil {
		log.Printf("couldn't remove manifest file '%s': %v", fp, err)
		return err
	}

	return nil
}

Patrick Devine's avatar
Patrick Devine committed
813
func ShowModelfile(model *Model) (string, error) {
Michael Yang's avatar
Michael Yang committed
814
	var mt struct {
Patrick Devine's avatar
Patrick Devine committed
815
		*Model
Michael Yang's avatar
Michael Yang committed
816
		From       string
Michael Yang's avatar
Michael Yang committed
817
		Parameters map[string][]any
Patrick Devine's avatar
Patrick Devine committed
818
819
	}

Michael Yang's avatar
Michael Yang committed
820
	mt.Parameters = make(map[string][]any)
Patrick Devine's avatar
Patrick Devine committed
821
	for k, v := range model.Options {
Michael Yang's avatar
Michael Yang committed
822
823
824
		if s, ok := v.([]any); ok {
			mt.Parameters[k] = s
			continue
Patrick Devine's avatar
Patrick Devine committed
825
826
		}

Michael Yang's avatar
Michael Yang committed
827
		mt.Parameters[k] = []any{v}
Patrick Devine's avatar
Patrick Devine committed
828
829
	}

Michael Yang's avatar
Michael Yang committed
830
831
	mt.Model = model
	mt.From = model.ModelPath
Patrick Devine's avatar
Patrick Devine committed
832

Michael Yang's avatar
Michael Yang committed
833
	if model.OriginalModel != "" {
Daniel Reis's avatar
Daniel Reis committed
834
		mt.From = model.OriginalModel
Patrick Devine's avatar
Patrick Devine committed
835
836
837
838
839
840
841
842
	}

	modelFile := `# Modelfile generated by "ollama show"
# To build a new Modelfile based on this one, replace the FROM line with:
# FROM {{ .ShortName }}

FROM {{ .From }}
TEMPLATE """{{ .Template }}"""
843
844

{{- if .System }}
Patrick Devine's avatar
Patrick Devine committed
845
SYSTEM """{{ .System }}"""
846
{{- end }}
847
848
849
850

{{- range $adapter := .AdapterPaths }}
ADAPTER {{ $adapter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
851

Michael Yang's avatar
Michael Yang committed
852
853
854
855
{{- range $k, $v := .Parameters }}
{{- range $parameter := $v }}
PARAMETER {{ $k }} {{ printf "%#v" $parameter }}
{{- end }}
Michael Yang's avatar
Michael Yang committed
856
{{- end }}`
Patrick Devine's avatar
Patrick Devine committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873

	tmpl, err := template.New("").Parse(modelFile)
	if err != nil {
		log.Printf("error parsing template: %q", err)
		return "", err
	}

	var buf bytes.Buffer

	if err = tmpl.Execute(&buf, mt); err != nil {
		log.Printf("error executing template: %q", err)
		return "", err
	}

	return buf.String(), nil
}

874
func PushModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
875
	mp := ParseModelPath(name)
876
877
	fn(api.ProgressResponse{Status: "retrieving manifest"})

878
879
880
881
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
	}

Patrick Devine's avatar
Patrick Devine committed
882
	manifest, _, err := GetManifest(mp)
883
	if err != nil {
884
		fn(api.ProgressResponse{Status: "couldn't retrieve manifest"})
885
886
887
888
		return err
	}

	var layers []*Layer
Jeffrey Morgan's avatar
Jeffrey Morgan committed
889
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
890
	layers = append(layers, manifest.Config)
891
892

	for _, layer := range layers {
Michael Yang's avatar
Michael Yang committed
893
		if err := uploadBlob(ctx, mp, layer, regOpts, fn); err != nil {
894
			log.Printf("error uploading blob: %v", err)
895
896
897
			if errors.Is(err, errUnauthorized) {
				return fmt.Errorf("unable to push %s, make sure this namespace exists and you are authorized to push to it", ParseModelPath(name).GetNamespaceRepository())
			}
898
899
			return err
		}
900
901
	}

902
	fn(api.ProgressResponse{Status: "pushing manifest"})
Michael Yang's avatar
Michael Yang committed
903
904
	requestURL := mp.BaseURL()
	requestURL = requestURL.JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
905
906
907
908
909
910

	manifestJSON, err := json.Marshal(manifest)
	if err != nil {
		return err
	}

Michael Yang's avatar
Michael Yang committed
911
912
	headers := make(http.Header)
	headers.Set("Content-Type", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
913
	resp, err := makeRequestWithRetry(ctx, http.MethodPut, requestURL, headers, bytes.NewReader(manifestJSON), regOpts)
914
915
916
917
918
	if err != nil {
		return err
	}
	defer resp.Body.Close()

919
	fn(api.ProgressResponse{Status: "success"})
920
921
922
923

	return nil
}

924
func PullModel(ctx context.Context, name string, regOpts *RegistryOptions, fn func(api.ProgressResponse)) error {
925
926
	mp := ParseModelPath(name)

927
928
929
930
931
	var manifest *ManifestV2
	var err error
	var noprune string

	// build deleteMap to prune unused layers
Michael Yang's avatar
Michael Yang committed
932
	deleteMap := make(map[string]struct{})
933
934
935
936
937
938
939
940
941

	if noprune = os.Getenv("OLLAMA_NOPRUNE"); noprune == "" {
		manifest, _, err = GetManifest(mp)
		if err != nil && !errors.Is(err, os.ErrNotExist) {
			return err
		}

		if manifest != nil {
			for _, l := range manifest.Layers {
Michael Yang's avatar
Michael Yang committed
942
				deleteMap[l.Digest] = struct{}{}
943
			}
Michael Yang's avatar
Michael Yang committed
944
			deleteMap[manifest.Config.Digest] = struct{}{}
945
946
947
		}
	}

948
949
	if mp.ProtocolScheme == "http" && !regOpts.Insecure {
		return fmt.Errorf("insecure protocol http")
950
	}
951

952
	fn(api.ProgressResponse{Status: "pulling manifest"})
953

954
	manifest, err = pullModelManifest(ctx, mp, regOpts)
955
	if err != nil {
956
		return fmt.Errorf("pull model manifest: %s", err)
957
958
959
	}

	var layers []*Layer
Bruce MacDonald's avatar
Bruce MacDonald committed
960
	layers = append(layers, manifest.Layers...)
Michael Yang's avatar
Michael Yang committed
961
	layers = append(layers, manifest.Config)
962
963

	for _, layer := range layers {
964
965
966
967
968
969
970
971
		if err := downloadBlob(
			ctx,
			downloadOpts{
				mp:      mp,
				digest:  layer.Digest,
				regOpts: regOpts,
				fn:      fn,
			}); err != nil {
972
973
			return err
		}
974
		delete(deleteMap, layer.Digest)
975
	}
976
	delete(deleteMap, manifest.Config.Digest)
977

Michael Yang's avatar
Michael Yang committed
978
979
980
	fn(api.ProgressResponse{Status: "verifying sha256 digest"})
	for _, layer := range layers {
		if err := verifyBlob(layer.Digest); err != nil {
981
982
983
984
985
986
987
988
989
990
991
			if errors.Is(err, errDigestMismatch) {
				// something went wrong, delete the blob
				fp, err := GetBlobsPath(layer.Digest)
				if err != nil {
					return err
				}
				if err := os.Remove(fp); err != nil {
					// log this, but return the original error
					log.Printf("couldn't remove file with digest mismatch '%s': %v", fp, err)
				}
			}
Michael Yang's avatar
Michael Yang committed
992
993
994
995
			return err
		}
	}

996
	fn(api.ProgressResponse{Status: "writing manifest"})
997

998
	manifestJSON, err := json.Marshal(manifest)
999
1000
1001
1002
	if err != nil {
		return err
	}

1003
	fp, err := mp.GetManifestPath()
1004
1005
1006
	if err != nil {
		return err
	}
1007
1008
1009
	if err := os.MkdirAll(filepath.Dir(fp), 0o755); err != nil {
		return err
	}
1010

Bruce MacDonald's avatar
Bruce MacDonald committed
1011
	err = os.WriteFile(fp, manifestJSON, 0o644)
1012
1013
1014
1015
1016
	if err != nil {
		log.Printf("couldn't write to %s", fp)
		return err
	}

1017
1018
1019
1020
1021
1022
1023
1024
	if noprune == "" {
		fn(api.ProgressResponse{Status: "removing any unused layers"})
		err = deleteUnusedLayers(nil, deleteMap, false)
		if err != nil {
			return err
		}
	}

1025
	fn(api.ProgressResponse{Status: "success"})
1026
1027
1028
1029

	return nil
}

1030
func pullModelManifest(ctx context.Context, mp ModelPath, regOpts *RegistryOptions) (*ManifestV2, error) {
Michael Yang's avatar
Michael Yang committed
1031
	requestURL := mp.BaseURL().JoinPath("v2", mp.GetNamespaceRepository(), "manifests", mp.Tag)
1032

Michael Yang's avatar
Michael Yang committed
1033
1034
	headers := make(http.Header)
	headers.Set("Accept", "application/vnd.docker.distribution.manifest.v2+json")
Michael Yang's avatar
Michael Yang committed
1035
	resp, err := makeRequestWithRetry(ctx, http.MethodGet, requestURL, headers, nil, regOpts)
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
	if err != nil {
		return nil, err
	}
	defer resp.Body.Close()

	var m *ManifestV2
	if err := json.NewDecoder(resp.Body).Decode(&m); err != nil {
		return nil, err
	}

	return m, err
}

// GetSHA256Digest returns the SHA256 hash of a given buffer and returns it, and the size of buffer
Michael Yang's avatar
Michael Yang committed
1050
func GetSHA256Digest(r io.Reader) (string, int64) {
Michael Yang's avatar
Michael Yang committed
1051
1052
1053
1054
1055
1056
	h := sha256.New()
	n, err := io.Copy(h, r)
	if err != nil {
		log.Fatal(err)
	}

Michael Yang's avatar
Michael Yang committed
1057
	return fmt.Sprintf("sha256:%x", h.Sum(nil)), n
1058
1059
}

1060
1061
var errUnauthorized = fmt.Errorf("unauthorized")

Michael Yang's avatar
Michael Yang committed
1062
func makeRequestWithRetry(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.ReadSeeker, regOpts *RegistryOptions) (*http.Response, error) {
1063
1064
1065
1066
1067
	resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
	if err != nil {
		if !errors.Is(err, context.Canceled) {
			log.Printf("request failed: %v", err)
		}
1068

1069
1070
1071
1072
1073
1074
1075
1076
1077
		return nil, err
	}

	switch {
	case resp.StatusCode == http.StatusUnauthorized:
		// Handle authentication error with one retry
		auth := resp.Header.Get("www-authenticate")
		authRedir := ParseAuthRedirectString(auth)
		token, err := getAuthToken(ctx, authRedir)
Michael Yang's avatar
Michael Yang committed
1078
1079
1080
		if err != nil {
			return nil, err
		}
1081
1082
1083
		regOpts.Token = token
		if body != nil {
			_, err = body.Seek(0, io.SeekStart)
Michael Yang's avatar
Michael Yang committed
1084
1085
1086
1087
			if err != nil {
				return nil, err
			}
		}
1088
1089
1090
1091
1092
1093
1094

		resp, err := makeRequest(ctx, method, requestURL, headers, body, regOpts)
		if resp.StatusCode == http.StatusUnauthorized {
			return nil, errUnauthorized
		}

		return resp, err
1095
1096
1097
1098
1099
1100
1101
1102
	case resp.StatusCode == http.StatusNotFound:
		return nil, os.ErrNotExist
	case resp.StatusCode >= http.StatusBadRequest:
		responseBody, err := io.ReadAll(resp.Body)
		if err != nil {
			return nil, fmt.Errorf("%d: %s", resp.StatusCode, err)
		}
		return nil, fmt.Errorf("%d: %s", resp.StatusCode, responseBody)
Michael Yang's avatar
Michael Yang committed
1103
1104
	}

1105
	return resp, nil
Michael Yang's avatar
Michael Yang committed
1106
1107
}

Michael Yang's avatar
Michael Yang committed
1108
func makeRequest(ctx context.Context, method string, requestURL *url.URL, headers http.Header, body io.Reader, regOpts *RegistryOptions) (*http.Response, error) {
Michael Yang's avatar
Michael Yang committed
1109
	if requestURL.Scheme != "http" && regOpts != nil && regOpts.Insecure {
Michael Yang's avatar
Michael Yang committed
1110
		requestURL.Scheme = "http"
1111
1112
	}

Michael Yang's avatar
Michael Yang committed
1113
	req, err := http.NewRequestWithContext(ctx, method, requestURL.String(), body)
1114
1115
1116
1117
	if err != nil {
		return nil, err
	}

Michael Yang's avatar
Michael Yang committed
1118
1119
1120
1121
	if headers != nil {
		req.Header = headers
	}

Michael Yang's avatar
Michael Yang committed
1122
1123
1124
1125
1126
1127
	if regOpts != nil {
		if regOpts.Token != "" {
			req.Header.Set("Authorization", "Bearer "+regOpts.Token)
		} else if regOpts.Username != "" && regOpts.Password != "" {
			req.SetBasicAuth(regOpts.Username, regOpts.Password)
		}
1128
1129
	}

Michael Yang's avatar
Michael Yang committed
1130
	req.Header.Set("User-Agent", fmt.Sprintf("ollama/%s (%s %s) Go/%s", version.Version, runtime.GOARCH, runtime.GOOS, runtime.Version()))
1131

Michael Yang's avatar
Michael Yang committed
1132
1133
1134
1135
1136
1137
1138
1139
1140
	if s := req.Header.Get("Content-Length"); s != "" {
		contentLength, err := strconv.ParseInt(s, 10, 64)
		if err != nil {
			return nil, err
		}

		req.ContentLength = contentLength
	}

Michael Yang's avatar
Michael Yang committed
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
	proxyURL, err := http.ProxyFromEnvironment(req)
	if err != nil {
		return nil, err
	}

	client := http.Client{
		Transport: &http.Transport{
			Proxy: http.ProxyURL(proxyURL),
		},
	}

	resp, err := client.Do(req)
1153
1154
1155
1156
1157
1158
	if err != nil {
		return nil, err
	}

	return resp, nil
}
Michael Yang's avatar
Michael Yang committed
1159

Patrick Devine's avatar
Patrick Devine committed
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
func getValue(header, key string) string {
	startIdx := strings.Index(header, key+"=")
	if startIdx == -1 {
		return ""
	}

	// Move the index to the starting quote after the key.
	startIdx += len(key) + 2
	endIdx := startIdx

	for endIdx < len(header) {
		if header[endIdx] == '"' {
			if endIdx+1 < len(header) && header[endIdx+1] != ',' { // If the next character isn't a comma, continue
				endIdx++
				continue
			}
			break
		}
		endIdx++
	}
	return header[startIdx:endIdx]
}

func ParseAuthRedirectString(authStr string) AuthRedirect {
	authStr = strings.TrimPrefix(authStr, "Bearer ")

	return AuthRedirect{
		Realm:   getValue(authStr, "realm"),
		Service: getValue(authStr, "service"),
		Scope:   getValue(authStr, "scope"),
	}
}

1193
1194
var errDigestMismatch = fmt.Errorf("digest mismatch, file must be downloaded again")

Michael Yang's avatar
Michael Yang committed
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
func verifyBlob(digest string) error {
	fp, err := GetBlobsPath(digest)
	if err != nil {
		return err
	}

	f, err := os.Open(fp)
	if err != nil {
		return err
	}
	defer f.Close()

	fileDigest, _ := GetSHA256Digest(f)
	if digest != fileDigest {
1209
		return fmt.Errorf("%w: want %s, got %s", errDigestMismatch, digest, fileDigest)
Michael Yang's avatar
Michael Yang committed
1210
1211
1212
1213
	}

	return nil
}