Document system package requirements

persephone-tools / persephone-web-API

Web API for use with the Persephone library

GNU Affero General Public License v3.0

8 stars 2 forks source link

Document system package requirements #102

Closed shuttle1987 closed 5 years ago

shuttle1987 commented 5 years ago

Various system packages must be installed, including:

ffmpeg
sox
Kaldi for pitch features

shuttle1987 commented 5 years ago

It seems like Kaldi is required in order to support functionality such as filterbank_and_pitch features

oadams commented 5 years ago

That is correct. For serious users, having the pitch features will be valuable if dealing with tonal languages (and often even if the languages aren't tonal), but it adds another step in the installation pipeline. Building these Kaldi binaries is straightforward though.