https://github.com/stdlib-js/datasets-cmudict

The Carnegie Mellon Pronouncing Dictionary (CMUdict).
https://github.com/stdlib-js/datasets-cmudict

data dataset datasets dictionary en english javascript language nlp node node-js nodejs pronounciation speech spelling stdlib words

Last synced: about 1 month ago
JSON representation

The Carnegie Mellon Pronouncing Dictionary (CMUdict).

Host: GitHub
URL: https://github.com/stdlib-js/datasets-cmudict
Owner: stdlib-js
License: other
Created: 2021-06-15T17:49:40.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2025-03-10T02:05:06.000Z (7 months ago)
Last Synced: 2025-04-12T20:22:16.637Z (6 months ago)
Topics: data, dataset, datasets, dictionary, en, english, javascript, language, nlp, node, node-js, nodejs, pronounciation, speech, spelling, stdlib, words
Language: JavaScript
Homepage: https://github.com/stdlib-js/stdlib
Size: 5.71 MB
Stars: 15
Watchers: 3
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md

Awesome Lists containing this project

README

          

  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

  The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

  When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

  To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!


# CMUdict

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 

> The Carnegie Mellon Pronouncing Dictionary.

The [Carnegie Mellon University Pronouncing Dictionary (CMUDict)][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

```bash

npm install @stdlib/datasets-cmudict

```

Alternatively,

-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

```javascript

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

```

#### cmudict( \[options] )

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

```javascript

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

```javascript

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

```javascript

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

```javascript

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

```javascript

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][arpabet] developed for speech recognition.

## Examples

```javascript

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 ) );

```

* * *

## CLI

## Installation

To use as a general utility, install the CLI package globally

```bash

npm install -g @stdlib/datasets-cmudict-cli

```

### Usage

```text

Usage: cmudict [options]

Options:

  -h,    --help                Print this message.

  -V,    --version             Print the package version.

         --data name           Dataset name: dict, phones, symbols, vp.

```

### Notes

-   If the `--data` option is set to a supported dataset name, the CLI prints the contents of the respective dataset file as plain text. Otherwise, the output format is newline-delimited JSON ([NDJSON][ndjson]).

### Examples

```bash

$ cmudict --data symbols

AA

AA0

AA1

AA2

...

```

* * *

## License

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

* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## Copyright

Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/datasets-cmudict.svg

[npm-url]: https://npmjs.org/package/@stdlib/datasets-cmudict

[test-image]: https://github.com/stdlib-js/datasets-cmudict/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/datasets-cmudict/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/datasets-cmudict/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/datasets-cmudict?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[cli-section]: https://github.com/stdlib-js/datasets-cmudict#cli

[cli-url]: https://github.com/stdlib-js/datasets-cmudict/tree/cli

[@stdlib/datasets-cmudict]: https://github.com/stdlib-js/datasets-cmudict/tree/main

[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/datasets-cmudict/tree/deno

[deno-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/datasets-cmudict/tree/umd

[umd-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/datasets-cmudict/tree/esm

[esm-readme]: https://github.com/stdlib-js/datasets-cmudict/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/datasets-cmudict/blob/main/branches.md

[cmudict]: http://www.speech.cs.cmu.edu/cgi-bin/cmudict#about

[arpabet]: https://en.wikipedia.org/wiki/ARPABET

[ndjson]: http://specs.frictionlessdata.io/ndjson/

[bsd-license]: https://opensource.org/licenses/bsd-license.html

[apache-license]: https://www.apache.org/licenses/LICENSE-2.0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/stdlib-js/datasets-cmudict

Awesome Lists containing this project

README