Skip to content

How to Run

Kotaro Sakamoto edited this page Feb 7, 2017 · 4 revisions

Run whole Pipeline

sbt "run-main uima.cpe.CPERunner"

Run a part of Pipeline

sbt "run-main uima.cpe.CPERunner -from [intermediate point] -to [intermediate point]"

Intermediate points:

UIMA Component [intermediate point]
[[Essay Question Reader https://github.com/ktr-skmt/FelisCatusZero/blob/master/src/main/scala/uima/cr/EssayQuestionReader.scala]]
[[Question Analyzer https://github.com/ktr-skmt/FelisCatusZero/blob/master/src/main/scala/uima/ae/QuestionAnalyzer.scala]]
[[Information Retriever https://github.com/ktr-skmt/FelisCatusZero/blob/master/src/main/scala/uima/ae/InformationRetriever.scala]]
[[Essay Generator https://github.com/ktr-skmt/FelisCatusZero/blob/master/src/main/scala/uima/ae/EssayGenerator.scala]]
[[Essay Writer https://github.com/ktr-skmt/FelisCatusZero/blob/master/src/main/scala/uima/cc/EssayWriter.scala]]
[[Essay Evaluator https://github.com/ktr-skmt/FelisCatusZero/blob/master/src/main/scala/uima/cc/EssayEvaluator.scala]]

Note that you have to run whole pipeline at first before running from an intermediate point except cr or qa.

For example, after you have already run the whole pipeline, when you want to do JCasGen and run the pipeline from Essay Generator, you can run it as below.

sbt "run-main uima.cpe.CPERunner -doJCasGen -from eg"

When you want just to run the pipeline from Essay Generator to Essay Writer, you can run it as below.

sbt "run-main uima.cpe.CPERunner -from eg -to w"

Examples of Runs

tutorial/run.ipynb

Help

sbt "run-main uima.cpe.CPERunner --help"

[info] Running uima.cpe.CPERunner --help
[info]  -doCharacterLevelIndriIndex            : do IndriIndex with character as
[info]  (--generateCharacterLevelIndriIndex)     pre-processing (default: false)
[info]  -doFastText (--generateFastTextModel)  : do fastText as pre-processing
[info]                                           (default: false)
[info]  -doJCasGen (--generateJCas)            : do JCasGen as pre-processing
[info]                                           (default: false)
[info]  -doWordLevelIndriIndex (--generateWord : do IndriIndex with word as
[info]  LevelIndriIndex)                         pre-processing (default: false)
[info]  -from (--startPoint) VAL               : start point: cr (EssayQuestionReader)
[info]                                           = default, qa (QuestionAnalyzer), ir
[info]                                           (InformationRetriever), eg
[info]                                           (EssayGenerator), w (EssayWriter), e
[info]                                           (EssayEvaluator) (default: cr)
[info]  -to (--endPoint) VAL                   : end point: cr (EssayQuestionReader),
[info]                                           qa (QuestionAnalyzer), ir
[info]                                           (InformationRetriever), eg
[info]                                           (EssayGenerator), w (EssayWriter), e
[info]                                           (EssayEvaluator) = default (default:
[info]                                           e)
[info]  -unSave (--unSaveIntermediateState)    : unsave intermediate state. If you
[info]  VAL                                      want to unsave all state, use
[info]                                           '-unSave=all' or '-unSave=qa,ir,eg'.
[info]                                           If you want to unsave the qa state,
[info]                                           use '-unSave=qa'. If you want to
[info]                                           unsave the qa and eg states, use
[info]                                           '-unSave=qa,eg'. (default: )
[success] Total time: 6 s, completed Jan 25, 2017 3:25:50 AM

-doFastText (--generateFastTextModel) option in the help is not supported.

Jupyter

Tutorial (tutorial/run.ipynb) uses Jupyter Bash to show the command lines on Github. http://jupyter.org/

Clone this wiki locally