gpt4all/README.md

63 lines
2.7 KiB
Markdown
Raw Normal View History

2023-04-09 03:28:39 +00:00
# gpt4all-chat
2023-04-09 03:46:23 +00:00
Cross platform Qt based GUI for GPT4All versions with GPT-J as the base
2023-04-09 05:37:12 +00:00
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
2023-04-12 12:59:50 +00:00
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.
2023-04-09 03:46:23 +00:00
2023-04-12 12:56:30 +00:00
![image](https://user-images.githubusercontent.com/50458173/231464085-da9edff6-a593-410e-8f38-7513f75c8aab.png)
2023-04-09 03:46:23 +00:00
## Features
2023-04-12 12:59:50 +00:00
* Cross-platform (Linux, Windows, MacOSX)
2023-04-09 03:46:23 +00:00
* 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
2023-04-13 11:14:23 +00:00
* Check for updates so you can alway stay fresh with latest models
2023-04-13 11:12:48 +00:00
* Easy to install with precompiled binaries available for all three major desktop platforms
## 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
* Multi-modal - Ability to load more than one model and switch between them
* 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
2023-04-13 21:37:18 +00:00
* Syntax highlighting support for programming languages, etc.
2023-04-13 22:57:33 +00:00
* REST API with a built-in webserver in the chat gui itself with a headless operation mode as well
2023-04-16 15:53:02 +00:00
* Advanced settings for changing temperature, topk, etc. (DONE)
2023-04-13 11:12:48 +00:00
* YOUR IDEA HERE
2023-04-09 03:46:23 +00:00
2023-04-09 04:01:42 +00:00
## Building and running
2023-04-09 03:53:24 +00:00
* 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/
2023-04-09 04:01:42 +00:00
* Download https://huggingface.co/EleutherAI/gpt-j-6b
2023-04-09 03:54:25 +00:00
* Clone this repo and build
```
git clone --recurse-submodules https://github.com/manyoso/gpt4all-chat.git
cd gpt4all-chat
mkdir build
cd build
cmake ..
cmake --build . --parallel
2023-04-09 04:01:42 +00:00
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
./chat
2023-04-09 03:54:25 +00:00
```
2023-04-09 03:53:24 +00:00
2023-04-09 03:46:23 +00:00
## Contributing
2023-04-13 11:12:48 +00:00
* Pull requests welcome. See the feature wish list for ideas :)
2023-04-09 03:53:24 +00:00
2023-04-13 16:17:58 +00:00
## License
2023-04-13 16:18:56 +00:00
The source code of this chat interface is currently under a GPL license. The underlying GPT4All-j model is released under non-restrictive open-source Apache 2 License.
2023-04-14 13:17:02 +00:00
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.