DocumentationClassesPolynomialFeatures

Class: PolynomialFeatures

Generate polynomial and interaction features.

Generate a new feature matrix consisting of all polynomial combinations of the features with degree less than or equal to the specified degree. For example, if an input sample is two dimensional and of the form [a, b], the degree-2 polynomial features are [1, a, b, a^2, ab, b^2].

Read more in the User Guide.

Python Reference

Constructors

new PolynomialFeatures()

new PolynomialFeatures(opts?): PolynomialFeatures

Parameters

ParameterTypeDescription
opts?object-
opts.degree?numberIf a single int is given, it specifies the maximal degree of the polynomial features. If a tuple (min_degree, max_degree) is passed, then min_degree is the minimum and max_degree is the maximum polynomial degree of the generated features. Note that min_degree=0 and min_degree=1 are equivalent as outputting the degree zero term is determined by include_bias.
opts.include_bias?booleanIf true (default), then include a bias column, the feature in which all polynomial powers are zero (i.e. a column of ones - acts as an intercept term in a linear model).
opts.interaction_only?booleanIf true, only interaction features are produced: features that are products of at most degree distinct input features, i.e. terms with power of 2 or higher of the same input feature are excluded:
opts.order?"C" | "F"Order of output array in the dense case. 'F' order is faster to compute, but may slow down subsequent estimators.

Returns PolynomialFeatures

Defined in generated/preprocessing/PolynomialFeatures.ts:25

Properties

PropertyTypeDefault valueDefined in
_isDisposedbooleanfalsegenerated/preprocessing/PolynomialFeatures.ts:23
_isInitializedbooleanfalsegenerated/preprocessing/PolynomialFeatures.ts:22
_pyPythonBridgeundefinedgenerated/preprocessing/PolynomialFeatures.ts:21
idstringundefinedgenerated/preprocessing/PolynomialFeatures.ts:18
optsanyundefinedgenerated/preprocessing/PolynomialFeatures.ts:19

Accessors

feature_names_in_

Get Signature

get feature_names_in_(): Promise<ArrayLike>

Names of features seen during fit. Defined only when X has feature names that are all strings.

Returns Promise<ArrayLike>

Defined in generated/preprocessing/PolynomialFeatures.ts:393


n_features_in_

Get Signature

get n_features_in_(): Promise<number>

Number of features seen during fit.

Returns Promise<number>

Defined in generated/preprocessing/PolynomialFeatures.ts:366


n_output_features_

Get Signature

get n_output_features_(): Promise<number>

The total number of polynomial output features. The number of output features is computed by iterating over all suitably sized combinations of input features.

Returns Promise<number>

Defined in generated/preprocessing/PolynomialFeatures.ts:420


py

Get Signature

get py(): PythonBridge

Returns PythonBridge

Set Signature

set py(pythonBridge): void

Parameters

ParameterType
pythonBridgePythonBridge

Returns void

Defined in generated/preprocessing/PolynomialFeatures.ts:58

Methods

dispose()

dispose(): Promise<void>

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Returns Promise<void>

Defined in generated/preprocessing/PolynomialFeatures.ts:114


fit()

fit(opts): Promise<any>

Compute number of output features.

Parameters

ParameterTypeDescription
optsobject-
opts.X?ArrayLikeThe data.
opts.y?anyNot used, present here for API consistency by convention.

Returns Promise<any>

Defined in generated/preprocessing/PolynomialFeatures.ts:131


fit_transform()

fit_transform(opts): Promise<any[]>

Fit to data, then transform it.

Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.

Parameters

ParameterTypeDescription
optsobject-
opts.fit_params?anyAdditional fit parameters.
opts.X?ArrayLike[]Input samples.
opts.y?ArrayLikeTarget values (undefined for unsupervised transformations).

Returns Promise<any[]>

Defined in generated/preprocessing/PolynomialFeatures.ts:172


get_feature_names_out()

get_feature_names_out(opts): Promise<any>

Get output feature names for transformation.

Parameters

ParameterTypeDescription
optsobject-
opts.input_features?anyInput features.

Returns Promise<any>

Defined in generated/preprocessing/PolynomialFeatures.ts:218


get_metadata_routing()

get_metadata_routing(opts): Promise<any>

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Parameters

ParameterTypeDescription
optsobject-
opts.routing?anyA MetadataRequest encapsulating routing information.

Returns Promise<any>

Defined in generated/preprocessing/PolynomialFeatures.ts:256


init()

init(py): Promise<void>

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Parameters

ParameterType
pyPythonBridge

Returns Promise<void>

Defined in generated/preprocessing/PolynomialFeatures.ts:71


set_output()

set_output(opts): Promise<any>

Set output container.

See Introducing the set_output API for an example on how to use the API.

Parameters

ParameterTypeDescription
optsobject-
opts.transform?"default" | "pandas" | "polars"Configure output of transform and fit_transform.

Returns Promise<any>

Defined in generated/preprocessing/PolynomialFeatures.ts:294


transform()

transform(opts): Promise<ArrayLike>

Transform data to polynomial features.

Parameters

ParameterTypeDescription
optsobject-
opts.X?ArrayLikeThe data to transform, row by row. Prefer CSR over CSC for sparse input (for speed), but CSC is required if the degree is 4 or higher. If the degree is less than 4 and the input format is CSC, it will be converted to CSR, have its polynomial features generated, then converted back to CSC. If the degree is 2 or 3, the method described in “Leveraging Sparsity to Speed Up Polynomial Feature Expansions of CSR Matrices Using K-Simplex Numbers” by Andrew Nystrom and John Hughes is used, which is much faster than the method used on CSC input. For this reason, a CSC input will be converted to CSR, and the output will be converted back to CSC prior to being returned, hence the preference of CSR.

Returns Promise<ArrayLike>

Defined in generated/preprocessing/PolynomialFeatures.ts:328