brain_pipe.pipeline.base.Pipeline

class Pipeline(steps: Sequence[PipelineStep], *args, **kwargs)

Bases: PipelineStep, ABC

The base pipeline class.

A pipeline represents a sequence of preprocessing steps (steps) that are applied in order to a data dictionary. The output of one step is the input of the next step.

See also

Overview, PipelineStep

brain_pipe.pipeline.default.DefaultPipleine

as a template.

__init__(steps: Sequence[PipelineStep], *args, **kwargs)

Initialize the pipeline.

Parameters:

  • steps (Sequence[PipelineStep]) – A sequence of PipelineSteps.

  • args – Additional arguments for the PipelineStep class.

  • kwargs – Additional keyword arguments for the PipelineStep class.

Methods

__init__(steps, *args, **kwargs)

Initialize the pipeline.

parse_dict_keys(key[, name, ...])

Parse a key or a sequence of keys.
parse_dict_keys(key: str | Sequence[str] | Mapping[str, str], name='key', require_ordered_dict=False) → OrderedDict[str, str]

Parse a key or a sequence of keys.

Parameters:

  • key (Union[str, Sequence[str], Mapping[str,str]]) – A key or a sequence of keys.

  • name (str) – The name of the key. Used for error messages.

  • require_ordered_dict (bool) – If True, the key must be an OrderedDict. If False, the key can also be an ordinary dict.

Returns:

A mapping of input keys to output keys.

Return type:

OrderedDict[str, str]

Raises:

TypeError – If the key is not a string, a sequence of strings or a mapping of strings. If the key is a mapping but require_ordered_dict is True and the mapping is not an OrderedDict.