llama.go 22.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package llm

import (
	"bufio"
	"bytes"
	"context"
	"embed"
	"encoding/json"
	"errors"
	"fmt"
	"io"
	"io/fs"
	"log"
	"math/rand"
	"net/http"
	"os"
	"os/exec"
	"path"
	"path/filepath"
	"runtime"
	"strconv"
	"strings"
23
	"sync"
24
25
26
	"time"

	"github.com/jmorganca/ollama/api"
Michael Yang's avatar
Michael Yang committed
27
	"github.com/jmorganca/ollama/format"
28
29
)

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
const jsonGrammar = `
root   ::= object
value  ::= object | array | string | number | ("true" | "false" | "null") ws

object ::=
  "{" ws (
            string ":" ws value
    ("," ws string ":" ws value)*
  )? "}" ws

array  ::=
  "[" ws (
            value
    ("," ws value)*
  )? "]" ws

string ::=
  "\"" (
    [^"\\] |
    "\\" (["\\/bfnrt] | "u" [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F] [0-9a-fA-F]) # escapes
  )* "\"" ws

number ::= ("-"? ([0-9] | [1-9] [0-9]*)) ("." [0-9]+)? ([eE] [-+]? [0-9]+)? ws

# Optional space: by convention, applied in this grammar after literal chars when allowed
ws ::= ([ \t\n] ws)?
`

Bruce MacDonald's avatar
Bruce MacDonald committed
58
//go:embed llama.cpp/*/build/*/bin/*
59
60
var llamaCppEmbed embed.FS

61
type ModelRunner struct {
62
	Type        string // "gguf" or "ggml"
63
64
	Path        string // path to the model runner executable
	Accelerated bool
65
}
66

67
func chooseRunners(workDir, runnerType string) []ModelRunner {
68
	buildPath := path.Join("llama.cpp", runnerType, "build")
69
	var runners []ModelRunner
70

71
72
	// set the runners based on the OS
	// IMPORTANT: the order of the runners in the array is the priority order
Bruce MacDonald's avatar
Bruce MacDonald committed
73
74
	switch runtime.GOOS {
	case "darwin":
75
		if runtime.GOARCH == "arm64" {
76
			runners = []ModelRunner{{Type: runnerType, Path: path.Join(buildPath, "metal", "bin", "ollama-runner")}}
77
		} else {
78
			runners = []ModelRunner{{Type: runnerType, Path: path.Join(buildPath, "cpu", "bin", "ollama-runner")}}
79
		}
80
	case "linux":
81
		runners = []ModelRunner{
82
83
			{Type: runnerType, Path: path.Join(buildPath, "cuda", "bin", "ollama-runner"), Accelerated: true},
			{Type: runnerType, Path: path.Join(buildPath, "cpu", "bin", "ollama-runner")},
84
85
86
		}
	case "windows":
		// TODO: select windows GPU runner here when available
87
		runners = []ModelRunner{
88
89
			{Type: runnerType, Path: path.Join(buildPath, "cuda", "bin", "Release", "ollama-runner.exe"), Accelerated: true},
			{Type: runnerType, Path: path.Join(buildPath, "cpu", "bin", "Release", "ollama-runner.exe")},
90
		}
91
92
	default:
		log.Printf("unknown OS, running on CPU: %s", runtime.GOOS)
93
		runners = []ModelRunner{
94
			{Type: runnerType, Path: path.Join(buildPath, "cpu", "bin", "ollama-runner")},
95
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
96
	}
97

98
99
100
	runnerAvailable := false // if no runner files are found in the embed, this flag will cause a fast fail
	for _, r := range runners {
		// find all the files in the runner's bin directory
101
		files, err := fs.Glob(llamaCppEmbed, path.Join(path.Dir(r.Path), "*"))
Bruce MacDonald's avatar
Bruce MacDonald committed
102
		if err != nil {
103
			// this is expected, ollama may be compiled without all runners packed in
Michael Yang's avatar
Michael Yang committed
104
			log.Printf("%s runner not found: %v", r.Path, err)
105
			continue
Bruce MacDonald's avatar
Bruce MacDonald committed
106
		}
107

108
		for _, f := range files {
Bruce MacDonald's avatar
Bruce MacDonald committed
109
110
			runnerAvailable = true

111
112
113
114
115
116
			srcFile, err := llamaCppEmbed.Open(f)
			if err != nil {
				log.Fatalf("read llama runner %s: %v", f, err)
			}
			defer srcFile.Close()

Bruce MacDonald's avatar
Bruce MacDonald committed
117
			// create the directory in case it does not exist, filepath.Dir() converts the file path to the OS's format
118
			destPath := filepath.Join(workDir, filepath.Dir(f))
119
120
121
			if err := os.MkdirAll(destPath, 0o755); err != nil {
				log.Fatalf("create runner temp dir %s: %v", filepath.Dir(f), err)
			}
122

Bruce MacDonald's avatar
Bruce MacDonald committed
123
			// create the path to the destination file, filepath.Base() converts the file path to the OS's format
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
			destFile := filepath.Join(destPath, filepath.Base(f))

			_, err = os.Stat(destFile)
			switch {
			case errors.Is(err, os.ErrNotExist):
				destFile, err := os.OpenFile(destFile, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o755)
				if err != nil {
					log.Fatalf("write llama runner %s: %v", f, err)
				}
				defer destFile.Close()

				if _, err := io.Copy(destFile, srcFile); err != nil {
					log.Fatalf("copy llama runner %s: %v", f, err)
				}
			case err != nil:
				log.Fatalf("stat llama runner %s: %v", f, err)
140
			}
141
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
142
	}
143
144
145
	if !runnerAvailable {
		log.Fatalf("%s runner not found", runnerType)
	}
146

147
148
149
	// return the runners to try in priority order
	localRunnersByPriority := []ModelRunner{}
	for _, r := range runners {
Bruce MacDonald's avatar
Bruce MacDonald committed
150
		// clean the ModelRunner paths so that they match the OS we are running on
151
		localRunnersByPriority = append(localRunnersByPriority, ModelRunner{
152
			Type:        r.Type,
153
154
155
			Path:        filepath.Clean(path.Join(workDir, r.Path)),
			Accelerated: r.Accelerated,
		})
Bruce MacDonald's avatar
Bruce MacDonald committed
156
	}
157

158
	return localRunnersByPriority
159
160
161
162
163
164
}

type llamaModel struct {
	hyperparameters llamaHyperparameters
}

Michael Yang's avatar
Michael Yang committed
165
166
func (llm *llamaModel) ModelFamily() string {
	return "llama"
167
168
}

Michael Yang's avatar
Michael Yang committed
169
170
func llamaModelType(numLayer uint32) string {
	switch numLayer {
171
	case 26:
Michael Yang's avatar
Michael Yang committed
172
		return "3B"
173
	case 32:
Michael Yang's avatar
Michael Yang committed
174
		return "7B"
175
	case 40:
Michael Yang's avatar
Michael Yang committed
176
		return "13B"
177
	case 48:
Michael Yang's avatar
Michael Yang committed
178
		return "34B"
179
	case 60:
Michael Yang's avatar
Michael Yang committed
180
		return "30B"
181
	case 80:
Michael Yang's avatar
Michael Yang committed
182
183
		return "65B"
	default:
Michael Yang's avatar
Michael Yang committed
184
		return "unknown"
185
	}
Michael Yang's avatar
Michael Yang committed
186
}
187

Michael Yang's avatar
Michael Yang committed
188
189
func (llm *llamaModel) ModelType() string {
	return llamaModelType(llm.hyperparameters.NumLayer)
190
191
}

Michael Yang's avatar
Michael Yang committed
192
193
func (llm *llamaModel) FileType() string {
	return fileType(llm.hyperparameters.FileType)
194
195
}

196
197
198
199
func (llm *llamaModel) NumLayers() int64 {
	return int64(llm.hyperparameters.NumLayer)
}

200
201
202
203
204
205
206
207
208
209
210
211
212
213
type llamaHyperparameters struct {
	// NumVocab is the size of the model's vocabulary.
	NumVocab uint32

	// NumEmbd is the size of the model's embedding layer.
	NumEmbd uint32
	NumMult uint32
	NumHead uint32

	// NumLayer is the number of layers in the model.
	NumLayer uint32
	NumRot   uint32

	// FileType describes the quantization level of the model, e.g. Q4_0, Q5_K, etc.
Michael Yang's avatar
Michael Yang committed
214
	FileType uint32
215
216
217
}

type Running struct {
218
219
220
221
222
223
	Port          int
	Cmd           *exec.Cmd
	Cancel        context.CancelFunc
	exitOnce      sync.Once
	exitCh        chan error // channel to receive the exit status of the subprocess
	*StatusWriter            // captures error messages from the llama runner process
224
225
}

Patrick Devine's avatar
Patrick Devine committed
226
227
228
229
230
type ImageData struct {
	Data []byte `json:"data"`
	ID   int    `json:"id"`
}

231
232
type llama struct {
	api.Options
Patrick Devine's avatar
Patrick Devine committed
233
	ImageData []ImageData
234
235
236
	Running
}

237
var (
Jeffrey Morgan's avatar
Jeffrey Morgan committed
238
	errNvidiaSMI     = errors.New("warning: gpu support may not be enabled, check that you have installed GPU drivers: nvidia-smi command failed")
239
240
	errAvailableVRAM = errors.New("not enough VRAM available, falling back to CPU only")
)
241

Michael Yang's avatar
Michael Yang committed
242
// CheckVRAM returns the free VRAM in bytes on Linux machines with NVIDIA GPUs
Michael Yang's avatar
Michael Yang committed
243
func CheckVRAM() (int64, error) {
244
	cmd := exec.Command("nvidia-smi", "--query-gpu=memory.free", "--format=csv,noheader,nounits")
245
246
247
248
	var stdout bytes.Buffer
	cmd.Stdout = &stdout
	err := cmd.Run()
	if err != nil {
249
		return 0, errNvidiaSMI
250
251
	}

Michael Yang's avatar
Michael Yang committed
252
	var freeMiB int64
253
254
255
	scanner := bufio.NewScanner(&stdout)
	for scanner.Scan() {
		line := scanner.Text()
256
257
258
259
		if strings.Contains(line, "[Insufficient Permissions]") {
			return 0, fmt.Errorf("GPU support may not enabled, check you have installed GPU drivers and have the necessary permissions to run nvidia-smi")
		}

Michael Yang's avatar
Michael Yang committed
260
		vram, err := strconv.ParseInt(strings.TrimSpace(line), 10, 64)
261
262
263
264
		if err != nil {
			return 0, fmt.Errorf("failed to parse available VRAM: %v", err)
		}

Michael Yang's avatar
Michael Yang committed
265
		freeMiB += vram
266
267
	}

Michael Yang's avatar
Michael Yang committed
268
269
	freeBytes := freeMiB * 1024 * 1024
	if freeBytes < 2*format.GigaByte {
270
271
		log.Printf("less than 2 GB VRAM available")
		return 0, errAvailableVRAM
Michael Yang's avatar
Michael Yang committed
272
273
	}

Michael Yang's avatar
Michael Yang committed
274
	return freeBytes, nil
275
276
}

277
func NumGPU(numLayer, fileSizeBytes int64, opts api.Options) int {
278
279
280
	if opts.NumGPU != -1 {
		return opts.NumGPU
	}
Jing Zhang's avatar
Jing Zhang committed
281
	if runtime.GOOS == "linux" || runtime.GOOS == "windows" {
Michael Yang's avatar
Michael Yang committed
282
		freeBytes, err := CheckVRAM()
283
		if err != nil {
284
			if !errors.Is(err, errNvidiaSMI) {
285
286
287
288
289
				log.Print(err.Error())
			}
			// nvidia driver not installed or no nvidia GPU found
			return 0
		}
290

291
292
293
294
295
		/*
		 Calculate bytes per layer, this will roughly be the size of the model file divided by the number of layers.
		 We can store the model weights and the kv cache in vram,
		 to enable kv chache vram storage add two additional layers to the number of layers retrieved from the model file.
		*/
296
297
		bytesPerLayer := fileSizeBytes / numLayer

298
299
		// 75% of the absolute max number of layers we can fit in available VRAM, off-loading too many layers to the GPU can cause OOM errors
		layers := int(freeBytes/bytesPerLayer) * 3 / 4
300
		log.Printf("%d MB VRAM available, loading up to %d GPU layers", freeBytes/(1024*1024), layers)
301

302
		return layers
303
	}
304
305
	// default to enable metal on macOS
	return 1
306
307
}

308
309
// StatusWriter is a writer that captures error messages from the llama runner process
type StatusWriter struct {
310
311
	ErrCh      chan error
	LastErrMsg string
312
313
314
315
316
317
318
319
320
}

func NewStatusWriter() *StatusWriter {
	return &StatusWriter{
		ErrCh: make(chan error, 1),
	}
}

func (w *StatusWriter) Write(b []byte) (int, error) {
321
	var errMsg string
322
	if _, after, ok := bytes.Cut(b, []byte("error:")); ok {
323
324
325
		errMsg = string(bytes.TrimSpace(after))
	} else if _, after, ok := bytes.Cut(b, []byte("CUDA error")); ok {
		errMsg = string(bytes.TrimSpace(after))
326
	}
327
328
329
330
331
332

	if errMsg != "" {
		w.LastErrMsg = errMsg
		w.ErrCh <- fmt.Errorf("llama runner: %s", errMsg)
	}

333
334
335
	return os.Stderr.Write(b)
}

Michael Yang's avatar
Michael Yang committed
336
func newLlama(model string, adapters, projectors []string, runners []ModelRunner, numLayers int64, opts api.Options) (*llama, error) {
337
338
	fileInfo, err := os.Stat(model)
	if err != nil {
339
340
341
342
343
344
345
		return nil, err
	}

	if len(adapters) > 1 {
		return nil, errors.New("ollama supports only one lora adapter, but multiple were provided")
	}

346
	numGPU := NumGPU(numLayers, fileInfo.Size(), opts)
347
348
349
350
	params := []string{
		"--model", model,
		"--ctx-size", fmt.Sprintf("%d", opts.NumCtx),
		"--batch-size", fmt.Sprintf("%d", opts.NumBatch),
351
		"--n-gpu-layers", fmt.Sprintf("%d", numGPU),
352
353
354
		"--embedding",
	}

355
356
357
358
	if opts.MainGPU > 0 {
		params = append(params, "--main-gpu", fmt.Sprintf("%d", opts.MainGPU))
	}

359
360
361
362
363
364
365
366
	if opts.RopeFrequencyBase > 0 {
		params = append(params, "--rope-freq-base", fmt.Sprintf("%f", opts.RopeFrequencyBase))
	}

	if opts.RopeFrequencyScale > 0 {
		params = append(params, "--rope-freq-scale", fmt.Sprintf("%f", opts.RopeFrequencyScale))
	}

Bruce MacDonald's avatar
Bruce MacDonald committed
367
368
369
370
	if opts.NumGQA > 0 {
		params = append(params, "--gqa", fmt.Sprintf("%d", opts.NumGQA))
	}

371
372
373
374
375
	if len(adapters) > 0 {
		// TODO: applying multiple adapters is not supported by the llama.cpp server yet
		params = append(params, "--lora", adapters[0])
	}

Michael Yang's avatar
Michael Yang committed
376
377
378
379
380
	if len(projectors) > 0 {
		// TODO: applying multiple projectors is not supported by the llama.cpp server yet
		params = append(params, "--mmproj", projectors[0])
	}

381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
	if opts.NumThread > 0 {
		params = append(params, "--threads", fmt.Sprintf("%d", opts.NumThread))
	}

	if !opts.F16KV {
		params = append(params, "--memory-f32")
	}
	if opts.UseMLock {
		params = append(params, "--mlock")
	}
	if !opts.UseMMap {
		params = append(params, "--no-mmap")
	}
	if opts.UseNUMA {
		params = append(params, "--numa")
	}

398
399
	var runnerErr error

400
	// start the llama.cpp server with a retry in case the port is already in use
401
	for _, runner := range runners {
402
403
404
405
406
		if runner.Accelerated && numGPU == 0 {
			log.Printf("skipping accelerated runner because num_gpu=0")
			continue
		}

407
408
409
410
411
		if _, err := os.Stat(runner.Path); err != nil {
			log.Printf("llama runner not found: %v", err)
			continue
		}

412
		port := rand.Intn(65535-49152) + 49152 // get a random port in the ephemeral range
413
414
415
416
417
418
		params := append(params, "--port", strconv.Itoa(port))

		if runner.Type == "gguf" {
			params = append(params, "--parallel", "2")
		}

419
420
421
422
		ctx, cancel := context.WithCancel(context.Background())
		cmd := exec.CommandContext(
			ctx,
			runner.Path,
423
			params...,
424
		)
Michael Yang's avatar
Michael Yang committed
425
426
427
428
429
430
431
432
433

		var libraryPaths []string
		if libraryPath, ok := os.LookupEnv("LD_LIBRARY_PATH"); ok {
			libraryPaths = append(libraryPaths, libraryPath)
		}

		libraryPaths = append(libraryPaths, filepath.Dir(runner.Path))

		cmd.Env = append(os.Environ(), fmt.Sprintf("LD_LIBRARY_PATH=%s", strings.Join(libraryPaths, ":")))
434
		cmd.Stdout = os.Stderr
435
436
		statusWriter := NewStatusWriter()
		cmd.Stderr = statusWriter
437

438
		llm := &llama{Options: opts, Running: Running{Port: port, Cmd: cmd, Cancel: cancel, exitCh: make(chan error)}}
439

440
		log.Print("starting llama runner")
Bruce MacDonald's avatar
Bruce MacDonald committed
441
		if err := llm.Cmd.Start(); err != nil {
442
			log.Printf("error starting the external llama runner: %v", err)
Bruce MacDonald's avatar
Bruce MacDonald committed
443
444
445
			continue
		}

446
		// monitor the llama runner process and signal when it exits
447
		go func() {
448
			err := llm.Cmd.Wait()
449
450
451
452
453
454
455
			// default to printing the exit message of the command process, it will probably just say 'exit staus 1'
			errMsg := err.Error()
			// try to set a better error message if llama runner logs captured an error
			if statusWriter.LastErrMsg != "" {
				errMsg = statusWriter.LastErrMsg
			}
			log.Println(errMsg)
456
457
458
459
			// llm.Cmd.Wait() can only be called once, use this exit channel to signal that the process has exited
			llm.exitOnce.Do(func() {
				close(llm.exitCh)
			})
460
461
		}()

462
		if err := waitForServer(llm); err != nil {
463
			log.Printf("error starting llama runner: %v", err)
464
			llm.Close()
465
466
467
468
469
470
471
472
473
474
475

			// default the runnerErr to the error returned by the most recent llama runner process
			runnerErr = err

			// capture the error directly from the runner process, if any
			select {
			case runnerErr = <-statusWriter.ErrCh:
			default:
				// the runner process probably timed out
			}

476
477
478
			// try again
			continue
		}
Bruce MacDonald's avatar
Bruce MacDonald committed
479

480
481
482
483
		// server started successfully
		return llm, nil
	}

484
485
486
487
488
	if runnerErr != nil {
		// this is the error returned from the llama runner process that failed most recently
		return nil, runnerErr
	}

489
	return nil, fmt.Errorf("failed to start a llama runner")
490
491
492
493
}

func waitForServer(llm *llama) error {
	start := time.Now()
494
	expiresAt := time.Now().Add(3 * time.Minute) // be generous with timeout, large models can take a while to load
Bruce MacDonald's avatar
Bruce MacDonald committed
495
	ticker := time.NewTicker(200 * time.Millisecond)
496
	defer ticker.Stop()
497

498
	log.Print("waiting for llama runner to start responding")
499
500
501
502
	for {
		select {
		case <-llm.exitCh:
			// failed to start subprocess
503
			return fmt.Errorf("llama runner process has terminated")
504
505
506
		case <-ticker.C:
			if time.Now().After(expiresAt) {
				// timeout
507
				return fmt.Errorf("timed out waiting for llama runner to start")
508
			}
509

510
511
512
513
514
			if err := llm.Ping(context.Background()); err == nil {
				// success
				log.Printf("llama runner started in %f seconds", time.Since(start).Seconds())
				return nil
			}
515
516
517
518
519
		}
	}
}

func (llm *llama) Close() {
520
	// signal the sub-process to terminate
Bruce MacDonald's avatar
Bruce MacDonald committed
521
	llm.Cancel()
522
523

	// wait for the command to exit to prevent race conditions with the next run
524
525
	<-llm.exitCh

526
527
	if llm.StatusWriter != nil && llm.StatusWriter.LastErrMsg != "" {
		log.Printf("llama runner stopped with error: %v", llm.StatusWriter.LastErrMsg)
528
529
	} else {
		log.Print("llama runner stopped successfully")
530
	}
531
532
533
534
535
536
}

func (llm *llama) SetOptions(opts api.Options) {
	llm.Options = opts
}

Michael Yang's avatar
Michael Yang committed
537
type prediction struct {
Michael Yang's avatar
Michael Yang committed
538
539
540
541
542
	Content string `json:"content"`
	Model   string `json:"model"`
	Prompt  string `json:"prompt"`
	Stop    bool   `json:"stop"`

Michael Yang's avatar
Michael Yang committed
543
544
545
546
547
548
	Timings struct {
		PredictedN  int     `json:"predicted_n"`
		PredictedMS float64 `json:"predicted_ms"`
		PromptN     int     `json:"prompt_n"`
		PromptMS    float64 `json:"prompt_ms"`
	}
549
550
}

Michael Yang's avatar
Michael Yang committed
551
const maxBufferSize = 512 * format.KiloByte
552

Bruce MacDonald's avatar
Bruce MacDonald committed
553
554
555
type PredictOpts struct {
	Prompt           string
	Format           string
Patrick Devine's avatar
Patrick Devine committed
556
	Images           []api.ImageData
Bruce MacDonald's avatar
Bruce MacDonald committed
557
558
559
	CheckpointStart  time.Time
	CheckpointLoaded time.Time
}
560

Bruce MacDonald's avatar
Bruce MacDonald committed
561
562
563
564
565
566
567
568
569
570
571
type PredictResult struct {
	CreatedAt          time.Time
	TotalDuration      time.Duration
	LoadDuration       time.Duration
	Content            string
	Done               bool
	PromptEvalCount    int
	PromptEvalDuration time.Duration
	EvalCount          int
	EvalDuration       time.Duration
}
572

Bruce MacDonald's avatar
Bruce MacDonald committed
573
func (llm *llama) Predict(ctx context.Context, predict PredictOpts, fn func(PredictResult)) error {
Patrick Devine's avatar
Patrick Devine committed
574
575
576
577
578
579
580
581
	imageData := llm.ImageData
	if len(predict.Images) > 0 {
		for cnt, i := range predict.Images {
			imageData = append(imageData, ImageData{Data: i, ID: cnt})
		}
	}
	log.Printf("loaded %d images", len(imageData))

Michael Yang's avatar
Michael Yang committed
582
	request := map[string]any{
Bruce MacDonald's avatar
Bruce MacDonald committed
583
		"prompt":            predict.Prompt,
Michael Yang's avatar
Michael Yang committed
584
585
586
		"stream":            true,
		"n_predict":         llm.NumPredict,
		"n_keep":            llm.NumKeep,
587
		"main_gpu":          llm.MainGPU,
Michael Yang's avatar
Michael Yang committed
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
		"temperature":       llm.Temperature,
		"top_k":             llm.TopK,
		"top_p":             llm.TopP,
		"tfs_z":             llm.TFSZ,
		"typical_p":         llm.TypicalP,
		"repeat_last_n":     llm.RepeatLastN,
		"repeat_penalty":    llm.RepeatPenalty,
		"presence_penalty":  llm.PresencePenalty,
		"frequency_penalty": llm.FrequencyPenalty,
		"mirostat":          llm.Mirostat,
		"mirostat_tau":      llm.MirostatTau,
		"mirostat_eta":      llm.MirostatEta,
		"penalize_nl":       llm.PenalizeNewline,
		"seed":              llm.Seed,
		"stop":              llm.Stop,
Patrick Devine's avatar
Patrick Devine committed
603
		"image_data":        imageData,
604
	}
605

Bruce MacDonald's avatar
Bruce MacDonald committed
606
	if predict.Format == "json" {
607
608
609
		request["grammar"] = jsonGrammar
	}

610
	// Handling JSON marshaling with special characters unescaped.
611
612
	buffer := &bytes.Buffer{}
	enc := json.NewEncoder(buffer)
613
614
	enc.SetEscapeHTML(false)

Michael Yang's avatar
Michael Yang committed
615
	if err := enc.Encode(request); err != nil {
616
		return fmt.Errorf("failed to marshal data: %v", err)
617
618
	}

Michael Yang's avatar
Michael Yang committed
619
	endpoint := fmt.Sprintf("http://127.0.0.1:%d/completion", llm.Port)
620
	req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, buffer)
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
	if err != nil {
		return fmt.Errorf("error creating POST request: %v", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		return fmt.Errorf("POST predict: %v", err)
	}
	defer resp.Body.Close()

	if resp.StatusCode >= 400 {
		bodyBytes, err := io.ReadAll(resp.Body)
		if err != nil {
			return fmt.Errorf("failed reading llm error response: %w", err)
		}
		log.Printf("llm predict error: %s", bodyBytes)
		return fmt.Errorf("%s", bodyBytes)
	}

	scanner := bufio.NewScanner(resp.Body)
642
643
644
	// increase the buffer size to avoid running out of space
	buf := make([]byte, 0, maxBufferSize)
	scanner.Buffer(buf, maxBufferSize)
645
646
647
648
649
650
	for scanner.Scan() {
		select {
		case <-ctx.Done():
			// This handles the request cancellation
			return ctx.Err()
		default:
Michael Yang's avatar
Michael Yang committed
651
652
			line := scanner.Bytes()
			if len(line) == 0 {
653
654
655
				continue
			}

656
657
658
659
			evt, ok := bytes.CutPrefix(line, []byte("data: "))
			if !ok {
				return fmt.Errorf("error parsing llm response stream: %s", line)
			}
660

661
662
663
664
			var p prediction
			if err := json.Unmarshal(evt, &p); err != nil {
				return fmt.Errorf("error unmarshaling llm prediction response: %v", err)
			}
Michael Yang's avatar
Michael Yang committed
665

666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
			if p.Content != "" {
				fn(PredictResult{
					CreatedAt: time.Now().UTC(),
					Content:   p.Content,
				})
			}

			if p.Stop {
				fn(PredictResult{
					CreatedAt:     time.Now().UTC(),
					TotalDuration: time.Since(predict.CheckpointStart),

					Done:               true,
					PromptEvalCount:    p.Timings.PromptN,
					PromptEvalDuration: parseDurationMs(p.Timings.PromptMS),
					EvalCount:          p.Timings.PredictedN,
					EvalDuration:       parseDurationMs(p.Timings.PredictedMS),
				})
				return nil
685
686
687
688
689
			}
		}
	}

	if err := scanner.Err(); err != nil {
690
691
692
693
694
695
696
697
		if strings.Contains(err.Error(), "unexpected EOF") {
			// this means the llama runner subprocess crashed
			llm.Close()
			if llm.StatusWriter != nil && llm.StatusWriter.LastErrMsg != "" {
				return fmt.Errorf("llama runner exited: %v", llm.StatusWriter.LastErrMsg)
			}
			return fmt.Errorf("llama runner exited, you may not have enough available memory to run this model")
		}
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
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
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
		return fmt.Errorf("error reading llm response: %v", err)
	}

	return nil
}

type TokenizeRequest struct {
	Content string `json:"content"`
}

type TokenizeResponse struct {
	Tokens []int `json:"tokens"`
}

func (llm *llama) Encode(ctx context.Context, prompt string) ([]int, error) {
	endpoint := fmt.Sprintf("http://127.0.0.1:%d/tokenize", llm.Port)
	data, err := json.Marshal(TokenizeRequest{Content: prompt})
	if err != nil {
		return nil, fmt.Errorf("marshaling encode data: %w", err)
	}

	req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewBuffer(data))
	if err != nil {
		return nil, fmt.Errorf("encode request: %w", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		return nil, fmt.Errorf("do encode request: %w", err)
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return nil, fmt.Errorf("read encode request: %w", err)
	}

	if resp.StatusCode >= 400 {
		log.Printf("llm encode error: %s", body)
		return nil, fmt.Errorf("%s", body)
	}

	var encoded TokenizeResponse
	if err := json.Unmarshal(body, &encoded); err != nil {
		return nil, fmt.Errorf("unmarshal encode response: %w", err)
	}

	return encoded.Tokens, nil
}

type DetokenizeRequest struct {
	Tokens []int `json:"tokens"`
}

type DetokenizeResponse struct {
	Content string `json:"content"`
}

func (llm *llama) Decode(ctx context.Context, tokens []int) (string, error) {
	if len(tokens) == 0 {
		return "", nil
	}
	endpoint := fmt.Sprintf("http://127.0.0.1:%d/detokenize", llm.Port)
	data, err := json.Marshal(DetokenizeRequest{Tokens: tokens})
	if err != nil {
		return "", fmt.Errorf("marshaling decode data: %w", err)
	}

	req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewBuffer(data))
	if err != nil {
		return "", fmt.Errorf("decode request: %w", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		return "", fmt.Errorf("do decode request: %w", err)
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return "", fmt.Errorf("read decode request: %w", err)
	}

	if resp.StatusCode >= 400 {
		log.Printf("llm decode error: %s", body)
		return "", fmt.Errorf("%s", body)
	}

	var decoded DetokenizeResponse
	if err := json.Unmarshal(body, &decoded); err != nil {
		return "", fmt.Errorf("unmarshal encode response: %w", err)
	}

	return decoded.Content, nil
}

type EmbeddingRequest struct {
	Content string `json:"content"`
}

type EmbeddingResponse struct {
	Embedding []float64 `json:"embedding"`
}

func (llm *llama) Embedding(ctx context.Context, input string) ([]float64, error) {
	endpoint := fmt.Sprintf("http://127.0.0.1:%d/embedding", llm.Port)
	data, err := json.Marshal(TokenizeRequest{Content: input})
	if err != nil {
		return nil, fmt.Errorf("error marshaling embed data: %w", err)
	}

	req, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewBuffer(data))
	if err != nil {
		return nil, fmt.Errorf("error creating embed request: %w", err)
	}
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		return nil, fmt.Errorf("POST embedding: %w", err)
	}
	defer resp.Body.Close()

	body, err := io.ReadAll(resp.Body)
	if err != nil {
		return nil, fmt.Errorf("error reading embed response: %w", err)
	}

	if resp.StatusCode >= 400 {
		log.Printf("llm encode error: %s", body)
		return nil, fmt.Errorf("%s", body)
	}

	var embedding EmbeddingResponse
	if err := json.Unmarshal(body, &embedding); err != nil {
		return nil, fmt.Errorf("unmarshal tokenize response: %w", err)
	}

	return embedding.Embedding, nil
}

// Ping checks that the server subprocess is still running and responding to requests
func (llm *llama) Ping(ctx context.Context) error {
Bruce MacDonald's avatar
Bruce MacDonald committed
844
	resp, err := http.Head(fmt.Sprintf("http://127.0.0.1:%d", llm.Port))
845
846
847
848
849
850
851
852
	if err != nil {
		return fmt.Errorf("ping resp: %w", err)
	}
	if resp.StatusCode != http.StatusOK {
		return fmt.Errorf("unexpected ping status: %s", resp.Status)
	}
	return nil
}