Metadata-Version: 2.1
Name: phonetisaurus
Version: 0.2.0
Summary: Python wrapper for phonetisaurus grapheme to phoneme tool
Home-page: https://github.com/rhasspy/phonetisaurus-pypi
Author: Michael Hansen
Author-email: mike@rhasspy.org
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Phonetisaurus for Python

Python wrapper for the excellent [phonetisaurus](https://github.com/AdolfVonKleist/Phonetisaurus) grapheme to phoneme tool ([license](https://github.com/AdolfVonKleist/Phonetisaurus/blob/master/LICENSE)).

Includes pre-built binaries for:

* `x86_64` - desktop/laptop/server (64-bit)
* `armv6l` - Raspberry Pi 0/1
* `armv7l` - Raspberry Pi 2/3/4 (32-bit)
* `aarch64` - Raspberry Pi 3/4 (64-bit)

## Requirements

* Python 3.7+
* Linux
    * Tested with Debian Buster

## Installing

For `x86_64` systems:

```sh
$ pip install phonetisaurus
```

For Raspberry Pi, see [Releases](https://github.com/rhasspy/phonetisaurus-pypi/releases) for compatible wheels:

* Raspberry Pi 0/1
    * `phonetisaurus-<VERSION>-py3-none-linux_armv6l.whl`
* Raspberry Pi 2/3/4 (32-bit)
    * `phonetisaurus-<VERSION>-py3-none-linux_armv7l.whl`
* Raspberry Pi 3/4 (64-bit)
    * `phonetisaurus-<VERSION>-py3-none-linux_aarch64.whl`

## Training

Assuming you have a lexicon formatted like [the CMU pronouncing dictionary](https://github.com/cmusphinx/cmudict):

```
word1 phoneme1 phoneme2 ...
word2 phoneme1 phoneme2 phoneme3 ...
```

saved to `lexicon.dict` run:

```sh
$ phonetisaurus train --model /path/to/write/g2p.fst /path/to/lexicon.dict
```

You may supply more than one lexicon.

See `phonetisaurus train --help` for more options.

## Predicting

```sh
$ phonetisaurus predict --model /path/to/g2p.fst word1 word2 ...
```

If no words are provided on the command line, they will be read line-by-line from standard in.

You may optionally supply one or more `--lexicon /path/to/lexicon.dict` arguments to avoid guessing pronunciations for known words.

See `phonetisaurus predict --help` for more options.


