poplar-annotation/readme.md

web-based annotation tool for natural language processing (NLP) needs, inspired by brat rapid annotation tool.

# Poplar

[![license](https://img.shields.io/github/license/synyi/poplar.svg)](https://github.com/synyi/poplar/blob/master/LICENSE)
[![version](https://img.shields.io/npm/v/poplar-annotation.svg)](https://www.npmjs.com/package/poplar-annotation)


A web-based annotation tool for natural language processing (NLP) needs, inspired by [brat rapid annotation tool](http://brat.nlplab.org/).

![screenshot](http://i.v2ex.co/t690JyZS.png)

> Poplar is the new version of [synyi-annotation-tool](https://github.com/synyi/poplar/tree/0.5.x) and not production ready. Please report an issue if you find any problems.

## Demo

See [https://synyi.github.io/poplar/](https://synyi.github.io/poplar/)

## Quick start

### Install
```shell
npm i poplar-annotation
```
or if you'd like to use yarn
```shell
yarn add poplar-annotation
```
### Create
```typescript
import {Annotator} from 'poplar-annotation'
/**
  * Create an Annotator object
  * @param data          can be JSON or string
  * @param htmlElement   the html element to bind to
  * @param config        config object
  */
new Annotator(data: string, htmlElement: HTMLElement, config?: Object)
```

### More info

View our [API Reference](https://github.com/synyi/poplar/tree/master/doc) here.

## Want to contribute?

See our [Developer's Guide](https://github.com/synyi/poplar/blob/master/doc/Develop_Guides.md).


## Support

<img src="https://i.v2ex.co/3rLM1mvc.png" width=300>

Poplar is led by AI team at [Synyi](https://www.synyi.com/)

[Contact us](mailto:shen.yanghua@synyi.com)