Skip to content

Commit

Permalink
Merge branch 'PromtEngineer:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Allaye authored Jun 2, 2023
2 parents 2115ee2 + 9dbc489 commit ae14457
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# localGPT

This project was inspired by the original privateGPT (https://github.com/imartinez/privateGPT). Most of the description here is inspired by the original privateGPT.
This project was inspired by the original [privateGPT] (https://github.com/imartinez/privateGPT). Most of the description here is inspired by the original privateGPT.

In this model, I have replaced the GPT4ALL model with Vicuna-7B model and we are using the InstructorEmbeddings instead of LlamaEmbeddings as used in the original privateGPT. Both Embeddings as well as LLM will run on GPU instead of CPU. It also has CPU support if you do not have a GPU (see below for instruction).

Expand Down Expand Up @@ -34,7 +34,9 @@ It will create an index containing the local vectorstore. Will take time, depend
You can ingest as many documents as you want, and all will be accumulated in the local embeddings database.
If you want to start from an empty database, delete the `index`.

Note: When you run this for the first time, it will download take time as it has to download the embedding model. In the subseqeunt runs, no data will leave your local enviroment and can be run without internet connection.
Note: When you run this for the first time, it will take time as it has to download the embedding model. In the subsequent runs, no data will leave your local enviroment and can be run without internet connection.

Pretrained models are downloaded and locally cached at: ```~/.cache/huggingface/hub```. This is the default directory given by the shell environment variable TRANSFORMERS_CACHE. On Windows, the default directory is given by ```C:\Users\username\.cache\huggingface\hub```. You can change the shell environment variable to specify a different cache directory. You can find more informations about it on the [Huggingface tranformers installation](https://huggingface.co/docs/transformers/installation#cache-setup) page.

## Ask questions to your documents, locally!
In order to ask a question, run a command like:
Expand Down

0 comments on commit ae14457

Please sign in to comment.