vector-graph-rag 0.1.2__tar.gz → 0.1.4__tar.gz

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vector-graph-rag
-Version: 0.1.2
+Version: 0.1.4
 Summary: A Graph RAG implementation using pure vector search with Milvus
 Project-URL: Homepage, https://github.com/zilliztech/vector-graph-rag
 Project-URL: Documentation, https://zilliztech.github.io/vector-graph-rag/
@@ -31,14 +31,14 @@ Requires-Dist: scipy>=1.10.0
 Requires-Dist: setuptools<71
 Requires-Dist: tenacity>=8.2.0
 Requires-Dist: tiktoken>=0.5.0
-Requires-Dist: torch>=2.0.0
 Requires-Dist: tqdm>=4.65.0
-Requires-Dist: transformers>=4.30.0
 Provides-Extra: all
 Requires-Dist: fastapi>=0.109.0; extra == 'all'
 Requires-Dist: pytest-asyncio>=0.21.0; extra == 'all'
 Requires-Dist: pytest>=7.0.0; extra == 'all'
 Requires-Dist: ruff>=0.1.0; extra == 'all'
+Requires-Dist: torch>=2.0.0; extra == 'all'
+Requires-Dist: transformers>=4.30.0; extra == 'all'
 Requires-Dist: uvicorn[standard]>=0.27.0; extra == 'all'
 Provides-Extra: api
 Requires-Dist: fastapi>=0.109.0; extra == 'api'
@@ -49,6 +49,9 @@ Requires-Dist: pytest>=7.0.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.0; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
+Provides-Extra: hf
+Requires-Dist: torch>=2.0.0; extra == 'hf'
+Requires-Dist: transformers>=4.30.0; extra == 'hf'
 Provides-Extra: loaders
 Requires-Dist: lxml-html-clean; extra == 'loaders'
 Requires-Dist: markitdown[docx,pdf]>=0.1.4; extra == 'loaders'
@@ -108,6 +111,17 @@ uv add "vector-graph-rag[loaders]"
 
 </details>
 
+<details>
+<summary><b>With local HuggingFace embedding models</b></summary>
+
+```bash
+pip install "vector-graph-rag[hf]"
+# or
+uv add "vector-graph-rag[hf]"
+```
+
+</details>
+
 ## 🚀 Quick Start
 
 ```python
@@ -238,30 +252,39 @@ Evaluated on three multi-hop QA benchmarks (Recall@5):
 
 ## 🗄️ Milvus Backend
 
-Vector Graph RAG supports three Milvus deployment modes — just change `milvus_uri`:
+Just change `milvus_uri` to switch between deployment modes:
 
-| Mode | `milvus_uri` | `milvus_token` | Best for |
-|------|-------------|----------------|----------|
-| **Milvus Lite** (default) | `./vector_graph_rag.db` | — | Personal use, dev — zero config |
-| **Milvus Server** | `http://localhost:19530` | Optional | Multi-dataset, team environments |
-| ⭐ **Zilliz Cloud** | `https://in03-xxx.api.gcp-us-west1.zillizcloud.com` | API key | Production, fully managed — [free tier available](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) |
+**Milvus Lite** (default) — zero config, single-process, data stored in a local file. Great for prototyping and small datasets:
 
-> **Recommended:** [Zilliz Cloud](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) gives you zero-config, zero-ops Milvus with concurrent access and real-time indexing — no Docker needed.
+```python
+rag = VectorGraphRAG(milvus_uri="./my_graph.db")  # just works
+```
+
+⭐ **Zilliz Cloud** — fully managed, [free tier available](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) — [sign up](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) 👇:
+
+```python
+rag = VectorGraphRAG(
+    milvus_uri="https://in03-xxx.api.gcp-us-west1.zillizcloud.com",
+    milvus_token="your-api-key",
+)
+```
 
 <details>
-<summary>Sign up for a free Zilliz Cloud cluster 👈</summary>
+<summary>⭐ Sign up for a free Zilliz Cloud cluster</summary>
 
 You can [sign up](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) on Zilliz Cloud to get a free cluster and API key.
 
 ![Sign up and get API key](https://raw.githubusercontent.com/zilliztech/CodeIndexer/master/assets/signup_and_get_apikey.png)
 
-Use your endpoint as `milvus_uri` and your API key as `milvus_token`:
+</details>
+
+<details>
+<summary>Self-hosted Milvus Server (Docker) — for advanced users</summary>
+
+If you need a dedicated Milvus instance for multi-user or team environments, you can deploy Milvus standalone with Docker Compose. This requires Docker and some infrastructure knowledge. See the [official installation guide](https://milvus.io/docs/install_standalone-docker-compose.md) for detailed steps.
 
 ```python
-rag = VectorGraphRAG(
-    milvus_uri="https://in03-xxx.api.gcp-us-west1.zillizcloud.com",
-    milvus_token="your-api-key",
-)
+rag = VectorGraphRAG(milvus_uri="http://localhost:19530")
 ```
 
 </details>
@@ -279,6 +302,10 @@ uv run uvicorn vector_graph_rag.api.app:app --host 0.0.0.0 --port 8000
 cd frontend && npm install && npm run dev
 ```
 
+<p align="center">
+  <img src="https://github.com/user-attachments/assets/8cc8e594-aed7-4ef5-8c3b-e5ff54275b64" alt="Frontend — interactive graph visualization with 4-step retrieval" width="800">
+</p>
+
 | Endpoint | Method | Description |
 |----------|--------|-------------|
 | `/api/health` | GET | Health check |

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/README.md

@@ -51,6 +51,17 @@ uv add "vector-graph-rag[loaders]"
 
 </details>
 
+<details>
+<summary><b>With local HuggingFace embedding models</b></summary>
+
+```bash
+pip install "vector-graph-rag[hf]"
+# or
+uv add "vector-graph-rag[hf]"
+```
+
+</details>
+
 ## 🚀 Quick Start
 
 ```python
@@ -181,30 +192,39 @@ Evaluated on three multi-hop QA benchmarks (Recall@5):
 
 ## 🗄️ Milvus Backend
 
-Vector Graph RAG supports three Milvus deployment modes — just change `milvus_uri`:
+Just change `milvus_uri` to switch between deployment modes:
 
-| Mode | `milvus_uri` | `milvus_token` | Best for |
-|------|-------------|----------------|----------|
-| **Milvus Lite** (default) | `./vector_graph_rag.db` | — | Personal use, dev — zero config |
-| **Milvus Server** | `http://localhost:19530` | Optional | Multi-dataset, team environments |
-| ⭐ **Zilliz Cloud** | `https://in03-xxx.api.gcp-us-west1.zillizcloud.com` | API key | Production, fully managed — [free tier available](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) |
+**Milvus Lite** (default) — zero config, single-process, data stored in a local file. Great for prototyping and small datasets:
 
-> **Recommended:** [Zilliz Cloud](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) gives you zero-config, zero-ops Milvus with concurrent access and real-time indexing — no Docker needed.
+```python
+rag = VectorGraphRAG(milvus_uri="./my_graph.db")  # just works
+```
+
+⭐ **Zilliz Cloud** — fully managed, [free tier available](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) — [sign up](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) 👇:
+
+```python
+rag = VectorGraphRAG(
+    milvus_uri="https://in03-xxx.api.gcp-us-west1.zillizcloud.com",
+    milvus_token="your-api-key",
+)
+```
 
 <details>
-<summary>Sign up for a free Zilliz Cloud cluster 👈</summary>
+<summary>⭐ Sign up for a free Zilliz Cloud cluster</summary>
 
 You can [sign up](https://cloud.zilliz.com/signup?utm_source=github&utm_medium=referral&utm_campaign=vector-graph-rag-readme) on Zilliz Cloud to get a free cluster and API key.
 
 ![Sign up and get API key](https://raw.githubusercontent.com/zilliztech/CodeIndexer/master/assets/signup_and_get_apikey.png)
 
-Use your endpoint as `milvus_uri` and your API key as `milvus_token`:
+</details>
+
+<details>
+<summary>Self-hosted Milvus Server (Docker) — for advanced users</summary>
+
+If you need a dedicated Milvus instance for multi-user or team environments, you can deploy Milvus standalone with Docker Compose. This requires Docker and some infrastructure knowledge. See the [official installation guide](https://milvus.io/docs/install_standalone-docker-compose.md) for detailed steps.
 
 ```python
-rag = VectorGraphRAG(
-    milvus_uri="https://in03-xxx.api.gcp-us-west1.zillizcloud.com",
-    milvus_token="your-api-key",
-)
+rag = VectorGraphRAG(milvus_uri="http://localhost:19530")
 ```
 
 </details>
@@ -222,6 +242,10 @@ uv run uvicorn vector_graph_rag.api.app:app --host 0.0.0.0 --port 8000
 cd frontend && npm install && npm run dev
 ```
 
+<p align="center">
+  <img src="https://github.com/user-attachments/assets/8cc8e594-aed7-4ef5-8c3b-e5ff54275b64" alt="Frontend — interactive graph visualization with 4-step retrieval" width="800">
+</p>
+
 | Endpoint | Method | Description |
 |----------|--------|-------------|
 | `/api/health` | GET | Health check |

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/docs/faq.md

@@ -70,7 +70,7 @@ Frequently asked questions about Vector Graph RAG — covering when to use it, c
     ```
 
 ??? note "Can I use my own embeddings?"
-    Vector Graph RAG uses OpenAI embedding models by default (`text-embedding-3-large`), but you can configure the embedding model via the `embedding_model` parameter. Any model accessible through the OpenAI-compatible API will work. If you are using a local or custom embedding endpoint, set the appropriate base URL and model name. The embedding dimensionality is detected automatically. Note that all entities, relations, and passages in a single graph must use the same embedding model — mixing models within one collection prefix is not supported.
+    Vector Graph RAG uses OpenAI embedding models by default (`text-embedding-3-large`), but you can configure the embedding model via the `embedding_model` parameter. Any model accessible through the OpenAI-compatible API will work. If you are using a local HuggingFace embedding model, install the optional dependencies with `pip install "vector-graph-rag[hf]"`. The embedding dimensionality is detected automatically. Note that all entities, relations, and passages in a single graph must use the same embedding model — mixing models within one collection prefix is not supported.
 
 ??? note "How do I deploy to production?"
     For production deployments, use a remote Milvus instance instead of Milvus Lite for better performance, scalability, and persistence. Run the FastAPI backend behind a reverse proxy (e.g., Nginx) with appropriate rate limiting and authentication. The frontend can be built as static files and served from any CDN or static file server.

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/docs/getting-started.md

@@ -20,6 +20,12 @@
     pip install "vector-graph-rag[loaders]"
     ```
 
+=== "With local embeddings"
+
+    ```bash
+    pip install "vector-graph-rag[hf]"
+    ```
+
 !!! note "Prerequisites"
     - Python 3.9+
     - An OpenAI API key (set `OPENAI_API_KEY` environment variable)

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/evaluation/README.md

@@ -74,7 +74,7 @@ These triplets were extracted using GPT-3.5-Turbo (1106) with HippoRAG's OpenIE
 
 1. Install dependencies:
 ```bash
-uv sync
+uv sync --extra hf
 ```
 
 2. Set environment variables:

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "vector-graph-rag"
-version = "0.1.2"
+version = "0.1.4"
 description = "A Graph RAG implementation using pure vector search with Milvus"
 readme = "README.md"
 license = { text = "MIT" }
@@ -32,8 +32,6 @@ dependencies = [
     "tqdm>=4.65.0",
     "tiktoken>=0.5.0",
     "tenacity>=8.2.0",
-    "transformers>=4.30.0",
-    "torch>=2.0.0",
     "langchain-core>=0.3.0",
     "python-multipart>=0.0.22",
     "setuptools<71",  # Required for pkg_resources used by milvus-lite
@@ -49,8 +47,12 @@ api = [
     "fastapi>=0.109.0",
     "uvicorn[standard]>=0.27.0",
 ]
+hf = [
+    "transformers>=4.30.0",
+    "torch>=2.0.0",
+]
 all = [
-    "vector-graph-rag[dev,api]",
+    "vector-graph-rag[dev,api,hf]",
 ]
 loaders = [
     "markitdown[docx,pdf]>=0.1.4",

{vector_graph_rag-0.1.2 → vector_graph_rag-0.1.4}/src/vector_graph_rag/__init__.py

@@ -6,19 +6,19 @@ using only vector similarity search, without requiring a separate graph database
 """
 
 from vector_graph_rag.config import Settings
-from vector_graph_rag.models import Document, Triplet, Entity, Relation, Passage
-from vector_graph_rag.llm.extractor import TripletExtractor
-from vector_graph_rag.storage.embeddings import EmbeddingModel
-from vector_graph_rag.storage.milvus import MilvusStore
 from vector_graph_rag.graph.builder import GraphBuilder
-from vector_graph_rag.graph.retriever import GraphRetriever
-from vector_graph_rag.graph.knowledge_graph import SubGraph
 from vector_graph_rag.graph.graph import Graph
+from vector_graph_rag.graph.knowledge_graph import SubGraph
+from vector_graph_rag.graph.retriever import GraphRetriever
+from vector_graph_rag.llm.cache import LLMCache, get_llm_cache
+from vector_graph_rag.llm.extractor import TripletExtractor
 from vector_graph_rag.llm.reranker import LLMReranker
+from vector_graph_rag.models import Document, Entity, Passage, Relation, Triplet
 from vector_graph_rag.rag import VectorGraphRAG, create_rag
-from vector_graph_rag.llm.cache import LLMCache, get_llm_cache
+from vector_graph_rag.storage.embeddings import EmbeddingModel
+from vector_graph_rag.storage.milvus import MilvusStore
 
-__version__ = "0.1.2"
+__version__ = "0.1.4"
 
 __all__ = [
     "Settings",