Add Canadian Invertebrates 1.5Mdocumentation for Bioscan dataset API

- Added Canadian Invertebrates 1.5M dataset to the Bioscan dataset API documentation.
- Updated `__init__.py` in bioscan_dataset to expose the new dataset class and loader.

Author: vivianp17

bioscan_dataset/__init__.py

@@ -2,7 +2,18 @@
 
 __version__ = __meta__.version
 
-__all__ = ["BIOSCAN1M", "BIOSCAN5M", "load_bioscan1m_metadata", "load_bioscan5m_metadata"]
+__all__ = [
+    "BIOSCAN1M",
+    "BIOSCAN5M",
+    "load_bioscan1m_metadata",
+    "load_bioscan5m_metadata",
+    "CanadianInvertebrates",
+    "load_CanadianInvertebrates_metadata",
+]
 
 from .bioscan1m import BIOSCAN1M, load_bioscan1m_metadata
 from .bioscan5m import BIOSCAN5M, load_bioscan5m_metadata
+from .CanadianInvertebrates import (
+    CanadianInvertebrates,
+    load_CanadianInvertebrates_metadata,
+)

docs/source/api.rst

@@ -1,22 +1,23 @@
 API Reference
 =============
 
-We provide :class:`~bioscan_dataset.BIOSCAN1M` and :class:`~bioscan_dataset.BIOSCAN5M` classes to load the respective `BIOSCAN-1M <BIOSCAN-1M paper_>`_ and `BIOSCAN-5M <BIOSCAN-5M paper_>`_ datasets for use within PyTorch.
+We provide :class:`~bioscan_dataset.BIOSCAN1M` , :class:`~bioscan_dataset.BIOSCAN5M` and :class:`~bioscan_dataset.CanadianInvertebrates` classes to load the respective `BIOSCAN-1M <BIOSCAN-1M paper_>`_ , `BIOSCAN-5M <BIOSCAN-5M paper_>`_ and `Canadian Invertebrates 1.5M <CanadianInvertebrates paper_>`_ datasets for use within PyTorch.
 These classes are subclasses of :class:`torch.utils.data.Dataset` and are designed to be used with PyTorch's :class:`~torch.utils.data.DataLoader` for batching and model training.
 
-General usage instructions for :class:`~bioscan_dataset.BIOSCAN1M` and :class:`~bioscan_dataset.BIOSCAN5M` are provided in our :doc:`usage <index>` guide.
+General usage instructions for :class:`~bioscan_dataset.BIOSCAN1M` , :class:`~bioscan_dataset.BIOSCAN5M` and :class:`~bioscan_dataset.CanadianInvertebrates` are provided in our :doc:`usage <index>` guide.
 
 .. tip::
     For new projects, we recommend using :class:`~bioscan_dataset.BIOSCAN5M` instead of :class:`~bioscan_dataset.BIOSCAN1M` since the newer dataset has cleaner labels and images.
     For larger scale projects, :class:`~bioscan_dataset.BIOSCAN5M` is a superset of :class:`~bioscan_dataset.BIOSCAN1M` and will provide five times more samples to train on.
     On the other hand, if 5 million samples is too much to handle, you can ignore the ``"pretrain"`` partition (train using the ``"train"`` partition only), which reduces the dataset to less than 400k samples.
 
-The accompanying functions :func:`~bioscan_dataset.load_bioscan1m_metadata` and :func:`~bioscan_dataset.load_bioscan5m_metadata` can be used to load the metadata from the CSV files.
+The accompanying functions :func:`~bioscan_dataset.load_bioscan1m_metadata` , :func:`~bioscan_dataset.load_bioscan5m_metadata` and :func:`~bioscan_dataset.load_CanadianInvertebrates_metadata` can be used to load the metadata from the CSV files.
 This produces a :class:`~pandas.DataFrame` in the same format as is used for model training.
-These functions do not need to be manually called when you are using :class:`~bioscan_dataset.BIOSCAN1M` and :class:`~bioscan_dataset.BIOSCAN5M` to work with the datasets.
+These functions do not need to be manually called when you are using :class:`~bioscan_dataset.BIOSCAN1M` , :class:`~bioscan_dataset.BIOSCAN5M` and :class:`~bioscan_dataset.CanadianInvertebrates` to work with the datasets.
 
 .. _BIOSCAN-1M paper: https://papers.nips.cc/paper_files/paper/2023/hash/87dbbdc3a685a97ad28489a1d57c45c1-Abstract-Datasets_and_Benchmarks.html
 .. _BIOSCAN-5M paper: https://arxiv.org/abs/2406.12723
+.. _CanadianInvertebrates paper: https://www.nature.com/articles/s41597-019-0320-2
 
 
 BIOSCAN-1M Dataset
@@ -38,3 +39,13 @@ BIOSCAN-5M Dataset
     :show-inheritance:
 
 .. autofunction:: bioscan_dataset.load_bioscan5m_metadata
+
+CANADIAN INVERTEBRATES 1.5M Dataset
+-----------------------------------
+
+.. autoclass:: bioscan_dataset.CanadianInvertebrates
+    :members:
+    :special-members: __getitem__
+    :show-inheritance:
+
+.. autofunction:: bioscan_dataset.load_CanadianInvertebrates_metadata