sherpa

sherpa is an open-source speech-to-text (i.e., speech recognition) framework, focusing exclusively on end-to-end (E2E) models, namely transducer- and CTC-based models.

Note: There is no plan to support attention-based encoder-decoder (AED) models.

Installation

Please first install:

git clone https://github.com/k2-fsa/sherpa
cd sherpa
mkdir build
cd build
cmake \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_INSTALL_PREFIX=$HOME/software/sherpa \
  ..
make -j6 install/strip

# If you don't want to strip the binaries and libraries, you can
# use "make -j6 install"

export PATH=$HOME/software/sherpa/bin:$PATH

# To uninstall sherpa, use
#  rm -rf $HOME/software/sherpa

git clone https://github.com/k2-fsa/sherpa
cd sherpa

python3 setup.py bdist_wheel
pip install ./dist/k2_sherpa-*.whl

# Please don't use `python3 setup.py install`.
# Otherwise, you won't have access to pre-compiled binaries

# To uninstall sherpa, use
#  pip uninstall k2-sherpa

Using Docker

docker build . -f Dockerfile -t sherpa_server:latest
docker run --rm --gpus all --name sherpa_server --net host -it sherpa_server:latest

To check that you have installed sherpa successfully, you can run the following binaries:

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

Usages

See documentation at https://k2-fsa.github.io/sherpa/ for more usages.

Metadata

Release files for k2-sherpa 1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for k2-sherpa 1.2
File	Size	Uploaded	Provenance
k2-sherpa-1.2.tar.gz	608.1 kB	Mar 10, 2023	Without provenance	Details

Release files / k2-sherpa-1.2.tar.gz

Download URL	k2-sherpa-1.2.tar.gz
Size	608.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`db17c57bec3d73a47457b2c2c20b67079ac5b563bc0446213686d33e6ccf7a7d`
BLAKE2b-256 checksum How to use checksums	`1124931129330992188509eea84d49122f0cf0447a2fe0f5db750fdfc64f27eb`
Upload date	Mar 10, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.8.16`

Security for k2-sherpa 1.2

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.