Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-19 21:25:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #637 from debghs/debghs-patch-1

Browse Source 
Update How-to-train-on-other-documentation.md
This commit is contained in:
Alex 2023-10-22 11:36:50 -04:00 committed by GitHub
commit 664ee2b433
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,28 +12,28 @@ It currently uses OPEN_AI to create the vector store, so make sure your document
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 ### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory
- Name it `inputs/` - Name it `inputs/`.
- Put all your .rst/.md files in there - Put all your .rst/.md files in there.
- The search is recursive, so you don't need to flatten them - The search is recursive, so you don't need to flatten them.
If there are no .rst/.md files just convert whatever you find to .txt and feed it. (don't forget to change the extension in script) If there are no .rst/.md files just convert whatever you find to .txt file and feed it. (don't forget to change the extension in script)
### 2. Create .env file in `scripts/` folder ### 2. Create .env file in `scripts/` folder
And write your OpenAI API key inside And write your OpenAI API key inside
`OPENAI_API_KEY=<your-api-key>` `OPENAI_API_KEY=<your-api-key>`.
### 3. Run scripts/ingest.py ### 3. Run scripts/ingest.py
`python ingest.py ingest` `python ingest.py ingest`
It will tell you how much it will cost It will tell you how much it will cost.
### 4. Move `index.faiss` and `index.pkl` generated in `scripts/output` to `application/` folder. ### 4. Move `index.faiss` and `index.pkl` generated in `scripts/output` to `application/` folder.
### 5. Run web app ### 5. Run web app
Once you run it will use new context that is relevant to your documentation 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 Make sure you select default in the dropdown in the UI.
## Customization ## Customization
You can learn more about options while running ingest.py by running: You can learn more about options while running ingest.py by running: