Updated with instructions about installing joshua-runtime
Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua-site/commit/33eedd8d Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua-site/tree/33eedd8d Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua-site/diff/33eedd8d Branch: refs/heads/asf-site Commit: 33eedd8db5753379d4fa90027c12341734bcc1f6 Parents: eb822f3 Author: Matt Post <[email protected]> Authored: Fri Nov 6 09:50:09 2015 -0500 Committer: Matt Post <[email protected]> Committed: Fri Nov 6 09:50:09 2015 -0500 ---------------------------------------------------------------------- 6.0/install.md | 47 +++++++++++++++++++++++++++----------------- language-packs/index.md | 8 ++++++++ 2 files changed, 37 insertions(+), 18 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-joshua-site/blob/33eedd8d/6.0/install.md ---------------------------------------------------------------------- diff --git a/6.0/install.md b/6.0/install.md index 68c4720..6d13e4d 100644 --- a/6.0/install.md +++ b/6.0/install.md @@ -5,30 +5,34 @@ title: Installation ### Download and install -To use Joshua as a standalone decoder (with -[language packs](/language-packs/)), you only need to download and -install the decoder. There are no external dependencies. +To use Joshua as a standalone decoder (with [language packs](/language-packs/)), you only need to download and install the runtime version of the decoder. +If you also wish to build translation models from your own data, you will want to install the full version. +See the instructions below. -1. Set up some basic environment variables. You need to define `$JAVA_HOME` and - also `$HADOOP`, if you have a Hadoop installation (Joshua's pipeline looks - for `$HADOOP/bin/hadoop`. +1. Set up some basic environment variables. + You need to define `$JAVA_HOME` export JAVA_HOME=/path/to/java # JAVA_HOME is not very standardized. Here are some places to look: # OS X: export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.7.0_71.jdk/Contents/Home # Linux: export JAVA_HOME=/usr/java/default - + +1. If you are installing the full version of Joshua, you also need to define `$HADOOP` to point to your Hadoop installation. + (Joshua looks for the Hadoop executuble in `$HADOOP/bin/hadoop`) + export HADOOP=/usr - -1. Download Joshua - wget -q http://cs.jhu.edu/~post/files/joshua-{{ site.data.joshua.release_version }}.tgz + If you don't have a Hadoop installation, [Joshua's pipeline](pipeline.html) can install a standalone version for you. + +1. To install just the runtime version of Joshua, type -1. Next, unpack it and compile everything. + wget -q http://cs.jhu.edu/~post/files/joshua-runtime-{{ site.data.joshua.release_version }}.tgz - tar xzf joshua-{{ site.data.joshua.release_version }}.tgz - cd joshua-{{ site.data.joshua.release_version }} + Then build everything + + tar xzf joshua-runtime-{{ site.data.joshua.release_version }}.tgz + cd joshua-runtime-{{ site.data.joshua.release_version }} # Add this to your init files export JOSHUA=$(pwd) @@ -36,15 +40,22 @@ install the decoder. There are no external dependencies. # build everything ant - This compiles Joshua and also a number of support tools, such as KenLM and GIZA++. +1. To instead install the full version, type + + wget -q http://cs.jhu.edu/~post/files/joshua-{{ site.data.joshua.release_version }}.tgz + + tar xzf joshua-{{ site.data.joshua.release_version }}.tgz + cd joshua-{{ site.data.joshua.release_version }} -1. [Download a model](/language-packes/) and start translating! + # Add this to your init files + export JOSHUA=$(pwd) + + # build everything + ant ### Building new models -If you wish to build models for new language pairs from existing data -(such as the [WMT data](http://statmt.org/wmt14/)), you need to -install some additional dependencies. +If you wish to build models for new language pairs from existing data (such as the [WMT data](http://statmt.org/wmt14/)), you need to install some additional dependencies. 1. For learning hierarchical models, Joshua includes a tool called [Thrax](thrax.html), which is built on Hadoop. If you have a Hadoop installation, make sure that the environment variable http://git-wip-us.apache.org/repos/asf/incubator-joshua-site/blob/33eedd8d/language-packs/index.md ---------------------------------------------------------------------- diff --git a/language-packs/index.md b/language-packs/index.md index c016de1..c07b6f4 100644 --- a/language-packs/index.md +++ b/language-packs/index.md @@ -17,6 +17,14 @@ It is important to note the assumptions underlying the translation engine: - Additionally, the input must be tokenized. To tokenize your data, you can use the script provided in each language pack. +## Runtime decoder + +The default release version of Joshua includes hundreds of megabytes of dependencies used +for building models from your own language pairs. If you only wish to run language packs +(effectively using Joshua as a black-box translation engine), you can install a "light" version +of Joshua that includes only dependencies needed to run the translation piece. See the notes +on [the installation page](../6/install.html). + ## Available language packs <table class="table table-condensed">
