pytreesearch 0.1.0__tar.gz

pytreesearch-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pytreesearch-0.1.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: pytreesearch
+Version: 0.1.0
+Summary: Structure-aware document retrieval without embeddings.
+Author-email: XuMing <xuming624@qq.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/shibing624/TreeSearch
+Project-URL: Repository, https://github.com/shibing624/TreeSearch
+Project-URL: Issues, https://github.com/shibing624/TreeSearch/issues
+Keywords: rag,retrieval,tree-search,best-first,mcts,llm,bm25,document-indexing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Text Processing :: Indexing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai>=1.0
+Requires-Dist: tiktoken>=0.5
+Requires-Dist: python-dotenv>=1.0
+Provides-Extra: cn
+Requires-Dist: jieba>=0.42; extra == "cn"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: jieba>=0.42; extra == "dev"
+Dynamic: license-file
+
+# TreeSearch
+
+**Structure-aware document retrieval without embeddings.**
+
+No vector embeddings. No chunk splitting. BM25 + LLM reasoning over document tree structures.
+
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](https://github.com/shibing624/TreeSearch/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/treesearch.svg)](https://pypi.org/project/treesearch/)
+
+## Why TreeSearch?
+
+Traditional RAG systems split documents into fixed-size chunks and retrieve by vector similarity. This **destroys document structure**, loses heading hierarchy, and misses reasoning-dependent queries.
+
+TreeSearch takes a fundamentally different approach — parse documents into **tree structures** based on their natural heading hierarchy, then use **BM25 + LLM reasoning** to navigate the tree and find the most relevant sections.
+
+| | Traditional RAG | TreeSearch |
+|---|---|---|
+| **Preprocessing** | Chunk splitting + embedding | Parse headings → build tree |
+| **Retrieval** | Vector similarity search | BM25 pre-scoring + LLM tree search |
+| **Multi-doc** | Needs vector DB for routing | LLM routes by document descriptions |
+| **Structure** | Lost after chunking | Fully preserved as tree hierarchy |
+| **Dependencies** | Vector DB + embedding model | LLM only (no embedding, no vector DB) |
+| **Zero-cost baseline** | N/A | BM25-only search (no LLM needed) |
+
+### Key Advantages
+
+- **No vector embeddings** — No embedding model to train, deploy, or pay for
+- **No chunk splitting** — Documents retain their natural heading structure
+- **No vector DB** — No Pinecone, Milvus, or Chroma to manage
+- **Tree-aware retrieval** — Heading hierarchy guides search, not arbitrary chunk boundaries
+- **BM25 zero-cost baseline** — Instant keyword search with no API calls, useful as standalone or pre-filter
+- **Budget-controlled LLM calls** — Set max LLM calls per query, with early stopping when confidence is high
+
+## Features
+
+- **Three-layer search** — BM25 pre-scoring → Best-First tree search → LLM relevance evaluation
+- **Tree-structured indexing** — Markdown and plain text documents are parsed into hierarchical trees
+- **BM25 node-level index** — Structure-aware scoring with hierarchical field weighting (title > summary > body) and ancestor propagation
+- **Best-First search** (default) — Priority queue driven, deterministic, with early stopping and budget control
+- **MCTS search** — Monte Carlo Tree Search with LLM as value function
+- **LLM single-pass** — One LLM call per document for minimal cost
+- **Multi-document search** — Route queries across document collections via LLM reasoning
+- **Chinese + English** — jieba tokenization for Chinese, regex for English (jieba is optional)
+- **Batch indexing** — `build_index()` supports glob patterns for concurrent multi-file processing
+- **Evaluation metrics** — Built-in Precision@K, Recall@K, MRR, NDCG@K, Hit@K, F1@K
+- **Async-first** — All core functions are async with sync wrappers available
+- **CLI included** — `treesearch index` and `treesearch search` commands
+
+## Installation
+
+```bash
+pip install treesearch
+```
+
+With Chinese support:
+```bash
+pip install "treesearch[cn]"
+```
+
+From source:
+
+```bash
+git clone https://github.com/shibing624/TreeSearch.git
+cd TreeSearch
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### 1. Set up API key
+
+```bash
+export OPENAI_API_KEY="sk-..."
+# Optional: custom endpoint
+export OPENAI_BASE_URL="https://your-endpoint/v1"
+```
+
+### 2. Build index and search
+
+```python
+import asyncio
+from treesearch import build_index, load_index, Document, search
+
+async def main():
+    # Build indexes for multiple files (supports glob patterns)
+    await build_index(
+        paths=["docs/*.md"],
+        output_dir="./indexes",
+        if_add_doc_description=True,
+    )
+
+    # Load indexed documents
+    import os
+    documents = []
+    for fp in sorted(os.listdir("./indexes")):
+        if not fp.endswith(".json"):
+            continue
+        data = load_index(os.path.join("./indexes", fp))
+        documents.append(Document(
+            doc_id=fp,
+            doc_name=data["doc_name"],
+            structure=data["structure"],
+            doc_description=data.get("doc_description", ""),
+        ))
+
+    # Search with Best-First strategy (default: BM25 + LLM)
+    result = await search(
+        query="How does the authentication system work?",
+        documents=documents,
+    )
+
+    for doc_result in result.documents:
+        for node in doc_result["nodes"]:
+            print(f"[{node['score']:.2f}] {node['title']}")
+            print(f"  {node.get('text', '')[:200]}")
+
+asyncio.run(main())
+```
+
+### 3. BM25 standalone (no LLM needed)
+
+```python
+from treesearch import NodeBM25Index, Document, load_index
+
+# Load documents
+data = load_index("indexes/my_doc.json")
+doc = Document(doc_id="doc1", doc_name=data["doc_name"], structure=data["structure"])
+
+# BM25 node-level search — instant results, no API key needed
+index = NodeBM25Index([doc])
+results = index.search("authentication config", top_k=5)
+for r in results:
+    print(f"[{r['bm25_score']:.4f}] {r['title']}")
+```
+
+### CLI Usage
+
+```bash
+# Build indexes from glob pattern
+treesearch index --paths "docs/*.md" --add-description
+
+# Build index from specific files
+treesearch index --paths doc1.md doc2.txt -o ./indexes
+
+# Search with Best-First (default, BM25 + LLM)
+treesearch search --index_dir ./indexes/ --query "How does auth work?"
+
+# Search with MCTS strategy
+treesearch search --index_dir ./indexes/ --query "deployment" --strategy mcts
+
+# Search without BM25 pre-scoring
+treesearch search --index_dir ./indexes/ --query "config" --no-bm25
+
+# Control LLM budget
+treesearch search --index_dir ./indexes/ --query "auth" --max-llm-calls 10
+```
+
+## How It Works
+
+```
+Input Documents (MD/TXT)
+        │
+        ▼
+   ┌──────────┐
+   │  Indexer  │  Parse headings → build tree → generate summaries
+   └────┬─────┘    (build_index supports glob for batch processing)
+        │  JSON index files
+        ▼
+   ┌──────────┐
+   │  search   │  BM25 pre-score → route to docs → tree search
+   └────┬─────┘
+        │  SearchResult
+        ▼
+  Ranked nodes with scores and text
+```
+
+**Layer 1 — BM25 Pre-Scoring**: `NodeBM25Index` scores all tree nodes using structure-aware BM25 with hierarchical field weighting (title > summary > body) and ancestor score propagation. Instant, no LLM needed.
+
+**Layer 2 — Best-First Tree Search**: `BestFirstTreeSearch` uses a priority queue to expand the most promising nodes. LLM evaluates each node's relevance (title + summary only). Early stopping when top score drops below threshold.
+
+**Layer 3 — Results**: Budget-controlled LLM calls with subtree caching for reuse across similar queries.
+
+### Search Strategies
+
+| Strategy | Description | LLM Calls | Best For |
+|----------|-------------|-----------|----------|
+| `best_first` (default) | BM25 pre-scoring + priority queue + LLM evaluation | Moderate (budget-controlled) | General-purpose, best accuracy |
+| `mcts` | Monte Carlo Tree Search with LLM as value function | High | Complex reasoning queries |
+| `llm` | Single LLM call per document | Minimal | Low-cost, simple queries |
+| BM25-only | `NodeBM25Index.search()` standalone | Zero | Instant keyword search, no API key |
+
+## Examples
+
+| Example | Description |
+|---------|-------------|
+| [`01_index_and_search.py`](examples/01_index_and_search.py) | Single document indexing + BestFirst search |
+| [`02_text_indexing.py`](examples/02_text_indexing.py) | Plain text → tree index with auto heading detection |
+| [`03_cli_workflow.py`](examples/03_cli_workflow.py) | CLI workflow: build indexes + search with strategies |
+| [`04_multi_doc_search.py`](examples/04_multi_doc_search.py) | Multi-doc BM25 + BestFirst + strategy comparison + Chinese |
+| [`05_benchmark.py`](examples/05_benchmark.py) | Benchmark: BM25 / BestFirst / MCTS / LLM with metrics |
+
+## Project Structure
+
+```
+treesearch/
+├── llm.py            # Async LLM client with retry and JSON extraction
+├── tree.py           # Document dataclass, tree operations, persistence
+├── indexer.py        # Markdown / plain text → tree structure, batch build_index()
+├── search.py         # Best-First, MCTS, LLM search, document routing, unified search() API
+├── rank_bm25.py      # BM25Okapi, NodeBM25Index, Chinese/English tokenizer
+├── metrics.py        # Evaluation: Precision@K, Recall@K, MRR, NDCG@K, Hit@K, F1@K
+└── cli.py            # CLI entry point (index / search)
+```
+
+## Documentation
+
+- [Architecture](https://github.com/shibing624/TreeSearch/blob/main/docs/architecture.md) — Design principles and three-layer architecture
+- [API Reference](https://github.com/shibing624/TreeSearch/blob/main/docs/api.md) — Complete API documentation
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/shibing624/TreeSearch/blob/main/LICENSE) for details.

pytreesearch-0.1.0/README.md

@@ -0,0 +1,223 @@
+# TreeSearch
+
+**Structure-aware document retrieval without embeddings.**
+
+No vector embeddings. No chunk splitting. BM25 + LLM reasoning over document tree structures.
+
+[![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](https://github.com/shibing624/TreeSearch/blob/main/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/treesearch.svg)](https://pypi.org/project/treesearch/)
+
+## Why TreeSearch?
+
+Traditional RAG systems split documents into fixed-size chunks and retrieve by vector similarity. This **destroys document structure**, loses heading hierarchy, and misses reasoning-dependent queries.
+
+TreeSearch takes a fundamentally different approach — parse documents into **tree structures** based on their natural heading hierarchy, then use **BM25 + LLM reasoning** to navigate the tree and find the most relevant sections.
+
+| | Traditional RAG | TreeSearch |
+|---|---|---|
+| **Preprocessing** | Chunk splitting + embedding | Parse headings → build tree |
+| **Retrieval** | Vector similarity search | BM25 pre-scoring + LLM tree search |
+| **Multi-doc** | Needs vector DB for routing | LLM routes by document descriptions |
+| **Structure** | Lost after chunking | Fully preserved as tree hierarchy |
+| **Dependencies** | Vector DB + embedding model | LLM only (no embedding, no vector DB) |
+| **Zero-cost baseline** | N/A | BM25-only search (no LLM needed) |
+
+### Key Advantages
+
+- **No vector embeddings** — No embedding model to train, deploy, or pay for
+- **No chunk splitting** — Documents retain their natural heading structure
+- **No vector DB** — No Pinecone, Milvus, or Chroma to manage
+- **Tree-aware retrieval** — Heading hierarchy guides search, not arbitrary chunk boundaries
+- **BM25 zero-cost baseline** — Instant keyword search with no API calls, useful as standalone or pre-filter
+- **Budget-controlled LLM calls** — Set max LLM calls per query, with early stopping when confidence is high
+
+## Features
+
+- **Three-layer search** — BM25 pre-scoring → Best-First tree search → LLM relevance evaluation
+- **Tree-structured indexing** — Markdown and plain text documents are parsed into hierarchical trees
+- **BM25 node-level index** — Structure-aware scoring with hierarchical field weighting (title > summary > body) and ancestor propagation
+- **Best-First search** (default) — Priority queue driven, deterministic, with early stopping and budget control
+- **MCTS search** — Monte Carlo Tree Search with LLM as value function
+- **LLM single-pass** — One LLM call per document for minimal cost
+- **Multi-document search** — Route queries across document collections via LLM reasoning
+- **Chinese + English** — jieba tokenization for Chinese, regex for English (jieba is optional)
+- **Batch indexing** — `build_index()` supports glob patterns for concurrent multi-file processing
+- **Evaluation metrics** — Built-in Precision@K, Recall@K, MRR, NDCG@K, Hit@K, F1@K
+- **Async-first** — All core functions are async with sync wrappers available
+- **CLI included** — `treesearch index` and `treesearch search` commands
+
+## Installation
+
+```bash
+pip install treesearch
+```
+
+With Chinese support:
+```bash
+pip install "treesearch[cn]"
+```
+
+From source:
+
+```bash
+git clone https://github.com/shibing624/TreeSearch.git
+cd TreeSearch
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+### 1. Set up API key
+
+```bash
+export OPENAI_API_KEY="sk-..."
+# Optional: custom endpoint
+export OPENAI_BASE_URL="https://your-endpoint/v1"
+```
+
+### 2. Build index and search
+
+```python
+import asyncio
+from treesearch import build_index, load_index, Document, search
+
+async def main():
+    # Build indexes for multiple files (supports glob patterns)
+    await build_index(
+        paths=["docs/*.md"],
+        output_dir="./indexes",
+        if_add_doc_description=True,
+    )
+
+    # Load indexed documents
+    import os
+    documents = []
+    for fp in sorted(os.listdir("./indexes")):
+        if not fp.endswith(".json"):
+            continue
+        data = load_index(os.path.join("./indexes", fp))
+        documents.append(Document(
+            doc_id=fp,
+            doc_name=data["doc_name"],
+            structure=data["structure"],
+            doc_description=data.get("doc_description", ""),
+        ))
+
+    # Search with Best-First strategy (default: BM25 + LLM)
+    result = await search(
+        query="How does the authentication system work?",
+        documents=documents,
+    )
+
+    for doc_result in result.documents:
+        for node in doc_result["nodes"]:
+            print(f"[{node['score']:.2f}] {node['title']}")
+            print(f"  {node.get('text', '')[:200]}")
+
+asyncio.run(main())
+```
+
+### 3. BM25 standalone (no LLM needed)
+
+```python
+from treesearch import NodeBM25Index, Document, load_index
+
+# Load documents
+data = load_index("indexes/my_doc.json")
+doc = Document(doc_id="doc1", doc_name=data["doc_name"], structure=data["structure"])
+
+# BM25 node-level search — instant results, no API key needed
+index = NodeBM25Index([doc])
+results = index.search("authentication config", top_k=5)
+for r in results:
+    print(f"[{r['bm25_score']:.4f}] {r['title']}")
+```
+
+### CLI Usage
+
+```bash
+# Build indexes from glob pattern
+treesearch index --paths "docs/*.md" --add-description
+
+# Build index from specific files
+treesearch index --paths doc1.md doc2.txt -o ./indexes
+
+# Search with Best-First (default, BM25 + LLM)
+treesearch search --index_dir ./indexes/ --query "How does auth work?"
+
+# Search with MCTS strategy
+treesearch search --index_dir ./indexes/ --query "deployment" --strategy mcts
+
+# Search without BM25 pre-scoring
+treesearch search --index_dir ./indexes/ --query "config" --no-bm25
+
+# Control LLM budget
+treesearch search --index_dir ./indexes/ --query "auth" --max-llm-calls 10
+```
+
+## How It Works
+
+```
+Input Documents (MD/TXT)
+        │
+        ▼
+   ┌──────────┐
+   │  Indexer  │  Parse headings → build tree → generate summaries
+   └────┬─────┘    (build_index supports glob for batch processing)
+        │  JSON index files
+        ▼
+   ┌──────────┐
+   │  search   │  BM25 pre-score → route to docs → tree search
+   └────┬─────┘
+        │  SearchResult
+        ▼
+  Ranked nodes with scores and text
+```
+
+**Layer 1 — BM25 Pre-Scoring**: `NodeBM25Index` scores all tree nodes using structure-aware BM25 with hierarchical field weighting (title > summary > body) and ancestor score propagation. Instant, no LLM needed.
+
+**Layer 2 — Best-First Tree Search**: `BestFirstTreeSearch` uses a priority queue to expand the most promising nodes. LLM evaluates each node's relevance (title + summary only). Early stopping when top score drops below threshold.
+
+**Layer 3 — Results**: Budget-controlled LLM calls with subtree caching for reuse across similar queries.
+
+### Search Strategies
+
+| Strategy | Description | LLM Calls | Best For |
+|----------|-------------|-----------|----------|
+| `best_first` (default) | BM25 pre-scoring + priority queue + LLM evaluation | Moderate (budget-controlled) | General-purpose, best accuracy |
+| `mcts` | Monte Carlo Tree Search with LLM as value function | High | Complex reasoning queries |
+| `llm` | Single LLM call per document | Minimal | Low-cost, simple queries |
+| BM25-only | `NodeBM25Index.search()` standalone | Zero | Instant keyword search, no API key |
+
+## Examples
+
+| Example | Description |
+|---------|-------------|
+| [`01_index_and_search.py`](examples/01_index_and_search.py) | Single document indexing + BestFirst search |
+| [`02_text_indexing.py`](examples/02_text_indexing.py) | Plain text → tree index with auto heading detection |
+| [`03_cli_workflow.py`](examples/03_cli_workflow.py) | CLI workflow: build indexes + search with strategies |
+| [`04_multi_doc_search.py`](examples/04_multi_doc_search.py) | Multi-doc BM25 + BestFirst + strategy comparison + Chinese |
+| [`05_benchmark.py`](examples/05_benchmark.py) | Benchmark: BM25 / BestFirst / MCTS / LLM with metrics |
+
+## Project Structure
+
+```
+treesearch/
+├── llm.py            # Async LLM client with retry and JSON extraction
+├── tree.py           # Document dataclass, tree operations, persistence
+├── indexer.py        # Markdown / plain text → tree structure, batch build_index()
+├── search.py         # Best-First, MCTS, LLM search, document routing, unified search() API
+├── rank_bm25.py      # BM25Okapi, NodeBM25Index, Chinese/English tokenizer
+├── metrics.py        # Evaluation: Precision@K, Recall@K, MRR, NDCG@K, Hit@K, F1@K
+└── cli.py            # CLI entry point (index / search)
+```
+
+## Documentation
+
+- [Architecture](https://github.com/shibing624/TreeSearch/blob/main/docs/architecture.md) — Design principles and three-layer architecture
+- [API Reference](https://github.com/shibing624/TreeSearch/blob/main/docs/api.md) — Complete API documentation
+
+## License
+
+Apache License 2.0. See [LICENSE](https://github.com/shibing624/TreeSearch/blob/main/LICENSE) for details.