mirror of https://github.com/nomic-ai/gpt4all synced 2024-11-02 09:40:42 +00:00

Go to file

Adam Treat 9979c78c6c Set the folder when the browse opens		2023-04-28 22:24:59 -04:00
cmake	No need to install so many icons.	2023-04-28 22:10:41 -04:00
icons	Fix the icons more.	2023-04-28 21:48:10 -04:00
llmodel	Load models from filepath only.	2023-04-28 20:15:10 -04:00
qml	Set the folder when the browse opens	2023-04-28 22:24:59 -04:00
.gitignore	Update ignore.	2023-04-28 14:11:56 -04:00
.gitmodules	Move the backend code into own subdirectory and make it a shared library. Begin fleshing out the C api wrapper that bindings can use.	2023-04-26 08:22:38 -04:00
CMakeLists.txt	Fix the icons more.	2023-04-28 21:48:10 -04:00
download.cpp	Add a requires field for the models.json for future proofing.	2023-04-28 20:30:52 -04:00
download.h	Add a requires field for the models.json for future proofing.	2023-04-28 20:30:52 -04:00
LICENSE	Changing to MIT license.	2023-04-17 16:37:50 -04:00
llm.cpp	Load models from filepath only.	2023-04-28 20:15:10 -04:00
llm.h	Move the promptCallback to own function.	2023-04-27 11:08:15 -04:00
main.cpp	Force ini format for all platforms.	2023-04-28 22:21:23 -04:00
main.qml	Fix bug with startup order and new logos.	2023-04-28 14:11:18 -04:00
network.cpp	New startup dialog features.	2023-04-28 11:03:16 -04:00
network.h	New startup dialog features.	2023-04-28 11:03:16 -04:00
README.md	Fix cli tools instructions	2023-04-24 19:00:15 -04:00
test_hw.cpp	Getting ready for next update.	2023-04-21 23:23:57 -04:00

README.md

gpt4all-chat

Cross platform Qt based GUI for GPT4All versions with GPT-J as the base model. NOTE: The model seen in the screenshot is actually a preview of a new training run for GPT4All based on GPT-J. The GPT4All project is busy at work getting ready to release this model including installers for all three major OS's. In the meantime, you can try this UI out with the original GPT-J model by following build instructions below.

Features

Cross-platform (Linux, Windows, MacOSX)
Fast CPU based inference using ggml for GPT-J based models
The UI is made to look and feel like you've come to expect from a chatty gpt
Check for updates so you can alway stay fresh with latest models
Easy to install with precompiled binaries available for all three major desktop platforms
Multi-modal - Ability to load more than one model and switch between them
Supports both llama.cpp and gptj.cpp style models
Model downloader in GUI featuring many popular open source models
Settings dialog to change temp, top_p, top_k, threads, etc
Copy your conversation to clipboard
Check for updates to get the very latest GUI

Feature wishlist

Multi-chat - a list of current and past chats and the ability to save/delete/export and switch between
Text to speech - have the AI response with voice
Speech to text - give the prompt with your voice
Python bindings
Typescript bindings
Plugin support for langchain other developer tools
Save your prompt/responses to disk
Upload prompt/respones manually/automatically to nomic.ai to aid future training runs
Syntax highlighting support for programming languages, etc.
REST API with a built-in webserver in the chat gui itself with a headless operation mode as well
Advanced settings for changing temperature, topk, etc. (DONE)
YOUR IDEA HERE

Building and running

Install Qt 6.x for your platform https://doc.qt.io/qt-6/get-and-install-qt.html
Install cmake for your platform https://cmake.org/install/
Download https://huggingface.co/EleutherAI/gpt-j-6b
Clone this repo and build

git clone https://github.com/ggerganov/ggml.git
cd ggml
mkdir build
cd build
cmake ..
cmake --build . --parallel
python3 ../ggml/examples/gpt-j/convert-h5-to-ggml.py /path/to/your/local/copy/of/EleutherAI/gpt-j-6B 0
./bin/gpt-j-quantize /path/to/your/local/copy/of/EleutherAI/gpt-j-6B/ggml-model-f32.bin ./ggml-model-q4_0.bin 2

and then

git clone --recurse-submodules https://github.com/nomic-ai/gpt4all-chat
cd gpt4all-chat
mkdir build
cd build
cmake ..
cmake --build . --parallel
mv /path/to/ggml-model-q4_0.bin .
./chat

Building and running CLI tools only (no Qt required)

Install cmake for your platform https://cmake.org/install/
Clone this repo and build the ggml subfolder

git clone --recurse-submodules https://github.com/nomic-ai/gpt4all-chat
cd gpt4all-chat/ggml
mkdir build
cd build
cmake ..
cmake --build . --parallel
wget https://gpt4all.io/models/ggml-gpt4all-j-v1.2-jazzy.bin # Download GGML model if you don't already have it.
./bin/gpt-j -m ggml-gpt4all-j-v1.2-jazzy.bin -n 200 --top_k 40 --top_p 0.9 -b 9 --temp 0.9 -p "Below is an instruction that describes a task. Write a response that appropriately completes the request.
### Instruction:
Tell me about artifical intelligence
### Response:"

To get Qt installed for your system

Highly advise using the official Qt online open source installer.
You can obtain this by creating an account on qt.io and downloading the installer.
You should get latest Qt {Qt 6.5.x} for your system and the developer tools including QtCreator, cmake, ninja.
WINDOWS NOTE: you need to use the mingw64 toolchain and not msvc
ALL PLATFORMS NOTE: the installer has options for lots of different targets which will add a lot of download overhead. You can deselect webassembly target, android, sources, etc to save space on your disk.

Contributing

Pull requests welcome. See the feature wish list for ideas :)

License

The source code of this chat interface is currently under a MIT license. The underlying GPT4All-j model is released under non-restrictive open-source Apache 2 License.

The GPT4All-J license allows for users to use generated outputs as they see fit. Users take responsibility for ensuring their content meets applicable requirements for publication in a given context or region.