README.md

---
title: Planolyzer
emoji: 🛍️
colorFrom: blue
colorTo: purple
sdk: docker
app_file: app.py
pinned: false
---

# Planolyzer

A smart planogram analysis tool that helps you verify shelf layouts and detect empty spaces in retail displays.

## Features

- 🔍 Compare uploaded shelf images with reference planograms
- 📊 Analyze empty spaces in shelf layouts
- 🎯 Detect missing products
- 📈 Generate detailed reports

## How to Use

1. Upload a shelf image
2. The system will compare it with the reference planogram
3. Get instant feedback on empty spaces and missing products
4. View detailed analysis and recommendations

## Technical Details

- Built with Chainlit for interactive UI
- Uses CLIP for image comparison
- Computer vision for empty space detection
- Real-time analysis and reporting

## Getting Started

The application will automatically download required files from the GitHub repository at runtime. No additional setup needed!

Visit the Space to try it out: [Planolyzer Space](https://huggingface.co/spaces/chelleboyer/planolyzer)

## Prerequisites

- Python 3.8 or higher
- pip (Python package installer)

## Installation

1. Clone the repository:
```bash
git clone https://github.com/yourusername/planolyzer.git
cd planolyzer
```

2. Create a virtual environment (recommended):
```bash
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
```

3. Install the required dependencies:
```bash
pip install -r requirements.txt
```

## Usage

1. Activate your virtual environment if you haven't already:
```bash
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
```

2. Run the application:
```bash
chainlit run app.py
```

## Project Structure

```
planolyzer/
├── requirements.txt    # Project dependencies
├── README.md          # This file
└── app.py            # Main application file
```

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## License

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