Differences

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

--- user:zeman:interset:how-to-use [2009/02/20 15:00]
zeman Level of headings.
+++ user:zeman:interset:how-to-use [2017/01/16 13:06] (current)
zeman
@@ Line 1: / Line 1: @@
-====== Manual ======
+====== DZ Interset Manual ======
 ===== Installation =====
-If you exist on the ÚFAL network, you can use directly Dan's version here. Otherwise, you need to [[download]] a zipped package of the currently existing drivers. Unzip it to a convenient place; below, we assume it is in ''/home/zeman/interset''.
+If you exist on the ÚFAL network and use Perl from PerlBrew, you probably already have ''Lingua::Interset'' available (depending on which Perl version you take from PerlBrew). Or you can point your ''PERL5LIB'' directly to Dan's version in ''/home/zeman/projekty/interset/lib''. Otherwise you can install ''Lingua::Interset'' from CPAN, e.g. using
-**Contributions welcome!** If you write your own driver, please share it with others! If you send it to me, I will add it to the package for download here.
+<code bash>cpanm Lingua::Interset</code>
+**Contributions welcome!** If you write your own driver, please share it with others! If you send it to me, I will add it to the package on CPAN.
 ==== Existing drivers ====
-Note: This list may not be up-to-date. To see what drivers are currently available on your system, call ''driver-test.pl'' without arguments.
+Use the tool ''bin/driver-test.pl'' from the package (call it without arguments) to list the tagsets/drivers currently available on your system.
-  - tagset::ar::conll - Arabic CoNLL treebank (coarse, fine and feat fields in one string, delimited by tabs)
-  - tagset::bg::conll - Bulgarian CoNLL treebank
-  - tagset::cs::conll - Czech CoNLL treebank, based on the Prague Dependency Treebank
-  - tagset::cs::multext - Czech subset of the tagset from the Multext East project
-  - tagset::cs::pdt - Czech positional tags of the Prague Dependency Treebank
-  - tagset::da::conll - Danish CoNLL treebank
-  - tagset::de::conll - German CoNLL treebank (one-to-one mapping to de::stts)
-  - tagset::de::stts - German: Stuttgart-Tübingen Tagset (Tiger treebank)
-  - tagset::en::conll - English CoNLL treebank (one-to-one mapping to en::penn)
-  - tagset::en::penn - English Penn Treebank
-  - tagset::pt::conll - Portuguese CoNLL treebank (based on the Floresta treebank)
-  - tagset::sv::conll - Swedish CoNLL treebank (one-to-one mapping to sv::mamba)
-  - tagset::sv::hajic - Tags output by Swedish tagger by Jan Hajič
-  - tagset::sv::mamba - Swedish Mamba tags from Talbanken05 (CoNLL treebank)
-  - tagset::sv::svdahybrid - Dan's tagset, aiming at making distribution of tags from sv::hajic and da::conll as close as possible
-  - tagset::zh::conll - Chinese CoNLL treebank
 ==== Directory Structure ====
-The drivers are Perl modules and must be somewhere under ''$PERLLIB'' (''@INC''). Their root folder is ''tagset'' (this is what separates the tag set drivers from other Perl libraries). Subfolders of ''tagset'' are two-letter codes of languages ([[http://en.wikipedia.org/wiki/ISO_639-1|ISO 639-1]]). Some tagsets may be designed for more than one language but most are language-specific. PM files in language folders are drivers. Drivers are called xxx.pm, where xxx is the code name of the tagset. The driver xxx.pm for language ll should be accessible from Perl via
+The drivers are Perl modules and must be somewhere under ''$PERLLIB'' (''@INC''). Their root folder is ''Lingua/Interset/Tagset''. Subfolders of ''Tagset'' are two-letter codes of languages ([[http://en.wikipedia.org/wiki/ISO_639-1|ISO 639-1]]), uppercased (because of the convention that Perl modules start with an uppercase letter). Some tagsets may be designed for more than one language but most are language-specific. PM files in language folders are drivers. Drivers are called Xxx.pm, where xxx is the code name of the tagset. The driver Xxx.pm for language ll should be accessible from Perl via
 <code perl>
-use tagset::ll::xxx;
+use Lingua::Interset::Tagset::LL::Xxx;
 </code>
-Besides drivers, there is a library of useful functions that can be called from within drivers: ''tagset/common.pm''.
+but usually it is more convenient to just call the main module and then refer to the tagset using the lowercased identifier:
+<code perl>
+use Lingua::Interset qw(decode);
+my $fs = decode('ll::xxx', $tag);
+</code>
+The main object in Interset is of the class ''Lingua::Interset::FeatureStructure'', which provides various useful access methods. For details, see the documentation at https://metacpan.org/pod/Lingua::Interset
 There is also the driver testing script, ''bin/driver-test.pl''. The distribution may contain some sample conversion scripts as well; however, these depend much more on the file format than on the tagset drivers, and thus you'll probably need to write your own anyway.
 ===== How to use the Interset =====
-You can write your own tag conversion Perl script, and use the Interset driver library. You have to tell Perl where to find the drivers (the following commands work in ''csh''; you have to use different syntax under ''bash'' or in Windows command line):
+You can write your own Perl script to convert tags, and use the Interset driver library. You may have to tell Perl where to find Interset (the following commands work in ''csh''; you have to use different syntax under ''bash'' or in Windows command line):
 <code>setenv PERLLIB /home/zeman/projekty/interset/lib:$PERLLIB
 setenv PATH /home/zeman/projekty/interset/bin:$PATH</code>
-Once the variable is set, writing a conversion script is very easy. For instance, my ''csts-cs-pdt-en-penn.pl'' script (meaning "read and write [[:Formát CSTS|CSTS format]], read Czech PDT tags, write English Penn tags) essentially looks like this:
+Once the variable is set, writing a conversion script is very easy. Here is an example (note that in CoNLL-X files we often merge the contents of the CPOS, POS and FEATS columns to create one long string that will be seen by Interset as one “tag”):
 <code perl>
-use tagset::cs::pdt;
+use Lingua::Interset::Converter;
-use tagset::en::penn;
-while(<>)
+my $c = new Lingua::Interset::Converter ('from' => $tagset1, 'to' => 'mul::uposf');
-{
-    if(s/<t>([^<]+)/<_tag_to_convert_>/)
-    {
-        my $tag0 = $1;
-        my $features = tagset::cs::pdt::decode($tag0);
-        my $tag1 = tagset::en::penn::encode($features);
-        s/<_tag_to_convert_>/<t>$tag1/;
-    }
-    print;
-}
-</code>
-Note the two-step replacement of the original tag. I do not dare to use the original tag in a regular expression because there could be special characters in the tag.
-Some operations performed by the drivers (especially when encoding) are not trivial. While you may not observe long processing times for toy runs, it might matter once you start converting millions of tags in a big corpus. Then you may want to use up the fact that there are tens to thousands of tags, and cache their translations like in the following example:
-<code perl>
-use tagset::cs::pdt;
-use tagset::en::penn;
+# Read the CoNLL-X file from STDIN or from files given as arguments.
 while(<>)
 {
-    if(s/<t>([^<]+)/<_tag_to_convert_>/)
+    unless(m/^\s*$/)
     {
-        my $tag0 = $1;
+        chomp();
-        my $tag1;
+        my @f = split(/\t/, $_);
-        if(exists($cache{$tag0}))
+        my $tag = "$f[3]\t$f[4]\t$f[5]";
-        {
+        my $utag = $c->convert($tag);
-            $tag1 = $cache{$tag0};
+        my ($upos, $ufeat) = split(/\t/, $utag);
-        }
+        $f[3] = $upos;
-        else
+        $f[5] = $ufeat;
-        {
+        $_ = join("\t", @f)."\n";
-            my $features = tagset::cs::pdt::decode($tag0);
-            $tag1 = tagset::en::penn::encode($features);
-            $cache{$tag0} = $tag1;
-        }
-        s/<_tag_to_convert_>/<t>$tag1/;
     }
-    print;
+    # Write the modified line to the standard output.
+    print();
 }
 </code>

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

Institute of Formal and Applied Linguistics Wiki

Differences