gpt4all/gpt4all-bindings/golang/README.md
Nandakumar 4161bfba33 Update README.md (#738)
* Update README.md

fix golang gpt4all import path

Signed-off-by: Nandakumar <nandagunasekaran@gmail.com>

* Update README.md

Signed-off-by: Nandakumar <nandagunasekaran@gmail.com>

---------

Signed-off-by: Nandakumar <nandagunasekaran@gmail.com>
2023-05-28 19:51:11 -04:00

1.3 KiB

GPT4All Golang bindings

The golang bindings have been tested on:

  • MacOS
  • Linux

Usage

import (
	"github.com/nomic-ai/gpt4all/gpt4all-bindings/golang"
)

func main() {
	// Load the model
	model, err := gpt4all.New("model.bin", gpt4all.SetModelType(gpt4all.GPTJType))
	if err != nil {
		panic(err)
	}
	defer model.Free()

	model.SetTokenCallback(func(s string) bool {
		fmt.Print(s)
		return true
	})

	_, err = model.Predict("Here are 4 steps to create a website:", gpt4all.SetTemperature(0.1))
	if err != nil {
		panic(err)
	}
}

Building

In order to use the bindings you will need to build libgpt4all.a:

git clone https://github.com/nomic-ai/gpt4all
cd gpt4all/gpt4all-bindings/golang
make libgpt4all.a

To use the bindings in your own software:

  • Import github.com/nomic-ai/gpt4all/gpt4all-bindings/golang;
  • Compile libgpt4all.a (you can use make libgpt4all.a in the bindings/go directory);
  • Link your go binary against whisper by setting the environment variables C_INCLUDE_PATH and LIBRARY_PATH to point to the binding.h file directory and libgpt4all.a file directory respectively.

Testing

To run tests, run make test:

git clone https://github.com/nomic-ai/gpt4all
cd gpt4all/gpt4all-bindings/golang
make test