audtorch 0.6.4
Deep learning with PyTorch and audio
License: MIT License
Keywords: audio,torch

========
audtorch
========

|tests| |coverage| |docs| |python-versions| |license|

Deep learning with PyTorch_ and audio.

Have a look at the installation_ and usage_ instructions as a starting point.

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`_

.. _installation: https://audeering.github.io/audtorch/install.html
.. _keunwoochoi/torchaudio-contrib: https://github.com/keunwoochoi/torchaudio-contrib
.. _PyTorch: https://pytorch.org
.. _pytorch/audio: https://github.com/pytorch/audio
.. _usage: https://audeering.github.io/audtorch/usage.html

.. |tests| image:: https://github.com/audeering/audtorch/workflows/Test/badge.svg
    :target: https://github.com/audeering/audtorch/actions?query=workflow%3ATest
    :alt: Test status
.. |coverage| image:: https://codecov.io/gh/audeering/audtorch/branch/master/graph/badge.svg?token=PUA9P2UJW1
    :target: https://codecov.io/gh/audeering/audtorch/
    :alt: code coverage
.. |docs| image:: https://img.shields.io/pypi/v/audtorch?label=docs
    :target: https://audeering.github.io/audtorch/
    :alt: audtorch's documentation
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/audtorch.svg
    :target: https://pypi.org/project/audtorch/
    :alt: audtorch's supported Python versions
.. |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

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.6.4 (2020-11-02)
--------------------------

* Fixed: link to documentation on Github pages in Python package


Version 0.6.3 (2020-10-30)
--------------------------

* Added: use copy-button Sphinx plugin
* Added: links to usage and installation to README
* Changed: use sphinx-audeering-theme
* Changed: update all documentation links to Github pages


Version 0.6.2 (2020-10-30)
--------------------------

* Fixed: install missing pandoc for publishing documentation


Version 0.6.1 (2020-10-30)
--------------------------

* Fixed: only install doc dependency for automatic release


Version 0.6.0 (2020-10-30)
--------------------------

* Added: code coverage
* Added: automatic publishing using Github Actions
* Changed: use Github Actions for testing
* Changed: host documentation as Github pages
* Fixed: use newest librosa version

Version 0.5.2 (2020-03-03)
--------------------------

* Fixed: disable automatic execution of notebook


Version 0.5.1 (2020-03-03)
--------------------------

* Fixed: execute jupyter notebook on readthedocs
* Fixed: release date of 5.0.0 in CHANGELOG


Version 0.5.0 (2020-03-03)
--------------------------

* Added: `RandomConvolutionalMix` transform
* Added: `EmoDB` data set
* Added: introduction tutorial
* Added: Python 3.8 support
* Added: ``column_end`` + ``column_start`` to ``CsvDataset`` and
  ``PandasDataset``
* Added: random convolutional mix transform
* Changed: default filename column in data sets is now ``file``
* Changed: force keyword only arguments
* Fixed: ``stft`` functional example
* Fixed: import of ``librosa``
* Removed: Python 3.5 support


Version 0.4.2 (2019-11-04)
--------------------------

* Fixed: critical bug of missing files in wheel package (#60)


Version 0.4.1 (2019-10-25)
--------------------------

* Fixed: default axis values for Masking transforms (#59)


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 readthedocs


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