Toggle Menu
Prev Up Next

scikit-learn 1.3.2
Other versions

Please cite us if you use the software.

# `sklearn.base`.ClassNamePrefixFeaturesOutMixin

class sklearn.base.ClassNamePrefixFeaturesOutMixin

  Mixin class for transformers that generate their own names by prefixing.

  This mixin is useful when the transformer needs to generate its own feature names out, such as `PCA`. For example, if `PCA` outputs 3 features, then the generated feature names out are: `["pca0", "pca1", "pca2"]`.

  This mixin assumes that a `_n_features_out` attribute is defined when the transformer is fitted. `_n_features_out` is the number of output features that the transformer will return in `transform` of `fit_transform`.

  Methods

  `get_feature_names_out`([input_features]) | Get output feature names for transformation.

  get_feature_names_out(input_features=None)

    Get output feature names for transformation.

    The feature names out will prefixed by the lowercased class name. For example, if the transformer outputs 3 features, then the feature names out are: `["class_name0", "class_name1", "class_name2"]`.

    Parameters:
      input_features array-like of str or None, default=None

        Only used to validate feature names with the names seen in `fit`.

    Returns:
      feature_names_out ndarray of str objects

        Transformed feature names.