Commit a051985f authored by moto's avatar moto Committed by Facebook GitHub Bot
Browse files

Update documentation about dependencies (#3517)

Summary: Pull Request resolved: https://github.com/pytorch/audio/pull/3517

Reviewed By: huangruizhe

Differential Revision: D47858452

Pulled By: mthrok

fbshipit-source-id: 62ee6c8bb2669dd70f8ca25703a04dc8a9d19aec
parent b7d2d928
...@@ -28,21 +28,40 @@ Dependencies ...@@ -28,21 +28,40 @@ Dependencies
Optional Dependencies Optional Dependencies
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
* `FFmpeg <https://ffmpeg.org>`_. * `FFmpeg <https://ffmpeg.org>`__
Required to use :py:mod:`torchaudio.io` module. Required to use :py:mod:`torchaudio.io` module. and ``backend="ffmpeg"`` in
TorchAudio official binary distributions are compatible with FFmpeg 4.1 to 4.4. I/O functions. (:py:func:`torchaudio.info`, :py:func:`torchaudio.load`,
If you need to use FFmpeg 5, please build TorchAudio from source. :py:func:`torchaudio.save`).
* `sentencepiece <https://pypi.org/project/sentencepiece/>`_ TorchAudio official binary distributions are compatible with FFmpeg 4 to 6.
TorchAudio searches FFmpeg 6, 5 then 4. You can use the environment variable
``TORCHAUDIO_USE_FFMPEG_VERSION`` to specify the version you would like to use.
For example, ``TORCHAUDIO_USE_FFMPEG_VERSION=5``, will only search for FFmpeg 5.
If dynamic linking is causing an issue, you can set the environment variable
``TORCHAUDIO_USE_FFMPEG=0``, and TorchAudio won't use FFmpeg.
* `SoX <https://sox.sourceforge.net/>`__
Required to use ``backend="sox"`` in I/O functions. (:py:func:`torchaudio.info`,
:py:func:`torchaudio.load`, :py:func:`torchaudio.save`).
TorchAudio is tested on libsox 14.4.2. Other versions are not supported.
If dynamic linking is causing an issue, you can set the environment variable
``TORCHAUDIO_USE_SOX=0``, and TorchAudio won't use SoX.
* `sentencepiece <https://pypi.org/project/sentencepiece/>`__
Required for performing automatic speech recognition with :ref:`Emformer RNN-T<RNNT>`. Required for performing automatic speech recognition with :ref:`Emformer RNN-T<RNNT>`.
* `deep-phonemizer <https://pypi.org/project/deep-phonemizer/>`_ * `deep-phonemizer <https://pypi.org/project/deep-phonemizer/>`__
Required for performing text-to-speech with :ref:`Tacotron2`. Required for performing text-to-speech with :ref:`Tacotron2`.
* `kaldi_io <https://pypi.org/project/kaldi-io/>`_ * `kaldi_io <https://pypi.org/project/kaldi-io/>`__
Required to use :py:mod:`torchaudio.kaldi_io` module. Required to use :py:mod:`torchaudio.kaldi_io` module.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment