lang-esu

Central Alaskan Yup'ik FST morphological analyzer/generator

https://github.com/giellalt/lang-esu

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.1%) to scientific vocabulary

Keywords

analyzer finite-state-transducer finite-state-transducers generator geo-northamerica langfam-eskimo-aleut maturity-beta morphology yugcetun yugtun yup-ik yupik
Last synced: 6 months ago · JSON representation ·

Repository

Central Alaskan Yup'ik FST morphological analyzer/generator

Basic Info
  • Host: GitHub
  • Owner: giellalt
  • License: other
  • Language: Text
  • Default Branch: main
  • Homepage:
  • Size: 4.34 MB
Statistics
  • Stars: 13
  • Watchers: 25
  • Forks: 1
  • Open Issues: 2
  • Releases: 0
Topics
analyzer finite-state-transducer finite-state-transducers generator geo-northamerica langfam-eskimo-aleut maturity-beta morphology yugcetun yugtun yup-ik yupik
Created over 6 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.md

Finite State Morphological Analyzer for Central Alaskan Yup'ik

Maturity Lemma count GitHub issues License Doc Build Status CI/CD Build Status

Download nightly / CI/CD installation packages for testing (contains the core zhfst file(s)):

Windows MacOS Mobile

NB!! Note that the nightly / CI/CD installation packages are not tested for language quality, and might contain regressions and errors.

Central Alaskan Yup'ik (CAY) (ISO 639-3: esu) is a member of the Inuit-Yupik-Unangan (IYU) (also known as Eskimo-Aleut) language family. It is spoken in south-west Alaska among the Yukon-Kuskokwim Delta and Bristol Bay areas.

This CAY morphological analyzer/generator can analyze (break the word into its individual parts) and generate (build a word from its individual parts) Yup'ik words. The underlying form is composed of morphemes represented by the analysis of Jacobson's (1984/1995/2012) dictionary and grammar book. It is build using the open source HFST tools. This project was developed with hfst 3.15.2.

Download and test speller files

The speller files downloadable at the top of this page (the *.bhfst files) can be used with divvunspell, to test their performance. These files are the exact same ones as installed on users' computers and mobile phones. Desktop and mobile speller files differ from each other in the error model and should be tested separately — thus also two different downloads.

Documentation

Documentation can be found at:

FST Stack

  1. lexc - esu.lexc - lexicon and morphotactics
  2. xfst - esu.lexc.xfst - orthography → phonemes, morphologically conditioned allomorphy
  3. twolc - esu.twol - morphophonology, phonologically conditioned allomorphy
  4. twolc - esu.stress.twol - prosodic stress marking on vowels used for prosodic adjustments
  5. xfst - esu.twol.xfst - prosodic adjustments, phonemes → orthography

Installation

  1. Install dependency: HFST tools. Tested with hfst 3.15.2.
    Note: MacOS users may have an easier time installing HFST with this Homebrew tap.

  2. Run make to run the Makefile and compile the FST stack

Output Files

  • esu.ana.hfstol: Morphological analyser

    • Input: calinrituq
    • Output: cali-–nrite[V→V][V][Intr][Ind][S_3Sg]
  • esu.gen.hfstol: Morphological generator

    • Input: cali-–nrite[V→V][V][Intr][Ind][S_3Sg]
    • Output: calinrituq
  • esu.seg.hfstol: Morphological segmenter

    • Input: calinrituq
    • Output: cali>nrit>uq

Usage

In the unix terminal, run this command to use the HFST lookup program:

echo "wordToInput" | hfst-optimized-lookup hfstName

where wordToInput is the Yup'ik word to analyze/generate and the hfstName is either: esu.ana.hfstol | esu.gen.hfstol | esu.seg.hfstol.

License

This Central Alaskan Yup'ik FST morphological analyzer/generator and the associated source code is available under the GNU Affero General Public License (GNU AGPL v.3):

Copyright (C) 2020 Lonny Alaskuk Strunk

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

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Citing

If you use language data from more than one GiellaLT language, consider citing our LREC 2022 article on whole infra:

Linda Wiechetek, Katri Hiovain-Asikainen, Inga Lill Sigga Mikkelsen, Sjur Moshagen, Flammie Pirinen, Trond Trosterud, and Børre Gaup. 2022. Unmasking the Myth of Effortless Big Data - Making an Open Source Multi-lingual Infrastructure and Building Language Resources from Scratch. In Proceedings of the Thirteenth Language Resources and Evaluation Conference, pages 1167–1177, Marseille, France. European Language Resources Association.

If you use bibtex, following is as it is on ACL anthology:

bibtex @inproceedings{wiechetek-etal-2022-unmasking, title = "Unmasking the Myth of Effortless Big Data - Making an Open Source Multi-lingual Infrastructure and Building Language Resources from Scratch", author = "Wiechetek, Linda and Hiovain-Asikainen, Katri and Mikkelsen, Inga Lill Sigga and Moshagen, Sjur and Pirinen, Flammie and Trosterud, Trond and Gaup, B{\o}rre", booktitle = "Proceedings of the Thirteenth Language Resources and Evaluation Conference", month = jun, year = "2022", address = "Marseille, France", publisher = "European Language Resources Association", url = "https://aclanthology.org/2022.lrec-1.125", pages = "1167--1177" }

Owner

  • Name: GiellaLT
  • Login: giellalt
  • Kind: organization
  • Email: giellalt@uit.no
  • Location: Tromsø

GiellaLT hosts resources for keyboards, proofing tools & text analysis for indigenous & minority languages. See also @divvun & @giellatekno.

Citation (CITATION.cff)

authors: # for whole infra, add / replace
  - family-names: Wiechetek
    given-names: Linda
    orcid: "https://orcid.org/0000-0002-5171-0841"
  - family-names: Hiovain-Asikainen
    given-names: Katri
    orcid: ""
  - family-names: Mikkelsen
    given-names: Inga Lill Sigga
    orcid: ""
  - family-names: Moshagen
    given-names: Sjur N.
    orcid: ""
  - family-names: Pirinen
    given-names: Flammie A
    orcid: "https://orcid.org/0000-0003-1207-5395"
  - family-names: Trosterud
    given-names: Trond
    orcid: ""
  - family-names: Gaup
    given-names: Børre
    orcid: ""
cff-version: 1.2.0
date-released: "2022-06-19"
identifiers:
  - description: ACL anthology
    type: url
    value: https://aclanthology.org/2022.lrec-1.125/
keywords:
  - Central Yupik
  - NLP
  - morphology
  - spell-checking
  - grammar-checking
  - stemming
  - tokenisation
message: If you use this software, please cite it using these metadata.
repository-code: "https://github.com/giellalt/lang-esu"
title: GiellaLT repository (__LANG__ language)
version: 0.0.0
preferred-citation: # whole repo, replace with specific if one exists!
  authors:
      - family-names: Wiechetek
        given-names: Linda
      - family-names: Hiovain-Asikainen
        given-names: Katri
      - family-names: Mikkelsen
        given-names: Inga Lill Sigg
      - family-names: Moshagen
        given-names: Sjur N.
      - family-names: Pirinen
        given-names: Flammie A
      - family-names: Trosterud
        given-names: Trond
      - family-names: Gaup
        given-names: Børre
  title: "Unmasking the Myth of Effortless Big Data - Making an Open Source Multi-lingual Infrastructure and Building Language Resources from Scratch"
  type: article
license: __LICENCE__
url: https://github.com/giellalt/lang-esu/

GitHub Events

Total
  • Watch event: 1
  • Push event: 38
Last Year
  • Watch event: 1
  • Push event: 38

Dependencies

.github/workflows/docsygen.yml actions
  • actions/checkout v2 composite
  • divvun/actions/lang/build master composite
  • divvun/actions/lang/install-deps master composite
  • divvun/compile-mermaid-markdown-action main composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/zulip.yml actions
  • actions/checkout v3 composite
  • actions/github-script v6 composite
  • tj-actions/changed-files v35 composite
  • zulip/github-actions-zulip/send-message v1 composite