@stdlib/datasets-cmudict NPM

CMUdict

The Carnegie Mellon Pronouncing Dictionary.

The Carnegie Mellon University Pronouncing Dictionary (CMUDict), created by the Speech Group in the School of Computer Science at CMU, is "an open-source machine-readable pronunciation dictionary for North American English that contains over 134,000 words".

Installation

npm install @stdlib/datasets-cmudict

Usage

var cmudict = require( '@stdlib/datasets-cmudict' );

cmudict( [options] )

Returns datasets from the Carnegie Mellon Pronouncing Dictionary (CMUdict).

var data = cmudict();
/* returns
    {
        'dict': {...},
        'phones': {...},
        'symbols': [...],
        'vp': {...}
    }
*/

The function accepts the following options:

data: dataset name. The following names are recognized:
- dict: the main pronouncing dictionary
- phones: manners of articulation for each sound
- symbols: complete list of ARPABET symbols used by the dictionary
- vp: verbal pronunciations of punctuation marks

To only return the main pronouncing dictionary, set the data option to dict.

var opts = {
    'data': 'dict'
};

var data = cmudict( opts );
/* returns
    {
        'A': 'AH0',
        'A(1)': 'EY1',
        'A\'S': 'EY1 Z',
        // ...
    }
*/

To return only sound articulation manners, set the data option to phones.

var opts = {
    'data': 'phones'
};

var data = cmudict( opts );
/* returns
    {
        'AA': 'vowel',
        'AE': 'vowel',
        'AH': 'vowel',
        // ...
    }
*/

To return only ARPABET symbols used by the dictionary, set the data option to symbols.

var opts = {
    'data': 'symbols'
};

var data = cmudict( opts );
/* returns
    [
        'AA',
        'AA0',
        'AA1',
        // ...
    ]
*/

To return only the verbal pronunciations of punctuation marks, set the data option to vp.

var opts = {
    'data': 'vp'
};

var data = cmudict( opts );
/* returns
    {
        '!exclamation-point': 'EH2 K S K L AH0 M EY1 SH AH0 N P OY2 N T',
        '"close-quote': 'K L OW1 Z K W OW1 T',
        '"double-quote': 'D AH1 B AH0 L K W OW1 T',
        // ...
    }
*/

Notes

Vowels carry a lexical stress marker (0: No stress, 1: Primary stress, 2: Secondary stress).
The phoneme set is based on the ARPAbet symbol set developed for speech recognition.

Examples

var cmudict = require( '@stdlib/datasets-cmudict' );

var opts = {};

opts.data = 'phones';
console.dir( cmudict( opts ) );

opts.data = 'symbols';
console.dir( cmudict( opts ) );

opts.data = 'dict';
console.dir( cmudict( opts ) );

License

The data files (databases) and their contents are licensed under a BSD-2-Clause license. The software is licensed under Apache License, Version 2.0.

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.