Skip to content

NeelayS/event_aug

Repository files navigation

EventAug

A Python package for augmenting event-camera datasets

Tests

Installation

From source (recommended)

Using Poetry (recommended)

If you don't have Poetry installed, you can install it with the following command:

pip install poetry

Clone the repository and enter working directory:

git clone https://github.com/NeelayS/event_aug
cd event_aug

To install the basic version of the package:

poetry install --no-dev

If you wish to install the development version of the package:

poetry install

If you wish to use the Youtube video downloading functionality of the package, you can additionally run:

poetry install -E youtube

Using Pip

To install the basic version of the package:

pip install git+https://github.com/NeelayS/event_aug.git

To use the YouTube video downloading functionality of the package:

pip install git+https://github.com/NeelayS/event_aug.git#[youtube]

Usage

Please refer to the tutorial_ntbks/ directory for usage examples. It contains two IPython notebooks which demonstrate how the package can be used to augment event-camera datasets end-to-end using spike-encoded (custom) videos and Perlin noise.