Installation

BenchmarkSTT requires Python version 3.5 or above. If you wish to make use of the API, Python version 3.6 or above is required.

From PyPI (preferred)

This is the easiest and preferred way of installing benchmarkstt.

1. Install Python 3.5 or above (latest stable version for your OS is preferred):

   Use the guides available at The Hitchhiker’s Guide to Python

   • Installing Python 3 on Mac OS X

   • Installing Python 3 on Windows

   • Installing Python 3 on Linux

Warning

Some dependent packages require python-dev to be installed. On Debian-based systems this can be done using e.g. apt-get install python3.7-dev for Python 3.7, Red Hat-based systems would use e.g. yum install python3.7-devel.

2. Install the package using pip, this will also install all requirements:

   python3 -m pip install benchmarkstt
   

3. Test and use

   BenchmarkSTT should now be installed and usable.

   $> benchmarkstt --version

   benchmarkstt: 1.1

   $> echo IT WORKS! | benchmarkstt-tools normalization --lowercase

   it works!

   Use the --help option to get all available options:

   benchmarkstt --help
   benchmarkstt-tools normalization --help
   

   See Usage for more information on how to use.

From the repository

For building the documentation locally and working with a development copy see Development

Removing benchmarkstt

BenchmarkSTT can be easily uninstalled using:

python3 -m pip uninstall benchmarkstt

Docker

See instructions for setting up and running as a docker image at:

• Using docker
  • Build the image
  • Run the image
  • Stopping the image