github/BriefGPT
1
1
Fork 0
mirror of https://github.com/e-johnstonn/BriefGPT.git synced 2026-01-09 13:57:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Ethan
2023-05-15 16:10:13 -07:00
committed by GitHub
parent 91d0976bf7
commit 291692c680
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -2,6 +2,11 @@
BriefGPT is a powerful, locally-run tool for document summarization and querying using OpenAI's models. You retain control over your documents and API keys, ensuring privacy and security.
## Update
Added support for fully local use! Instructor is used to embed documents, and the LLM can be either LlamaCpp or GPT4ALL, ggml formatted. Put your model in the 'models' folder, set up your environmental variables (model type and path), and run ```streamlit run local_app.py``` to get started. Tested with the following models: [Llama](https://huggingface.co/eachadea/ggml-vicuna-13b-1.1/blob/main/ggml-vic13b-q5_1.bin), [GPT4ALL](https://gpt4all.io/models/ggml-gpt4all-j-v1.3-groovy.bin).
Please note this is experimental - it will be significantly slower and the quality may vary. PR's welcome!
# Example (using the "Sparks of AGI" paper, sped up)
![chat](https://i.imgur.com/ipgvsgb.gif)