Reworking datasets & interfaces

* Introduced slightly different interfaces for datasets
* Made a dedicated folder for images datasets. Renamed and moved old datasets. Kept names of the old dataset for backward compatibility.
* Removed `ListDataset` and its' tests
* In tests: `DummyQGDataset` -> `EmbeddingsQueryGalleryDataset`

Author: AlekseySh

.gitignore

@@ -16,6 +16,7 @@ tmp.ipynb
 *outputs*
 *.hydra*
 *predictions.json*
+*ml-runs*
 
 # __________________________________
 

docs/source/contents/datasets.rst

@@ -7,42 +7,51 @@ Datasets
 .. contents::
    :local:
 
-BaseDataset
+ImageBaseDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: oml.datasets.base.BaseDataset
+.. autoclass:: oml.datasets.images.ImageBaseDataset
     :undoc-members:
     :show-inheritance:
 
     .. automethod:: __init__
+    .. automethod:: __getitem__
+    .. automethod:: visualize
 
-DatasetWithLabels
+ImageLabeledDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: oml.datasets.base.DatasetWithLabels
+.. autoclass:: oml.datasets.images.ImageLabeledDataset
     :undoc-members:
     :show-inheritance:
 
     .. automethod:: __init__
     .. automethod:: __getitem__
     .. automethod:: get_labels
-    .. automethod:: get_label2category
+    .. automethod:: visualize
 
-DatasetQueryGallery
+ImageQueryGalleryLabeledDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: oml.datasets.base.DatasetQueryGallery
+.. autoclass:: oml.datasets.images.ImageQueryGalleryLabeledDataset
     :undoc-members:
     :show-inheritance:
 
     .. automethod:: __init__
     .. automethod:: __getitem__
+    .. automethod:: get_query_ids
+    .. automethod:: get_gallery_ids
+    .. automethod:: get_labels
+    .. automethod:: visualize
 
-ListDataset
+ImageQueryGalleryDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: oml.datasets.list_dataset.ListDataset
+.. autoclass:: oml.datasets.images.ImageQueryGalleryDataset
     :undoc-members:
     :show-inheritance:
 
     .. automethod:: __init__
     .. automethod:: __getitem__
+    .. automethod:: get_query_ids
+    .. automethod:: get_gallery_ids
+    .. automethod:: visualize
 
 EmbeddingPairsDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/contents/interfaces.rst

@@ -52,22 +52,39 @@ ITripletLossWithMiner
 
     .. automethod:: forward
 
-IDatasetWithLabels
+IBaseDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: oml.interfaces.datasets.IDatasetWithLabels
+.. autoclass:: oml.interfaces.datasets.IBaseDataset
+    :undoc-members:
+    :show-inheritance:
+
+ILabeledDataset
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: oml.interfaces.datasets.ILabeledDataset
     :undoc-members:
     :show-inheritance:
 
     .. automethod:: __getitem__
     .. automethod:: get_labels
 
-IDatasetQueryGallery
+IQueryGalleryDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: oml.interfaces.datasets.IDatasetQueryGallery
+.. autoclass:: oml.interfaces.datasets.IQueryGalleryDataset
     :undoc-members:
     :show-inheritance:
 
-    .. automethod:: __getitem__
+    .. automethod:: get_query_ids
+    .. automethod:: get_gallery_ids
+
+IQueryGalleryLabeledDataset
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: oml.interfaces.datasets.IQueryGalleryLabeledDataset
+    :undoc-members:
+    :show-inheritance:
+
+    .. automethod:: get_query_ids
+    .. automethod:: get_gallery_ids
+    .. automethod:: get_labels
 
 IPairsDataset
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -78,6 +95,14 @@ IPairsDataset
     .. automethod:: __init__
     .. automethod:: __getitem__
 
+IVisualizableDataset
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: oml.interfaces.datasets.IVisualizableDataset
+    :undoc-members:
+    :show-inheritance:
+
+    .. automethod:: visualize
+
 IBasicMetric
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autoclass:: oml.interfaces.metrics.IBasicMetric

oml/const.py

@@ -2,7 +2,7 @@
 import tempfile
 from pathlib import Path
 from sys import platform
-from typing import Any, Dict, Tuple, Union
+from typing import Any, Dict, Optional, Sequence, Tuple, Union
 
 from omegaconf import DictConfig
 
@@ -50,6 +50,7 @@ def get_cache_folder() -> Path:
 GREEN = (0, 255, 0)
 BLUE = (0, 0, 255)
 GRAY = (120, 120, 120)
+BLACK = (0, 0, 0)
 PAD_COLOR = (255, 255, 255)
 
 TCfg = Union[Dict[str, Any], DictConfig]
@@ -62,6 +63,9 @@ def get_cache_folder() -> Path:
 MEAN_CLIP = (0.48145466, 0.4578275, 0.40821073)
 STD_CLIP = (0.26862954, 0.26130258, 0.27577711)
 
+TBBox = Tuple[int, int, int, int]
+TBBoxes = Sequence[Optional[TBBox]]
+
 CROP_KEY = "crop"  # the format is [x1, y1, x2, y2]
 
 # Required dataset format: