correct wrapper, typos; add links

Signed-off-by: LunarMarathon <lmaytan24@gmail.com>
pull/456/head
LunarMarathon 1 year ago
parent 92572ff919
commit b3f2827961

@ -38,7 +38,7 @@ When deploying your DocsGPT to a live environment, we're eager to provide person
You can find our [Roadmap](https://github.com/orgs/arc53/projects/2) here. Please don't hesitate to contribute or create issues, it helps us make DocsGPT better!
## Our Open-Source models optimised for DocsGPT:
## Our Open-Source models optimized for DocsGPT:
| Name | Base Model | Requirements (or similar) |
|-------------------|------------|----------------------------------------------------------|
@ -47,7 +47,7 @@ You can find our [Roadmap](https://github.com/orgs/arc53/projects/2) here. Pleas
| [Docsgpt-40b-falcon](https://huggingface.co/Arc53/docsgpt-40b-falcon) | falcon-40b | 8xA10G gpu's |
If you don't have enough resources to run it you can use bitsnbytes to quantize
If you don't have enough resources to run it you can use [bitsandbytes](https://github.com/TimDettmers/bitsandbytes) to quantize.
## Features

@ -10,7 +10,7 @@ It will install all the dependencies and give you an option to download the loca
Otherwise, refer to this Guide:
1. Open and download this repository with `git clone https://github.com/arc53/DocsGPT.git`.
2. Create a `.env` file in your root directory and set your `API_KEY` with your openai api key.
2. Create a `.env` file in your root directory and set your `API_KEY` with your [OpenAI api key](https://platform.openai.com/account/api-keys).
3. Run `docker-compose build && docker-compose up`.
4. Navigate to `http://localhost:5173/`.

@ -133,7 +133,7 @@ There are two types of responses:
```
### /api/delete_old
Deletes old vecotstores:
Deletes old vectorstores:
```js
// Task status (GET http://127.0.0.1:5000/api/docs_check)
fetch("http://localhost:5001/api/task_status?task_id=b2d2a0f4-387c-44fd-a443-e4fe2e7454d1", {

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

@ -35,7 +35,7 @@ It will tell you how much it will cost
Once you run it will use new context that is relevant to your documentation
Make sure you select default in the dropdown in the UI
## Customisation
## Customization
You can learn more about options while running ingest.py by running:
`python ingest.py --help`

Loading…
Cancel
Save