cheesechaser.datapool.threedbooru

This module provides a data pool implementation for the 3D Booru dataset.

It includes a class ThreedbooruDataPool which extends the IncrementIDDataPool to specifically handle the 3D Booru dataset. This module allows users to easily access and manage data from the 3D Booru repository hosted on Hugging Face.

Note

The dataset deepghs/3dbooru_full is gated, you have to get the access of it before using this module.

ThreedbooruDataPool

class cheesechaser.datapool.threedbooru.ThreedbooruDataPool(revision: str = 'main', hf_token: str | None = None)[source]

A data pool class for managing and accessing the 3D Booru dataset.

This class extends the IncrementIDDataPool to provide specific functionality for the 3D Booru dataset. It uses a predefined repository ID for both data and index information.

Parameters:

revision (str) – The specific revision of the 3D Booru dataset to use, defaults to ‘main’.
hf_token (Optional[str]) – Optional Hugging Face authentication token for accessing private repositories.

Usage:

>>> pool = ThreedbooruDataPool()
>>> pool_with_token = ThreedbooruDataPool(hf_token='your_token_here')

Note

The 3D Booru dataset is hosted in the ‘deepghs/3dbooru_full’ repository on Hugging Face.

__init__(revision: str = 'main', hf_token: str | None = None)[source]

Initialize the ThreedbooruDataPool.

This constructor sets up the data pool with the specified revision of the 3D Booru dataset. It uses the same repository for both data and index information.

Parameters:

revision (str) – The specific revision of the 3D Booru dataset to use, defaults to ‘main’.
hf_token (Optional[str]) – Optional Hugging Face authentication token for accessing private repositories.