Skip to content

Commit

Permalink
Update How-to-train-on-other-documentation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
debghs authored Oct 18, 2023
1 parent 49a4b11 commit f0d4847
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions docs/pages/Guides/How-to-train-on-other-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

### 1. Find documentation in .rst/.md and create a folder with it in your scripts directory
- Name it `inputs/`
- Put all your .rst/.md files in there
- The search is recursive, so you don't need to flatten them
- Name it `inputs/`.
- Put all your .rst/.md files in there.
- 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
And write your OpenAI API key inside
`OPENAI_API_KEY=<your-api-key>`
`OPENAI_API_KEY=<your-api-key>`.

### 3. Run scripts/ingest.py

`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.


### 5. Run web app
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
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.

## Customization
You can learn more about options while running ingest.py by running:
Expand Down

0 comments on commit f0d4847

Please sign in to comment.