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. 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 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.
    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.
    Gliffy Diagram
    nameset global value
  4. Set a reader for your pipeline.  readFiles is a convenience method, equivalent to "reader FileTreeReader".  Note: if you run with PiperFileRunner and do not specify a reader then FileTreeReader will be used.

  5. To add common groups of components, load another piper file.  See Table 2 for piper files in cTAKES.
  6. If you 

 

 

 

ContainsClearNLPDependencyParserAE ClearNLPSemanticRoleLabelerAE PolarityCleartkAnalysisEngine UncertaintyCleartkAnalysisEngine HistoryCleartkAnalysisEngine ConditionalCleartkAnalysisEngine GenericCleartkAnalysisEngine SubjectCleartkAnalysisEngine
ModulePiper fileModuleDescription
coreDefaultTokenizerPipeline.pipercoreComplete Tokenizer pipeline.
SimpleSegmentAnnotator SentenceDetector TokenizerAnnotatorPTBchunkerChunkerSubPipe.piperchunkerChunker partial pipeline.
Chunker ChunkAdjuster (NP,NP 1) ChunkAdjuster (NP,NP,NP 2)assertionAssertionSubPipe.piperassertionEntity attribute partial pipeline.
ClearNLPDependencyParserAE ClearNLPSemanticRoleLabelerAE ConceptConverterAnalysisEngine AssertionAnalysisEngineFit GenericAttributeAnalysisEngine SubjectAttributeAnalysisEngineassertionAttributeCleartkSubPipe.piperassertionEntity attribute partial pipeline.
DefaultFastPipeline.piperclinical-pipelineDefaultFastPipelineComplete Clinical pipeline.DefaultTokenizerPipeline.piper ContextDependentTokenizerAnnotator POSTagger ChunkerSubPipe.piper DefaultJCasTermAnnotator AttributeCleartkSubPipe.piper

Table 2.  Available standard piper files in cTAKES.

...