requires_y#

Behaviour flag: transformer requires y in fit.

String name: "requires_y"
Public behaviour flag
Values: boolean, True / False
Example: True
Default: False

This tag applies to transformations.

If the tag is True, the transformer requires the target data argument y to be passed in the fit method, as well as in the update method. The type of y required is specified by the tag scitype:transform-labels. The requirement to pass y is usually in addition to passing X.

If the tag is True, it does not necessarily imply that y is also required in the transform or inverse_transform methods. This may be the case, but is not implied by this tag. Usually, y is not required in transform or inverse_transform. There is currently no tag to specify this requirement, users should consult the documentation of the transformer.

If the tag is False, the transformer does not require the target data argument y to be passed in any method.