capability__unequal_length__removes#

capability__unequal_length__removes()[source]#

Capability: the transformer produces equal length series on unequal length input.

  • String name: "capability:unequal_length:removes"

  • Public capability tag

  • Values: boolean, True / False

  • Example: True

  • Default: False

This tag is only meaningful for transformers that return time series as output, i.e., the tag scitype:transform-output is "Series" or "Panel".

The tag specifies whether the transformer returns equal length time series, when given unequal length time series as input. This is the case for example for truncation or padding transformers, that is, transformations that are specifically designed to remove unequal length. However, the tag may also be True for other transformers, that are not specifically designed for this purpose.

If the tag is True, the transformer will return equal length time series, when given unequal length time series as input.

If the tag is False, the transformer may return unequal length time series, when given unequal length time series as input.

Also see the tag capability:unequal_length:adds. The typical transformer with series output will have both tags being False.