tonic 1.4.4.dev16__tar.gz → 1.4.4.dev34__tar.gz

{tonic-1.4.4.dev16 → tonic-1.4.4.dev34}/.github/workflows/ci-pipeline.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-2022]
-        python-version: ["3.7", "3.9", "3.11"]
+        python-version: ["3.8", "3.10", "3.11"]
     steps:
       - uses: actions/checkout@v3
       - if: matrix.os == 'ubuntu-latest'
@@ -21,8 +21,8 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install requirements
         run: |
-          pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
           pip install -r test/requirements.txt
+          pip install -r test/torch_requirements.txt
           pip install .
       - name: Test with pytest
         run: pytest test
@@ -42,8 +42,8 @@ jobs:
           python-version: 3.9
       - name: Generate coverage report
         run: |
-          pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
           pip install -r test/requirements.txt
+          pip install -r test/torch_requirements.txt
           pip install .
           coverage run -m pytest test
           coverage xml
@@ -63,8 +63,8 @@ jobs:
           python-version: 3.9
       - name: Install dependencies
         run: |
-          pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
           pip install -r docs/requirements.txt
+          pip install -r test/torch_requirements.txt
           pip install .
       - name: Build documentation
         run: cd docs && make clean && make html # Use SPHINXOPTS="-W" to fail on warning.

{tonic-1.4.4.dev16 → tonic-1.4.4.dev34}/AUTHORS

@@ -9,6 +9,7 @@ Felix Bauer <felix.bauer@aictx.ai>
 Gokul B. Nair <14059534+gokulbnr@users.noreply.github.com>
 Gokul B. Nair <gokulbnr@gmail.com>
 Gregor Lenz <gregor.lenz@synsense.ai>
+Gregor Lenz <gregor@neurobus.space>
 Gregor Lenz <mail@lenzgregor.com>
 Guido Zarrella <jzarrella@mitre.org>
 James Knight <jk421@inf900374.inf.susx.ac.uk>
@@ -19,6 +20,7 @@ Jonah P. Sengupta <jsengup1@jhu.edu>
 Kenneth Chaney <chaneyk@seas.upenn.edu>
 Laurent Perrinet <laurent.perrinet@univ-amu.fr>
 Marco Rasetto <marcorax93@gmail.com>
+Mina Khoei <mina.khoei@synsense.ai>
 MrPeterJin <Cheng.Jin@std.uestc.edu.cn>
 Omar Oubari <omaroubari@gmail.com>
 Sadique Sheik <sadique.sheik@aictx.ai>

{tonic-1.4.4.dev16 → tonic-1.4.4.dev34}/ChangeLog

@@ -1,6 +1,13 @@
 CHANGES
 =======
 
+* DataSet class import was removed, the mini dataset does not inherent from that
+* moving torchvision import to inside function
+* moving typing-extensions to the root requirement
+* moving torch import to inside function, where it is used
+* pin torchvision version to something compatible with torch 2.1
+* add torch requirements to documentation github action
+* shorten GH actions pipeline to three Python versions
 * specified unit
 * build lists of users indices and lighting  in DVS gesture
 * Update ebssa.py
@@ -9,6 +16,10 @@ CHANGES
 * Revert "fix path format on windows for test case for ThreeET\_Eyetracking"
 * fix path format on windows for test case for ThreeET\_Eyetracking
 * add test case for ThreeET\_Eyetracking
+* notebook added to elaborate teh function of AugDiskCachedDataset
+* test added for aug\_diskcached
+* including Aug\_DiskCachedDataset in init imports
+* bug fixed in Aug\_DiskCach
 * add ThreeET\_Eyetracking to the documentation
 * fix: check for empty array in DropPixel transform
 * added: tests for empty frames
@@ -24,9 +35,52 @@ v1.4.3
 * change .h5 file loader to h5py
 * add 3ET eye tracking dataset
 * add threeET\_eyetracking(3et) dataset
+* tutorial added for audio transforms/augmentations
+* bug fixed in test
+* sample\_length was removed from some transforms (when not needed)
 * Fix: silent frames is now supported in uniform noise
 * Fix: silent frame support
+* importing TypedDict from typing\_extensions for python 3.7
+* adding typing-extensions to requirments
+* small fixes and cleanup
+* noise related augmentations removed
 * Fix: wrong range of histogram in drop\_pixel
+* Testing with python>=3.8 and python<=3.11
+* Update ci-pipeline.yml
+* Update torch\_requirements.txt
+* Update ci-pipeline.yml
+* Update torch\_requirements.txt
+* Update ci-pipeline.yml
+* Update torch\_requirements.txt
+* Update requirements.txt
+* Create torch\_requirements.txt
+* Update requirements.txt
+* Update requirements.txt
+* merge
+* Trying to make torchaudio work
+* cpu version is spesified for torchaudio
+* adding torchaudio
+* removing conflicting requirements
+* updated the required version of torch
+* dict keys updated to more generic
+* RIR test updated
+* removing hard coded room impulse audio from RIR transform
+* requirments updated with torch and torchaudio versions
+* removing torchaudio dependency temporarily to run the tests
+* torchaudio added to requirements
+* AugDiskCachedDataset added
+* tests\_passed
+* tests for audio augmentations
+* tests for added transforms
+* fixes in docstrings
+* typos fixed in docstrings
+* Noise augmentations added
+* AmplitudeScale and RobustAmplitudeScale transforms added
+* RIR transform (room impulse response) added
+* RandomAmplitudeScale is added
+* RandomPitchShift transfrom added
+* audio\_augmentation module is added: with RandomTimeStretch
+* new transform added: SwapAxes
 * fix EBSSA test sample file path
 * Prophesee prototype docstring updates
 * update documentation config

{tonic-1.4.4.dev16 → tonic-1.4.4.dev34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tonic
-Version: 1.4.4.dev16
+Version: 1.4.4.dev34
 Summary: Neuromorphic datasets and transformations.
 Home-page: UNKNOWN
 Author: The Neuromorphs of Telluride

{tonic-1.4.4.dev16 → tonic-1.4.4.dev34}/docs/requirements.txt

@@ -4,8 +4,6 @@ sphinx-book-theme
 sphinx-gallery
 myst_nb
 pbr
-torchvision
 ipywidgets
 matplotlib
-torchdata
 sphinx-autoapi

tonic-1.4.4.dev34/docs/tutorials/Aug_DiskCachDataset.ipynb

@@ -0,0 +1,179 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Using Aug_DiskCachedDataset for efficient caching of augmented copies\n",
+    "-  `Aug_DiskCachedDataset` is a modified version of `DiskCachedDataset` that is useful while applying deterministic augmentations on data samples. \n",
+    "\n",
+    "- This is the case when the parameter space of augmentation is desceret, for instance applying     `pitchshift` on audio data in which shift parameter (semitone) can only take N values.\n",
+    "\n",
+    "- Using `DiskCachedDataset` and setting `num_copies` to N is likely to cause 2 issues:\n",
+    "\n",
+    "    - Copies might not be unique, as copy_index is not linked to the augmentation parameter \n",
+    "    - And there is no guarantee that copies cover the desired augmentation space\n",
+    "    \n",
+    "\n",
+    "\n",
+    "- `Aug_DiskCachedDataset` resolves this limitation by mapping and linking copy index to augmentation parameter. Following considerations need to be takes into account:\n",
+    "\n",
+    "    - The user needs to pass `all_transforms` dict as input with seperated transforms `pre_aug`,  `aug`,  `post_aug` (spesifying transforms that are applied before and after augmentations, also augmentation transforms). \n",
+    "    \n",
+    "    - The augmentation class receives `aug_index` (aug_index = copy) as initialization parameter also `caching=True` needs to be set (please see `tonic.audio_augmentations`)\n",
+    "\n",
+    "- Follwing is a simple example to show function of `Aug_DiskCachedDataset`"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### A simple dataset "
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# %%writefile mini_dataset.py\n",
+    "import warnings\n",
+    "warnings.filterwarnings('ignore')\n",
+    "from torch.utils.data import Dataset\n",
+    "import numpy as np\n",
+    "\n",
+    "class mini_dataset(Dataset):\n",
+    "    def __init__(self) -> None:\n",
+    "        super().__init__()\n",
+    "        np.random.seed(0)\n",
+    "        self.data = np.random.rand(10, 16000)\n",
+    "        self.transform = None\n",
+    "        self.target_transform = None\n",
+    "\n",
+    "    def __getitem__(self, index):\n",
+    "        sample = self.data[index]\n",
+    "        label =  1\n",
+    "        if sample.ndim==1:\n",
+    "            sample = sample[None,...]\n",
+    "        if self.transform is not None:\n",
+    "            sample = self.transform(sample)\n",
+    "        if self.target_transform is not None:\n",
+    "            label = self.target_transform(label)  \n",
+    "\n",
+    "        return sample, label      "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Initializing `Aug_DiskCachedDataset` with transforms"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from tonic.cached_dataset import Aug_DiskCachedDataset, load_from_disk_cache\n",
+    "from tonic.audio_transforms import AmplitudeScale, FixLength\n",
+    "from tonic.audio_augmentations import RandomPitchShift\n",
+    "\n",
+    "all_transforms = {}\n",
+    "all_transforms[\"pre_aug\"] = [AmplitudeScale(max_amplitude = 0.150)]\n",
+    "all_transforms[\"augmentations\"] = [RandomPitchShift(samplerate=16000, caching=True)]\n",
+    "all_transforms[\"post_aug\"] = [FixLength(16000)]\n",
+    "\n",
+    "# number of copies is set to number of augmentation params (factors)\n",
+    "n = len(RandomPitchShift(samplerate=16000, caching=True).factors)\n",
+    "Aug_cach = Aug_DiskCachedDataset(dataset=mini_dataset(), cache_path='cache/', all_transforms = all_transforms, num_copies=n)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Generating all copies of a data sample\n",
+    "    - 10 augmented versions of data sample with index = 0 are generated"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "sample_index = 0\n",
+    "Aug_cach.generate_all(sample_index)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### To verify\n",
+    "    - loading the saved copies \n",
+    "    - and comparing them with the ones generated out of `Aug_DiskCacheDataset` with the same transforms and matching augmentation parameter \n",
+    "    - they are equal\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n",
+      "True\n"
+     ]
+    }
+   ],
+   "source": [
+    "from torchvision.transforms import Compose\n",
+    "\n",
+    "for i in range(n):\n",
+    "    transform = Compose([AmplitudeScale(max_amplitude = 0.150),RandomPitchShift(samplerate=16000, caching=True, aug_index=i), FixLength(16000)])\n",
+    "    ds = mini_dataset()\n",
+    "    ds.transform = transform\n",
+    "    sample = ds[sample_index][0]\n",
+    "    data, targets = load_from_disk_cache('cache/' + '0_' + str(i) + '.hdf5' )\n",
+    "    print((sample==data).all())\n"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "py_310",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.2"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}