gpt4all/gpt4all-bindings/python
Andriy Mulyar fca2578a81
Documentation improvements on LocalDocs (#790)
* Update gpt4all_chat.md

Signed-off-by: Andriy Mulyar <andriy.mulyar@gmail.com>

* typo

Signed-off-by: Andriy Mulyar <andriy.mulyar@gmail.com>

---------

Signed-off-by: Andriy Mulyar <andriy.mulyar@gmail.com>
2023-06-01 10:29:29 -04:00
..
docs Documentation improvements on LocalDocs (#790) 2023-06-01 10:29:29 -04:00
gpt4all hotfix default verbose optioin 2023-05-26 12:49:32 -04:00
tests [DATALAD RUNCMD] run codespell throughout 2023-05-16 11:33:59 -04:00
.gitignore transfer python bindings code 2023-05-10 13:38:32 -04:00
LICENSE.txt transfer python bindings code 2023-05-10 13:38:32 -04:00
makefile transfer python bindings code 2023-05-10 13:38:32 -04:00
MANIFEST.in transfer python bindings code 2023-05-10 13:38:32 -04:00
mkdocs.yml GPT4All Updated Docs and FAQ (#632) 2023-05-18 16:07:57 -04:00
README.md Improvements to documentation (#606) 2023-05-16 15:29:27 -04:00
setup.py fixed response formatting when streaming 2023-05-18 12:02:11 -04:00

Python GPT4All

This package contains a set of Python bindings around the llmodel C-API.

Documentation

docs.gpt4all.io

Installation

pip install gpt4all

Local Build Instructions

NOTE: If you are doing this on a Windows machine, you must build the GPT4All backend using MinGW64 compiler.

  1. Setup llmodel
git clone --recurse-submodules https://github.com/nomic-ai/gpt4all
cd gpt4all/gpt4all-backend/
mkdir build
cd build
cmake ..
cmake --build . --parallel

Confirm that libllmodel.* exists in gpt4all-backend/build.

  1. Setup Python package
cd ../../gpt4all-bindings/python
pip3 install -e .
  1. Test it out! In a Python script or console:

from gpt4all import GPT4All

gptj = GPT4All("ggml-gpt4all-j-v1.3-groovy")
messages = [{"role": "user", "content": "Name 3 colors"}]
gptj.chat_completion(messages)