DocumentQandAI / README.md
ghostai1's picture
Updated status on June 11, 2025
a2a1d24 verified
|
raw
history blame
3.56 kB
---
title: DocumentQandAI
emoji: ๐Ÿ“Š
colorFrom: gray
colorTo: yellow
sdk: gradio
sdk_version: 5.31.0
app_file: app.py
pinned: false
license: apache-2.0
short_description: QandAI
---
# ๐Ÿ“ Document Q&A Demo
[![Hugging Face Space](https://img.shields.io/badge/HuggingFace-Spaces-blue?logo=huggingface)](https://huggingface.co/spaces/your-username/doc-qa)
[![Gradio UI](https://img.shields.io/badge/Gradio-5.31.0-brightgreen?logo=gradio)]
[![Model](https://img.shields.io/badge/Model-RoBERTa--SQuAD2-orange)](https://huggingface.co/deepset/roberta-base-squad2)
[![License](https://img.shields.io/badge/License-MIT-lightgrey)](LICENSE)
---
## ๐Ÿš€ Overview
Turn **any piece of text**โ€”policies, FAQs, product descriptionsโ€”into an interactive **QA interface**.
Leverages **contextual embeddings** and **spanโ€extraction** to pinpoint precise answers in real time.
> **Key AI buzzwords:**
> โ€ข Contextual Question Answering โ€ข Span Extraction โ€ข Transformer-based NLP โ€ข Real-time inference โ€ข Edge (CPU) deployment โ€ข User-centric UX โ€ข Cloud-native AI
---
## โœจ Features
| ๐Ÿ”‘ Feature | ๐Ÿ” Description |
|-----------------------------|--------------------------------------------------------------------|
| **๐Ÿ“š Document Context** | Paste up to thousands of wordsโ€”no size limits beyond text input. |
| **โ“ Natural Questions** | Ask anything about your document in plain English. |
| **โšก Instant Answers** | Results in <500 ms on free CPU tierโ€”no GPUs required. |
| **๐Ÿ“ˆ Confidence Score** | See the modelโ€™s certainty (0โ€“1) alongside each answer. |
| **๐ŸŽจ Sleek Gradio UI** | Intuitive Blocks layout with input, button, and output panel. |
| **๐Ÿ”ง Drop-in Deployment** | Commit three filesโ€”Spaces auto-builds and hosts your demo. |
---
## ๐Ÿ—๏ธ Architecture & Workflow
1. **User pastes** document text into the **Context** box.
2. **User submits** a free-form question.
3. **`transformers` QA pipeline** (RoBERTa-SQuAD2) locates the answer span.
4. **Answer + confidence** rendered in the UI.
All computation happens **locally on the Space**, ensuring **data privacy** and **zero API costs**.
---
## ๐Ÿ› ๏ธ Local Development
```bash
git clone https://github.com/your-username/doc-qa.git
cd doc-qa
python3 -m venv venv && source venv/bin/activate
pip install -r requirements.txt
python app.py
## Latest Update
- Upgraded RoBERTa-SQuAD2 model for better answers. - May 29, 2025 ๐Ÿ“
- Optimized CPU inference for faster responses. - June 11, 2025 ๐Ÿ“
- Enhanced confidence score display. ๐ŸŽจ - June 10, 2025 ๐Ÿ“
- Improved handling of large documents. ๐Ÿ“Š - June 09, 2025 ๐Ÿ“
- Upgraded RoBERTa-SQuAD2 model for better answers. ๐Ÿ“ˆ - June 08, 2025 ๐Ÿ“
- Added support for multi-question inputs. ๐ŸŽจ - June 07, 2025 ๐Ÿ“
- Optimized CPU inference for faster responses. โšก - June 06, 2025 ๐Ÿ“
- Enhanced confidence score display. - June 05, 2025 ๐Ÿ“
- Improved handling of large documents. - June 04, 2025 ๐Ÿ“
- Upgraded RoBERTa-SQuAD2 model for better answers. โ“ - June 03, 2025 ๐Ÿ“
- Added support for multi-question inputs. - June 02, 2025 ๐Ÿ“
- Optimized CPU inference for faster responses. ๐Ÿ“Š - June 01, 2025 ๐Ÿ“
- Enhanced confidence score display. - May 31, 2025 ๐Ÿ“
- Improved handling of large documents. - May 30, 2025 ๐Ÿ“
**Website**: https://ghostainews.com/
**Discord**: https://discord.gg/BfA23aYz