torchaudio 0.11.0 Release Note

Highlights

TorchAudio 0.11.0 release includes:

• Emformer (paper) RNN-T components, training recipe, and pre-trained pipeline for streaming ASR
• Voxpopuli pre-trained pipelines
• HuBERTPretrainModel for training HuBERT from scratch
• Conformer model for speech recognition
• Drop Python 3.6 support

[Beta] Emformer RNN-T

To support streaming ASR use cases, the release adds implementations of Emformer (docs), an RNN-T model that uses Emformer (emformer_rnnt_base), and an RNN-T beam search decoder (RNNTBeamSearch). It also includes a pipeline bundle (EMFORMER_RNNT_BASE_LIBRISPEECH) that wraps pre- and post-processing components, the beam search decoder, and the RNN-T Emformer model with weights pre-trained on LibriSpeech, which in whole allow for performing streaming ASR inference out of the box. For reference and reproducibility, the release provides the training recipe used to produce the pre-trained weights in the examples directory.

[Beta] HuBERT Pretrain Model

The masked prediction training of HuBERT model requires the masked logits, unmasked logits, and feature norm as the outputs. The logits are for cross-entropy losses and the feature norm is for penalty loss. The release adds HuBERTPretrainModel and corresponding factory functions (hubert_pretrain_base, hubert_pretrain_large, and hubert_pretrain_xlarge) to enable training from scratch.

[Beta] Conformer (paper)

The release adds an implementation of Conformer (docs), a convolution-augmented transformer architecture that has achieved state-of-the-art results on speech recognition benchmarks.

Backward-incompatible changes

Ops

• Removed deprecated F.magphase, F.angle, F.complex_norm, and T.ComplexNorm. (#1934, #1935, #1942)
  • Utility functions for pseudo complex types were deprecated in 0.10, and now they are removed in 0.11. For the detail of this migration plan, please refer to #1337.
• Dropped pseudo complex support from F.spectrogram, T.Spectrogram, F.phase_vocoder, and T.TimeStretch (#1957, #1958)
  • The support for the pseudo complex type was deprecated in 0.10, and now they are removed in 0.11. For the detail of this migration plan, please refer to #1337.
• Removed deprecated create_fb_matrix (#1998)
  • create_fb_matrix was replaced by melscale_fbanks in release 0.10. It is removed in 0.11. Please use melscale_fbanks.

Datasets

• Removed deprecated VCTK (#1825)
  • The original VCTK archive file is no longer accessible. Please migrate to VCTK_092 class for the latest version of the dataset.
• Removed deprecated dataset utils (#1826)
  • Undocumented methods diskcache_iterator and bg_iterator were deprecated in 0.10. They are removed in 0.11. Please cease the usage of them.

Models

• Removed unused dimension from pretrained Wav2Vec2 ASR (#1914)
  • The final linear layer of Wav2Vec2 ASR models included dimensions (<s>, <pad>, </s>, <unk>) that were not related to ASR tasks and not used. These dimensions were removed.

Build

• Dropped support for Python3.6 (#2119, #2139)
  • Following the lifecycle of Python-3.6, torchaudio dropped the support for Python 3.6.

New Features

RNN-T Emformer

• Introduced Emformer (#1801)
• Added Emformer RNN-T model (#2003)
• Added RNN-T beam search decoder (#2028)
• Cleaned up Emformer module (#2091)
• Added pretrained Emformer RNN-T streaming ASR inference pipeline (#2093)
• Reorganized RNN-T components in prototype module (#2110)
• Added integration test for Emformer RNN-T LibriSpeech pipeline (#2172)
• Registered RNN-T pipeline global stats constants as buffers (#2175)
• Refactored RNN-T factory function to support num_symbols argument (#2178)
• Fixed output shape description in RNN-T docstrings (#2179)
• Removed invalid token blanking logic from RNN-T decoder (#2180)
• Updated stale prototype references (#2189)
• Revised RNN-T pipeline streaming decoding logic (#2192)
• Cleaned up Emformer (#2207)
• Applied minor fixes to Emformer implementation (#2252)

Conformer

• Introduced Conformer (#2068)
• Removed subsampling and positional embedding logic from Conformer (#2171)
• Moved ASR features out of prototype (#2187)
• Passed bias and dropout args to Conformer convolution block (#2215)
• Adjusted Conformer args (#2223)

Datasets

• Added DR-VCTK dataset (#1819)

Models

• Added HuBERT pretrain model to enable training from scratch (#2064)
• Added feature mean square value to HuBERT Pretrain model output (#2128)

Pipelines

• Added wav2vec2 ASR French pretrained from voxpopuli (#1919)
• Added wav2vec2 ASR Spanish pretrained model from voxpopuli (#1924)
• Added wav2vec2 ASR German pretrained model from voxpopuli (#1953)
• Added wav2vec2 ASR Italian pretrained model from voxpopuli (#1954)
• Added wav2vec2 ASR English pretrained model from voxpopuli (#1956)

Build

• Added CUDA-11.5 builds to torchaudio (#2067)

Improvements

I/O

• Fixed load behavior for 24-bit input (#2084)

Ops

• Added OpenMP support (#1761)
• Improved MVDR stability (#2004)
• Relaxed dtype for MVDR (#2024)
• Added warnings in mu_law* for the wrong input type (#2034)
• Added parameter p to TimeMasking (#2090)
• Removed unused vars from RNN-T loss (#2142)
• Removed complex32 dtype in F.griffinlim (#2233)

Datasets

• Deprecated data utils (#2073)
• Updated URLs for libritts (#2074)
• Added subset support for TEDLIUM release3 dataset (#2157)

Models

• Replaced dropout with Dropout (#1815)
• Inplace initialization of RNN weights (#2010)
• Updated to xavier_uniform and avoid legacy data.uniform_ initialization (#2018)
• Allowed Tacotron2 decode batch_size 1 examples (#2156)

Pipelines

• Added tool to convert voxpopuli model (#1923)
• Refactored wav2vec2 pipeline util (#1925)
• Allowed the customization of axis exclusion for ASR head (#1932)
• Tweaked wav2vec2 checkpoint conversion tool (#1938)
• Added melkwargs setting for MFCC in HuBERT pipeline (#1949)

Documentation

• Added 0.10.0 to version compatibility matrix (#1862)
• Removed MACOSX_DEPLOYMENT_TARGET (#1880)
• Updated intersphinx inventory (#1893)
• Updated compatibility matrix to include LTS version (#1896)
• Updated CONTRIBUTING with doc conventions (#1898)
• Added anaconda stats to README (#1910)
• Updated README.md (#1916)
• Added citation information (#1947)
• Updated CONTRIBUTING.md (#1975)
• Doc fixes (#1982)
• Added tutorial to CONTRIBUTING (#1990)
• Fixed docstring (#2002)
• Fixed minor typo (#2012)
• Updated audio augmentation tutorial (#2082)
• Added Sphinx gallery automatically (#2101)
• Disabled matplotlib warning in tutorial rendering (#2107)
• Updated prototype documentations (#2108)
• Added custom CSS to make signatures appear in multi-line (#2123)
• Updated prototype pipeline documentation (#2148)
• Tweaked documentation (#2152)

Tests

• Refactored integration test (#1922)
• Enabled integration tests on CI (#1939)
• Removed facebook folder in wav2vec unit tests (#2015)
• Temporarily skipped threadpool test (#2025)
• Revised Griffin-Lim transform test to reduce execution time (#2037)
• Fixed CircleCI test failures (#2069)
• Do not auto-skip tests on CI (#2127)
• Relaxed absolute tolerance for Kaldi compat tests (#2165)
• Added tacotron2 unit test with different batch_size (#2176)

Build

• Updated GPU resource class (#1791)
• Updated the main version to 0.11.0 (#1793)
• Updated windows cuda installer 11.1.0 to 11.1.1 (#1795)
• Renamed build_tools to tools (#1812)
• Limit Windows GPU testing to CUDA-11.3 only (#1842)
• Used cu113 for unittest_windows_gpu (#1853)
• USE_CUDA in windows and reduce one vcvarsall (#1854)
• Check torch installation before building package (#1867)
• Install tools from conda instead of brew (#1873)
• Cleaned up setup.py (#1900)
• Moved TorchAudio conda package to use pytorch-mutex (#1904)
• Updated smoke test docker image (#1905)
• Fixed formatting CIRCLECI_TAG when building docs (#1915)
• Fetch third party sources automatically (#1966)
• Disabled SPHINXOPT=-W for local env (#2013)
• Improved installing nightly pytorch (#2026)
• Improved cuda installation on windows (#2032)
• Refactored the library loading mechanism (#2038)
• Cleaned up libtorchaudio customization logic (#2039)
• Refactored and functionize the library definition (#2040)
• Introduced helper function to define extension (#2077)
• Standardized the location of third-party source code (#2086)
• Show lint diff with color (#2102)
• Updated third party submodule setup (#2132)
• Suppressed stderr from subprocess in setup.py (#2133)
• Fixed header include (#2135)
• Updated ROCM version 4.1 -> 4.3.1 and 4.5 (#2186)
• Added "cu102" back (#2190)
• Pinned flake8 version (#2191)

Style

• Removed trailing whitespace (#1803)
• Fixed style checks (#1913)
• Resolved lint warning (#1971)
• Enabled CLANGFORMAT (#1999)
• Fixed style checks in examples/tutorials (#2006)
• OSS config for lint checks (#2066)
• Excluded sphinx-gallery examples (#2071)
• Reverted linting exemptions introduced in #2071 (#2087)
• Applied arc lint to pytorch audio (#2096)
• Enforced lint checks and fix/mute lint errors (#2116)

Other

• Replaced issue templates with new issue forms (#1802)
• Notify merger if PR is incorrectly labeled (#1937)
• Added script to collect PRs between commits (#1943)
• Fixed PR labeling requirement (#1946)
• Refactored collecting-PR script for release note (#1951)
• Fixed bandit failure (#1960)
• Renamed bug fix label (#1961)
• Updated PR label notifier (#1964)
• Reverted "Update PR label notifier (#1964)" (#1965)
• Consolidated network utils (#1974)
• Added PR collecting script (#2008)
• Re-sync with internal repository (#2017)
• Updated script for getting PR merger and labels (#2030)
• Fixed third party archive fetch job (#2095)
• Use python:3.X Docker image for build doc (#2151)
• Updated PR labeling workflow (#2160)
• Fixed librosa calls (#2208)

Examples

Ops

• Removed the MVDR tutorial in examples (#2109)
• Abstracted BucketizeSampler to be usable outside of HuBERT example (#2147)
• Refactored BucketizeBatchSampler and HuBERTDataset (#2150)
• Removed multiprocessing from audio dataset tutorial (#2163)

Models

• Added training recipe for RNN-T Emformer ASR model (#2052)
• Added global stats script and new json for LibriSpeech RNN-T training recipe (#2183)

Pipelines

• Added preprocessing scripts for HuBERT model training (#1911)
• Supported multi-node training for source separation pipeline (#1968)
• Added bucketize sampler and dataset for HuBERT Base model training pipeline (#2000)
• Added librispeech inference script (#2130)

Other

• Added unmaintained warnings (#1813)
• torch.quantization -> torch.ao.quantization (#1823)
• Use download.pytorch.org for asset URL (#2182)
• Added deprecation path for renamed training type plugins (#11227)
• Renamed DDPPlugin to DDPStrategy (#11142)