Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A natural language parser for Icelandic

Project description

https://github.com/mideind/ReynirPackage/blob/master/doc/_static/ReynirLogo216.png?raw=true https://travis-ci.com/mideind/ReynirPackage.svg?branch=master

Overview

Reynir is a Python 3.x package for parsing Icelandic text into sentence trees (i.e. full constituency parse trees). The trees can then be used to extract information from the text, for instance about people, titles, entities, facts, actions and opinions.

Along the way, Reynir tokenizes the text, finds lemmas and assigns part-of-speech (POS) tags to every word.

Full documentation for Reynir is available here.

Reynir is the engine of Greynir.is, a natural-language front end for a database of 8 million sentences parsed from Icelandic news articles.

Reynir uses the Tokenizer package, by the same authors, to tokenize text.

Example

>>> from reynir import Reynir
>>> r = Reynir()
>>> sent = r.parse_single("Ása sá sól.")
>>> print(sent.tree.view)
P                               # Root
+-S-MAIN                        # Main sentence
  +-IP                          # Inflected phrase
    +-NP-SUBJ                   # Noun phrase, subject
      +-no_et_nf_kvk: 'Ása'     # Noun, singular, nominative, feminine
    +-VP                        # Verb phrase containing arguments
      +-VP                      # Verb phrase containing verb
        +-so_1_þf_et_p3: 'sá'   # Verb, 1 accusative arg, singular, 3rd p
      +-NP-OBJ                # Noun phrase, object
        +-no_et_þf_kvk: 'sól' # Noun, singular, accusative, feminine
+-'.'                           # Punctuation
>>> sent.tree.nouns
['Ása', 'sól']
>>> sent.tree.verbs
['sjá']
>>> sent.tree.flat
'P S-MAIN IP NP-SUBJ no_et_nf_kvk /NP-SUBJ VP so_1_þf_et_p3
    NP-OBJ no_et_þf_kvk /NP-OBJ /VP /IP /S-MAIN p /P'
>>> # The subject noun phrase (S.IP.NP also works)
>>> sent.tree.S.IP.NP_SUBJ.lemmas
['Ása']
>>> # The verb phrase
>>> sent.tree.S.IP.VP.lemmas
['sjá', 'sól']
>>> # The object within the verb phrase (S.IP.VP.NP also works)
>>> sent.tree.S.IP.VP.NP_OBJ.lemmas
['sól']

Prerequisites

This package runs on CPython 3.4 or newer, and on PyPy 3.5 or newer.

If a binary wheel package isn’t available on PyPi for your system, you may need to have the python3-dev and/or potentially python3.6-dev packages (or their Windows equivalents) installed on your system to set up Reynir successfully. This is because a source distribution install requires a C++ compiler and linker:

# Debian or Ubuntu:
sudo apt-get install python3-dev
sudo apt-get install python3.6-dev

Installation

To install this package:

$ pip3 install reynir   # or pip install reynir if Python3 is your default

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

$ git clone https://github.com/mideind/ReynirPackage
$ cd ReynirPackage
$ # [ Activate your virtualenv here if you have one ]
$ python setup.py develop

The package source code is now in ReynirPackage/src/reynir.

Tests

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

$ python -m pytest

Documentation

Please consult Reynir’s documentation for detailed installation instructions, a quickstart guide, and reference information, as well as important information about copyright and licensing.

Copyright and licensing

Reynir is copyright (C) 2019 by Miðeind ehf. The original author of this software is Vilhjálmur Þorsteinsson.

https://raw.githubusercontent.com/mideind/Reynir/master/static/img/GPLv3.png

This set of programs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This set of programs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

The full text of the GNU General Public License v3 is included here and also available here: https://www.gnu.org/licenses/gpl-3.0.html.

If you would like to use this software in ways that are incompatible with the standard GNU GPLv3 license, please contact Miðeind ehf. to negotiate alternative arrangements.

Download files

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

Files for reynir, version 1.9.0
Filename, size File type Python version Upload date Hashes
Filename, size reynir-1.9.0-cp34-cp34m-manylinux1_x86_64.whl (38.2 MB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size reynir-1.9.0-cp35-cp35m-manylinux1_x86_64.whl (38.2 MB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size reynir-1.9.0-cp36-cp36m-manylinux1_x86_64.whl (38.2 MB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size reynir-1.9.0-cp36-cp36m-win_amd64.whl (39.5 MB) File type Wheel Python version cp36 Upload date Hashes View hashes
Filename, size reynir-1.9.0-cp37-cp37m-manylinux1_x86_64.whl (38.2 MB) File type Wheel Python version cp37 Upload date Hashes View hashes
Filename, size reynir-1.9.0-cp38-cp38-manylinux1_x86_64.whl (38.2 MB) File type Wheel Python version cp38 Upload date Hashes View hashes
Filename, size reynir-1.9.0.tar.gz (38.2 MB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page