Package: reynir-correct
GreynirCorrect: Spelling and grammar correction for IcelandicOverviewGreynirCorrectis a Python 3 (>= 3.8) package and command line tool forchecking and correcting spelling and grammarin Icelandic text.GreynirCorrect relies on theGreynirpackage,
by the same authors, to tokenize and parse text.GreynirCorrect is documented in detailhere.The software has three main modes of operation, described below.As a fourth alternative, you can call the JSON REST API
ofYfirlestur.isto apply the GreynirCorrect spelling and grammar engine to your text,
asdocumented here.Token-level correctionGreynirCorrect 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 analysisGreynirCorrect 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 toolGreynirCorrect can be invoked as a command-line tool
to perform token-level correction and, optionally, grammar analysis.
The command iscorrect infile.txt outfile.txt.
The command-line tool is further documented below.ExamplesTo perform token-level correction from Python code:>>>fromreynir_correctimporttokenize>>>g=tokenize("Af gefnu tilefni fékk fékk daninn vilja sýnum ">>>"framgengt í auknu mæli.")>>>fortoking:>>>print("{0:10}{1}".format(tok.txtor"",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:fromreynir_correctimportcheck_singlesent=check_single("Páli, vini mínum, langaði að horfa á sjónnvarpið.")forannotationinsent.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_textOutput:'Páli, vini mínum, langaði að horfa á sjónvarpið.'Theannotation.startandannotation.endproperties
(herestartis 0 andendis 4) contain the 0-based indices of the first
and last tokens to which the annotation applies.
Theannotation.start_charandannotation.end_charproperties
contain the indices of the first and last character to which the
annotation applies, within the original input string.P_WRONG_CASE_þgf_þfandS004are error codes.For more detailed, low-level control, thecheck_errors()function
supports options and can produce various types of output:fromreynir_correctimportcheck_errorsx="Páli, vini mínum, langaði að horfa á sjónnvarpið."options={"input":x,"annotations":True,"format":"text"}s=check_errors(**options)foriins.split("\n"):print(i)Output:Pál, vin minn, langaði að horfa á sjónvarpið.
000-004: P_WRONG_CASE_þgf_þf Á líklega að vera 'Pál, vin minn' | 'Páli, vini mínum,' -> 'Pál, vin minn' | None
009-009: S004   Orðið 'sjónnvarpið' var leiðrétt í 'sjónvarpið' | 'sjónnvarpið' -> 'sjónvarpið' | NoneThe following options can be specified:OptionDescriptionDefault valueinputDefines the input. Can be a string or an
iterable of strings, such as a file object.sys.stdinall_errors(aliasgrammar)Defines the level of correction.
If False, only token-level annotation is
carried out. If True, sentence-level
annotation is carried out.Trueannotate_unparsed_sentencesIf True, sentences that cannot be parsed
are annotated in their entirety as errors.Truegenerate_suggestion_listIf True, annotations can in certain
cases contain a list of possible corrections,
for the user to pick from.Falsesuppress_suggestionsIf True, more farfetched automatically
suggested corrections are suppressed.Falseignore_wordlistThe value is a set of strings to whitelist.
Each string is a word that should not be
marked as an error or corrected. The comparison
is case-sensitive.set()one_sentThe input contains a single sentence only.
Sentence splitting should not be attempted.Falseignore_rulesA set of error codes that should be ignored
in the annotation process.set()tov_configPath to an additional configuration file that
may be provided for correcting custom
tone-of-voice issues.FalseAn overview of error codes is availablehere.PrerequisitesGreynirCorrect runs on CPython 3.8 or newer, and on PyPy 3.8 or newer. It has
been tested on Linux, macOS and Windows. ThePyPi packageincludes binary wheels for common environments, but if the setup on your OS
requires compilation from sources, you may need$sudoapt-getinstallpython3-dev…or something to similar effect to enable this.InstallationTo install this package (assuming you have Python >= 3.8 withpipinstalled):$pipinstallreynir-correctIf you want to be able to edit the source, do like so
(assuming you havegitinstalled):$gitclonehttps://github.com/mideind/GreynirCorrect$cdGreynirCorrect$# [ Activate your virtualenv here if you have one ]$pipinstall-e.The package source code is now inGreynirCorrect/src/reynir_correct.The command line toolAfter installation, the corrector can be invoked directly from the command line:$correctinput.txtoutput.txt…or:$echo"Þinngið samþikkti tilöguna"|correctÞingiðsamþykktitillögunaInput and output files are encoded in UTF-8. If the files are not
given explicitly,stdinandstdoutare 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:--csvOutput token objects in CSV
format, one per line. Sentences are separated by
lines containing0,"",""--jsonOutput token objects in JSON format, one per line.--normalizeNormalize punctuation, causing e.g. quotes to be
output in Icelandic form and hyphens to be
regularized.--grammarOutput whole-sentence annotations, including
corrections and suggestions for spelling and
grammar. Each sentence in the input is output as
a text line containing a JSON object, terminated
by a newline.The CSV and JSON formats of token objects are identical to those documented
for theTokenizer package.The JSON format of whole-sentence annotations is identical to the one documented for
theYfirlestur.is HTTPS REST API.Typecorrect-hto get a short help message.Command Line Examples$echo"Atvinuleysi jógst um 3%"|correctAtvinnuleysijókstum3%$echo"Barnið vil grænann lit"|correct--csv6,"Barnið",""6,"vil",""6,"grænan",""6,"lit",""0,"",""Note howvilis not corrected, as it is a valid and common word, and
thecorrectcommand does not perform grammar checking by default.$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"}To perform whole-sentence grammar checking and annotation as well as spell checking,
use the--grammaroption:$echo"Ég kláraði verkefnið þrátt fyrir að ég var þreittur."|correct--grammar{"original":"Ég kláraði verkefnið þrátt fyrir að ég var þreittur.","corrected":"Ég kláraði verkefnið þrátt fyrir að ég var þreyttur.","tokens":[{"k":6,"x":"Ég","o":"Ég"},{"k":6,"x":"kláraði","o":" kláraði"},{"k":6,"x":"verkefnið","o":" verkefnið"},{"k":6,"x":"þrátt fyrir","o":" þrátt fyrir"},{"k":6,"x":"að","o":" að"},{"k":6,"x":"ég","o":" ég"},{"k":6,"x":"var","o":" var"},{"k":6,"x":"þreyttur","o":" þreittur"},{"k":1,"x":".","o":"."}],"annotations":[{"start":6,"end":6,"start_char":35,"end_char":37,"code":"P_MOOD_ACK","text":"Hér er réttara að nota viðtengingarhátt
            sagnarinnar 'vera', þ.e. 'væri'.","detail":"Í viðurkenningarsetningum á borð við 'Z'
            í dæminu 'X gerði Y þrátt fyrir að Z' á sögnin að vera
            í viðtengingarhætti fremur en framsöguhætti.","suggest":"væri"},{"start":7,"end":7,"start_char":38,"end_char":41,"code":"S004","text":"Orðið 'þreittur' var leiðrétt í 'þreyttur'","detail":"","suggest":"þreyttur"}]}The output has been formatted for legibility - each input sentence is actually
represented by a JSON object in a single line of text, terminated by newline.Note that thecorrectedfield only includes token-level spelling correction
(in this caseþreittur->þreyttur), but no grammar corrections.
The grammar corrections are found in theannotationslist.
To apply corrections and suggestions from the annotations,
replace source text or tokens (as identified by thestartandend,
orstart_charandend_charproperties) with thesuggestfield, if present.TestsTo run the built-in tests, installpytest,cdto yourGreynirCorrectsubdirectory (and optionally activate your
virtualenv), then run:$python-mpytestAcknowledgementsParts of this software are developed under the auspices of the
Icelandic Government’s 5-year Language Technology Programme for Icelandic,
which is managed by Almannarómur and describedhere(English versionhere).Copyright and LicenseCopyright © 2023 Miðeind ehf.GreynirCorrect’s original author isVilhjálmur Þorsteinsson.This software is licensed under theMIT License:Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the “Software”), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.GreynirCorrect indirectly embeds theDatabase of Icelandic Morphology(Beygingarlýsing íslensks nútímamáls), abbreviated BÍN,
along with directly usingRitmyndir,
a collection of non-standard word forms.
Miðeind does not claim any endorsement by the BÍN authors or copyright holders.The BÍN source data are publicly available under theCC BY-SA 4.0 license, as further
detailedhere in Englishandhere in Icelandic.In accordance with the BÍN license terms, credit is hereby given as follows:Beygingarlýsing íslensks nútímamáls. Stofnun Árna Magnússonar í íslenskum fræðum.Höfundur og ritstjóri Kristín Bjarnadóttir.