diff --git a/README.md b/README.md index e3b8fae..4a598c9 100755 --- a/README.md +++ b/README.md @@ -107,17 +107,6 @@ This demo showcases how to build a RAG system for PDF documents using Leann. uv run examples/main_cli_example.py ``` -### Regenerating Protobuf Files - -If you modify any `.proto` files (such as `embedding.proto`), or if you see errors about protobuf version mismatch, **regenerate the C++ protobuf files** to match your installed version: - -```bash -cd packages/leann-backend-diskann -protoc --cpp_out=third_party/DiskANN/include --proto_path=third_party embedding.proto -protoc --cpp_out=third_party/DiskANN/src --proto_path=third_party embedding.proto -``` - -This ensures the generated files are compatible with your system's protobuf library. ## ✨ Features @@ -368,18 +357,10 @@ The script will print the recall and search time for each query, followed by the ## πŸ—οΈ Architecture -``` -β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” -β”‚ Query Text │───▢│ Embedding │───▢│ Graph-based β”‚ -β”‚ β”‚ β”‚ Computation β”‚ β”‚ Search β”‚ -β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ - β”‚ β”‚ - β–Ό β–Ό - β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” - β”‚ ZMQ Server β”‚ β”‚ Pruned Graph β”‚ - β”‚ (Cached) β”‚ β”‚ Index β”‚ - β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ -``` +

+ LEANN Architecture +

+ ### Key Components diff --git a/asset/arch.png b/asset/arch.png new file mode 100644 index 0000000..5abc7d4 Binary files /dev/null and b/asset/arch.png differ