tonic

Subpackages

• tonic.datasets
  • tonic.datasets.asl_dvs
  • tonic.datasets.cifar10dvs
  • tonic.datasets.davisdataset
  • tonic.datasets.dsec
  • tonic.datasets.dvs_lips
  • tonic.datasets.dvsgesture
  • tonic.datasets.ebssa
  • tonic.datasets.hsd
  • tonic.datasets.mvsec
  • tonic.datasets.ncaltech101
  • tonic.datasets.nmnist
  • tonic.datasets.pokerdvs
  • tonic.datasets.s_mnist
  • tonic.datasets.tum_vie
  • tonic.datasets.visual_place_recognition
• tonic.functional
  • tonic.functional.crop
  • tonic.functional.decimate
  • tonic.functional.denoise
  • tonic.functional.drop_event
  • tonic.functional.drop_pixel
  • tonic.functional.event_downsampling
  • tonic.functional.refractory_period
  • tonic.functional.spatial_jitter
  • tonic.functional.time_jitter
  • tonic.functional.time_skew
  • tonic.functional.to_averaged_timesurface
  • tonic.functional.to_bina_rep
  • tonic.functional.to_frame
  • tonic.functional.to_timesurface
  • tonic.functional.to_voxel_grid
  • tonic.functional.uniform_noise
• tonic.prototype
  • tonic.prototype.datasets
    • tonic.prototype.datasets.utils
    • tonic.prototype.datasets.ncars
    • tonic.prototype.datasets.nmnist
    • tonic.prototype.datasets.prophesee
    • tonic.prototype.datasets.stmnist
  • tonic.prototype.slicers

Submodules

• tonic.audio_transforms
• tonic.cached_dataset
• tonic.collation
• tonic.dataset
• tonic.download_utils
• tonic.io
• tonic.sliced_dataset
• tonic.slicers
• tonic.transforms
• tonic.utils

Package Contents

Classes

CachedDataset	Deprecated class that points to DiskCachedDataset for now but will be removed in a future
DiskCachedDataset	DiskCachedDataset caches the data samples to the hard drive for subsequent reads, thereby
MemoryCachedDataset	MemoryCachedDataset caches the samples to memory to substantially improve data loading
Dataset	Base class for Tonic datasets which download public data.
SlicedDataset	The primary use case for a SlicedDataset is to cut existing examples in a dataset into

Attributes

all
__version__

class tonic.CachedDataset(*args, **kwargs)

Bases: DiskCachedDataset

Deprecated class that points to DiskCachedDataset for now but will be removed in a future release.

Please use MemoryCachedDataset or DiskCachedDataset in the future.

class tonic.DiskCachedDataset

DiskCachedDataset caches the data samples to the hard drive for subsequent reads, thereby potentially improving data loading speeds. If dataset is None, then the length of this dataset will be inferred from the number of files in the caching folder. Pay attention to the cache path you’re providing, as DiskCachedDataset will simply check if there is a file present with the index that it is looking for. When using train/test splits, it is wise to also take that into account in the cache path.

Note

When you change the transform that is applied before caching, DiskCachedDataset cannot know about this and will present you with an old file. To avoid this you either have to clear your cache folder manually when needed, incorporate all transformation parameters into the cache path which creates a tree of cache files or use reset_cache=True.

Note

Caching Pytorch tensors will write numpy arrays to disk, so be careful when loading the sample and you expect a tensor. The recommendation is to defer the transform to tensor as late as possible.

Parameters:

• dataset – Dataset to be cached to disk. Can be None, if only files in cache_path should be used.

• cache_path – The preferred path where the cache will be written to and read from.

• reset_cache – When True, will clear out the cache path during initialisation. Default is False

• transform – Transforms to be applied on the data

• target_transform – Transforms to be applied on the label/targets

• transforms – A callable of transforms that is applied to both data and labels at the same time.

• num_copies – Number of copies of each sample to be cached. This is a useful parameter if the dataset is being augmented with slow, random transforms.

• compress – Whether to apply lightweight lzf compression, default is True.

dataset: Iterable

cache_path: str

reset_cache: bool = False

transform: Optional[Callable]

target_transform: Optional[Callable]

transforms: Optional[Callable]

num_copies: int = 1

compress: bool = True

__post_init__()

__getitem__(item) → Tuple[object, object]

Return type:

Tuple[object, object]

__len__()

class tonic.MemoryCachedDataset

MemoryCachedDataset caches the samples to memory to substantially improve data loading speeds. However you have to keep a close eye on memory consumption while loading your samples, which can increase rapidly when converting events to rasters/frames. If your transformed dataset doesn’t fit into memory, yet you still want to cache samples to speed up training, consider using DiskCachedDataset instead.

Parameters:

• dataset – Dataset to be cached to memory.

• device – Device to cache to. This is preferably a torch device. Will cache to CPU memory if None (default).

• transform – Transforms to be applied on the data

• target_transform – Transforms to be applied on the label/targets

• transforms – A callable of transforms that is applied to both data and labels at the same time.

dataset: Iterable

device: Optional[str]

transform: Optional[Callable]

target_transform: Optional[Callable]

transforms: Optional[Callable]

samples_dict: dict

__getitem__(index)

__len__()

class tonic.Dataset(save_to: str, transform: Optional[Callable] = None, target_transform: Optional[Callable] = None, transforms: Optional[Callable] = None)

Base class for Tonic datasets which download public data.

Contains a few helper function to reduce duplicated code.

Parameters:

• save_to (str) –

• transform (Optional[Callable]) –

• target_transform (Optional[Callable]) –

• transforms (Optional[Callable]) –

__repr__()

Return repr(self).

download() → None

Downloads from a given url, places into target folder and verifies the file hash.

Return type:

None

class tonic.SlicedDataset

The primary use case for a SlicedDataset is to cut existing examples in a dataset into smaller chunks. For that it takes an iterable dataset and a slicing method as input. It then generates metadata about the slices and where to find them in each original sample. The new dataset length will be the sum of all slices across samples.

Parameters:

• dataset – a dataset object which implements __getitem__ and __len__ methods.

• slicer – a function which implements the tonic.slicers.Slicer protocol, meaning that it doesn’t have to inherit from it but implement all its methods.

• metadata_path – filepath where slice metadata should be stored, so that it does not have to be recomputed the next time. If None, will be recomputed every time.

• transform – Transforms to be applied on the data

• target_transform – Transforms to be applied on the label/targets

• transforms – A callable of transforms that is applied to both data and labels at the same time.

dataset: Iterable

slicer: tonic.slicers.Slicer

metadata_path: Optional[str]

transform: Optional[Callable]

target_transform: Optional[Callable]

transforms: Optional[Callable]

__post_init__()

Will try to read metadata from disk to know where slices start and stop for each sample.

If no metadata_path is provided or no file slice_metadata.h5 is found in that path, metadata will be generated from scratch.

generate_metadata()

Slices every sample in the wrapped dataset and returns start and stop metadata for each slice.

__getitem__(item) → Any

Return type:

Any

__len__()

tonic.all = '__version__'

tonic.__version__