Modes - Revision history

Unhammer at 07:29, 23 December 2024

2024-12-23T07:29:59Z

Unhammer at 07:26, 23 December 2024

2024-12-23T07:26:55Z

Marcriera: /* Naming conventions */

2022-01-24T22:30:15Z

Naming conventions

Ilnar.salimzyan at 22:32, 23 March 2019

2019-03-23T22:32:25Z

Ilnar.salimzyan: update links

2019-03-23T22:29:27Z

update links

Ilnar.salimzyan: /* Naming conventions */

2019-03-06T19:24:02Z

Naming conventions

Jona: /* Statistics mode */ typo

2017-04-06T12:02:53Z

Statistics mode: typo

Unhammer: /* Mixed modes */

2017-04-06T07:14:05Z

Mixed modes

Unhammer: /* Autogenerating debug modes */

2017-03-14T19:37:49Z

Autogenerating debug modes

Unhammer: /* Autogenerating debug modes */

2017-03-14T19:36:41Z

Autogenerating debug modes

@@ Line 1: / Line 1: @@
 [[Les fichiers modes|En français]]
-There are a few ways you can use [[pipeline]]s in Apertium. One of them is '''Modes''' files. Modes files (typically called <code>modes.xml</code>) are XML files (see [https://github.com/apertium/apertium/blob/master/apertium/modes.dtd modes.dtd]) which specify which programs should be run and in what order. Normally each linguistic package has one of these files which specifies various ways in which you can use the data to perform translations.
+There are a few ways you can use translation [[pipeline]]s in Apertium. One of them is '''Modes''' files. Modes files (typically called <code>modes.xml</code>) are XML files (see [https://github.com/apertium/apertium/blob/master/apertium/modes.dtd modes.dtd]) which specify which programs should be run and in what order. The pipeline(s) specified in the XML is converted to one more more files containing individual shell pipelines. Normally each linguistic package has one of these XML files which specifies various ways in which you can use the data to perform translations.
 See the [https://github.com/apertium/apertium-spa-cat/blob/master/modes.xml modes file from Spanish-Catalan pair] for an example. The modes which do not say <code>install="yes"</code> are only usable with the -d switch to apertium, these are typically used during development (eg. ca-es-anmor which only performs morphological analysis on Catalan and nothing else).
@@ Line 7: / Line 7: @@
 See [[Writing_Makefiles#Modes]] on how to ensure modes that say install="yes" are installed.
-The program <code>apertium-gen-modes</code> turns modes.xml descriptions into <code>modes/*.mode</code> executables.
+The program <code>apertium-gen-modes</code> turns modes.xml descriptions into individual executable pipelines in <code>modes/*.mode</code>.
 == Naming conventions ==

@@ Line 6: / Line 6: @@
 See [[Writing_Makefiles#Modes]] on how to ensure modes that say install="yes" are installed.
+The program <code>apertium-gen-modes</code> turns modes.xml descriptions into <code>modes/*.mode</code> executables.
 == Naming conventions ==

@@ Line 18: / Line 18: @@
 * -syntax runs up until syntactical (CG) disambiguation
 * -tagger runs up until probabilistic (apertium-tagger) disambiguation (or, if no .prob, up until the last disambiguation step)
+* -autoseq runs up until separable multiwords
 * -biltrans runs up until the bidix
 * -lex runs up until lexical selection
+* -anaph runs up until anaphora resolution
 * -transfer runs up until (1-stage) transfer
 * -chunker runs up until the first stage of 3-or-more-stage transfer

@@ Line 3: / Line 3: @@
 There are a few ways you can use [[pipeline]]s in Apertium. One of them is '''Modes''' files. Modes files (typically called <code>modes.xml</code>) are XML files (see [https://github.com/apertium/apertium/blob/master/apertium/modes.dtd modes.dtd]) which specify which programs should be run and in what order. Normally each linguistic package has one of these files which specifies various ways in which you can use the data to perform translations.
-See the [https://github.com/apertium/apertium-spa-cat/blob/master/modes.xml modes file from es-ca] for an example. The modes which do not say <code>install="yes"</code> are only usable with the -d switch to apertium, these are typically used during development (eg. ca-es-anmor which only performs morphological analysis on Catalan and nothing else).
+See the [https://github.com/apertium/apertium-spa-cat/blob/master/modes.xml modes file from Spanish-Catalan pair] for an example. The modes which do not say <code>install="yes"</code> are only usable with the -d switch to apertium, these are typically used during development (eg. ca-es-anmor which only performs morphological analysis on Catalan and nothing else).
 See [[Writing_Makefiles#Modes]] on how to ensure modes that say install="yes" are installed.

@@ Line 1: / Line 1: @@
 [[Les fichiers modes|En français]]
-There are a few ways you can use [[pipeline]]s in Apertium. One of them is '''Modes''' files. Modes files (typically called <code>modes.xml</code>) are XML files (see [http://apertium.svn.sourceforge.net/viewvc/apertium/trunk/apertium/apertium/modes.dtd modes.dtd]) which specify which programs should be run and in what order. Normally each linguistic package has one of these files which specifies various ways in which you can use the data to perform translations.
+There are a few ways you can use [[pipeline]]s in Apertium. One of them is '''Modes''' files. Modes files (typically called <code>modes.xml</code>) are XML files (see [https://github.com/apertium/apertium/blob/master/apertium/modes.dtd modes.dtd]) which specify which programs should be run and in what order. Normally each linguistic package has one of these files which specifies various ways in which you can use the data to perform translations.
-See the [http://sourceforge.net/p/apertium/svn/HEAD/tree/trunk/apertium-es-ca/modes.xml modes file from es-ca] for an example. The modes which do not say <code>install="yes"</code> are only usable with the -d switch to apertium, these are typically used during development (eg. ca-es-anmor which only performs morphological analysis on Catalan and nothing else).
+See the [https://github.com/apertium/apertium-spa-cat/blob/master/modes.xml modes file from es-ca] for an example. The modes which do not say <code>install="yes"</code> are only usable with the -d switch to apertium, these are typically used during development (eg. ca-es-anmor which only performs morphological analysis on Catalan and nothing else).
 See [[Writing_Makefiles#Modes]] on how to ensure modes that say install="yes" are installed.

@@ Line 9: / Line 9: @@
 == Naming conventions ==
-The main translation mode is always named "from-to", e.g. "sme-nob". The debug modes each have a suffiks, e.g. "sme-nob-morph".
+The main translation mode is always named "from-to", e.g. "sme-nob". The debug modes each have a suffix, e.g. "sme-nob-morph".
 Common debug mode names:

@@ Line 99: / Line 99: @@
 /usr/local/share/apertium/apertium-es-ca/trules-ca-es.bin  /usr/local/share/apertium/apertium-es-ca/ca-es.autobil.bin \
 |/usr/local/bin/lt-proc $1 /usr/local/share/apertium/apertium-es-ca/ca-es.autogen.bin \
-|/usr/local/bin/lt-proc -p /usr/local/share/apertium/apertium-es-ca/ca-es.autopgen.bin
+|/usr/local/bin/lt-proc -p /usr/local/share/apertium/apertium-es-ca/ca-es.autogen.bin
 </pre>

@@ Line 116: / Line 116: @@
 See [[Mixed modes]]
+==See also==
+* https://victorio.uit.no/langtech/trunk/tools/CorpusTools/corpustools/modes.py is a Python module that parses modes files into a <code>Pipeline</code> class
 [[Category:Documentation]]

@@ Line 28: / Line 28: @@
 == Autogenerating debug modes ==
-It's a drag to create all the regular install=no debug modes all the time (e.g. foo-bar-tagger, foo-bar-chunker, etc.).  If you put <code>gendebug="yes"</code> on a &lt;mode&gt; element, debug modes will be created automatically for you! If a mode comes out with the wrong suffix, you can override the guess by adding the <code>debug-suff</code> attribute. So e.g.
+It's a drag to create all the regular install=no debug modes all the time (e.g. foo-bar-tagger, foo-bar-chunker, etc.).
+If you put '''<code>gendebug="yes"</code>''' on a &lt;mode&gt; element, debug modes will be created automatically for you! If a mode comes out with the wrong suffix, you can override the guess by adding the <code>debug-suff</code> attribute.
+For example, the following entry
 <pre>

@@ Line 28: / Line 28: @@
 == Autogenerating debug modes ==
-It's a drag to create all the regular install=no debug modes all the time (e.g. foo-bar-tagger, foo-bar-chunker, etc.).  If you put gendebug="yes" on a &lt;mode&gt; element, debug modes will be created automatically for you! It might not always do the right thing, if you have a weird setup and/or strange programs in your pipeline, but it can save some time :)
+It's a drag to create all the regular install=no debug modes all the time (e.g. foo-bar-tagger, foo-bar-chunker, etc.).  If you put <code>gendebug="yes"</code> on a &lt;mode&gt; element, debug modes will be created automatically for you! If a mode comes out with the wrong suffix, you can override the guess by adding the <code>debug-suff</code> attribute. So e.g.
+<pre>
+  <mode name="sme-nob" install="yes" gendebug="yes">
+    <pipeline>
+      <program name="hfst-proc --weight-classes 1 -w -p">
+        <file name="sme-nob.automorf.hfst"/>
+      </program>
+      <program name="cg-proc" debug-suff="disam">
+        <file name="sme-nob.mor.rlx.bin"/>
+      </program>
+      <program name="cg-proc -1 -n -w" debug-suff="syntax">
+        <file name="sme-nob.syn.rlx.bin"/>
+      </program>
+      <program name="apertium-pretransfer"/>
+      <program name="lt-proc -b">
+        <file name="sme-nob.autobil.bin"/>
+      </program>
+      <program name="cg-proc" debug-suff="lex">
+        <file name="sme-nob.lex.bin"/>
+      </program>
+      <program name="apertium-transfer -b">
+        <file name="apertium-sme-nob.sme-nob.t1x"/>
+        <file name="sme-nob.t1x.bin"/>
+      </program>
+      <program name="apertium-interchunk" debug-suff="interchunk1">
+        <file name="apertium-sme-nob.sme-nob.t2x"/>
+        <file name="sme-nob.t2x.bin"/>
+      </program>
+      <program name="apertium-interchunk" debug-suff="interchunk2">
+        <file name="apertium-sme-nob.sme-nob.t3x"/>
+        <file name="sme-nob.t3x.bin"/>
+      </program>
+      <program name="lt-proc $1">
+        <file name="sme-nob.autogen.bin"/>
+      </program>
+    </pipeline>
+  </mode>
+</pre>
+would make all these modes automatically:
+* sme-nob.mode
+* sme-nob-morph.mode
+* sme-nob-disam.mode
+* sme-nob-syntax.mode
+* sme-nob-pretransfer.mode
+* sme-nob-biltrans.mode
+* sme-nob-lex.mode
+* sme-nob-chunker.mode
+* sme-nob-interchunk1.mode
+* sme-nob-interchunk2.mode
+* sme-nob-postchunk.mode
+* sme-nob-dgen.mode
+(but only install the sme-nob.mode), where -disam, -syntax, -interchunk1, -interchunk2 are manually specified names, and the rest are default names based on program names.
 == Modes hacks ==