docs: add naive rag

gusye1234 · Sep 5, 2024 · e041b3d · e041b3d
1 parent 4d0ae78
commit e041b3d
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/ROADMAP.md b/ROADMAP.md
@@ -1,7 +1,7 @@
 ## Next Version TODO
 
 - [ ] Add `eval` method for `GraphRAG`, add at least one benchmark dataset
-- [ ] Add `before_query`, `before_insert` to separate component loadings.
+- [x] Add naive RAG pipeline
 
 ## Interesting directions
 

diff --git a/readme.md b/readme.md
@@ -103,6 +103,23 @@ with open("./book.txt") as f:
 
 </details>
 
+<details>
+<summary> Naive RAG</summary>
+
+`nano-graphrag` supports naive RAG insert and query as well:
+
+```python
+graph_func = GraphRAG(working_dir="./dickens", enable_naive_rag=True)
+...
+# Query
+print(rag.query(
+      "What are the top themes in this story?",
+      param=QueryParam(mode="naive")
+)
+```
+</details>
+
+
 ### Async
 
 For each method `NAME(...)` , there is a corresponding async method `aNAME(...)`