Installation

Before installing sherpa, we assume you have installed:

• PyTorch

• k2

• kaldifeat

You can use the following commands to install sherpa:

git clone http://github.com/k2-fsa/sherpa
cd sherpa
python3 setup.py bdist_wheel
ls -lh dist
pip install ./dist/k2_sherpa*.whl

Caution

Please don’t use python3 setup.py install. Otherwise, you won’t get sherpa related binaries installed, such as sherpa-offline and sherpa-online.

To uninstall sherpa, please use

pip uninstall k2-sherpa

To test that you have installed sherpa successfully, you can run the following commands:

sherpa-version

sherpa-offline --help
sherpa-online --help
sherpa-online-microphone --help

sherpa-offline-websocket-server --help
sherpa-offline-websocket-client --help

sherpa-online-websocket-server --help
sherpa-online-websocket-client --help
sherpa-online-websocket-client-microphone --help

If you have any issues about the installation, please create an issue at the following address:

https://github.com/k2-fsa/sherpa/issues

Hint

If you have a WeChat account, you can scan the following QR code to join the WeChat group of next-gen Kaldi to get help.

Installation for advanced users/developers

As an advanced user/developer, you can use the following method to install sherpa:

git clone http://github.com/k2-fsa/sherpa
cd sherpa
mkdir build
cd build
cmake ..
make -j

export PATH=$PWD/bin:$PATH
export PYTHONPATH=$PWD/lib:$PWD/../sherpa/python:$PYTHONPATH