dev(narugo): fix docs

cheesechaser/datapool/gelbooru.py

@@ -46,6 +46,8 @@ def __init__(self, revision: str = 'main', hf_token: Optional[str] = None):
 
         :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,

cheesechaser/datapool/rule34.py

@@ -40,12 +40,14 @@ class Rule34DataPool(IncrementIDDataPool):
         the images are stored in a directory structure with 4 levels of subdirectories.
     """
 
-    def __init__(self, revision: str = 'main'):
+    def __init__(self, revision: str = 'main', hf_token: Optional[str] = None):
         """
         Initialize the Rule34DataPool.
 
         :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,
@@ -54,6 +56,7 @@ def __init__(self, revision: str = 'main'):
             idx_repo_id=_RULE34_REPO,
             idx_revision=revision,
             base_level=[3, 4],
+            hf_token=hf_token,
         )
 
 

cheesechaser/datapool/safebooru.py

@@ -40,12 +40,14 @@ class SafebooruDataPool(IncrementIDDataPool):
         the images are stored in a directory structure with 4 levels of subdirectories.
     """
 
-    def __init__(self, revision: str = 'main'):
+    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,
@@ -54,6 +56,7 @@ def __init__(self, revision: str = 'main'):
             idx_repo_id=_GELBOORU_REPO,
             idx_revision=revision,
             base_level=[3, 4],
+            hf_token=hf_token,
         )
 
 

cheesechaser/datapool/sankaku.py

@@ -1,3 +1,22 @@
+"""
+This module provides data pool classes for accessing Sankaku image data.
+
+It contains two classes:
+
+1. SankakuDataPool: For accessing the full Sankaku dataset.
+2. SankakuWebpDataPool: For accessing the WebP-formatted Sankaku 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 Sankaku image data, allowing users to easily integrate this data into their projects or
+research.
+
+.. note::
+    The datasets `deepghs/sankaku_full <https://huggingface.co/datasets/deepghs/sankaku_full>`_ and
+    `deepghs/sankaku-webp-4Mpixel <https://huggingface.co/datasets/deepghs/sankaku-webp-4Mpixel>`_
+    is gated, you have to get the access of it before using this module.
+"""
+
 import os.path
 from collections import defaultdict
 from threading import Lock
@@ -13,7 +32,30 @@
 
 
 class SankakuDataPool(IncrementIDDataPool):
+    """
+    A data pool class for accessing the full Sankaku dataset.
+
+    This class inherits from IncrementIDDataPool and is configured to access
+    the full Sankaku dataset stored in the 'deepghs/sankaku_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.
+    """
+
     def __init__(self, revision: str = 'main', hf_token: Optional[str] = None):
+        """
+        Initialize the SankakuDataPool.
+
+        :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=_SANKAKU_REPO,

docs/source/api_doc/datapool/index.rst

@@ -24,6 +24,7 @@ cheesechaser.datapool
     realbooru
     rule34
     safebooru
+    sankaku
     table
     threedbooru
     yande

docs/source/api_doc/datapool/sankaku.rst

@@ -0,0 +1,24 @@
+cheesechaser.datapool.sankaku
+========================================================
+
+.. currentmodule:: cheesechaser.datapool.sankaku
+
+.. automodule:: cheesechaser.datapool.sankaku
+
+
+SankakuDataPool
+-----------------------------------------------------
+
+.. autoclass:: SankakuDataPool
+    :members: __doc__,__init__,__module__
+
+
+
+SankakuWebpDataPool
+-----------------------------------------------------
+
+.. autoclass:: SankakuWebpDataPool
+    :members: __doc__,__init__,__module__
+
+
+