Differences

This shows you the differences between two versions of the page.

--- user:zeman:addicter [2010/05/28 09:10]
zeman A note on Apache on Ubuntu.
+++ user:zeman:addicter [2012/06/22 18:05] (current)
bojar emplus acknowledged
@@ Line 3: / Line 3: @@
 //Addicter// stands for Automatic Detection and DIsplay of Common Translation ERrors. It will be a set of tools (mostly scripts written in Perl) that help with error analysis for machine translation.
-The work on Addicter has started at the MT Marathon 2010 in Dublin, within a broader 5-day project called Failfinder (Dan Zeman, Ondřej Bojar, Martin Popel, David Mareček, Jon Clark, Ken Heafield, Qin Gao, Loïc Barrault). The code that resulted from the project can be freely downloaded from https://failfinder.googlecode.com/svn/trunk/. The nucleus that existed just after the MT Marathon (4 Feb 2010) is Addicter version 0.1, to reflect that this is by no means deemed a final product. Anyway, it can already do a useful job.
+The work on Addicter has started at the MT Marathon 2010 in Dublin, within a broader 5-day project called Failfinder (Dan Zeman, Ondřej Bojar, Martin Popel, David Mareček, Jon Clark, Ken Heafield, Qin Gao, Loïc Barrault). The code that resulted from the project can be freely downloaded from https://failfinder.googlecode.com/svn/trunk/. The nucleus that existed just after the MT Marathon (4 Feb 2010) is Addicter version 0.1, to reflect that this was by no means deemed a final product.
-Currently, Addicter can view and browse aligned corpora, look for example words in context and summarize known alignments of a given word. The viewing and browsing is performed using a web server that generates web pages dynamically (to avoid pre-generating millions of static HTML documents). The obvious drawback is that access to a web server is needed.
+In 2011, the viewer was accompanied by an automatic error recognizer and classifier, thanks to Mark Fishel. The development has been moved to ÚFAL StatMT SVN repository (i.e. ''failfinder.googlecode.com'' is currently not maintained). In September 2011 at the Sixth MT Marathon in Trento, Addicter was further developed and thoroughly compared with another tool for error analysis, [[http://www.dfki.de/~mapo02/hjerson/|Hjerson]]. See the [[http://statmt.org/mtm6/?n=Main.AutomaticMTErrorAnalysis|project wiki]]. For further developments, see also [[http://terra.cl.uzh.ch/|the Terra website]].
+Currently, Addicter can do the following:
+  * Find erroneous tokens and classify the errors in a way similar to Vilar's taxonomy.
+  * Browse the test data, sentence by sentence, and show aligned source sentence, reference translation and system hypothesis.
+  * Browse aligned training corpus, look for example words in context.
+  * Show lines of the phrase table that contain a given word.
+  * Summarize alignments of a given word. This feature can also serve as a primitive corpus-based dictionary.
+  * In the near future, we also plan to add searching and grouping of words sharing the same lemma. That way morphological errors will be highlighted.
+The viewing and browsing is performed using a web server that generates web pages dynamically (to avoid pre-generating millions of static HTML documents). Words in sentences are clickable so that the user can quickly navigate to examples and summaries of other than the current word. If you have access to a webserver you may use Addicter with it; otherwise you can use Addicter's own lightweight server. A small subset can be also generated as static HTML files and viewed without a web server: the test data browser.
+There is another subpage for Addicter in this wiki that lies in the external name space, thus it can be used for [[external:addicter|external collaboration]].
 ===== Installation =====
-  * Install a web server, unless you already have access to one (local or remote). For instance, the Apache web server is available for at least Linux and MS Windows, and it's free. Configure your web server to work with CGI scripts written in Perl.
+  * Addicter is written in Perl and you need a Perl interpreter to run Addicter. This is usually no problem on Unix-like systems but you may need to install Perl version ≥ 5.8 if you are working on Windows. Options include [[http://www.activestate.com/activeperl|Active Perl]] and [[http://strawberryperl.com/|Strawberry Perl]].
-  * To be able to generate alignments that will be displayed by Addicter, you need Giza++ or equivalent. The first training few steps of the Moses suite will do.
+  * There is now no need to install or have access to a web server; nevertheless, we keep the tutorial section below for those interested.
-  * Check out Addicter code from the Failfinder SVN repository.
+  * To be able to generate alignments that will be displayed by Addicter, you need [[http://code.google.com/p/giza-pp/|Giza++]] or equivalent. The first training few steps of the [[http://www.statmt.org/moses/|Moses]] suite will do.
+  * Check out Addicter code from the ÚFAL SVN repository (see below how).
 ==== How to install and configure Apache ====
+**NOTE:** Since September 2011, it is not necessary to install a local web server, so skip this section if you do not want it. Addicter now comes with a script called ''server.pl'' that works as a HTTP daemon and serves Addicter content (but nothing else) to your browser. This section is thus optional.
 === Microsoft Windows ===
@@ Line 23: / Line 38: @@
     * Look for a ''ScriptAlias'' directive. It tells the server: 1. what path on the hard disk contains scripts that can generate dynamic HTML content on the fly, and 2. how the path will be represented in the URL (web address). For example <code>ScriptAlias /cgi/ "C:/Documents and Settings/Dan/Documents/Web/cgi/"</code> says that the URL ''http://localhost/cgi/anyscript.pl'' leads to your script ''C:\Documents and Settings\Dan\Documents\Web\cgi\anyscript.pl'', and that it's a script (i.e., the server shall invoke it and send its output, instead of sending the script itself).
     * Under Windows, you will also want to set <code>ScriptInterpreterSource registry</code> It tells the server that the Windows registry shall be used to figure out how to run a script (e.g., that ''C:\Perl\Perl.exe'' binary must be run to interpret a ''.pl'' script).
+    * CGI scripts will not run under the same environment as a user command line. They will not see the ''PERLLIB'' variable and thus not find the libraries unless we specifically instruct Apache to pass the variable to the CGI environment: <code>PassEnv PERLLIB PERL5LIB</code>
   * Restart the server. On the main Windows panel, there is (typically in the lower right corner) a set of icons, including a new one for Apache. Right-click on it, select Open Apache Monitor, then Restart.
@@ Line 43: / Line 59: @@
 ==== How to install Addicter ====
-We use ''$CGI'' to refer to the path you registered with Apache as containing CGI scripts (using the ''ScriptAlias'' directive).
+We use ''$CGI'' to refer to the path you registered with Apache as containing CGI scripts (using the ''ScriptAlias'' directive). **NOTE:** If you are using Addicter's own web server or if Addicter content is the only thing you intend to use the server to serve, probably the easiest thing to do is to set the Addicter's ''cgi'' folder as your ''$CGI''. **NOTE 2:** There are couple of files with static (non-CGI) web content, needed by the CGI scripts. These files (currently ''tabs.gif'' and ''activatables.js'') are in ''$CGI/..''. With Addicter's own web server, this is just fine. If you are using another web server, however, you must copy these files to the appropriate location in your static content directory structure so that the server finds them. They should not be directly in the ''$CGI'' folder because they are not scripts and should not be treated as scripts by the server.
-  * Check out the current version of Addicter from the SVN repository. In Linux, the following command will do that: <code>svn checkout https://failfinder.googlecode.com/svn/trunk addicter</code> In Windows, you can use [[http://tortoisesvn.tigris.org/|TortoiseSVN]] to access the repository.
+  * Addicter uses some general-purpose Perl libraries that are maintained in a separate repository. Download these first, using username ''public'' and password ''public''. Then make sure that Perl finds these libraries. In Linux/bash, the following commands will do that: <code bash>svn --username public checkout https://svn.ms.mff.cuni.cz/svn/dzlib ~/lib
-  * All you need at this moment is in the folder ''dan''. There are two subfolders, ''prepare'' and ''cgi''. Copy the contents of the ''cgi'' folder to ''$CGI''.
+export PERL5LIB=~/lib:$PERL5LIB</code> In Windows, you can use [[http://tortoisesvn.tigris.org/|TortoiseSVN]] to access the repository.
+  * Check out the current version of Addicter from the StatMT SVN repository, again using username ''public'' and password ''public'': <code bash>svn --username public checkout https://svn.ms.mff.cuni.cz/svn/statmt/trunk/addicter addicter</code>
+  * There are three subfolders, ''testchamber'', ''prepare'' and ''cgi''. Copy the contents of the ''cgi'' folder to ''$CGI''.
+  * For every experiment whose data shall be explored by addicter, create a subfolder in ''$CGI'', e.g. ''$CGI/fr-en-exp01''.
 ===== Alignment viewer =====
@@ Line 61: / Line 80: @@
   * ''test.system.ali'' ... alignment of the source and the system output for test data
-The ''prepare'' folder contains some sample corpora in ''sample_data.zip''.
+<!--The ''prepare'' folder contains some sample corpora in ''sample_data.zip''.-->
-The indexer splits the output index into multiple files in order to reduce size of any individual file. All index files must be stored in the same folder as the viewing CGI scripts.
+The indexer splits the output index into multiple files in order to reduce size of any individual file. All index files must be stored in the experiment subfolder of ''$CGI'' so that the CGI scripts can find them.
 ==== How to prepare a corpus for viewing ====
@@ Line 84: / Line 103: @@
 The indexer will copy the input files and output all index files into the ''$CGI'' folder where the CGI scripts will find them.
+==== How to invoke the error classifier ====
+The error classifier currently uses its own monlingual word-alignment of reference translation and the hypothesis. It is invoked as follows:
+<code bash>${ADDICTER}/prepare/detecter.pl -s srcfile -r reffile -h hypfile [-a alignment] -w workdir</code>
+and it creates the files ''workdir/tcali.txt'' and ''workdir/tcerr.txt''. The input files (src, ref and hyp) can also be gzipped. Custom alignment between hypothesis and reference can be supplied. If it is not supplied, then the default aligner (''${ADDICTER}/testchamber/align-greedy.pl'') is invoked.
+Place the files ''tcali.txt'' and ''tcerr.txt'' in the experiment subfolder of ''$CGI'' and the error classes will be displayed during test data browsing in the viewer. The viewer can work with several alternating alignments (perhaps using different aligning algorithms) of the same data. For each of those alignments, you have to run ''detecter.pl'' separately.
 ==== How to use the viewer ====
-Now if your web server is running and configured properly and your index and data files have been prepared in the correct place, launch your web browser and point it to http://localhost/cgi/index.pl.
+First make sure that your web server is running and configured properly and that your index and data files have been prepared in the correct place. If you do not use your own web server, invoke the script ''server.pl'' in the main Addicter folder. It will say something like
+<code>Please contact me at: <URL:http://localhost:2588/cgi/index.pl></code>
+which is the URL you should point your browser to. The server uses a randomly picked port number unless you specify it as a commandline parameter: ''server.pl 8080''.
+In the browser, you will see a list of experiments (all subfolders of ''$CGI''). Start browsing your data by clicking on an experiment.
+===== Acknowledgements =====
+This research has been supported by the grant of the Czech Ministry of Education no. MSM0021620838 (2010), by the grants of the Czech Science Foundation no. P406/11/1499 and P406/10/P259, the Estonian Science Foundation target financed theme SF0180078s08 (2011) and by the project EuroMatrixPlus (FP7-ICT-2007-3-231720 of the EU and 7E09003+7E11051 of the Ministry of Education, Youth and Sports of the Czech Republic; 2011-2012).
+===== Publications =====
+  * Mark Fishel, Ondřej Bojar, Daniel Zeman, Jan Berka: //[[http://ufal.mff.cuni.cz:8080/bib/?section=publication&id=-8080356071532247643&mode=view|Automatic Translation Error Analysis]].// In: TSD 2011, Plzeň, Czechia, 2011
+  * Daniel Zeman, Mark Fishel, Jan Berka, Ondřej Bojar: //[[http://ufal.mff.cuni.cz:8080/bib/?section=publication&id=-4951860774549764116&mode=view|Addicter: What Is Wrong with My Translations?]]// In: The Prague Bulletin of Mathematical Linguistics, vol. 96, pp. 79–88; MT Marathon, Trento, Italy, 2011
+  * Maja Popović: //[[http://ufal.ms.mff.cuni.cz/pbml/96/art-popovic.pdf|Hjerson: An Open Source Tool for Automatic Error Classification of Machine Translation Output]].// In: The Prague Bulletin of Mathematical Linguistics, vol. 96, pp. 59–68; MT Marathon, Trento, Italy, 2011
+  * Jan Berka, Ondřej Bojar, Mark Fishel, Maja Popović, Daniel Zeman: //[[http://ufal.mff.cuni.cz:8080/bib/?section=publication&id=-6688512557324036032&mode=view|Automatic MT Error Analysis: Hjerson Helping Addicter]].// In: Proceedings of LREC 2012, İstanbul, Turkey, 2012

[ Back to the navigation ] [ Back to the content ]

Institute of Formal and Applied Linguistics Wiki

Differences