# Natural Language Processing

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

> Standard library natural language processing (NLP).

## Installation

```bash
npm install @stdlib/nlp
```


## Usage

```javascript
var nlp = require( '@stdlib/nlp' );
```

#### nlp

Standard library natural language processing (NLP).

```javascript
var fcns = nlp;
// returns {...}
```


-   [`expandContractions( str )`][@stdlib/nlp/expand-contractions]: expand all contractions to their formal equivalents.
-   [`lda( docs, K[, options] )`][@stdlib/nlp/lda]: latent Dirichlet Allocation via collapsed Gibbs sampling.
-   [`porterStemmer( word )`][@stdlib/nlp/porter-stemmer]: extract the stem of a given word.
-   [`tokenize( str[, keepWhitespace] )`][@stdlib/nlp/tokenize]: tokenize a string.

## Examples

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var nlp = require( '@stdlib/nlp' );

console.log( objectKeys( nlp ) );
```


* * *

## 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]

---

## License

See [LICENSE][stdlib-license].

## Copyright

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

[npm-image]: http://img.shields.io/npm/v/@stdlib/nlp.svg
[npm-url]: https://npmjs.org/package/@stdlib/nlp

[test-image]: https://github.com/stdlib-js/nlp/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/nlp/actions/workflows/test.yml

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/nlp/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/nlp?branch=main

[dependencies-image]: https://img.shields.io/david/stdlib-js/nlp.svg
[dependencies-url]: https://david-dm.org/stdlib-js/nlp/main

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

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

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

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/nlp/main/LICENSE

[@stdlib/nlp/expand-contractions]: https://github.com/stdlib-js/nlp/tree/main/expand-contractions

[@stdlib/nlp/lda]: https://github.com/stdlib-js/nlp/tree/main/lda

[@stdlib/nlp/porter-stemmer]: https://github.com/stdlib-js/nlp/tree/main/porter-stemmer

[@stdlib/nlp/tokenize]: https://github.com/stdlib-js/nlp/tree/main/tokenize

