pliers.transformers.BatchTransformerMixin

class pliers.transformers.BatchTransformerMixin(batch_size=None, *args, **kwargs)

Bases: Transformer

A mixin that overrides the default implicit iteration behavior. Use whenever batch processing of multiple stimuli should be handled within the _transform method rather than applying a naive loop–e.g., for API Extractors that can handle list inputs.

Parameters

• batch_size (int) – Number of Stims to process in each batch.

• args – Optional positional and keyword arguments to pass onto the base Transformer initializer.

• kwargs – Optional positional and keyword arguments to pass onto the base Transformer initializer.

__init__(batch_size=None, *args, **kwargs)

transform(stims, validation='strict', *args, **kwargs)

Executes the transformation on the passed stim(s).

Parameters

• stims (str, Stim, list) –

  One or more stimuli to process. Must be one of:

  • A string giving the path to a file that can be read in as a Stim (e.g., a .txt file, .jpg image, etc.)

  • A Stim instance of any type.

  • An iterable of stims, where each element is either a string or a Stim.

• validation (str) –

  String specifying how validation errors should be handled. Must be one of:

  • ’strict’: Raise an exception on any validation error

  • ’warn’: Issue a warning for all validation errors

  • ’loose’: Silently ignore all validation errors

• args – Optional positional arguments to pass onto the internal _transform call.

• kwargs – Optional positional arguments to pass onto the internal _transform call.