Versions Compared

Key

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

...

Table 1.  Standard Piper commands.
A  A complete runnable pipeline can be created using a reader (or readFiles) and only add commands.

Step-by-step guide

...

  1. Create an empty text file.  The standard file extension for piper files is .piper
  2. To easily 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 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.  Using package simplifies this.  The two examples below are functionally equivalent.
    Gliffy Diagram
    chromemin
    nameUse of package
  3. To easily add multiple components that use the same parameter, use set to assign a value to that parameter.
  4. Set a reader for your pipeline.  readFiles is a convenience method, equivalent to "reader FileTreeReader".
  5. If applicable, start with a load of an available piper file.  See Table 2 for standard piper files in cTAKES.
  6. If you 

 

 

 

Piper fileModuleDescriptionContains
DefaultTokenizerPipeline.pipercoreComplete Tokenizer pipeline.SimpleSegmentAnnotator SentenceDetector TokenizerAnnotatorPTB
ChunkerSubPipe.piperchunkerChunker partial pipeline.Chunker ChunkAdjuster (NP,NP 1) ChunkAdjuster (NP,NP,NP 2)
AssertionSubPipe.piperassertionEntity attribute partial pipeline.ClearNLPDependencyParserAE ClearNLPSemanticRoleLabelerAE ConceptConverterAnalysisEngine AssertionAnalysisEngineFit GenericAttributeAnalysisEngine SubjectAttributeAnalysisEngine
AttributeCleartkSubPipe.piperassertionEntity attribute partial pipeline.ClearNLPDependencyParserAE ClearNLPSemanticRoleLabelerAE PolarityCleartkAnalysisEngine UncertaintyCleartkAnalysisEngine HistoryCleartkAnalysisEngine ConditionalCleartkAnalysisEngine GenericCleartkAnalysisEngine SubjectCleartkAnalysisEngine
DefaultFastPipeline.piperclinical-pipelineComplete Clinical pipeline.DefaultTokenizerPipeline.piper ContextDependentTokenizerAnnotator POSTagger ChunkerSubPipe.piper DefaultJCasTermAnnotator AttributeCleartkSubPipe.piper

...