:py:mod:`tonic.datasets.dvs_lips`
=================================

.. py:module:: tonic.datasets.dvs_lips


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   tonic.datasets.dvs_lips.DVSLip




.. py:class:: DVSLip(save_to: str, train: bool = True, transform: collections.abc.Callable | None = None, target_transform: collections.abc.Callable | None = None, transforms: collections.abc.Callable | None = None)


   Bases: :py:obj:`tonic.dataset.Dataset`

   `DVS-Lip <https://sites.google.com/view/event-based-lipreading>`_
   ::

       @inproceedings{tan2022multi,
           title={Multi-Grained Spatio-Temporal Features Perceived Network for Event-Based Lip-Reading},
           author={Tan, Ganchao and Wang, Yang and Han, Han and Cao, Yang and Wu, Feng and Zha, Zheng-Jun},
           booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
           pages={20094--20103},
           year={2022}
       }

       Implementation inspired from original script: https://github.com/tgc1997/event-based-lip-reading/blob/main/utils/dataset.py

   :param save_to: Location to save files to on disk.
   :type save_to: string
   :param train: If True, uses training subset, otherwise testing subset.
   :type train: bool
   :param transform: A callable of transforms to apply to the data.
   :type transform: callable, optional
   :param target_transform: A callable of transforms to apply to the targets/labels.
   :type target_transform: callable, optional
   :param transforms: A callable of transforms that is applied to both data and
                      labels at the same time.
   :type transforms: callable, optional

   .. py:attribute:: base_url
      :value: 'https://drive.google.com/file/d/1dBEgtmctTTWJlWnuWxFtk8gfOdVVpkQ0/view'

      

   .. py:attribute:: filename
      :value: 'DVS-Lip.zip'

      

   .. py:attribute:: base_folder
      :value: 'DVS-Lip'

      

   .. py:attribute:: file_md5
      :value: '2dcb959255122d4cdeb6094ca282494b'

      

   .. py:attribute:: sensor_size
      :value: (128, 128, 2)

      

   .. py:attribute:: dtype

      

   .. py:attribute:: ordering

      

   .. py:attribute:: classes
      :value: ['accused', 'action', 'allow', 'allowed', 'america', 'american', 'another', 'around', 'attacks',...

      

   .. py:attribute:: ambiguous_classes
      :value: ['action', 'allow', 'allowed', 'america', 'american', 'around', 'being', 'benefit', 'benefits',...

      

   .. py:method:: __getitem__(index)

      :returns: a tuple of (events, target) where target is the index of the target class.


   .. py:method:: __len__()