mirrors/icefall
1
0
Fork 0
mirror of https://github.com/k2-fsa/icefall.git synced 2025-08-08 09:32:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
icefall/README.md
Fangjun Kuang 12a2fd023e
Add doc about installation and usage (#7) 
* Add readme.

* Add TOC.

* fix typos

* Minor fixes after review.
2021-08-12 12:44:04 +08:00

1.7 KiB
Raw Blame History

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.

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.