Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Create an empty text file.  The standard file extension for piper files is .piper
  2. Set a reader for your pipeline.   To set values to parameters used by the reader class, simply add one or more name=value pairs after the class name.   * readFiles is a convenience command.  "readFiles my/data" is equivalent to "reader FileTreeReader InputDirectory=my/data".
  3. 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=value pairs after the class name. 
  4. load common groups of components from another piper file.  See Table 2 for piper files in cTAKES.
  5. reader, load and To add multiple pipeline components from a package not standard to cTAKES, use the package command to point to it.
    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  or cc package 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.  Using package simplifies this
  6. Use package to simplify adding multiple pipeline components from a package not standard to cTAKES.
    Gliffy Diagram
    chromemin
    nameUse of package
  7. To easily add multiple components that use the same parameter, use Use set to assign a value to that a parameter used by following components.
    Gliffy Diagram
    nameset global value

    *A name=value pair on a component line will, for that component, override a set parameter value.
  8. cli is a special type of Set a reader for your pipeline.  readFiles is a convenience method, .  "readFiles my/data" is equivalent to "reader FileTreeReader ".  Note: if you run with PiperFileRunner and do not specify a reader then FileTreeReader will be usedInputDirectory=my/data".

  9. To add common groups of components, load another piper file.  See Table 2 for piper files in cTAKES.
  10. If you add annotation engines and cas consumers to your pipeline. 

 

 

 

ModulePiper fileDescription
coreDefaultTokenizerPipelineComplete Tokenizer pipeline.
chunkerChunkerSubPipeChunker partial pipeline.
assertionAssertionSubPipeEntity attribute partial pipeline.
assertionAttributeCleartkSubPipeEntity attribute partial pipeline.
clinical-pipelineDefaultFastPipelineComplete Clinical pipeline.

...