Skip to content

Commit

Permalink
Update Userguide
Browse files Browse the repository at this point in the history
  • Loading branch information
@nreimers
nreimers committed Oct 15, 2015
1 parent e0e82ce commit 97d71ef
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions doc/user-guide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.6" />
<title>DARIAH-DKPro-Wrapper v0.3.5</title>
<title>DARIAH-DKPro-Wrapper v0.3.6</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */

Expand Down Expand Up @@ -735,7 +735,7 @@
</head>
<body class="article">
<div id="header">
<h1>DARIAH-DKPro-Wrapper v0.3.5</h1>
<h1>DARIAH-DKPro-Wrapper v0.3.6</h1>
<span id="author">DARIAH2 - Cluster 5, Use Case 1 Team</span><br />
<div id="toc">
<div id="toctitle">User Guide</div>
Expand All @@ -745,7 +745,7 @@ <h1>DARIAH-DKPro-Wrapper v0.3.5</h1>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>This is a short user guide for the current version v0.3.5 of the DARIAH-DKPro-Wrapper.</p></div>
<div class="paragraph"><p>This is a short user guide for the current version v0.3.6 of the DARIAH-DKPro-Wrapper.</p></div>
</div>
</div>
<div class="sect1">
Expand Down Expand Up @@ -779,12 +779,12 @@ <h2 id="_running_the_pipeline">2. Running the pipeline</h2>
<div class="paragraph"><p>After downloading and unzipping the files, execute in your command line the following code:</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -input file.txt -output folder</tt></p></div>
</div></div>
<div class="paragraph"><p>You can change the language by specifying the language parameter for the pipeline. Support for the following languages are include in the current version of the DARIAH-DKPro-Wrapper: German (de), English (en), Spanish (es), and French (fr). To run the pipeline for English, execute the following command:</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -language en -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -language en -input file.txt -output folder</tt></p></div>
</div></div>
</div>
</div>
Expand All @@ -802,23 +802,23 @@ <h2 id="_write_your_own_config_files">4. Write your own config files</h2>
<div class="paragraph"><p>If you like to write your own config file, just create your own <tt>.properties</tt> file. You can run the pipeline with your <tt>.properties</tt>-file by setting the command argument.</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -config /path/to/my/config/myconfigfile.properties -language en -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -config /path/to/my/config/myconfigfile.properties -language en -input file.txt -output folder</tt></p></div>
</div></div>
<div class="paragraph"><p>In case you store your <tt>myconfigfile.properties</tt> in the <tt>configs</tt> folder, you can run the pipeline via:</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -config myconfigfile.properties -language en -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -config myconfigfile.properties -language en -input file.txt -output folder</tt></p></div>
</div></div>
<div class="paragraph"><p>You can split your config file into different parts and pass them all to the pipeline by seperating the paths using comma or semicolons. The pipeline examines all passed config files and derives the final configuration from all files. The config-file passed as last arguments has the highest priority, i.e. it can overwrite the values for all previous config files:</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -config myfile1.properties,myconfig2.properties,myfile3.properties -language en -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -config myfile1.properties,myconfig2.properties,myfile3.properties -language en -input file.txt -output folder</tt></p></div>
</div></div>
<div class="paragraph"><p><strong>Note:</strong> The system always uses the default.properties and default_[langcode].properties as basic configuration files. All further config files are added on top of these files.</p></div>
<div class="paragraph"><p>In case you like to use the <em>full</em>-version and also want to change the POS-tagger, you can run the pipeline in the following way:</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -config myFullVersion.properties,myPOSTagger.properties -language en -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -config myFullVersion.properties,myPOSTagger.properties -language en -input file.txt -output folder</tt></p></div>
</div></div>
<div class="paragraph"><p>In <tt>myPOSTagger.properties</tt> you just add the configuration for the different POS-tagger.</p></div>
<div class="paragraph"><p><strong>Note:</strong> The properties-files must use the ISO-8859-1 encoding. If you like to include UTF-8 characters, you must encode them using \u[HEXCode].</p></div>
Expand Down Expand Up @@ -951,7 +951,7 @@ <h3 id="_configuration_of_the_pipeline">5.3. Configuration of the pipeline</h3>
<div class="paragraph"><p>Change the paths for the parameter <em>executablePath</em> and <em>modelLocation</em> to the correct paths on your machine. You can then use Treetagger in your pipeline using the <tt>-config</tt> argument:</p></div>
<div class="sidebarblock">
<div class="content">
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.5-standalone.jar -config treetagger-example.properties -language de -input file.txt -output folder</tt></p></div>
<div class="paragraph"><p><tt>java -Xmx4g -jar de.tudarmstadt.ukp.dariah.pipeline-0.3.6-standalone.jar -config treetagger-example.properties -language de -input file.txt -output folder</tt></p></div>
</div></div>
<div class="paragraph"><p>Check the output of the pipeline that Treetagger is used. The output of your pipeline should look something like this:</p></div>
<div class="listingblock">
Expand All @@ -967,7 +967,7 @@ <h3 id="_configuration_of_the_pipeline">5.3. Configuration of the pipeline</h3>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2015-10-13 14:39:35 CEST
Last updated 2015-10-15 11:49:13 CEST
</div>
</div>
</body>
Expand Down

0 comments on commit 97d71ef

Please sign in to comment.