compromise

natural-language processing in the browser

_{by Spencer Kelly and contributors}

npm install compromise@next

_{(formerly nlp_compromise)}

inspect and play with english text

focus on being handy, and not overly-fancy.

nlp('I look just like buddy holly').sentences().toPastTense().out('text')
// "I looked just like buddy holly."

Demos   |   Quick-start   |   Docs   |   Accuracy

:boom:Welcome to v7:boom:

a lot has changed!

Yup,

• a 200k js file
• 86% on the Penn treebank
• keypress speed, constant-time.
• caniuse, uhuh. IE9+
• no dependencies, training, configuration, or prolog

###Grammar, for the win:

r = nlp('john is really nice. sara quickly walks.')

//pluck-out some parts
r.remove('#Adverb')

//reach-in and transform parts
r.match('#Person').toTitleCase()

r.plaintext()
// 'John is nice. Sara walks.'

###Conjugation:

r = nlp('she sells seashells by the seashore.').sentences().toFuture().text()
//'she will sell seashells...'

r.verbs().conjugate()
// [{ PastTense: 'sold',
//    Infinitive: 'sell',
//    Gerund: 'selling', ...
// }]

###Plural/singular:

r = nlp('a bottle of beer on the wall.')
r.nouns().first().toPlural()
r.text()
//'The bottles of beer on the wall.'

###Negation:

r = nlp('london is calling')
r.sentences().toNegative()
// 'london is not calling'

###Number interpretation:

r = nlp('fifth of december')

r.values().toCardinal().text()
// 'five of december'

r.values().toNumber().text()
// '5 of december'

###Clever normalization:

r = nlp("the guest-singer's björk at seven thirty.").normalize().text()
// 'The guest singer is Bjork at 7:30.'

###Named-entity recognition:

r = nlp('the opera about richard nixon visiting china')
r.match('(#Person|#Place|#Organization)').data()
// [
//   { text: 'richard nixon', tags: ['Person'] },
//   { text: 'china', tags: ['Place', 'Country'] }
// ]

###Fancy outputs:

r = nlp('Tony Hawk won').asHtml()
/*
<span>
  <span class="Person Noun MalePerson">Tony Hawk</span>
  <span>&nbsp;</span>
  <span class="Verb PastTense">won</span>
</span>
*/

and yes, ofcourse, there's a lot more stuff.

###Join-in:

we're fun, we're using semver, and moving fast. :hammer_and_wrench: get involved :dancer:

 

#See also For the former promise-library, see jnewman/compromise (Thanks to the awesome jnewman for the npm package!)

• naturalNode - decidedly fancier, statistical nlp in javascript
• SuperScript - clever conversation engine in javascript
• NodeBox Linguistics - conjugation, inflection in javascript
• reText - very impressive text utilities in javascript
• jsPos - js-build of the time-tested Brill-tagger
• spaCy - speedy, multilingual tagger in C/python

(don't forget NLTK, GATE, Stanford, and Illinois toolkit )