Table of Contents
Installation
icefall depends on k2 for FSA operations and lhotse for
data preparations. To use icefall, you have to install its dependencies first.
The following subsections describe how to setup the environment.
CAUTION: There are various ways to setup the environment. What we describe here is just one alternative.
Install k2
Please refer to k2's installation documentation to install k2. If you have any issues about installing k2, please open an issue at https://github.com/k2-fsa/k2/issues.
The following shows the minimal commands needed to install k2 from source:
mkdir $HOME/open-source
cd $HOME/open-source
git clone https://github.com/k2-fsa/k2.git
cd k2
mkdir build_release
cd build_release
cmake -DCMAKE_BUILD_TYPE=Release ..
make -j _k2
export PYTHONPATH=$HOME/open-source/k2/k2/python:$PYTHONPATH
export PYTHONPATH=$HOME/open-source/k2/build_release/lib:$PYTHONPATH
To check that k2 is installed successfully, please run
python3 -m k2.version
It should show the information about the environment in which k2 was built.
Install lhotse
Please refer to lhotse's installation documentation to install lhotse.
Install icefall
icefall is a set of Python scripts. What you need to do is just to set
the environment variable PYTHONPATH:
cd $HOME/open-source
git clone https://github.com/k2-fsa/icefall
cd icefall
pip install -r requirements.txt
export PYTHONPATH=$HOME/open-source/icefall:$PYTHONPATHON
To verify icefall was installed successfully, you can run:
python3 -c "import icefall; print(icefall.__file__)"
It should print the path to icefall.
Run recipes
At present, only LibriSpeech recipe is provided. Please follow egs/librispeech/ASR/README.md to run it.