THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
- XML Descriptor files are the original method used to create pipelines in Apache UIMA™. Though self-descriptive, they are verbose and error prone.
- uimaFIT™ enables creation of pipelines through Java code. This greatly simplifies unit testing and experimentation.
The
PipelineBuilderclass in ctakes-core is a facade for uimaFIT™ factories and objects.- Piper files are a modern equivalent of the XML descriptor files. Piper files list basic commands and parameters in a flat format.
| Command | Parameter 1 | Parameters 2-n | Description |
|---|---|---|---|
| package | package path | Add to known packages. Shortens load and add specifications. | |
| load | Piper file path | Load external piper file. | |
| set | name=value | <name=value ...> | Add global parameter values. |
| cli | name=char | <name=char ...> | Add global parameter values based upon command-line character option values. |
| reader | CR name | <name=value ...> | Set the collection reader for pipeline input data. |
| readFiles | input directory | Set the collection reader for pipeline input data to the files in directory tree reader. | |
| add | AE or CC name | <name=value ...> | Add AE/CC to pipeline. |
| addDescription | AE or CC name | <value ...> | Add AE/CC to pipeline using its .createDescription method. |
| addLogged | AE or CC name | <name=value ...> | Add AE/CC to pipeline with Start/Finish logging. |
| addLast | AE or CC name | <name=value ...> | Add AE/CC to the end of pipeline. Useful if the pipeline is meant to be extended. |
| writeXmis | output directory | Add XMI writer to the pipeline. | |
| // or # or ! | comment text | Line Comment. |
...
- Create an empty text file. The standard file extension for piper files is
.piper - Set a reader for your pipeline. To set values to parameters used by the reader class, simply add one or more
name=valuepairs after the class name. * readFiles is a convenience command. "readFiles my/data" is equivalent to "reader FileTreeReader InputDirectory=my/data". - add annotation engines and cas consumers to your pipeline. To set values to parameters used by the annotation engine class, simply add one or more
name=valuepairs after the class name. - load common groups of components from another piper file. See Table 2 for piper files in cTAKES.
- reader, load and add* commands all take class names or file directories as their first parameter. If the class is not in a standard cTAKES module's cr ae or cc package, or a piper file is not in a standard module's pipeline/ directory then the package or path must be specified for that component / file.
- Use package to simplify adding multiple pipeline components from a package not standard to cTAKES.
Gliffy Diagram chrome min name Use of package - Use set to assign a value to a parameter used by following components.
Gliffy Diagram name set global value
*Aname=valuepair on a component line will, for that component, override a set parameter value. cli is a special type of set that sets a parameter to some value entered by the User on a command line.
* cli can only be used with theGliffy Diagram name Use of cli PiperFileRunnerclass or thebin/runPiperFilescript.
* Reserved parameters unavailable for cli are listed in Table 3.et Set a reader for your pipeline. readFiles is a convenience method. "readFiles my/data" is equivalent to "reader
FileTreeReader InputDirectory=my/data".- To add common groups of components, load another piper file. See Table 2 for piper files in cTAKES.
- add annotation engines and cas consumers to your pipeline.
...