Skip to main content

Neuromorphic datasets and transformations.

Project description

tonic PyPI codecov Documentation Status contributors Binder DOI Discord

Tonic is a tool to facilitate the download, manipulation and loading of event-based/spike-based data. It's like PyTorch Vision but for neuromorphic data!

Documentation

You can find the full documentation on Tonic on this site.

Install

pip install tonic

or (thanks to @Tobias-Fischer)

conda install -c conda-forge tonic

For the latest pre-release on the develop branch that passed the tests:

pip install tonic --pre

This package has been tested on:

Linux
Windows

Quickstart

If you're looking for a minimal example to run, this is it!

import tonic
import tonic.transforms as transforms

sensor_size = tonic.datasets.NMNIST.sensor_size
transform = transforms.Compose(
    [
        transforms.Denoise(filter_time=10000),
        transforms.ToFrame(sensor_size=sensor_size, time_window=3000),
    ]
)

testset = tonic.datasets.NMNIST(save_to="./data", train=False, transform=transform)

from torch.utils.data import DataLoader

testloader = DataLoader(
    testset,
    batch_size=10,
    collate_fn=tonic.collation.PadTensors(batch_first=True),
)

frames, targets = next(iter(testloader))

Discussion and questions

Have a question about how something works? Ideas for improvement? Feature request? Please get in touch on the #tonic Discord channel or alternatively here on GitHub via the Discussions page!

Contributing

Please check out the contributions page for details.

Sponsoring

The development of this library is supported by

SynSense

Citation

If you find this package helpful, please consider citing it:

@software{lenz_gregor_2021_5079802,
  author       = {Lenz, Gregor and
                  Chaney, Kenneth and
                  Shrestha, Sumit Bam and
                  Oubari, Omar and
                  Picaud, Serge and
                  Zarrella, Guido},
  title        = {Tonic: event-based datasets and transformations.},
  month        = jul,
  year         = 2021,
  note         = {{Documentation available under 
                   https://tonic.readthedocs.io}},
  publisher    = {Zenodo},
  version      = {0.4.0},
  doi          = {10.5281/zenodo.5079802},
  url          = {https://doi.org/10.5281/zenodo.5079802}
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

tonic-1.6.0.tar.gz (3.7 MB view details)

Uploaded Source

Built Distribution

tonic-1.6.0-py3-none-any.whl (106.2 kB view details)

Uploaded Python 3

File details

Details for the file tonic-1.6.0.tar.gz.

File metadata

  • Download URL: tonic-1.6.0.tar.gz
  • Upload date:
  • Size: 3.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for tonic-1.6.0.tar.gz
Algorithm Hash digest
SHA256 7b266b8407c445f9ab12f85b47d40cba2925b4d8b9678ac716334dab7e4189c9
MD5 03aecadf611228e5c290aa79a6425a8f
BLAKE2b-256 0125542bd12c5dbbd7ac128e26f359e2847558fc7b8cc2f18d6ebaf9b4abbfe3

See more details on using hashes here.

File details

Details for the file tonic-1.6.0-py3-none-any.whl.

File metadata

  • Download URL: tonic-1.6.0-py3-none-any.whl
  • Upload date:
  • Size: 106.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for tonic-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e483223362c306c293336b76d054bdc7771a3e710644f644d29ffc4302a2c8a
MD5 0bfaf6284270a6de62e3efcc197a0fc9
BLAKE2b-256 d637371314f0646d9daa4c9e741b60bd655ad06ff68c87b2c929fe5fd955ea91

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page