pronounce: A library for interfacing with the CMU Pronouncing Dictionary

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

Text.Pronounce is a Haskell library for interfacing and CMU Pronouncing Dictionary. It is based off of Allison Parrish's python library called pronouncing, and it exports much of the same functionality. The underlying data structure that I used for representing the dictionary was a Map from entries to lists of their possible phones as represented in the CMU dict. Many functions rely on access to the CMU dict, so I decided to encompass this underlying state of the dictionary by using the Reader Monad.

When working with this library, the default setting is to load the dictionary from an included binary file, but the user has the option to parse the dictionary from a unicode text file, or encode the text file into binary themselves. For this last purpose, I included the script I originally used to encode the dictionary into a binary in the examples folder.

Finally, I would like to note that Text.Pronounce.ParseDict operates on utf8 encoded files, due to compatibility with Text, which is utf encoded, despite the fact the original CMU Pronouncing Dictionary uses latin1 encoding. Because of this, if the user wants to use a version of the CMU Dictionary other than the included one, they must change to encoding to utf before parsing.


[Skip to ReadMe]

Properties

Versions1.1.0.1, 1.1.0.2, 1.1.0.2, 1.1.0.3, 1.2.0.0
Change logChangeLog.md
Dependenciesbase (==4.10.*), binary (>=0.8.4), containers (==0.5.*), filepath (==1.4.*), mtl (==2.2.*), text (==1.2.*) [details]
LicenseBSD-3-Clause
AuthorNoah Goodman
Maintainerngoodman@uchicago.edu
CategoryText
Home pagehttps://github.com/buonuomo/Text.Pronounce
Source repositoryhead: git clone https://github.com/buonuomo/Text.Pronounce.git
UploadedSun May 13 07:25:09 UTC 2018 by NoahGoodman

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for pronounce-1.1.0.2

[back to package description]

Text.Pronounce

A pronunciation and rhyming library that uses the CMU Pronouncing Dictionary

This package is a basic interface for the Carnegie Mellon University Pronouncing Dictionary, based off of Allison Parrish's Python API, pronouncing.

Installation

In general, a cabal sandbox is the safest and easiest way to install most Haskell packages, so I recommend running

cabal sandbox init
cabal update
cabal install pronounce

in the project directory where you would like to use Text.Pronounce.

Documentation

A general overview and information about the package can be found on Text.Pronounce's Hackage page

For basic descriptions of the package's exports, the Haddockumentation can also be found on Hackage at this address.