README.md

✅ SmartManuals-AI for Hugging Face Spaces

SmartManuals-AI is a local-first document QA system that uses RAG (retrieval-augmented generation), OCR, and embedding search to answer technical questions from PDFs and Word documents.

---

🔧 Features

• 🔍 Ask natural-language questions to your manuals
• 📄 Handles both PDFs and Word .docx files
• 🧠 Uses semantic search with sentence-transformers
• 🗃️ ChromaDB for fast local vector indexing
• 💬 Answers generated by Meta LLaMA 3.1 8B Instruct (default)
• 📊 Gradio dashboard for interaction

---

📁 Folder Structure

SmartManuals-AI/
├── app.py                 # Hugging Face Spaces main app
├── Manuals/               # 📂 Upload your PDF and Word manuals here
│   ├── OM_Treadmill.pdf
│   └── Parts_Bike.docx
├── chroma_store/         # ⛓️ ChromaDB vector DB (auto-generated)
├── requirements.txt      # 📦 Dependencies
└── README.md             # 📖 This file

---

🚀 Usage in Hugging Face Spaces

🔐 Environment Variables

Add your Hugging Face token as a secret:

• HF_TOKEN: Your Hugging Face access token (required for gated models)

📤 Upload Your Files

Put all your manuals (PDF and Word .docx) into the Manuals/ folder.

🧠 App Behavior

• On startup:
  • Extracts text (with OCR fallback) from PDFs
  • Extracts clean text from Word documents
  • Chunks and embeds content into ChromaDB
• During inference:
  • Retrieves semantically relevant chunks
  • Sends them to LLaMA 3.1 Instruct for answer generation

❌ No User Upload

This app is designed to work without file uploads. All processing is done on preloaded files in the Manuals/ directory.

---

🧠 Default Model

• Uses meta-llama/Llama-3.1-8B-Instruct
• All question answering is fully automatic
• User is not required to pick a model, doc type, or filter — the system decides based on question and content.

---

🧩 Supported File Types

• .pdf (with OCR for scanned pages)
• .docx (via python-docx)

---

🧪 Local Development

Install dependencies:

pip install -r requirements.txt

Run locally:

python app.py

---

👨🏽‍💻 Project by: Damilare Eniolabi

GitHub: @damoojeje

---

📌 Tags

RAG LLM Chroma OCR PDF Word Gradio HuggingFace SmartManualsAI