README.md

---
title: Code to Doc Streamlit App
emoji: 📝
colorFrom: blue
colorTo: green
sdk: streamlit
sdk_version: "1.30.0"
app_file: app.py
pinned: false
---

# Python Code Summarizer

This Streamlit app utilizes the CodeT5 model to generate summaries of Python code files, leveraging the Hugging Face Transformers library.

## Features
- Upload Python files or paste code directly
- Generate file-level summaries
- Generate function-level summaries
- Generate class-level summaries

## Usage
1. Upload a Python file or paste your code
2. Select the types of summaries you want to generate
3. Click "Summarize Code"
4. View the generated summaries

## Model Information
This app employs CodeT5, a pretrained model available on Hugging Face, developed by Salesforce Research for code understanding and generation tasks. It is trained on a vast corpus of code and documentation.

## Limitations
- Summaries may not always be accurate
- Long files may be truncated due to model context limits
- Complex code structures might not be properly understood