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-15 08:33:30 +07:00
parent 710e3cce59
commit 41966fcd5b
No known key found for this signature in database
GPG Key ID: 399380A00CC9028D
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -177,10 +177,12 @@ Default username / password are: `admin` / `admin`. You can setup additional use
## Setup GraphRAG
<small>NOTE: Currently GraphRAG feature only works with OpenAI or Ollama API.</small>
> [!NOTE]
> Currently GraphRAG feature only works with OpenAI or Ollama API.
- [*If you are not using Docker installation*], install GraphRAG with `pip install graphrag future`
- 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`.
- To use GraphRAG with local models (Ollama), set `USE_CUSTOMIZED_GRAPHRAG_SETTING=true` and tweak your settings in `settings.yaml.example`.
## Setup local models (for local / private RAG)