Versions Compared

Key

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

...

The Simple Pipeline Fabricator can save your pipeline in a reusable Piper File, as well as load and run Piper Files.  It only assists creating cTAKES pipelines, displaying information and allowing selection of available Readers, Annotators and Writers (Pipe Bits).  It also displays information and facilitates assigning values to Pipe Bit parameters.  However, creating a proper working pipeline requires knowledge of basic NLP artifacts and dataflow. 

Step-by-step guide

Before or while using the Simple Pipeline Fabricator GUI, reference the information on Piper Files.

  1. From a command-line in the cTAKES root directory, execute: bin/runPiperCreator

  2. Click Scan to allow the tool to discover all pipeline components (Pipe Bits) available to cTAKES.  The scan may take several seconds.
  3. Select a Pipe Bit on the left.  Information on the Pipe Bit will be displayed in the center pane.
  4. Select a Parameter Name in the center table.  Information on the Parameter will be displayed below the table.
  5. Enter a Value in the table for any parameter that requires one.   An 'open file' button makes file selection easy.
  6. Click Add(plus) when all parameter requirements are met.  The Pipe Bit will be added to the piper file on the right.
  7. Continue to Add pipe bits in order to create your pipeline.
  8. Click the Validate  button when you are finished.  A valid piper will activate the run button.
  9. Click Saveto save to file.
  10. Click Run  to run your pipeline within the GUI.  If your pipeline is complex or you have a large amount of input/output, running with a bin/runPiperFile script is recommended. 

...