refactor: moving files

gusye1234 · Sep 6, 2024 · 92b17cc · 92b17cc
1 parent b985264
commit 92b17cc
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 4 deletions.
diff --git a/FAQ.md → docs/FAQ.md b/FAQ.md → docs/FAQ.md
diff --git a/ROADMAP.md → docs/ROADMAP.md b/ROADMAP.md → docs/ROADMAP.md
diff --git a/benchmark-en.md → docs/benchmark-en.md b/benchmark-en.md → docs/benchmark-en.md
diff --git a/benchmark-zh.md → docs/benchmark-zh.md b/benchmark-zh.md → docs/benchmark-zh.md
diff --git a/examples/visualize.py → examples/graphml_visualize.py b/examples/visualize.py → examples/graphml_visualize.py
diff --git a/readme.md b/readme.md
@@ -154,6 +154,8 @@ Below are the components you can use:
 | Vector DataBase | [`nano-vectordb`](https://github.com/gusye1234/nano-vectordb) |             Built-in             |
 |                 |        [`hnswlib`](https://github.com/nmslib/hnswlib)        | Built-in, [examples](./examples) |
 |                 |  [`milvus-lite`](https://github.com/milvus-io/milvus-lite)   |      [examples](./examples)      |
+|                 | [faiss](https://github.com/facebookresearch/faiss?tab=readme-ov-file) |      [examples](./examples)      |
+| Visualization   |                           graphml                            |      [examples](./examples)      |
 
 - `Built-in` means we have that implementation inside `nano-graphrag`. `examples` means we have that implementation inside an tutorial under [examples](./examples) folder.
 
@@ -312,21 +314,21 @@ You can refer to `nano_graphrag.base` to see detailed interfaces for each compon
 
 ## FQA
 
-Check [FQA](./FAQ.md).
+Check [FQA](./docs/FAQ.md).
 
 
 
 ## Roadmap
 
-See [ROADMAP.md](./ROADMAP.md)
+See [ROADMAP.md](./docs/ROADMAP.md)
 
 
 
 
 ## Benchmark
 
-- [benchmark for English](./benchmark-en.md)
-- [benchmark for Chinese](./benchmark-zh.md)
+- [benchmark for English](./docs/benchmark-en.md)
+- [benchmark for Chinese](./docs/benchmark-zh.md)