Class: SelectFpr
Filter: Select the pvalues below alpha based on a FPR test.
FPR test stands for false
Positive Rate test. It controls the total amount of false detections.
Read more in the User Guide.
Constructors
new SelectFpr()
new SelectFpr(
opts
?):SelectFpr
Parameters
Parameter | Type | Description |
---|---|---|
opts ? | object | - |
opts.alpha ? | number | Features with p-values less than alpha are selected. |
opts.score_func ? | any | Function taking two arrays X and y, and returning a pair of arrays (scores, pvalues). Default is f_classif (see below “See Also”). The default function only works with classification tasks. |
Returns SelectFpr
Defined in generated/feature_selection/SelectFpr.ts:25
Properties
Property | Type | Default value | Defined in |
---|---|---|---|
_isDisposed | boolean | false | generated/feature_selection/SelectFpr.ts:23 |
_isInitialized | boolean | false | generated/feature_selection/SelectFpr.ts:22 |
_py | PythonBridge | undefined | generated/feature_selection/SelectFpr.ts:21 |
id | string | undefined | generated/feature_selection/SelectFpr.ts:18 |
opts | any | undefined | generated/feature_selection/SelectFpr.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/feature_selection/SelectFpr.ts:464
n_features_in_
Get Signature
get n_features_in_():
Promise
<number
>
Number of features seen during fit.
Returns Promise
<number
>
Defined in generated/feature_selection/SelectFpr.ts:439
pvalues_
Get Signature
get pvalues_():
Promise
<ArrayLike
>
p-values of feature scores.
Returns Promise
<ArrayLike
>
Defined in generated/feature_selection/SelectFpr.ts:416
py
Get Signature
get py():
PythonBridge
Returns PythonBridge
Set Signature
set py(
pythonBridge
):void
Parameters
Parameter | Type |
---|---|
pythonBridge | PythonBridge |
Returns void
Defined in generated/feature_selection/SelectFpr.ts:42
scores_
Get Signature
get scores_():
Promise
<ArrayLike
>
Scores of features.
Returns Promise
<ArrayLike
>
Defined in generated/feature_selection/SelectFpr.ts:393
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/feature_selection/SelectFpr.ts:93
fit()
fit(
opts
):Promise
<any
>
Run score function on (X, y) and get the appropriate features.
Parameters
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.X ? | ArrayLike [] | The training input samples. |
opts.y ? | ArrayLike | The target values (class labels in classification, real numbers in regression). If the selector is unsupervised then y can be set to undefined . |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:110
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
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.fit_params ? | any | Additional fit parameters. |
opts.X ? | ArrayLike [] | Input samples. |
opts.y ? | ArrayLike | Target values (undefined for unsupervised transformations). |
Returns Promise
<any
[]>
Defined in generated/feature_selection/SelectFpr.ts:149
get_feature_names_out()
get_feature_names_out(
opts
):Promise
<any
>
Mask feature names according to selected features.
Parameters
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.input_features ? | any | Input features. |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:191
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
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.routing ? | any | A MetadataRequest encapsulating routing information. |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:227
get_support()
get_support(
opts
):Promise
<any
>
Get a mask, or integer index, of the features selected.
Parameters
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.indices ? | boolean | If true , the return value will be an array of integers, rather than a boolean mask. |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:261
init()
init(
py
):Promise
<void
>
Initializes the underlying Python resources.
This instance is not usable until the Promise
returned by init()
resolves.
Parameters
Parameter | Type |
---|---|
py | PythonBridge |
Returns Promise
<void
>
Defined in generated/feature_selection/SelectFpr.ts:55
inverse_transform()
inverse_transform(
opts
):Promise
<any
>
Reverse the transformation operation.
Parameters
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.X ? | any | The input samples. |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:295
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
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.transform ? | "default" | "pandas" | "polars" | Configure output of transform and fit_transform . |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:329
transform()
transform(
opts
):Promise
<any
>
Reduce X to the selected features.
Parameters
Parameter | Type | Description |
---|---|---|
opts | object | - |
opts.X ? | any | The input samples. |
Returns Promise
<any
>
Defined in generated/feature_selection/SelectFpr.ts:361