Skip to main content

A spelling and grammar corrector for Icelandic

Project description

https://github.com/mideind/GreynirCorrect/workflows/Python%20package/badge.svg?branch=master

Overview

GreynirCorrect is a Python 3 (>= 3.6) package and command line tool for checking and correcting spelling and grammar in Icelandic text.

GreynirCorrect relies on the Greynir package, by the same authors, to tokenize and parse text.

GreynirCorrect is documented in detail here.

The software has three main modes of operation, described below.

Token-level correction

GreynirCorrect can tokenize text and return an automatically corrected token stream. This catches token-level errors, such as spelling errors and erroneous phrases, but not grammatical errors. Token-level correction is relatively fast.

Full grammar analysis

GreynirCorrect can analyze text grammatically by attempting to parse it, after token-level correction. The parsing is done according to Greynir’s context-free grammar for Icelandic, augmented with additional production rules for common grammatical errors. The analysis returns a set of annotations (errors and suggestions) that apply to spans (consecutive tokens) within sentences in the resulting token list. Full grammar analysis is considerably slower than token-level correction.

Command-line tool

GreynirCorrect can be invoked as a command-line tool to perform token-level correction. The command is correct infile.txt outfile.txt. The command-line tool is further documented below.

Examples

To perform token-level correction from Python code:

>>> from reynir_correct import tokenize
>>> g = tokenize("Af gefnu tilefni fékk fékk daninn vilja sýnum "
>>>     "framgengt í auknu mæli.")
>>> for tok in g:
>>>     print("{0:10} {1}".format(tok.txt or "", tok.error_description))

Output:

Að         Orðasambandið 'Af gefnu tilefni' var leiðrétt í 'að gefnu tilefni'
gefnu
tilefni
fékk       Endurtekið orð ('fékk') var fellt burt
Daninn     Orð á að byrja á hástaf: 'daninn'
vilja      Orðasambandið 'vilja sýnum framgengt' var leiðrétt í 'vilja sínum framgengt'
sínum
framgengt
í          Orðasambandið 'í auknu mæli' var leiðrétt í 'í auknum mæli'
auknum
mæli
.

To perform full spelling and grammar analysis of a sentence from Python code:

from reynir_correct import check_single
sent = check_single("Páli, vini mínum, langaði að horfa á sjónnvarpið.")
for annotation in sent.annotations:
    print("{0}".format(annotation))

Output:

000-004: P_WRONG_CASE_þgf_þf Á líklega að vera 'Pál, vin minn' / [Pál , vin minn]
009-009: S004   Orðið 'sjónnvarpið' var leiðrétt í 'sjónvarpið'
sent.tidy_text

Output:

'Páli, vini mínum, langaði að horfa á sjónvarpið.'

Note that the annotation.start and annotation.end properties (here start is 0 and end is 4) contain the indices of the first and last tokens to which the annotation applies. P_WRONG_CASE_þgf_þf and S004 are error codes.

Prerequisites

GreynirCorrect runs on CPython 3.6 or newer, and on PyPy 3.6 or newer. It has been tested on Linux, MacOS and Windows. The PyPi package includes binary wheels for common environments, but if the setup on your OS requires compilation from sources, you may need

$ sudo apt-get install python3-dev

…or something to similar effect to enable this.

Installation

To install this package (assuming you have Python 3 with pip installed):

$ pip install reynir-correct

If you want to be able to edit the source, do like so (assuming you have git installed):

$ git clone https://github.com/mideind/GreynirCorrect
$ cd GreynirCorrect
$ # [ Activate your virtualenv here if you have one ]
$ pip install -e .

The package source code is now in GreynirCorrect/src/reynir_correct.

The command line tool

After installation, the corrector can be invoked directly from the command line:

$ correct input.txt output.txt

…or:

$ echo "Þinngið samþikkti tilöguna" | correct
Þingið samþykkti tillöguna

Input and output files are encoded in UTF-8. If the files are not given explicitly, stdin and stdout are used for input and output, respectively.

Empty lines in the input are treated as sentence boundaries.

By default, the output consists of one sentence per line, where each line ends with a single newline character (ASCII LF, chr(10), "\n"). Within each line, tokens are separated by spaces.

The following (mutually exclusive) options can be specified on the command line:

--csv
Output token objects in CSV format, one per line. Sentences are separated by lines containing 0,"",""
--json
Output token objects in JSON format, one per line.
--normalize
Normalize punctuation, causing e.g. quotes to be output in Icelandic form and hyphens to be regularized.

The CSV and JSON formats are identical to those documented for the Tokenizer package.

Type correct -h to get a short help message.

Command Line Examples

$ echo "Atvinuleysi jógst um 3%" | correct
Atvinnuleysi jókst um 3%
$ echo "Barnið vil grænann lit" | correct --csv
6,"Barnið",""
6,"vil",""
6,"grænan",""
6,"lit",""
0,"",""

Note how vil is not corrected, as it is a valid and common word, and the correct command does not perform grammar checking.

$ echo "Pakkin er fyrir hestin" | correct --json
{"k":"BEGIN SENT"}
{"k":"WORD","t":"Pakkinn"}
{"k":"WORD","t":"er"}
{"k":"WORD","t":"fyrir"}
{"k":"WORD","t":"hestinn"}
{"k":"END SENT"}

Tests

To run the built-in tests, install pytest, cd to your GreynirCorrect subdirectory (and optionally activate your virtualenv), then run:

$ python -m pytest

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for reynir-correct, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size reynir-correct-1.2.0.tar.gz (3.2 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page