README.md

metadata

title: SIMPLIFY Text Summarizer
emoji: 🚀
colorFrom: indigo
colorTo: red
sdk: gradio
sdk_version: 4.15.0
app_file: app.py
pinned: false
pip_version: 23.3.2

S I M P L I F Y

Harness the power of LLMs to extract concise summaries from extensive text.

Installation

1. Create a virtual environment:

   • Navigate to the project directory in your terminal.
   • Create a virtual environment: python -m venv env
   • Activate the environment:
     • Windows: env\Scripts\activate.bat
     • Linux/macOS: source env/bin/activate

2. Install dependencies:

   • Install required packages: pip install -r requirements.txt

3. Set environment variable:

   • Set your Hugging Face API token: export HUGGINFACEHUB_API_TOKEN=YOUR_API_TOKEN
   • Set your Hugging Face API token as api_token variable.

Usage

1. Run the main script:
   • Execute the main script: python main.py

Additional Information

• Key frameworks: LangChain, Hugging Face LLMs
• Supported document types: PDF (currently)
• Customization: Adjust prompts and code for different content and queries.

Creators

• Anish De, B.Tech. Electrical Engineering
• Yash Shrivastava, B.Tech. Computer Science Engineering
• Dev Virani, B.Tech. Computer Science Engineering