Public/kotaemon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README for GraphRAG instructions #none

Browse Source
This commit is contained in:
Tadashi 2024-10-14 21:46:30 +07:00
parent 8188760f32
commit 710e3cce59
No known key found for this signature in database
GPG Key ID: 399380A00CC9028D
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -175,6 +175,13 @@ Default username / password are: `admin` / `admin`. You can setup additional use
- Check the Resources tab and LLMs and Embeddings and ensure that your `api_key` value is set correctly from your `.env`. file. If it is not set, you can set it here. - Check the Resources tab and LLMs and Embeddings and ensure that your `api_key` value is set correctly from your `.env`. file. If it is not set, you can set it here.
## Setup GraphRAG
<small>NOTE: Currently GraphRAG feature only works with OpenAI or Ollama API.</small>
- To use GraphRAG retriever feature, make sure to set `GRAPHRAG_API_KEY` environment variables (or in the `.env` file).
- To use GraphRAG with local models (Ollama), set `USE_CUSTOMIZED_GRAPHRAG_SETTING=true` and tweak your settings in `kotaemon/settings.yaml.example`.
## Setup local models (for local / private RAG) ## Setup local models (for local / private RAG)
See [Local model setup](docs/local_model.md). See [Local model setup](docs/local_model.md).