requires_y#
- requires_y()[source]#
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 argumenty
to be passed in thefit
method, as well as in theupdate
method. The type ofy
required is specified by the tagscitype:transform-labels
. The requirement to passy
is usually in addition to passingX
.If the tag is
True
, it does not necessarily imply thaty
is also required in thetransform
orinverse_transform
methods. This may be the case, but is not implied by this tag. Usually,y
is not required intransform
orinverse_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 argumenty
to be passed in any method.