From be65ba7370ebdd2c7afe42fd9fe075b8368e3cb0 Mon Sep 17 00:00:00 2001
From: Stephen Lomnes <84101284+lomnes-atlast-food@users.noreply.github.com>
Date: Thu, 1 Jun 2023 09:08:33 -0400
Subject: [PATCH] Update README.md
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Example in README documentation out of date for v.0.8.0.  __iter__() yields a length 3 tuple.  Example shows a length 2 tuple.

Change proposed: add image_name to example.

Reference: From API docs

```
__iter__() ¶
Iterate over the images and annotations in the dataset.

Yields:

Type	Description
Iterator[Tuple[str, np.ndarray, Detections]]
Iterator[Tuple[str, np.ndarray, Detections]]: An iterator that yields tuples containing the image name, the image data, and its corresponding annotation.
```
---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f14ca93c..822d7701 100644
--- a/README.md
+++ b/README.md
@@ -141,7 +141,7 @@ pip install -e ".[dev]"
 - Loop over dataset entries
 
     ```python
-    >>> for image, labels in dataset:
+    >>> for name, image, labels in dataset:
     ...     print(labels.xyxy)
 
     array([[404.      , 719.      , 538.      , 884.5     ],