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

Merge branch 'main' of https://github.com/arc53/docsgpt

Browse Source
This commit is contained in:
Alex
2023-02-03 21:47:04 +00:00
parent dbc0964588 b35bab7909
commit 94b7887aad
1 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -4,13 +4,28 @@
The aim of DocsGPT is to utilize the GPT engine to answer questions about the documentation of any project, making it easier for developers to find the information they need .
## Project structure
application - flask app (main application)
extensions - chrome extension
scripts - script that creates similarity search index and store for other libraries
## QuickStart
Please note: current vector database uses pandas Python documentation, thus responses will be related to it, if you want to use other docs please follow a guide below
1. Navigate to `/application` folder
2. Install dependencies
`pip install -r requirements.txt`
3. Prepare .env file
Copy .env_sample and create .env with your openai api token
4. Run the app
`python app.py`
## Join our community here [Discord](https://discord.gg/guzNA6DSBk)
## [Guides](https://github.com/arc53/docsgpt/wiki)
## [Discord](https://discord.gg/guzNA6DSBk)
## [How to use any other documentation](https://github.com/arc53/docsgpt/wiki/How-to-train-on-other-documentation)
Join our community here [Discord](https://discord.gg/guzNA6DSBk)
## Guides
## How to use any other documentation
Built with [🦜️🔗 LangChain](https://github.com/hwchase17/langchain)