Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the What you really need to know section for the big picture.

julearn.transformers.target.register_target_transformer

julearn.transformers.target.register_target_transformer(transformer_name, transformer_cls, overwrite=None)

Register a target transformer to julearn.

Parameters:

  • transformer_name (str) – Name by which the transformer will be referenced by

  • transformer_cls (type[JuTargetTransformer]) – The class by which the transformer can be initialized from.

  • overwrite (bool | None, default: None) – decides whether overwrite should be allowed. Options are:

Raises:

ValueError – If transformer_name is already registered and overwrite is False.

Warns:
RuntimeWarning

If transformer_name is already registered and overwrite is None.