pronounce: A library for interfacing with the CMU Pronouncing Dictionary

[ bsd3, library, text ] [ Propose Tags ]

Text.Pronounce is a Haskell library for interfacing and CMU Pronouncing Dictionary. It is based off of Allison Parrish's python library 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]
Versions [faq] 1.1.0.1, 1.1.0.2, 1.1.0.3, 1.2.0.0
Change log ChangeLog.md
Dependencies base (>=4.10 && <4.12), binary (>=0.8.4 && <0.9), containers (==0.5.*), filepath (==1.4.*), mtl (==2.2.*), text (==1.2.*) [details]
License BSD-3-Clause
Author Noah Goodman
Maintainer ngoodman@uchicago.edu
Category Text
Home page https://github.com/buonuomo/Text.Pronounce
Source repo head: git clone https://github.com/buonuomo/Text.Pronounce.git
Uploaded by NoahGoodman at Thu Jul 26 10:45:37 UTC 2018
Distributions NixOS:1.2.0.0
Downloads 1470 total (159 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2018-07-26 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for pronounce-1.1.0.3

[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.