Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 5.45 KB

README.md

File metadata and controls

117 lines (79 loc) · 5.45 KB
Raw

gr-nlp-toolkit

A Transformer-based natural language processing toolkit for (modern) Greek. The toolkit has state-of-the-art performance in Greek and supports:

  1. Named Entity Recognition (NER)
  2. Part-of-Speech Tagging (POS Tagging)
  3. Morphological tagging
  4. Dependency parsing
  5. Greeklish to Greek transliteration

Installation

We support Python 3.9+.

You can install the toolkit from PyPI by executing the following in the command line:

pip install gr-nlp-toolkit

Usage

Available Processors

To use the toolkit, first initialize a Pipeline specifying which processors you need. Each processor annotates the text with a specific task's annotations.

  • To obtain Part-of-Speech and Morphological Tagging annotations, add the pos processor
  • To obtain Named Entity Recognition annotations, add the ner processor
  • To obtain Dependency Parsing annotations, add the dp processor
  • To enable the transliteration from Greeklish to Greek, add the g2g processor or the g2g_lite processor for a lighter but less accurate model (Greeklish to Greek transliteration example: "thessalonikh" -> "θεσσαλονίκη")

Example Usage Scenarios

  • DP, POS, NER processors (input text in Greek)

    from gr_nlp_toolkit import Pipeline

nlp = Pipeline("pos,ner,dp")  # Instantiate the Pipeline with the DP, POS and NER processors
doc = nlp("Η Ιταλία κέρδισε την Αγγλία στον τελικό του Euro 2020.") # Apply the pipeline to a sentence in Greek

    A Document object is created and is annotated. The original text is tokenized and split to tokens

    # Iterate over the generated tokens
for token in doc.tokens:
  print(token.text) # the text of the token

  print(token.ner) # the named entity label in IOBES encoding : str

  print(token.upos) # the UPOS tag of the token
  print(token.feats) # the morphological features for the token

  print(token.head) # the head of the token
  print(token.deprel) # the dependency relation between the current token and its head

    token.ner is set by the ner processor, token.upos and token.feats are set by the pos processor and token.head and token.deprel are set by the dp processor.

    A small detail is that to get the Token object that is the head of another token you need to access doc.tokens[head-1]. The reason for this is that the enumeration of the tokens starts from 1 and when the field token.head is set to 0, that means the token is the root of the word.

  • Greeklish to Greek Conversion (input text in Greeklish)

    from gr_nlp_toolkit import Pipeline
nlp  = Pipeline("g2g")  # Instantiate the pipeline with the g2g processor

doc = nlp("O Volos kai h Larisa einai sth Thessalia") # Apply the pipeline to a sentence in Greeklish
print(doc.text) # Access the transliterated text, which is "ο Βόλος και η Λάρισα είναι στη Θεσσαλία"

  • Use all the processors together (input text in Greeklish)

    from gr_nlp_toolkit import Pipeline
nlp = Pipeline("pos,ner,dp,g2g")  # Instantiate the Pipeline with the G2G, DP, POS and NER processors

doc = nlp("O Volos kai h Larisa einai sthn Thessalia") # Apply the pipeline to a sentence in Greeklish

print(doc.text) # Print the transliterated text

# Iterate over the generated tokens
for token in doc.tokens:
  print(token.text) # the text of the token

  print(token.ner) # the named entity label in IOBES encoding : str

  print(token.upos) # the UPOS tag of the token
  print(token.feats) # the morphological features for the token

  print(token.head) # the head of the token
  print(token.deprel) # the dependency relation between the current token and its head

Notes:

  • The first time you use a processor, the models are downloaded from Hugging Face and stored into the .cache folder. The NER, DP and POS processors are each about 500 MB, while the G2G processor is about 1.2 GB in size.
  • If the input text is already in Greek, the G2G (Greeklish-to-Greek) processor is skipped.
  • If your machine has an accelerator but you want to run the process on the CPU, you can pass the flag use_cpu=True to the Pipeline object. By default, use_cpu is set to False.

Hugging Face related repositories, where the processors are downloaded from

References

  1. C. Dikonimaki, "A Transformer-based natural language processing toolkit for Greek -- Part of speech tagging and dependency parsing", BSc thesis, Department of Informatics, Athens University of Economics and Business, 2021. http://nlp.cs.aueb.gr/theses/dikonimaki_bsc_thesis.pdf

  2. N. Smyrnioudis, "A Transformer-based natural language processing toolkit for Greek -- Named entity recognition and multi-task learning", BSc thesis, Department of Informatics, Athens University of Economics and Business, 2021. http://nlp.cs.aueb.gr/theses/smyrnioudis_bsc_thesis.pdf

  3. A. Toumazatos, J. Pavlopoulos, I. Androutsopoulos, & S. Vassos, "Still All Greeklish to Me: Greeklish to Greek Transliteration." In Proceedings of the 2024 Joint International Conference on Computational Linguistics, Language Resources and Evaluation (LREC-COLING 2024) (pp. 15309–15319). https://aclanthology.org/2024.lrec-main.1330/