Difference between revisions of "Apertium-html-tools/Paradigm dictionary"

From Apertium
Jump to navigation Jump to search
Line 5: Line 5:
# Ensure that at least one language pair has a <tt>billookup</tt> mode and <tt>bilsearch</tt> mode in at least one direction (ideally both):
# Ensure that at least one language pair has a <tt>billookup</tt> mode and <tt>bilsearch</tt> mode in at least one direction (ideally both):
#* <tt>modes.xml</tt> will need blocks like in [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/modes.xml#L45-L65 uum-eng].
#* <tt>modes.xml</tt> will need blocks like in [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/modes.xml#L45-L65 uum-eng].
# Optionally, add embeddings (documentation to follow)
⚫
#* You'll need a way to generate embeddings, cf. the scripts in [https://github.com/apertium/apertium-uum-eng/tree/main/dev/embeddings uum-eng]
⚫
#* You'll need to compile embeddings into a transducer, cf. [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/Makefile.am#L106-L110 uum-eng]
⚫
#* You'll need to add a block to the <tt>modes.xml</tt> file, cf. [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/modes.xml#L134-L140 uum-eng]


=== Setting up paradigms ===
=== Setting up paradigms ===
Line 14: Line 10:
# Add a reference to the language file in [https://github.com/apertium/apertium-html-tools/blob/urum/src/components/dictionary/index.ts dictionary/index.ts]
# Add a reference to the language file in [https://github.com/apertium/apertium-html-tools/blob/urum/src/components/dictionary/index.ts dictionary/index.ts]
# Localisation for labels is in [https://github.com/apertium/apertium-html-tools/tree/urum/src/strings/pos strings/pos]
# Localisation for labels is in [https://github.com/apertium/apertium-html-tools/tree/urum/src/strings/pos strings/pos]

=== Adding embeddings ===
Embeddings allow searches to return semantically similar results. <b>This is optional.</b>

Real documentation to become available. For now some hints:
⚫
* You'll need a way to generate embeddings, cf. the scripts in [https://github.com/apertium/apertium-uum-eng/tree/main/dev/embeddings uum-eng]
⚫
* You'll need to compile embeddings into a transducer, cf. [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/Makefile.am#L106-L110 uum-eng]
⚫
* You'll need to add a block to the <tt>modes.xml</tt> file, cf. [https://github.com/apertium/apertium-uum-eng/blob/01896a5ce3fc58e218c27fe4b97167069683a4a7/modes.xml#L134-L140 uum-eng]

Revision as of 01:38, 15 October 2025

Installation

  1. Get APy and HTML-Tools running
    • You'll need a version of APy that supports billookup and bilsearch modes, currently the embeddings branch in master branch as of 2025-10-14.
    • You'll need a version of HTML-Tools that supports paradigm dictionary mode, currently the urum branch.
  2. Ensure that at least one language pair has a billookup mode and bilsearch mode in at least one direction (ideally both):
    • modes.xml will need blocks like in uum-eng.

Setting up paradigms

  1. Add a language module to dictionary/langs/
  2. Add a reference to the language file in dictionary/index.ts
  3. Localisation for labels is in strings/pos

Adding embeddings

Embeddings allow searches to return semantically similar results. This is optional.

Real documentation to become available. For now some hints:

  • You'll need a way to generate embeddings, cf. the scripts in uum-eng
  • You'll need to compile embeddings into a transducer, cf. uum-eng
  • You'll need to add a block to the modes.xml file, cf. uum-eng
Retrieved from "https://wiki.apertium.org/w/index.php?title=Apertium-html-tools/Paradigm_dictionary&oldid=75743"