diff --git a/README.md b/README.md index af039a35..aa3696ef 100644 --- a/README.md +++ b/README.md @@ -42,69 +42,52 @@ 🦜️🔗 Official Langchain Backend
- - -GPT4All is made possible by our compute partner Paperspace.
- ++ +
++Run on an M1 Mac (not sped up!) +
## GPT4All: An ecosystem of open-source on-edge large language models. -![gpt4all-j-demo](https://user-images.githubusercontent.com/13879686/231876409-e3de1934-93bb-4b4b-9013-b491a969ebbc.gif) +GTP4All is an ecosystem to train and deploy **powerful** and **customized** large language models that run locally on consumer grade CPUs. -Run on an M1 Mac (not sped up!) +The goal is simple - be the best instruction tuned assistant-style language model that any person or enterprise can freely use, distribute and build on. - -## Contributing -GPT4All welcomes contribution, involvment, and discussion from the open source community! -Please see CONTRIBUTING.md and follow the issue, bug report, and PR markdown templates. - -Check project discord, with project owners, or through existing issues/PRs to avoid duplicate work. -Please make sure to tag all of the above with relevant project identifiers or your contribution could potentially get lost. -Example tags: `backend`, `bindings`, `python-bindings`, `documentation`, etc. - +A GPT4All model is a 3GB - 8GB file that you can download and plug into the GPT4All open-source ecosystem software. **Nomic AI** supports and maintains this software ecosystem to enforce quality and security alongside spearheading the effort to allow any person or enterprise to easily train and deploy their own on-edge large language models. ### Chat Client -Run any GPT4All model natively on your home desktop with the auto-updating desktop chat client. See website for exaustive list of models. - - +Run any GPT4All model natively on your home desktop with the auto-updating desktop chat client. See GPT4All Website for a full list of open-source models you can run with this powerful desktop application. Direct Installer Links: -[Mac/OSX](https://gpt4all.io/installers/gpt4all-installer-darwin.dmg) +* [Mac/OSX](https://gpt4all.io/installers/gpt4all-installer-darwin.dmg) -[Windows](https://gpt4all.io/installers/gpt4all-installer-win64.exe) +* [Windows](https://gpt4all.io/installers/gpt4all-installer-win64.exe) -[Ubuntu](https://gpt4all.io/installers/gpt4all-installer-linux.run) +* [Ubuntu](https://gpt4all.io/installers/gpt4all-installer-linux.run) If you have older hardware that only supports avx and not avx2 you can use these. -[Mac/OSX - avx-only](https://gpt4all.io/installers/gpt4all-installer-darwin-avx-only.dmg) +* [Mac/OSX - avx-only](https://gpt4all.io/installers/gpt4all-installer-darwin-avx-only.dmg) -[Windows - avx-only](https://gpt4all.io/installers/gpt4all-installer-win64-avx-only.exe) +* [Windows - avx-only](https://gpt4all.io/installers/gpt4all-installer-win64-avx-only.exe) -[Ubuntu - avx-only](https://gpt4all.io/installers/gpt4all-installer-linux-avx-only.run) +* [Ubuntu - avx-only](https://gpt4all.io/installers/gpt4all-installer-linux-avx-only.run) Find the most up-to-date information on the [GPT4All Website](https://gpt4all.io/) -### Python Bindings +### Bindings -```bash -pip install gpt4all -``` +* :snake: Official Python Bindings +* :computer: Official Typescript Bindings -```python -import gpt4all -gptj = gpt4all.GPT4All("ggml-gpt4all-j-v1.3-groovy") -messages = [{"role": "user", "content": "Name 3 colors"}] -gptj.chat_completion(messages) -``` ## Training GPT4All-J @@ -139,7 +122,16 @@ model = AutoModelForCausalLM.from_pretrained("nomic-ai/gpt4all-j-prompt-generati ```bash accelerate launch --dynamo_backend=inductor --num_processes=8 --num_machines=1 --machine_rank=0 --deepspeed_multinode_launcher standard --mixed_precision=bf16 --use_deepspeed --deepspeed_config_file=configs/deepspeed/ds_config_gptj.json train.py --config configs/train/finetune_gptj.yaml ``` - + +## Contributing +GPT4All welcomes contribution, involvment, and discussion from the open source community! +Please see CONTRIBUTING.md and follow the issue, bug report, and PR markdown templates. + +Check project discord, with project owners, or through existing issues/PRs to avoid duplicate work. +Please make sure to tag all of the above with relevant project identifiers or your contribution could potentially get lost. +Example tags: `backend`, `bindings`, `python-bindings`, `documentation`, etc. + + ## Citation If you utilize this repository, models or data in a downstream project, please consider citing it with: