Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher Bryant committed Jul 10, 2017
1 parent bbf0928 commit 9ee8e9c
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,24 @@ If you make use of this code, please cite the above papers.
The main aim of ERRANT is to automatically annotate parallel English sentences with error type information. Specifically, given an original and corrected sentence pair, ERRANT will extract the edits that transform the former to the latter and then classify them according to a rule-based error type framework. The annotated output file is in M2 format.

### Example:
Original:     This are gramamtical sentence .
Corrected:     This is a grammatical sentence .
Output M2:      S This are gramamtical sentence .
        A 1 2|||R:VERB:SVA|||is|||REQUIRED|||-NONE-|||0
        A 2 2|||M:DET|||a|||REQUIRED|||-NONE-|||0
        A 2 3|||R:SPELL|||grammatical|||REQUIRED|||-NONE-|||0
        A -1 -1|||noop|||-NONE-|||REQUIRED|||-NONE-|||1
Original:
This are gramamtical sentence .
Corrected:
This is a grammatical sentence .
Output M2:
S This are gramamtical sentence .
A 1 2|||R:VERB:SVA|||is|||REQUIRED|||-NONE-|||0
A 2 2|||M:DET|||a|||REQUIRED|||-NONE-|||0
A 2 3|||R:SPELL|||grammatical|||REQUIRED|||-NONE-|||0
A -1 -1|||noop|||-NONE-|||REQUIRED|||-NONE-|||1

In M2 format, a line preceded by S denotes an original sentence while a line preceded by A indicates an edit annotation. Each edit line consists of the start and end token offset of the edit, the error type, and the tokenized correction string. The next two fields are included for historical reasons (see the CoNLL-2014 shared task) while the last field is the annotator id.

A "noop" edit is a special kind of edit that explicitly indicates an annotator/system made no changes to the original sentence. If there is only one annotator, noop edits are optional, otherwise a noop edit should be included whenever at least 1 out of n annotators considered the original sentence to be correct. This is something to be aware of when combining individual m2 files, as missing noops can affect results.

# Pre-requisites

Currently, we only support Python 3. You may need `sudo` access to install the following libraries, or else you can install everything in a [virtualenv](http://python-guide-pt-br.readthedocs.io/en/latest/dev/virtualenvs/).
Currently, we only support Python 3. It is safest to install everything in a clean [virtualenv](http://python-guide-pt-br.readthedocs.io/en/latest/dev/virtualenvs/) since we have had reports of conflicting dependencies.

## spaCy

Expand Down

0 comments on commit 9ee8e9c

Please sign in to comment.