You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@joshua.apache.org by mj...@apache.org on 2016/06/01 02:52:26 UTC
[91/94] [abbrv] incubator-joshua git commit: updated README
updated README
Project: http://git-wip-us.apache.org/repos/asf/incubator-joshua/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-joshua/commit/408416c7
Tree: http://git-wip-us.apache.org/repos/asf/incubator-joshua/tree/408416c7
Diff: http://git-wip-us.apache.org/repos/asf/incubator-joshua/diff/408416c7
Branch: refs/heads/JOSHUA-252
Commit: 408416c73cd818969111858d542af03654354d50
Parents: 04428ff
Author: Matt Post <po...@cs.jhu.edu>
Authored: Tue May 31 22:12:19 2016 -0400
Committer: Matt Post <po...@cs.jhu.edu>
Committed: Tue May 31 22:33:16 2016 -0400
----------------------------------------------------------------------
README.md | 22 +++++++++-------------
build.xml | 1 +
download-deps.sh | 8 ++++++++
examples/README.md | 2 +-
4 files changed, 19 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/408416c7/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index de8edf2..b021f85 100644
--- a/README.md
+++ b/README.md
@@ -25,10 +25,11 @@ Joshua 6.X includes the following new features:
## Quick start
-Joshua must be run with a Java JDK 1.8 minimum. Anything older than that will not run.
+Joshua must be run with a Java JDK 1.8 minimum.
To run the decoder in any form requires setting a few basic environment
-variables: `$JAVA_HOME`, `$JOSHUA`, and potentially `$MOSES`.
+variables: `$JAVA_HOME`, `$JOSHUA`, and, for certain portions of the model-training
+pipeline, potentially `$MOSES`.
export JAVA_HOME=/path/to/java # maybe /usr/java/home
export JOSHUA=/path/to/joshua
@@ -41,7 +42,7 @@ You might also find it helpful to set these:
Then, compile Joshua by typing:
cd $JOSHUA
- ant
+ mvn clean compile assembly:single
The basic method for invoking the decoder looks like this:
@@ -49,17 +50,12 @@ The basic method for invoking the decoder looks like this:
Some example usage scenarios and scripts can be found in the [examples/](https://github.com/apache/incubator-joshua/tree/master/examples) directory.
-----
-### Maven Build
-
-### Create executable jar
-
- mvn clean compile assembly:single
+## Development With Eclipse
-### Run the jar
+If you are hoping to work on the decoder, we suggest you use Eclipse. You can get started
+with this by typing
- java -jar target/joshua-6.0.6-SNAPSHOT-jar-with-dependencies.jar
-
+ mvn eclipse:eclipse
## Working with "language packs"
@@ -77,4 +73,4 @@ grammar construction, and tuning of the model parameters. See [the documentation
for a walkthrough and more information about the many available options.
# License
-Joshua is licensed and released under the permissive [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0), a copy of which ships with the Joshua source code.
\ No newline at end of file
+Joshua is licensed and released under the permissive [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0), a copy of which ships with the Joshua source code.
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/408416c7/build.xml
----------------------------------------------------------------------
diff --git a/build.xml b/build.xml
index 8cbeeef..e688da8 100644
--- a/build.xml
+++ b/build.xml
@@ -416,3 +416,4 @@
</project>
+
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/408416c7/download-deps.sh
----------------------------------------------------------------------
diff --git a/download-deps.sh b/download-deps.sh
new file mode 100755
index 0000000..a01f593
--- /dev/null
+++ b/download-deps.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+git clone https://github.com/kpu/kenlm.git ext/kenlm
+(cd ext/kenlm; git checkout 56fdb5c44fca34d5a2e07d96139c28fb163983c5)
+./jni/build_kenlm.sh
+
+git clone https://github.com/joshua-decoder/berkeleylm.git ext/berkeleylm
+(cd ext/berkeleylm; ant)
http://git-wip-us.apache.org/repos/asf/incubator-joshua/blob/408416c7/examples/README.md
----------------------------------------------------------------------
diff --git a/examples/README.md b/examples/README.md
index c2f14ee..1468372 100644
--- a/examples/README.md
+++ b/examples/README.md
@@ -45,4 +45,4 @@ C) Train the model:
--corpus $SPANISH/corpus/asr/fisher_train \
--tune $SPANISH/corpus/asr/fisher_dev \
--test $SPANISH/corpus/asr/callhome_devtest \
- --lm-order 3
\ No newline at end of file
+ --lm-order 3