Skip to content

Commit b86ac6f

Browse files
committed
docs(README): update development status and architecture description
- remove "Not recommended for production yet" from early development warning - add detailed explanation of hybrid algorithm + LLM approach - clarify how Vectorless navigates document structure differently - remove unnecessary separator line before Architecture section
1 parent f33b0de commit b86ac6f

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,16 @@
1010

1111
</div>
1212

13-
> ⚠️ **Early Development** — API may change. Not recommended for production yet.
13+
> ⚠️ **Early Development** — API may change.
1414
1515
## What is Vectorless?
1616

17-
**Vectorless** is a Rust library for querying structured documents using natural language — without vector databases or embedding models.
17+
**Vectorless** is a Rust library for querying structured documents using natural language — without vector databases or embedding models.
1818

19-
Instead of chunking documents into vectors, Vectorless preserves the document's tree structure and uses an LLM to navigate it — like how a human reads a table of contents.
19+
Instead of chunking documents into vectors, Vectorless preserves the document's tree structure and uses a **hybrid algorithm + LLM approach** to navigate it — like how a human reads a table of contents:
20+
21+
- **Algorithm** handles "how to walk" — BM25 scoring, tree traversal (fast, deterministic)
22+
- **Pilot (LLM)** handles "where to go" — semantic understanding, ambiguity resolution
2023

2124
**Analogy:** Traditional RAG is like searching every word in a book. Vectorless is like reading the table of contents, then going to the right chapter.
2225

@@ -139,7 +142,6 @@ async fn main() -> vectorless::Result<()> {
139142
| **Feedback Learning** | Improves from user feedback over time |
140143
| **Multi-turn Queries** | Handles complex questions with decomposition |
141144

142-
---
143145

144146
## Architecture
145147

0 commit comments

Comments
 (0)