Skip to content

pixano.datasets.builders.folders.image

ImageFolderBuilder(source_dir, target_dir, info, dataset_item=DefaultImageDatasetItem, url_prefix=None)

Bases: FolderBaseBuilder

Builder for image datasets stored in a folder.

Parameters:

Name Type Description Default
source_dir Path | str

The source directory for the dataset.

 required
target_dir Path | str

The target directory for the dataset.

 required
dataset_item type[DatasetItem]

The dataset item schema.

 DefaultImageDatasetItem
info DatasetInfo

User informations (name, description, ...) for the dataset.

 required
url_prefix Path | str | None

The path to build relative URLs for the views. Useful to build dataset libraries to pass the relative path from the media directory.

 None
Source code in pixano/datasets/builders/folders/image.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def __init__(
    self,
    source_dir: Path | str,
    target_dir: Path | str,
    info: DatasetInfo,
    dataset_item: type[DatasetItem] = DefaultImageDatasetItem,
    url_prefix: Path | str | None = None,
) -> None:
    """Initialize the `ImageFolderBuilder`.

    Args:
        source_dir: The source directory for the dataset.
        target_dir: The target directory for the dataset.
        dataset_item: The dataset item schema.
        info: User informations (name, description, ...) for the dataset.
        url_prefix: The path to build relative URLs for the views. Useful to build dataset libraries to pass the
            relative path from the media directory.
    """
    super().__init__(
        source_dir=source_dir, target_dir=target_dir, dataset_item=dataset_item, info=info, url_prefix=url_prefix
    )