README.md

---
title: Document Summarization
emoji: 🌖
colorFrom: gray
colorTo: indigo
sdk: gradio
sdk_version: 5.12.0
app_file: app.py
pinned: true
license: apache-2.0
short_description: text2text models for document summarization
---

Check out the configuration reference at <https://huggingface.co/docs/hub/spaces-config-reference>

# README - Document Summarization

The original demo/what this repo was built for can be found [here](https://huggingface.co/spaces/pszemraj/document-summarization)

## Usage

If you are using this **not** as a gradio demo on hf spaces, you can run it locally with:

```bash
python app.py --share
```

To see all the available arguments, run `python app.py --help`.

## Installation

```bash
pip install -r requirements.txt
```

## 📁 Using Example Files

To use the "Examples" dropdown in the UI, create an `examples/` folder in the root directory and add one or more `.txt` files.

Each file will appear as a selectable example for summarization. Here's how:

```
examples/
└── example1.txt
```

> Note: The app gracefully handles missing `examples/` folder — no error will occur even if it's absent.