planolyzer-v2 / README.md
chelleboyer's picture
fix README 3rdx
af0b24e
metadata
title: Planolyzer-v2
emoji: πŸ›οΈ
colorFrom: blue
colorTo: purple
sdk: docker
app_file: app.py
pinned: false

Planolyzer

A planogram analysis tool that helps detect empty spaces on retail shelves.

Features

  • Upload shelf images for analysis
  • Compare with reference planogram
  • Detect empty spaces and missing products
  • Real-time analysis with visual feedback

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

Technical Details

  • Built with Chainlit
  • Uses CLIP for image comparison
  • OpenCV for image processing
  • Python-based backend

Prerequisites

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

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/planolyzer.git
cd planolyzer
  1. Create a virtual environment (recommended):
python -m venv venv
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
  1. Install the required dependencies:
pip install -r requirements.txt

Usage

  1. Activate your virtual environment if you haven't already:
source venv/bin/activate  # On Windows, use: venv\Scripts\activate
  1. Run the application:
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.