Skip to content

Austin-John/AskMyDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AskMyDocs

Offline PDF Q&A Bot built with Streamlit, LangChain, FAISS & Hugging Face Transformers.

Features

  • Upload any PDF and ask natural‑language questions about its content
  • Local embeddings via sentence-transformers + FAISS for fast, private search
  • Instruct‑style answers from a local LLM (e.g. Flan‑T5‑Base)
  • Special handlers for “structural” queries (e.g. “how many lines?”)
  • Dark‑mode‑friendly UI with simple, responsive layout

Installation

  1. Clone the repo

    git clone https://github.com/YOUR_USERNAME/askmydocs.git
    cd askmydocs
  2. Create & activate a virtual environment

    python3 -m venv venv
    # macOS/Linux
    source venv/bin/activate  
    # Windows
    venv\Scripts\activate
  3. Install dependencies

    pip install -r requirements.txt

Usage

streamlit run app.py
  • Open your browser to the URL shown (usually http://localhost:8501).
  • Upload a PDF, type your question, and get instant answers—all offline.

Project Structure

.
├── app.py
├── loader.py
├── indexer.py
├── llm.py
├── qa_chain.py
├── requirements.txt
├── README.md
└── .gitignore

Contributing

Feel free to open issues or submit pull requests for new features, bug‑fixes, or UI improvements!

License

This project is released under the MIT License.

About

Chat with your PDF documents. Upload. Ask. Understand.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages