Package renamed to torchdatasets!

Use map, apply, reduce or filter directly on Dataset objects
cache data in RAM/disk or via your own method (partial caching supported)
Full PyTorch's Dataset and IterableDataset support
General torchdatasets.maps like Flatten or Select
Extensible interface (your own cache methods, cache modifiers, maps etc.)
Useful torchdatasets.datasets classes designed for general tasks (e.g. file reading)
Support for torchvision datasets (e.g. ImageFolder, MNIST, CIFAR10) via td.datasets.WrapDataset
Minimal overhead (single call to super().__init__())

Version	Docs	Tests	Coverage	Style	PyPI	Python	PyTorch	Docker	Roadmap

:bulb: Examples

Check documentation here: https://szymonmaszke.github.io/torchdatasets

General example

Create image dataset, convert it to Tensors, cache and concatenate with smoothed labels:

import torchdatasets as td
import torchvision

class Images(td.Dataset): # Different inheritance
    def __init__(self, path: str):
        super().__init__() # This is the only change
        self.files = [file for file in pathlib.Path(path).glob("*")]

    def __getitem__(self, index):
        return Image.open(self.files[index])

    def __len__(self):
        return len(self.files)


images = Images("./data").map(torchvision.transforms.ToTensor()).cache()

You can concatenate above dataset with another (say labels) and iterate over them as per usual:

for data, label in images | labels:
    # Do whatever you want with your data

Cache first 1000 samples in memory, save the rest on disk in folder ./cache:

images = (
    ImageDataset.from_folder("./data").map(torchvision.transforms.ToTensor())
    # First 1000 samples in memory
    .cache(td.modifiers.UpToIndex(1000, td.cachers.Memory()))
    # Sample from 1000 to the end saved with Pickle on disk
    .cache(td.modifiers.FromIndex(1000, td.cachers.Pickle("./cache")))
    # You can define your own cachers, modifiers, see docs
)

To see what else you can do please check torchdatasets documentation

Integration with `torchvision`

Using torchdatasets you can easily split torchvision datasets and apply augmentation only to the training part of data without any troubles:

import torchvision

import torchdatasets as td

# Wrap torchvision dataset with WrapDataset
dataset = td.datasets.WrapDataset(torchvision.datasets.ImageFolder("./images"))

# Split dataset
train_dataset, validation_dataset, test_dataset = torch.utils.data.random_split(
    model_dataset,
    (int(0.6 * len(dataset)), int(0.2 * len(dataset)), int(0.2 * len(dataset))),
)

# Apply torchvision mappings ONLY to train dataset
train_dataset.map(
    td.maps.To(
        torchvision.transforms.Compose(
            [
                torchvision.transforms.RandomResizedCrop(224),
                torchvision.transforms.RandomHorizontalFlip(),
                torchvision.transforms.ToTensor(),
                torchvision.transforms.Normalize(
                    mean=[0.485, 0.456, 0.406], std=[0.229, 0.224, 0.225]
                ),
            ]
        )
    ),
    # Apply this transformation to zeroth sample
    # First sample is the label
    0,
)

Please notice you can use td.datasets.WrapDataset with any existing torch.utils.data.Dataset instance to give it additional caching and mapping powers!

:wrench: Installation

:snake: pip

Latest release:

pip install --user torchdatasets

Nightly:

pip install --user torchdatasets-nightly

:whale2: Docker

CPU standalone and various versions of GPU enabled images are available at dockerhub.

For CPU quickstart, issue:

docker pull szymonmaszke/torchdatasets:18.04

Nightly builds are also available, just prefix tag with nightly_. If you are going for GPU image make sure you have nvidia/docker installed and it's runtime set.

:question: Contributing

If you find any issue or you think some functionality may be useful to others and fits this library, please open new Issue or create Pull Request.

To get an overview of thins one can do to help this project, see Roadmap

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

torchdatasets-nightly-1704931400.tar.gz (24.9 kB view details)

Uploaded Jan 11, 2024 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

torchdatasets_nightly-1704931400-py3-none-any.whl (29.7 kB view details)

Uploaded Jan 11, 2024 Python 3

File details

Details for the file torchdatasets-nightly-1704931400.tar.gz.

File metadata

Download URL: torchdatasets-nightly-1704931400.tar.gz
Upload date: Jan 11, 2024
Size: 24.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for torchdatasets-nightly-1704931400.tar.gz
Algorithm	Hash digest
SHA256	`e054dc7597c3d1fa66f8dae296c85e0ef768c6e65b682c440b23e4c87620587f`
MD5	`ba48303ae9516eaa26bbda730c98d243`
BLAKE2b-256	`54e34be3e89e1aa81095bc6c141eeba3f97d229e4b505243099b3aa1a2f46f04`

See more details on using hashes here.

File details

Details for the file torchdatasets_nightly-1704931400-py3-none-any.whl.

File metadata

Download URL: torchdatasets_nightly-1704931400-py3-none-any.whl
Upload date: Jan 11, 2024
Size: 29.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for torchdatasets_nightly-1704931400-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9d10014342177ca609221154ef2e04f7a405d118a52f659e0c5d15014e48b105`
MD5	`432c41ff4b6e96d409fe1f37bc2490ea`
BLAKE2b-256	`89aff32ead8118df75182f8fb70b23385af1af0126ed207255e5ee1a72ac55c7`