AI Document Analysis App is an AI-powered tool designed to help undergraduate students quickly analyze and summarize academic documents. This application uses advanced natural language processing techniques to extract key information from PDF and Word documents, providing summaries and topic-specific notes to aid in studying and research.
- 📤 Upload PDF or Word documents for analysis
- 🔑 Specify key topics for focused note-taking
- 📚 Generate concise summaries of document content
- 🧠 Extract key points from the entire document
- 📝 Create topic-specific notes based on user input
- 🤖 Utilizes GPT-4o for intelligent text analysis
- 🎓 Explanations tailored for easy understanding (ELI5 style)
This app is primarily designed for:
- Undergraduate students looking to quickly grasp main concepts from academic papers or textbooks
- Researchers needing to efficiently process and summarize large volumes of text
- Anyone seeking to extract key information from lengthy documents without reading them in full
- Python 3.12 or higher
- pip (Python package installer)
-
Clone the repository:
git clone https://github.com/mohibmirza-py/DocumentSummarizer.git cd document-analysis-app -
Create a virtual environment (optional but recommended):
python -m venv venv source venv/bin/activate # On Windows, use `venv\Scripts\activate` -
Install the required dependencies:
pip install -r requirements.txt -
Set up environment variables: Create a
.envfile in the project root and add your OpenAI API key:OPENAI_API_KEY=your_api_key_here
-
Start the Streamlit app:
streamlit run main.py -
Open your web browser and navigate to the URL provided by Streamlit (usually
http://localhost:8501).
- Upload a PDF or Word document using the file uploader.
- Enter topics you want to explore in the text area (one per line).
- Click the "Analyze Document" button.
- Review the generated summary, key points, and topic-specific notes.
We welcome contributions to improve Zahra's Document Analysis App! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with clear, descriptive messages.
- Push your changes to your fork.
- Submit a pull request with a detailed description of your changes.
This project is licensed under the MIT License - see the LICENSE file for details.
- OpenAI for providing the GPT-4o model
- Streamlit for the web app framework
- Langchain for document processing utilities
This tool is designed to assist with studying and research, not to replace thorough reading and critical thinking. Always verify important information and use this app as a supplement to your academic work, not a substitute.