From 859cda0d874bf08223bc152d7e3ab0aa02f8e6bb Mon Sep 17 00:00:00 2001 From: sroy9 Date: Mon, 14 Nov 2016 23:25:55 -0600 Subject: [PATCH] Readme changes --- .gitignore | 3 ++- README.md | 13 ++++++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index e7af201..5c5caa7 100644 --- a/.gitignore +++ b/.gitignore @@ -19,4 +19,5 @@ models/ easyccg* giza* parallel* -data/shyam* \ No newline at end of file +data/shyam* +*~ \ No newline at end of file diff --git a/README.md b/README.md index 2ee12fb..117f774 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,24 @@ Data can be found in the folder data/equationparsebrat/. Instructions to run the code : +You will need to have maven installed in your system. To download the +dependencies, run + + mvn dependency:copy-dependencies + +Next compile using : + + mvn compile + +Finally here are the options: + 1. sh run.sh Numoccur : Predicts quantity trigger list. Output file log/Numoccur.out 2. sh run.sh Var : Predicts variable trigger list. Output file log/Var.out 3. sh run.sh Tree : Predicts equation tree. Output file log/Tree.out -4. sh run.sh Pipeline : Runs the first three classifiers in a pipeline, and predicts complete equation parse. Output file log/Pipeline.out +4. sh run.sh Pipeline : Runs the first three classifiers in a pipeline, and predicts complete equation parse. Output file log/Pipeline.out. Assumes steps 1-3 have been already run. 5. sh run.sh : Runs the pipeline method end to end, basically runs steps 1 to 4.