"""
This module provides data pool classes for accessing Safebooru image data.
It contains two classes:
1. SafebooruDataPool: For accessing the full Safebooru dataset.
2. SafebooruWebpDataPool: For accessing the WebP-formatted Safebooru dataset with 4M pixel images.
Both classes inherit from IncrementIDDataPool and provide easy access to the respective datasets
stored in Hugging Face repositories. These classes simplify the process of retrieving and working
with Safebooru image data, allowing users to easily integrate this data into their projects or
research.
.. note::
The datasets `deepghs/safebooru_full <https://huggingface.co/datasets/deepghs/safebooru_full>`_ and
`deepghs/safebooru-webp-4Mpixel <https://huggingface.co/datasets/deepghs/safebooru-webp-4Mpixel>`_
is gated, you have to get the access of it before using this module.
"""
from typing import Optional
from .base import IncrementIDDataPool
_GELBOORU_REPO = 'deepghs/safebooru_full'
[docs]class SafebooruDataPool(IncrementIDDataPool):
"""
A data pool class for accessing the full Safebooru dataset.
This class inherits from IncrementIDDataPool and is configured to access
the full Safebooru dataset stored in the 'deepghs/safebooru_full' repository.
It provides methods to retrieve image data based on image IDs.
:param revision: The revision of the dataset to use, defaults to 'main'.
:type revision: str
Note:
This class uses a base level of 4 for file organization, which means
the images are stored in a directory structure with 4 levels of subdirectories.
"""
[docs] def __init__(self, revision: str = 'main', hf_token: Optional[str] = None):
"""
Initialize the SafebooruDataPool.
:param revision: The revision of the dataset to use, defaults to 'main'.
:type revision: str
:param hf_token: Hugging Face authentication token, defaults to None.
:type hf_token: Optional[str]
"""
IncrementIDDataPool.__init__(
self,
data_repo_id=_GELBOORU_REPO,
data_revision=revision,
idx_repo_id=_GELBOORU_REPO,
idx_revision=revision,
base_level=[3, 4],
hf_token=hf_token,
)
_GELBOORU_WEBP_REPO = 'deepghs/safebooru-webp-4Mpixel'
[docs]class SafebooruWebpDataPool(IncrementIDDataPool):
"""
A data pool class for accessing the WebP-formatted Safebooru dataset with 4M pixel images.
This class inherits from IncrementIDDataPool and is configured to access
the WebP-formatted Safebooru dataset stored in the 'deepghs/safebooru-webp-4Mpixel' repository.
It provides methods to retrieve WebP-formatted image data based on image IDs.
:param revision: The revision of the dataset to use, defaults to 'main'.
:type revision: str
:param hf_token: Hugging Face authentication token, defaults to None.
:type hf_token: Optional[str]
Note:
This class uses a base level of 3 for file organization, which means
the images are stored in a directory structure with 3 levels of subdirectories.
Authentication may be required to access this dataset.
"""
[docs] def __init__(self, revision: str = 'main', hf_token: Optional[str] = None):
"""
Initialize the SafebooruWebpDataPool.
:param revision: The revision of the dataset to use, defaults to 'main'.
:type revision: str
:param hf_token: Hugging Face authentication token, defaults to None.
:type hf_token: Optional[str]
"""
IncrementIDDataPool.__init__(
self,
data_repo_id=_GELBOORU_WEBP_REPO,
data_revision=revision,
idx_repo_id=_GELBOORU_WEBP_REPO,
idx_revision=revision,
base_level=3,
hf_token=hf_token,
)