Skip to main content

Local RAG pipeline for fixing LLM hallucinations using high-precision documentation indexing.

Project description

logo

Python 3.11+ PyPI Docker Hub Tests

A local RAG pipeline for reducing hallucinations in LLMs by indexing technical documentation and research papers. Built for personal use on local hardware, shared here in case others find it useful. Web UI is built with Streamlit, with high level of configurability for the pipeline.

Note: For the moment, this is very much a hobby project. The app has no authentication or multi-user support and is designed to run locally on your own machine. If there's interest in production-ready deployment features, I can add them (feel free to make a request via issues).

What It Does

Indexes technical documentation and research papers into vector databases, then uses retrieval-augmented generation to ground LLM responses in source material. Uses hierarchical node parsing with auto-merging retrieval and cross-encoder reranking to balance accuracy and context window constraints.

Quick Start

Install the tool via PyPI. But before you do, I advise you prep the environment because of large volume of dependencies (use Python 3.11+):

python -m venv venv
source venv/bin/activate  # or .\venv\Scripts\activate(.ps1) on Windows CMD/PowerShell

Or via conda:

conda create -n tensor-truth python=3.11
conda activate tensor-truth

If using CUDA, make sure to first install the appropriate PyTorch version from pytorch.org. I used torch 2.9 and CUDA 12.8 in environments with CUDA.

If not, just install tensor-truth via pip, which includes CPU-only PyTorch.

pip install tensor-truth

Make sure ollama is installed and set up. Start the server:

ollama serve

Run the app:

tensor-truth

On first launch, pre-built indexes will auto-download from Google Drive (takes a few minutes). Also a small qwen2.5:0.5b will be pulled automatically for assigning automatic titles to chats.

Docker Deployment

For easier deployment without managing virtual environments or CUDA installations, a pre-built Docker image is available. This approach is useful if you want to avoid setting up PyTorch with CUDA manually, though you still need a machine with NVIDIA GPU and drivers installed.

Quick start - Pull and run from Docker Hub:

docker run -d \
  --name tensor-truth \
  --gpus all \
  -p 8501:8501 \
  -v ~/.tensortruth:/root/.tensortruth \
  -e OLLAMA_HOST=http://host.docker.internal:11434 \
  ljubobratovicrelja/tensor-truth:latest

See DOCKER.md for complete Docker documentation, troubleshooting, and advanced usage.

Data Storage

All user data (chat history, presets, indexes) is stored in ~/.tensortruth on macOS/Linux or %USERPROFILE%\.tensortruth on Windows. This keeps your working directory clean while maintaining persistent state across sessions.

Pre-built indexes download automatically to this directory on startup. If Google Drive rate limits prevent auto-download, manually fetch indexes.tar and extract to ~/.tensortruth/indexes.

For index contents, see config/sources.json. This is a curated list of useful libraries and research papers. Fork and customize as needed.

Requirements

Tested on:

  • MacBook M1 Max (32GB unified memory)
  • Desktop with RTX 3090 Ti (24GB VRAM)

If you encounter memory issues, consider running smaller models. Also keep track of what models are loaded in Ollama, as they consume GPU VRAM, and tend to stuck in memory until Ollama is restarted.

Recommended Models

Any Ollama model works, but I recommend these for best balance of performance and capability with RAG:

General Purpose:

ollama pull deepseek-r1:8b     # Balanced
ollama pull deepseek-r1:14b    # More capable

Note that, even though pure Ollama can run deepseek-r1:32b, with RAG workflow it is likely to struggle on 24GB 3090 for e.g.

Code/Technical Docs:

For coding, deepseek-coder-v2 is a strong choice:

ollama pull deepseek-coder-v2:16b 

Or, the smaller qwen2.5-coder, holds up well with API docs on coding aid.

ollama pull qwen2.5-coder:7b 

Building Your Own Indexes

Pre-built indexes cover common libraries, but you can create custom knowledge bases.

Scrape Documentation:

tensor-truth-docs --list                                    # Show all available sources
tensor-truth-docs pytorch numpy                             # Scrape library docs
tensor-truth-docs --type papers --category dl_foundations   # Fetch paper category
tensor-truth-docs --type papers --category ml --ids 1706.03762 1810.04805  # Specific papers

Build Vector Index:

tensor-truth-build --modules module_name

Session PDFs:

Upload PDFs directly in the web UI to create per-session indexes. For now only standard PDF files are supported, but more formats may be added later.

License

MIT License - see LICENSE for details.

Built for personal use but released publicly. Provided as-is with no warranty.

Disclaimer & Content Ownership

1. Software License: The source code of tensor-truth is licensed under the MIT License. This covers the logic, UI, and retrieval pipelines created for this project.

2. Third-Party Content: This tool is designed to fetch and index publicly available technical documentation, research papers (via ArXiv), and educational textbooks.

  • I do not own the rights to the indexed content. All PDF files, textbooks, and research papers fetched by this tool remain the intellectual property of their respective authors and publishers.
  • Source Links: The configuration files (config/sources.json, etc.) point exclusively to official sources, author-hosted pages, or open-access repositories (like ArXiv).
  • Usage: This tool is intended for personal, non-commercial research and educational use.

3. Takedown Request: If you are an author or copyright holder of any material referenced in the default configurations or included in the pre-built indexes and wish for it to be removed, please open an issue or contact me at ljubobratovic.relja@gmail.com, and the specific references/data will be removed immediately.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tensor_truth-0.1.13.tar.gz (214.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tensor_truth-0.1.13-py3-none-any.whl (223.3 kB view details)

Uploaded Python 3

File details

Details for the file tensor_truth-0.1.13.tar.gz.

File metadata

  • Download URL: tensor_truth-0.1.13.tar.gz
  • Upload date:
  • Size: 214.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for tensor_truth-0.1.13.tar.gz
Algorithm Hash digest
SHA256 7a7f4561ffdd7a5682a121cf153e206f963125fad72a700c78b704656bd84e2d
MD5 0d3fdbc2332decd342d3bf5766dcada9
BLAKE2b-256 1d66b417151fada9026f940b8d3d5b17b111dda21be26c66e82346e15e7a0c87

See more details on using hashes here.

File details

Details for the file tensor_truth-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: tensor_truth-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 223.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for tensor_truth-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 0e272d1f7908389c0637a3fdf38a9777f959b470067674161a4efad660e6e1cb
MD5 c79fb0a7b8bb8bd196954e9169877610
BLAKE2b-256 f749a66195204d3474d53993b4e0743d418c4390cdb6c52fe9e8569b3d42e4a0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page