From 291692c680250aca8e424af065d2be232b12410b Mon Sep 17 00:00:00 2001 From: Ethan Date: Mon, 15 May 2023 16:10:13 -0700 Subject: [PATCH] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 3d07a6c..49bf387 100644 --- a/README.md +++ b/README.md @@ -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)