LLM/DocsGPT
1
0
Fork 0
mirror of https://github.com/arc53/DocsGPT.git synced 2025-11-29 08:33:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revert some files

Browse Source
This commit is contained in:
arpitpandey0209
2023-11-01 09:51:09 +05:30
parent cbfdaec394
commit 715cd9daf5
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -23,20 +23,22 @@ Say goodbye to time-consuming manual searches, and let <strong><a href="https://
</div> </div>
### Production Support / Help for Companies: ### Production Support / Help for companies:
We're eager to provide personalized assistance when deploying your DocsGPT to a live environment. We're eager to provide personalized assistance when deploying your DocsGPT to a live environment.
- [Book Demo :wave:](https://airtable.com/appdeaL0F1qV8Bl2C/shrrJF1Ll7btCJRbP) - [Book Demo :wave:](https://airtable.com/appdeaL0F1qV8Bl2C/shrrJF1Ll7btCJRbP)
- [Send Email :email:](mailto:contact@arc53.com?subject=DocsGPT%20support%2Fsolutions) - [Send Email :email:](mailto:contact@arc53.com?subject=DocsGPT%20support%2Fsolutions)
### [:tada: Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! :tada:](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md)
![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif) ![video-example-of-docs-gpt](https://d3dg1063dc54p9.cloudfront.net/videos/demov3.gif)
## Roadmap ## Roadmap
You can find our roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT! You can find our roadmap [here](https://github.com/orgs/arc53/projects/2). Please don't hesitate to contribute or create issues, it helps us improve DocsGPT!
## Our Open-Source Models Optimized for DocsGPT: ## Our Open-Source models optimized for DocsGPT:
| Name | Base Model | Requirements (or similar) | | Name | Base Model | Requirements (or similar) |
| --------------------------------------------------------------------- | ----------- | ------------------------- | | --------------------------------------------------------------------- | ----------- | ------------------------- |
@@ -50,7 +52,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
![Main features of DocsGPT showcasing six main features](https://user-images.githubusercontent.com/17906039/220427472-2644cff4-7666-46a5-819f-fc4a521f63c7.png) ![Main features of DocsGPT showcasing six main features](https://user-images.githubusercontent.com/17906039/220427472-2644cff4-7666-46a5-819f-fc4a521f63c7.png)
## Useful Links ## Useful links
- :mag: :fire: [Live preview](https://docsgpt.arc53.com/) - :mag: :fire: [Live preview](https://docsgpt.arc53.com/)
@@ -64,7 +66,7 @@ If you don't have enough resources to run it, you can use bitsnbytes to quantize
- :house: :closed_lock_with_key: [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM) - :house: :closed_lock_with_key: [How to host it locally (so all data will stay on-premises)](https://docs.docsgpt.co.uk/Guides/How-to-use-different-LLM)
## Project Structure ## Project structure
- Application - Flask app (main application). - Application - Flask app (main application).
@@ -102,9 +104,9 @@ Otherwise, refer to this Guide:
To stop, just run `Ctrl + C`. To stop, just run `Ctrl + C`.
## Development Environments ## Development environments
### Spin up Mongo and Redis ### Spin up mongo and redis
For development, only two containers are used from [docker-compose.yaml](https://github.com/arc53/DocsGPT/blob/main/docker-compose.yaml) (by deleting all services except for Redis and Mongo). For development, only two containers are used from [docker-compose.yaml](https://github.com/arc53/DocsGPT/blob/main/docker-compose.yaml) (by deleting all services except for Redis and Mongo).
See file [docker-compose-dev.yaml](./docker-compose-dev.yaml). See file [docker-compose-dev.yaml](./docker-compose-dev.yaml).
@@ -116,7 +118,7 @@ docker compose -f docker-compose-dev.yaml build
docker compose -f docker-compose-dev.yaml up -d docker compose -f docker-compose-dev.yaml up -d
``` ```
### Run the Backend ### Run the backend
Make sure you have Python 3.10 or 3.11 installed. Make sure you have Python 3.10 or 3.11 installed.
@@ -151,7 +153,7 @@ pip install -r requirements.txt
4. Run the app using `flask --app application/app.py run --host=0.0.0.0 --port=7091`. 4. Run the app using `flask --app application/app.py run --host=0.0.0.0 --port=7091`.
5. Start worker with `celery -A application.app.celery worker -l INFO`. 5. Start worker with `celery -A application.app.celery worker -l INFO`.
### Start Frontend ### Start frontend
Make sure you have Node version 16 or higher. Make sure you have Node version 16 or higher.