pdf-chat-app / README.md
Saketh12345's picture
Initial clean commit for Streamlit Hugging Face Spaces deployment
82e2888

A newer version of the Streamlit SDK is available: 1.56.0

Upgrade
metadata
title: PDF Chat App
emoji: πŸ“„
colorFrom: blue
colorTo: green
sdk: streamlit
sdk_version: 1.45.1
app_file: app.py
pinned: false

PDF Chat Application

A PDF chat application that allows you to upload PDFs and ask questions about their content using natural language processing. Built with Streamlit, LangChain, and Hugging Face Transformers, this app runs entirely in your browser on Hugging Face Spaces.

✨ Features

  • πŸ“„ Upload and process PDF documents
  • πŸ’¬ Chat with your documents using natural language
  • πŸ”’ Local processing - no data leaves your machine
  • πŸ€— Uses Hugging Face models for embeddings and question answering
  • πŸš€ Built with Streamlit for a clean web interface

πŸ›  Prerequisites

  • A Hugging Face account (for Spaces deployment)
  • Git (for cloning the repository)
  • At least 4GB of free RAM (for running the models)

πŸš€ Getting Started

  1. Clone the repository:

    git clone https://github.com/saketh-005/pdf-chat-app.git
    cd pdf-chat-app
    
  2. Install dependencies and run locally (optional):

    pip install -r requirements.txt
    streamlit run app.py
    
  3. Or deploy directly to Hugging Face Spaces by pushing this folder to your Space.

πŸ–₯️ Usage

  1. Click "Browse files" to upload a PDF document
  2. Wait for the document to be processed (you'll see a success message)
  3. Type your question in the chat input and press Enter
  4. The app will analyze the document and provide an answer

πŸ—οΈ Project Structure

.
β”œβ”€β”€ app.py              # Main Streamlit application
β”œβ”€β”€ requirements.txt    # Python dependencies
β”œβ”€β”€ .gitignore          # Git ignore file
└── README.md           # This file

πŸ€– Technologies Used

πŸ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments