Apache UIMA Ruta Guide and Reference - Apache UIMA - The ...

More documents

Recommendations

Info

Ruta Engine Name Short description Type removeBasics Option to remove all inference annotations after execution of the rule script. dynamicAnchoring Option to allow rule matches to start at any rule element. lowMemoryProfile Option to decrease the memory consumption when processing a large CAS. simpleGreedyForComposed Option to activate a different inferencer for composed rule elements. Single Boolean Single Boolean Single Boolean Single Boolean debug Option to add debug information to the CAS. Single Boolean debugWithMatches Option to add information about the rule matches to the CAS. debugOnlyFor List of rule ids. If provided, then debug information is only created for those rules. Single Boolean Multi String profile Option to add profile information to the CAS. Single Boolean statistics Option to add statistics of conditions and actions to the CAS. createdBy Option to add additional information, which rule created a annotation. mainScript Single Boolean Single Boolean This parameter specifies the rule file that will be executed by the analysis engine and is, therefore, one of the most important ones. The exact name of the script is given by the complete namespace of the file, which corresponds to its location relative to the given parameter scriptPaths. The single names of packages (or folders) are separated by periods. An exemplary value for this parameter could be "org.apache.uima.Main", whereas "Main" specifies the file containing the rules and "org.apache.uima" its package. In this case, the analysis engine loads the script file "Main.ruta", which is located in the folder structure "org/apache/uima/". This parameter has no default value and has to be provided, although it is not specified as mandatory. scriptEncoding This parameter specifies the encoding of the rule files. Its default value is "UTF-8". scriptPaths The parameter scriptPaths refers to a list of String values, which specify the possible locations of script files. The given locations are absolute paths. A typical value for this parameter is, for example, "C:/Ruta/MyProject/script/". If the parameter mainScript is set to org.apache.uima.Main, then the absolute path of the script file has to be "C:/Ruta/MyProject/script/org/apache/uima/ Main.ruta". This parameter can contain multiple values, as the main script can refer to multiple projects similar to a class path in Java. 12 Apache UIMA Ruta Overview UIMA Ruta Version 2.0.1
descriptorPaths Ruta Engine This parameter specifies the possible locations for descriptors like analysis engines or type systems, similar to the parameter scriptPaths for the script files. A typical value for this parameter is for example "C:/Ruta/MyProject/descriptor/". The relative values of the parameter additionalEngines are resolved to these absolute locations. This parameter can contain multiple values, as the main script can refer to multiple projects similar to a class path in Java. resourcePaths This parameter specifies the possible locations of additional resources like word lists or CSV tables. The string values have to contain absolute locations, for example, "C:/Ruta/MyProject/ resources/". additionalScripts The parameter additionalScripts is defined as a list of string values and contains script files, which are additionally loaded by the analysis engine. These script files are specified by their complete namespace, exactly like the value of the parameter mainScript and can be refered to by language elements, e.g., by executing the containing rules. An exemplary value of this parameter is "org.apache.uima.SecondaryScript". In this example, the main script could import this script file by the declaration "SCRIPT org.apache.uima.SecondaryScript;" and then could execute it with the rule "Document{-> CALL(SecondaryScript)};". additionalEngines This parameter contains a list of additional analysis engines, which can be executed by the UIMA Ruta rules. The single values are given by the name of the analysis engine with their complete namespace and have to be located relative to one value of the parameter descriptorPaths, the location where the analysis engine searches for the descriptor file. An example for one value of the parameter is "utils.HtmlAnnotator", which points to the descriptor "HtmlAnnotator.xml" in the folder "utils". additionalEngineLoaders The parameter "additionalEngineLoaders" specifies a list of optional implementations of the interface "org.apache.uima.ruta.extensions.IEngineLoader", which can be used to applicationspecific configurations of additional analysis engines. additionalExtensions This parameter specifies optional extensions of the UIMA Ruta language. The elements of the string list have to implement the interface "org.apache.uima.ruta.extensions.IRutaExtension". With these extensions, application-specific conditions and actions can be added to the set of provided ones. reloadScript This boolean parameter indicates whether the script or resource files should be reloaded when processing a CAS. The default value is set to false. In this case, the script files are loaded when the analysis engine is initialized. If script files or resource files are extended, e.g., a dictionary is filled yet when a collection of documents are processed, then the parameter is needed to be set to true in order to include the changes. UIMA Ruta Version 2.0.1 Apache UIMA Ruta Overview 13
Page 1 and 2: Apache UIMA Ruta Guide and Referenc
Page 3 and 4: Table of Contents 1. Apache UIMA Ru
Page 5: Apache UIMA Ruta Guide and Referenc
Page 8 and 9: Core Concepts then the actions of t
Page 10 and 11: Learning by Example There is also a
Page 12 and 13: Learning by Example matches on numb
Page 14 and 15: Learning by Example BLOCK(German) D
Page 16 and 17: Ruta Engine File specFile = new Fil
Page 20 and 21: seeders Ruta Engine This list of st
Page 22 and 23: 1.5.4. Modifier Modifier The Modifi
Page 24 and 25: Style Map Creator pattern. Per defa
Page 26 and 27: Basic annotations and tokens | ("BO
Page 28 and 29: Quantifiers Annotation Parent Descr
Page 30 and 31: Rule: SW CW[1,2] SW Matched: small
Page 32 and 33: Components //package "my.package" D
Page 34 and 35: 2.5.3.2. Example: Boolean Expressio
Page 36 and 37: 2.6.2.1. Definition: AND(Condition1
Page 38 and 39: 2.6.6.2. Example: CURRENTCOUNT Para
Page 40 and 41: 2.6.12. IS IS The IS condition eval
Page 42 and 43: 2.6.18. PARSE PARSE The PARSE condi
Page 44 and 45: 2.6.23.1. Definition: SIZE SCORE(Nu
Page 46 and 47: 2.7.2. ADDFILTERTYPE ADDFILTERTYPE
Page 48 and 49: CONFIGURE This rule colors all Head
Page 50 and 51: 2.7.13.2. Example: FILTERTYPE Headl
Page 52 and 53: 2.7.18. GETLIST GETLIST This action
Page 54 and 55: MARKONCE This rule annotates the la
Page 56 and 57: 2.7.27.2. Example: REMOVE Document{
Page 58 and 59: 2.7.33.2. Example: Document{->RETAI
Page 60 and 61: 2.7.38.2. Example: Keyword{-> TRIM(
Page 62 and 63: Blocks You will see that this match
Page 64 and 65: } Heuristic extraction using scorin
Page 66 and 67: WORDTABLEs WORDLIST FirstNameList =
Page 69 and 70:
Chapter 3. Apache UIMA Ruta Workben
Page 71 and 72:
UIMA Ruta Workbench Overview 2. The
Page 73 and 74:
UIMA Ruta create project wizard Fig
Page 75 and 76:
UIMA Ruta Perspective 3.4. UIMA Rut
Page 77 and 78:
Explain Perspective Figure 3.7. Sel
Page 79 and 80:
Matched Rules and Failed Rules 3.5.
Page 81 and 82:
Statistics The following image show
Page 83 and 84:
Usage script. As a product of the t
Page 85 and 86:
Usage collected result data can be
Page 87 and 88:
Usage The testing environment also
Page 89 and 90:
3.7.2. Evaluators Evaluators When t
Page 91 and 92:
Available Learners • Status: The
Page 93 and 94:
Martin Apply a UIMA Ruta script to
show all

Apache UIMA Ruta Guide and Reference - Apache UIMA - The ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?