LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2026-04-28 13:00:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doc formatting and fix some spelling.

Browse Source
This commit is contained in:
Roman Zhukov
2023-10-05 20:27:48 +03:00
parent d13e5e7e3f
commit d37885ea88
8 changed files with 68 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/pages/Guides/Customising-prompts.md
View File

@@ -1,4 +1,4 @@
## To customise a main prompt navigate to `/application/prompt/combine_prompt.txt`
You can try editing it to see how the model responds.
You can try editing it to see how the model responses.

7
docs/pages/Guides/How-to-train-on-other-documentation.md
View File

@@ -3,14 +3,13 @@ This AI can use any documentation, but first it needs to be prepared for similar
![video-example-of-how-to-do-it](https://d3dg1063dc54p9.cloudfront.net/videos/how-to-vectorise.gif)
Start by going to
`/scripts/` folder
Start by going to `/scripts/` folder.
If you open this file you will see that it uses RST files from the folder to create a `index.faiss` and `index.pkl`.
It currently uses OPEN_AI to create vector store, so make sure your documentation is not too big. Pandas cost me around 3-4$
It currently uses OPEN_AI to create vector store, so make sure your documentation is not too big. Pandas cost me around 3-4$.
You can usually find documentation on github in docs/ folder for most open-source projects.
You can usually find documentation on github in `docs/` folder for most open-source projects.
### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory
Name it `inputs/`

12
docs/pages/Guides/How-to-use-different-LLM.md
View File

@@ -1,10 +1,10 @@
Fortunately there are many providers for LLM's and some of them can even be ran locally
There are two models used in the app:
1. Embeddings
2. Text generation
1. Embeddings.
2. Text generation.
By default we use OpenAI's models but if you want to change it or even run it locally, its very simple!
By default, we use OpenAI's models but if you want to change it or even run it locally, it's very simple!
### Go to .env file or set environment variables:
@@ -18,7 +18,7 @@ By default we use OpenAI's models but if you want to change it or even run it lo
`VITE_API_STREAMING=<true or false (true if using openai, false for all others)>`
You dont need to provide keys if you are happy with users providing theirs, so make sure you set LLM_NAME and EMBEDDINGS_NAME
You don't need to provide keys if you are happy with users providing theirs, so make sure you set `LLM_NAME` and `EMBEDDINGS_NAME`.
Options:
LLM_NAME (openai, manifest, cohere, Arc53/docsgpt-14b, Arc53/docsgpt-7b-falcon)
@@ -27,6 +27,6 @@ EMBEDDINGS_NAME (openai_text-embedding-ada-002, huggingface_sentence-transformer
That's it!
### Hosting everything locally and privately (for using our optimised open-source models)
If you are working with important data and dont want anything to leave your premises.
If you are working with important data and don't want anything to leave your premises.
Make sure you set SELF_HOSTED_MODEL as true in you .env variable and for your LLM_NAME you can use anything that's on Hugging Face
Make sure you set `SELF_HOSTED_MODEL` as true in you `.env` variable and for your `LLM_NAME` you can use anything that's on Hugging Face.