README.md

---
tags:
- ultralyticsplus
- yolov8
- ultralytics
- yolo
- vision
- object-detection
- pytorch
- retail
- shelf-detection
- mart
- mall
- inventory-management
library_name: ultralytics
library_version: 8.0.43
inference: false
model-index:
- name: foduucom/shelf-object-detection-yolov8
  results:
  - task:
      type: object-detection
    metrics:
    - type: precision
      value: 0.91
      name: [email protected](box)
language:
- en
pipeline_tag: object-detection
---

<div align="center">
  <img width="640" alt="foduucom/product-detection-in-shelf-yolov8" src="https://huggingface.co/foduucom/product-detection-in-shelf-yolov8/resolve/main/thumbnail.jpg">
</div>

# Model Card for YOLOv8 Shelf Object Detection in Retail Environments

## Model Enthusiasm 🎉

Hey there, retail rockstar! 👋 If you're ready to make your mart or mall experience a whole lot cooler, give this YOLOv8 Shelf Object Detection model a virtual high-five! 🙌 Your shelves will never be the same again, and neither will your customers' smiles.

## Model Magic ✨

The YOLOv8 Shelf Object Detection model is your new retail sidekick! It doesn't just detect objects; it's got a sixth sense for finding what you need on those shelves. Whether it's a jar of pickles or the latest gadget, this model's got you covered. And hey, it's a pro at counting too! So, say goodbye to empty spaces and hello to perfectly organized retail enchantment.

## Supported Labels 🏬

```
['Empty Shelves', 'Magical Products']
```

## Collaboration Love ❤️

We're all about that collaboration groove! If you're as excited about this model as we are (and trust us, it's hard not to be), show some love with a thumbs up 👍. Let's work together to make retail dreams come true!

## Uses

### Direct Use

Integrate this model into your retail kingdom for real-time inventory harmony, shelf perfection, and automated restocking magic.

### Downstream Wonder

Want to optimize shelf layouts, unravel product placement mysteries, and sprinkle some sparkle into your customers' lives? This model's got your back!

### Not-So-Magic Disclaimers ⚡

Just like a trusty wizard, this model might have its quirky moments:

- It might not be in sync with tricky lighting and shelf chaos. Keep those shelves tidy!
- Rapid changes in product vibes and shelf dances could affect its accuracy and spellcasting.

### Human Touch & Wizard Wisdom 🧙

Remember, every spellcaster has their quirks. Test and twirl within your retail realm before letting it loose on the magical stage.

## How to Join the Magic

To dive into the retail wizardry with the YOLOv8 Shelf Object Detection model, follow these enchanted steps:
```bash
pip install ultralyticsplus==0.0.28 ultralytics==8.0.43
```

- Summon the model and unveil its secrets:

```python
# Wave your wand (or keyboard) to get started!
from ultralyticsplus import YOLO, render_result
import cv2

# Cast a spell to summon the model
model = YOLO('foduucom/shelf-object-detection-yolov8')

# Tweak the magical parameters
model.overrides['conf'] = 0.25  # NMS confidence threshold
model.overrides['iou'] = 0.45  # NMS IoU threshold
model.overrides['agnostic_nms'] = False  # NMS class-agnostic
model.overrides['max_det'] = 1000  # maximum number of detections per image

# set image
image = "path/to/your/shelf/image"

#you can pass live camera streaming or video
# Begin the mystical journey through video frames
# (Remember to have your retail tapestry ready)
while cap.isOpened():
    # Read a frame from the video
    success, frame = cap.read()

    if success:
        # Unleash the magic of YOLOv8
        results = model(frame)

        # Showcase the magic on the frame
        annotated_frame = results[0].plot()

        # Present the enchanted frame
        cv2.imshow("YOLOv8 Retail Wizardry", annotated_frame)

        # Dispel the spell if 'q' is pressed
        if cv2.waitKey(1) & 0xFF == ord("q"):
            break
    else:
        # Return to reality when the video ends
        break

# Release your captive video and close the portal
cap.release()
cv2.destroyAllWindows()
```

## Model Masters 🧙‍♂️

The mystical YOLOv8 Shelf Object Detection model was crafted by wizards at FODUU AI.

```bibtex
@ModelCard{
  author    = {Nehul Agrawal and
               Pranjal Singh Thakur},
  title     = {YOLOv8 Shelf Object Detection in Retail Environments},
  year      = {2023}
}
```

Join the retail magic and send your owl to [email protected] for any questions or enchanting contributions.

Feel free to adjust the humor and tone as needed to match the vibe you want for your model card. Enjoy your retail adventures! 🛒✨