Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vunb/node-crfsuite
A nodejs binding for crfsuite
https://github.com/vunb/node-crfsuite
crf crfsuite data-science node-crfsuite vntk
Last synced: about 1 month ago
JSON representation
A nodejs binding for crfsuite
- Host: GitHub
- URL: https://github.com/vunb/node-crfsuite
- Owner: vunb
- License: mit
- Created: 2017-10-24T08:56:51.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-26T07:54:11.000Z (10 months ago)
- Last Synced: 2024-04-26T12:21:33.817Z (8 months ago)
- Topics: crf, crfsuite, data-science, node-crfsuite, vntk
- Language: C++
- Size: 513 KB
- Stars: 14
- Watchers: 2
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-crfsuite
A nodejs binding for crfsuite
[](./LICENSE)
[](https://www.npmjs.com/package/crfsuite)
[](https://www.npmjs.com/package/crfsuite)
[](https://travis-ci.org/vunb/node-crfsuite)
[](https://ci.appveyor.com/project/vunb/node-crfsuite/branch/master)
> This is a link to the CRFSuite library written by Naoaki Okazaki. CRF or Conditional Random Fields are a class of statistical modeling method often applied in pattern recognition and machine learning and used for structured prediction.
# Installation
For most "standard" use cases (on Mac, Linux, or Windows on a x86 or x64 processor), `node-crfsuite` will install easy with:
> npm install crfsuite
# API Usage
## CRFSuite Tagger
```js
const crfsuite = require('crfsuite')
const tagger = new crfsuite.Tagger()
let is_opened = tagger.open('./path/to/crf.model')
console.log('File model is opened:', is_opened)
let tags = tagger.tag(input)
console.log('Tags: ', tags)
```
## CRFSuite Trainer
```js
const path = require('path')
const crfsuite = require('crfsuite')
const trainer = new crfsuite.Trainer({
debug: true
})
let model_filename = path.resolve('./model.crfsuite')
let xseq = [['walk'], ['walk', 'shop'], ['clean', 'shop']]
let yseq = ['sunny', 'sunny', 'rainy']
// submit training data to the trainer
trainer.append(xseq, yseq)
trainer.train(model_filename)
// output: ./model.crfsuite
```
# Installation Special Cases
We use [node-pre-gyp](https://github.com/mapbox/node-pre-gyp) to compile and publish binaries of the library for most common use cases (Linux, Mac, Windows on standard processor platforms). If you have a special case, `node-crfsuite` will work, but it will compile the binary during the install. Compiling with nodejs is done via [node-gyp](https://github.com/nodejs/node-gyp) which requires Python 2.x, so please ensure you have it installed and in your path for all operating systems. Python 3.x will not work.
* See [node-gyp installation prerequisites](https://github.com/nodejs/node-gyp#installation).
## Build from source
```bash
# clone the project
git clone --recursive https://github.com/vunb/node-crfsuite.git
# go to working folder
cd node-crfsuite
# install dependencies and build the binary
npm install
```
For development:
```bash
# rebuild
npm run build
# run unit-test
npm test
```
# Change Log
### 2020-03-07: Release version 1.0.1
* Add an options parameter to pass to a Trainer with a debug property to avoid writing logs to stdout. ([17](https://github.com/vunb/node-crfsuite/pull/17)) ([mathquis](https://github.com/mathquis))
* Update typescript declaration file
### 2019-07-18: Release version 1.0.0
* Convert all sources to use N-API, remove `nan`
* Add typescript declaration file
* Cleanup package dependencies
* CI Tool run & test only in node version 10 LTS
* Add project convention: `.gitattributes`, `.editorconfig`
* Enforced to use `new` keyword to create new **Tagger** and **Trainer**
### 2019-06-09: uses N-API
From `[email protected]` the library uses `N-API` to use the binary in multiple version of Node.
* [Acording to Node.js Foundation](https://medium.com/the-node-js-collection/4f35b781f00e): With N-API, native module developers can compile their module once per platform and architecture, and make it available for any version of Node.js that implements N-API. This holds true even for versions of Node.js that are built with a different VM, e.g. [Node-ChakraCore](https://github.com/nodejs/node-chakracore/).
# Contributing
Pull requests and stars are highly welcome.
For bugs and feature requests, please [create an issue](https://github.com/vunb/node-crfsuite/issues/new).