From 41966fcd5b8badc04e0d0e2981c1b8542d41a824 Mon Sep 17 00:00:00 2001 From: Tadashi Date: Tue, 15 Oct 2024 08:33:30 +0700 Subject: [PATCH] docs: update README for GraphRAG instructions #none --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e15bcea..bc3df84 100644 --- a/README.md +++ b/README.md @@ -177,10 +177,12 @@ Default username / password are: `admin` / `admin`. You can setup additional use ## Setup GraphRAG -NOTE: Currently GraphRAG feature only works with OpenAI or Ollama API. +> [!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)