Installation

Requirements

• Python 3.7+
• gcc 4.9+ for PyTorch1.10.2+

(If you'll use a conda environment at the installation step2, the following packages are installed using conda, so you can skip them.)

• cmake3 for some extensions

  # For Ubuntu
  $ sudo apt-get install cmake

• sox

  # For Ubuntu
  $ sudo apt-get install sox
  # For CentOS
  $ sudo yum install sox

• flac (This is not required when installing, but used in some recipes)

  # For Ubuntu
  $ sudo apt-get install flac
  # For CentOS
  $ sudo yum install flac

Supported Linux distributions and other requirements

We support the following Linux distributions with CI. If you want to build your own Linux by yourself, please also check our CI configurations to prepare the appropriate environments.

• ubuntu18
• centos7
• debian11
• Windows10 (installation only)
  • We can conduct complete experiments based on WSL-2 (Ubuntu 20.04). See the link and #4909 for details (Thanks, @Bereket-Desbele!)
• MacOS12 (installation only)

Step 1) [Optional] Install Kaldi

• If you use ESPnet1 (under egs/), you must compile Kaldi.
• If you use ESPnet2 (under egs2/), You can skip the installation of Kaldi.

Click to compile Kaldi...

Related links:

• Kaldi Github
• Kaldi Documentation
  • Downloading and installing Kaldi
  • The build process (how Kaldi is compiled)
• Kaldi INSTALL

Kaldi's requirements:

• OS: Ubuntu, CentOS, MacOSX, Windows, Cygwin, etc.
• GCC >= 4.7

1. Git clone Kaldi

   $ cd <any-place>
   $ git clone https://github.com/kaldi-asr/kaldi

2. Install tools

   $ cd <kaldi-root>/tools
   $ make -j <NUM-CPU>

   1. Select BLAS library from ATLAS, OpenBLAS, or MKL
   • OpenBLAS

   $ cd <kaldi-root>/tools
   $ ./extras/install_openblas.sh

   • MKL (You need sudo privilege)

   $ cd <kaldi-root>/tools
   $ sudo ./extras/install_mkl.sh

   • ATLAS (You need sudo privilege)

   # Ubuntu
   $ sudo apt-get install libatlas-base-dev

3. Compile Kaldi & install

   $ cd <kaldi-root>/src
   # [By default MKL is used] ESPnet uses only a feature extractor, so you can disable CUDA
   $ ./configure --use-cuda=no
   # [With OpenBLAS]
   # $ ./configure --openblas-root=../tools/OpenBLAS/install --use-cuda=no
   # If you'll use CUDA
   # ./configure --cudatk-dir=/usr/local/cuda-10.0
   $ make -j clean depend; make -j <NUM-CPU>

We also have prebuilt Kaldi binaries.

Step 2) Installation ESPnet

1. Git clone ESPnet

   $ cd <any-place>
   $ git clone https://github.com/espnet/espnet

2. [Optional] Put compiled Kaldi under espnet/tools

   If you have compiled Kaldi at Step 1, put it under tools.

   $ cd <espnet-root>/tools
   $ ln -s <kaldi-root> .

3. Setup Python environment

   You must create <espnet-root>/tools/activate_python.sh to specify the Python interpreter used in espnet recipes. (To understand how ESPnet specifies Python, see path.sh for example.)

   We also have some scripts to generate tools/activate_python.sh.

   • Option A) Setup conda environment

     $ cd <espnet-root>/tools
     $ ./setup_miniforge.sh [output-dir-name|default=venv] [conda-env-name|default=root] [python-version|default=none]
     # e.g.
     $ ./setup_miniforge.sh miniconda espnet 3.8

     This script tries to create a new miniconda if the output directory doesn't exist. If you already have conda and you'll use it, then,

     $ cd <espnet-root>/tools
     $ CONDA_ROOT=${CONDA_PREFIX}/../..  # CONDA_PREFIX is an environment variable set by ${CONDA_ROOT}/etc/profile.d/conda.sh
     $ ./setup_miniforge.sh ${CONDA_ROOT} [conda-env-name] [python-version]
     # e.g.
     $ ./setup_miniforge.sh ${CONDA_ROOT} espnet 3.8

   • Option B) Setup venv from the system Python

     $ cd <espnet-root>/tools
     $ ./setup_venv.sh $(command -v python3)

   • Option C) Setup system Python environment

     $ cd <espnet-root>/tools
     $ ./setup_python.sh $(command -v python3)

   • Option D) Without setting the Python environment

     Option C and Option D are almost the same. This option might be suitable for Google colab.

     $ cd <espnet-root>/tools
     $ rm -f activate_python.sh && touch activate_python.sh

4. Install ESPnet

   $ cd <espnet-root>/tools
   $ make

   The Makefile tries to install ESPnet and all dependencies, including PyTorch. You can also specify the PyTorch version, for example:

   $ cd <espnet-root>/tools
   $ make TH_VERSION=1.10.1

   Note that the CUDA version is derived from nvcc command. If you'd like to specify the other CUDA version, you need to give CUDA_VERSION.

   $ cd <espnet-root>/tools
   $ make TH_VERSION=1.10.1 CUDA_VERSION=11.3

   If you don't have nvcc command, packages are installed for CPU mode by default. If you'll turn it on manually, give CPU_ONLY option.

   $ cd <espnet-root>/tools
   $ make CPU_ONLY=0

Step 3) [Optional] Custom tool installation

Some packages used only for specific tasks, e.g., Transducer ASR, Japanese TTS, etc. are not installed by default, so if you meet some installation error when running these recipes, you need to install them optionally.

e.g.

• To install Warp Transducer

  cd <espnet-root>/tools
  cuda_root=<cuda-root>  # e.g. <cuda-root> = /usr/local/cuda
  bash -c ". activate_python.sh; . ./setup_cuda_env.sh $cuda_root; ./installers/install_warp-transducer.sh"

• To install PyOpenJTalk

  cd <espnet-root>/tools
  bash -c ". activate_python.sh; ./installers/install_pyopenjtalk.sh"

• To install a module using pip: e.g. to install ipython

  cd <espnet-root>/tools
  bash -c ". activate_python.sh; pip install ipython"

  In addition to the python libraries, you can also install several non-python libraries in the conda environment, e.g.,

  cd <espnet-root>/tools
  bash -c ". activate_python.sh; conda install cmake"

Check installation

You can check whether your installation is successfully finished by

cd <espnet-root>/tools
bash -c ". ./activate_python.sh; . ./extra_path.sh; python3 check_install.py"

Note that this check is always called in the last stage of the above installation.