Metadata-Version: 1.2
Name: audtorch
Version: 0.4.0
Summary: Deep learning with PyTorch and audio
Home-page: https://github.com/audeering/audtorch
Author: Andreas Triantafyllopoulos, Stephan Huber, Johannes Wagner, Hagen Wierstorf
Author-email: atriant@audeering.com
License: MIT License
Project-URL: Documentation, https://audtorch.readthedocs.io
Project-URL: Tracker, https://github.com/audeering/audtorch/issues
Description: ========
        audtorch
        ========
        
        |tests| |docs| |license|
        
        Deep learning with PyTorch_ and audio.
        
        **Documentation:** https://audtorch.readthedocs.io
        
        If you are interested in PyTorch_ and audio you should also check out the
        efforts to integrate more audio directly into PyTorch_:
        
        * `pytorch/audio`_
        * `keunwoochoi/torchaudio-contrib`_
        
        .. _PyTorch: https://pytorch.org
        .. _pytorch/audio: https://github.com/pytorch/audio
        .. _keunwoochoi/torchaudio-contrib:
            https://github.com/keunwoochoi/torchaudio-contrib
        
        .. |tests| image:: https://api.travis-ci.org/audeering/audtorch.svg?branch=master
            :target: https://travis-ci.org/audeering/audtorch/
            :alt: audtorch on TravisCI
        .. |docs| image:: https://readthedocs.org/projects/audtorch/badge/
            :target: https://audtorch.readthedocs.io/
            :alt: audtorch's documentation on Read the Docs
        .. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
            :target: https://github.com/audeering/audtorch/blob/master/LICENSE
            :alt: audtorch's MIT license
        
        
        Installation
        ============
        
        audtorch_ is supported by Python 3.5 or higher. To install it run
        (preferable in a `virtual environment`_):
        
        .. code-block:: bash
        
            pip install audtorch
        
        .. _audtorch: https://audtorch.readthedocs.io
        .. _virtual environment: https://docs.python-guide.org/dev/virtualenvs
        
        
        Usage
        =====
        
        audtorch_ automates the data iteration process for deep neural
        network training using PyTorch_. It provides a set of feature extraction
        transforms that can be implemented on-the-fly on the CPU.
        
        The following example creates a data set of speech samples that are cut to a
        fixed length of 10240 samples. In addition they are augmented on the fly during
        data loading by a transform that adds samples from another data set:
        
        .. code-block:: python
        
            >>> import sounddevice as sd
            >>> from audtorch import datasets, transforms
            >>> noise = datasets.WhiteNoise(duration=10240, sampling_rate=16000)
            >>> augment = transforms.Compose([transforms.RandomCrop(10240),
            ...                               transforms.RandomAdditiveMix(noise)])
            >>> data = datasets.LibriSpeech(root='~/LibriSpeech', sets='dev-clean',
            ...                             download=True, transform=augment)
            >>> signal, label = data[8]
            >>> sd.play(signal.transpose(), data.sampling_rate)
        
        Besides data sets and transforms the package provides standard evaluation
        metrics, samplers, and necessary collate functions for training deep neural
        networks for audio tasks.
        
        .. _audtorch: https://audtorch.readthedocs.io
        .. _PyTorch: https://pytorch.org
        
        Changelog
        =========
        
        All notable changes to this project will be documented in this file.
        
        The format is based on `Keep a Changelog`_,
        and this project adheres to `Semantic Versioning`_.
        
        
        Version 0.4.0 (2019-10-21)
        --------------------------
        
        * Added: masking transforms in time and frequency domain
        
        
        Version 0.3.2 (2019-10-04)
        --------------------------
        
        * Fixed: long description in ``setup.cfg``
        
        
        Version 0.3.1 (2019-10-04)
        --------------------------
        
        * Changed: define package in ``setup.cfg``
        
        
        Version 0.3.0 (2019-09-13)
        --------------------------
        
        * Added: ``datasets.SpeechCommands`` (#49)
        * Removed: ``LogSpectrogram`` (#52)
        
        
        Version 0.2.1 (2019-08-01)
        --------------------------
        
        * Changed: Remove os.system call for moving files (#43)
        * Fixed: Remove broken logos from issue templates (#31)
        * Fixed: Wrong ``Spectrogram`` output shape in documentation (#40)
        * Fixed: Broken data set loading for relative paths (#33)
        
        
        Version 0.2.0 (2019-06-28)
        --------------------------
        
        * Added: ``Standardize``, ``Log`` (#29)
        * Changed: Switch to `Keep a Changelog`_ format (#34)
        * Deprecated: ``LogSpectrogram`` (#29)
        * Fixed: ``normalize`` axis (#28)
        
        
        Version 0.1.1 (2019-05-23)
        --------------------------
        
        * Fixed: Broken API documentation on RTD_
        
        
        Version 0.1.0 (2019-05-22)
        --------------------------
        
        * Added: Public release
        
        
        .. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/
        .. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
        .. _RTD: https://audtorch.readthedocs.io/
        
Keywords: audio,torch
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Multimedia :: Sound/Audio
