Lingua...amadoir(3pm)

💖 Lingua::GA::Gramadoir — the vibe ✨

okay bestie, so this is Lingua::GA::Gramadoir, a 3pm Perl module, and it's literally the whole brain behind An Gramadóir — the open-source grammar + style checker for the Irish language 👑 (iykyk, it's a whole legend in the low-resource NLP world).

---

🌸 SYNOPSIS 🌸

  use Lingua::GA::Gramadoir;

  my $gr = new Lingua::GA::Gramadoir;

  my $errors = $gr->grammatical_errors( $text );
  foreach my $error (@$errors) {
        # process $error appropriately
  }

---

🦋 DESCRIPTION 🦋

This module is where all the segmentation, spell checking, part-of-speech tagging, and grammar checking code lives — the exact same code that powers "An Gramadóir", an open-source grammar and style checker you can use with vim, emacs, OpenOffice, or straight up through a command-line interface. An Gramadóir is intended as a platform for the development of sophisticated natural language processing tools for languages with limited computational resources 💅 — like, genuinely doing the most for languages that big tech forgot about, periodt.

🚨 the way that this matters: the Perl code in here is generated automatically from a higher-level representation of the grammatical rules, so do not edit it directly. fr fr. If you wanna help improve the lexicon or the rule sets, download the developers' pack from the An Gramadóir web site: <http://borel.slu.edu/gramadoir/> 🫶

---

✨ CONSTRUCTOR ✨

• new %PARAMS — Constructs an instance of the grammar checker and loads the lexicon into memory. It should only be called once 👑. Options may be specified by passing a hash containing any of the following keys:
  • fix_spelling => 0 — Suggest replacements for misspelled or unknown words. 🔍
  • use_ignore_file => 0 — Read a file containing words to be ignored when checking spelling and grammar. 🙈
  • unigram_tagging => 1 — Resolve ambiguous part of speech according to frequency. This should be set to false only for debugging purposes, because the pattern matching for grammatical errors relies on complete disambiguation — turn this off and the whole vibe check fails, no cap 💀.
  • interface_language => "" — Specify the language of output messages (not necessarily the language of the text to be checked). With the default value, Locale::Maketext attempts to determine the correct language to use based on things like your environment variables 🌈.
  • input_encoding => 'ISO-8859-1' — Specify the encoding for all texts passed to one of the module's exported functions. There is no currently no way to change the encoding of the data returned by the exported functions (always encoded as perl strings) 🎀.

---

💅 METHODS 💅

• get_sentences TEXT — Splits the input TEXT up into sentences and returns a reference to an array containing the sentences ✂️.
• tokenize TEXT — Splits the input TEXT up into orthographic words and returns a reference to an array containing the words 🍓.
• spell_check TEXT — Returns a reference to an array containing the misspelled words appearing in the input text 👀.
• all_possible_tags WORD — Takes the input WORD and returns it with (XML-style) markup indicating all of its possible parts of speech 🏷️.
• add_tags TEXT — Takes the input TEXT and returns a reference to an array of sentences with (XML-style) disambiguated part-of-speech tags. Does not do any grammatical rule checking. so close but not quite the full thing 😭
• xml_stream TEXT — Takes the input TEXT and returns it as well-formed XML (encoded as perl strings, not utf-8) with full grammatical markup ✨. Error messages are not localized. This function should only be exported for debugging/development purposes. Use grammatical_errors (which is basically xml_stream plus some whittling down) as an interface with other programs — that's the one you actually want, bestie 🫶.
• grammatical_errors TEXT — Returns the grammatical errors in the input TEXT as a reference to an array, one error per element of the array, with each error given in a simple XML format usable by other applications 🔥. Error messages are localized according to locale settings as determined by Locale::Maketext 🌍.

---

👑 SEE ALSO 👑

• <http://borel.slu.edu/gramadoir/>
• Locale::Maketext
• perl(1)

---

💀 BUGS 💀

okay so ngl, the grammar checker does not attempt a full parse of the input sentences, nor does it attempt to exploit any semantic information. There are, therefore, certain constructs that cannot be dealt with correctly 😭. See <http://borel.slu.edu/gramadoir/bugs.html> for a detailed discussion and specific examples — go read it, it's giving receipts.

---

🎀 AUTHOR 🎀

Kevin P. Scannell, <kscanne@gmail.com>. an icon, honestly 👑

---

💜 COPYRIGHT AND LICENSE 💜

Copyright (C) 2004, 2005, 2007 Kevin P. Scannell

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.2 or, at your option, any later version of Perl 5 you may have available 🌈.

---

and that's the whole page, bestie 🦋 — this was perl v5.32.0, dated 2021-01-09, straight from the Lingua::GA::Gramadoir(3pm) User Contributed Perl Documentation. slay, stay grammatical 💖✨