Difference between revisions of "Matxin linearisation with the statistical text generator"

From Apertium
Jump to navigation Jump to search
m (M5w moved page Matxin linearisation with linear to Matxin linearisation with the statistical text generator: ``This project contain a statistical text generator.")
 
Line 6: Line 6:
 
== Building ==
  
== Building ==
   
−
Once you have cloned the repository, simply run
 +
First, clone the repository.
   
−
<code>$ ant</code>
 +
<code>$ git clone https://github.com/m5w/tg.git</code>
   
  +
Then, simply run Ant.
−
from its root directory. Ant will automatically compile and jar all the classes.
  
   
  ⚫
<code>$ ant</code>
−
You can also generate documentation with
  
   
  +
Ant will compile all the classes to the <code>build</code> directory and jar them to <code>dist/lib/tg.jar</code>. Ant can also generate the documentation to the <code>doc</code> directory.
⚫
<code>$ ant doc</code>
  
   
  ⚫
<code>$ ant doc</code>
−
and remove all generated content with
  
   
  +
However, very little of the code is documented, so this is not particularly useful.
⚫
<code>$ ant clean</code>
  
   
 
== Usage ==
  
== Usage ==
   
−
We use Ant to run the project's programs. Ant, however, cannot forward command-line arguments to programs on its own, so we use a simple wrapper script.
 +
We also use Ant to run the project's programs. Ant, however, cannot directory forward command-line arguments to programs, so we use a simple wrapper script.
   
 
<code>./run.sh [CLASS] [ARGS]...</code>
  
<code>./run.sh [CLASS] [ARGS]...</code>
   
−
<code>CLASS</code> is the name of the main class---that is, the class that contains the <code>main</code> function that you want to execute. The programs themselves do not appear to be very well-documented, so I have simply compiled a list of all possible main classes:
 +
<code>CLASS</code> is the name of the main class—that is, the class that contains the <code>main</code> function that you want to execute. The programs themselves do not appear to be very well-documented, so I have simply compiled a list of all possible main classes:
   
 
* commata.Evaluator
  
* commata.Evaluator

Latest revision as of 20:54, 15 January 2017

Prerequisites[edit]

You will need Apache Ant, the Java Development Kit (JDK), and Java. On Ubuntu or any other Debian-based operating system, you can simply install the ant package from APT, and APT will automatically install Java and the JDK.

Building[edit]

First, clone the repository.

$ git clone https://github.com/m5w/tg.git

Then, simply run Ant.

$ ant

Ant will compile all the classes to the build directory and jar them to dist/lib/tg.jar. Ant can also generate the documentation to the doc directory.

$ ant doc

However, very little of the code is documented, so this is not particularly useful.

Usage[edit]

We also use Ant to run the project's programs. Ant, however, cannot directory forward command-line arguments to programs, so we use a simple wrapper script.

./run.sh [CLASS] [ARGS]...

CLASS is the name of the main class—that is, the class that contains the main function that you want to execute. The programs themselves do not appear to be very well-documented, so I have simply compiled a list of all possible main classes:

  • commata.Evaluator
  • commata.Tagger
  • dsynt2synt.Convert
  • dsynt2synt.Evaluator
  • dsynt2synt.Mapper
  • dsynt2synt2.Convert
  • dsynt2synt2.Evaluator
  • dsynt2synt2.Mapper
  • dsynt2syntP.Convert
  • dsynt2syntP.Evaluator
  • dsynt2syntP.Mapper
  • morph2.Main
  • morph2.StringEdit
  • move.Main
  • sem2syn.DSyntConverter
  • sem2syn.Main
  • sem2syn.SemConverter
  • sem2syn2.DSyntConverter
  • sem2syn2.Main
  • sem2syn2.SemConverter
  • syn2lin2.Main
  • syn2lin2b.Main
  • syn2lin3.Lin
  • syn2lin4.Main
  • syn2lin5.Main
  • syn2lin6.Main
  • syn2lin6b.Main
  • syn2lin6c.Main
  • syn2lin7.Main
  • tag7.Evaluator
  • tag7.Tagger
  • util.ConvertDS
  • util.ConvertSSynt
  • util.Converter
  • util.Evaluate
  • util.Evaluator
Retrieved from "https://wiki.apertium.org/w/index.php?title=Matxin_linearisation_with_the_statistical_text_generator&oldid=61238"