From b536c6c8891bbbc8f17690862b8703100fdd9da0 Mon Sep 17 00:00:00 2001 From: SkalskiP Date: Wed, 17 May 2023 16:27:31 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20small=20documentation=20updates?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/dataset/core.md | 6 +++--- supervision/dataset/core.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dataset/core.md b/docs/dataset/core.md index 0bafd52a..0713c9dc 100644 --- a/docs/dataset/core.md +++ b/docs/dataset/core.md @@ -1,8 +1,8 @@ !!! warning - `Dataset` API is still fluid and may change. If you use Dataset in your project until further notice, freeze the - `supervision` version in your `requirements.txt`. + Dataset API is still fluid and may change. If you use Dataset API in your project until further notice, freeze the + `supervision` version in your `requirements.txt` or `setup.py`. -## Dataset +## DetectionDataset :::supervision.dataset.core.DetectionDataset \ No newline at end of file diff --git a/supervision/dataset/core.py b/supervision/dataset/core.py index f1ccb3d5..f5c85b24 100644 --- a/supervision/dataset/core.py +++ b/supervision/dataset/core.py @@ -29,7 +29,7 @@ class BaseDataset: @dataclass class DetectionDataset(BaseDataset): """ - Dataclass containing information about the dataset. + Dataclass containing information about object detection dataset. Attributes: classes (List[str]): List containing dataset class names.