Custom Pipeline Steps

OctaiPipe allows users to create their own custom pipeline steps. This gives customizability to tailor OctaiPipe to users’ needs.

A guide to creating and uploading a custom step can be found here.

Example custom steps can be found at Guide - Custom Pipeline Steps

Registering Custom Steps

To see existing functionalities for testing and registering custom steps through the Pythonic Interface, see the develop interface documentation at: Python Interface

Custom steps can also be created and viewed in the Portal UI. Navigate to the Custom Steps tab to view a table of existing custom steps. From here, users can also create new custom steps through the Import Custom Steps button.

Custom steps have to be a Python file that defines a class inheriting from the PipelineStep base class. If the custom step already exists, users can register a new version of the step.

In order to run a custom pipeline step, the name of the pipeline step can simply be provided when running OctaiPipe. If the step is not found in the base mapping of steps, it will be searched for online and retrieved if it exists in storage. In this way, both pipeline steps that a user has themselves saved in storage or steps that have been publicly shared can be used. Alternatively, the user can run a custom pipeline step locally without having to register it online.