Skip to content

Latest commit

 

History

History
284 lines (166 loc) · 6.85 KB

LabelEncoder.md

File metadata and controls

284 lines (166 loc) · 6.85 KB

LabelEncoder

Encode target labels with value between 0 and n_classes-1.

This transformer should be used to encode target values, i.e. y, and not the input X.

Read more in the User Guide.

Python Reference

Constructors

constructor()

Signature

new LabelEncoder(opts?: object): LabelEncoder;

Parameters

Name Type Description
opts? object -
opts.classes_? ArrayLike Holds the label for each class.

Returns

LabelEncoder

Defined in: generated/preprocessing/LabelEncoder.ts:25

Methods

dispose()

Disposes of the underlying Python resources.

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

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/preprocessing/LabelEncoder.ts:88

fit()

Fit label encoder.

Signature

fit(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.y? ArrayLike Target values.

Returns

Promise<any>

Defined in: generated/preprocessing/LabelEncoder.ts:105

fit_transform()

Fit label encoder and return encoded labels.

Signature

fit_transform(opts: object): Promise<ArrayLike>;

Parameters

Name Type Description
opts object -
opts.y? ArrayLike Target values.

Returns

Promise<ArrayLike>

Defined in: generated/preprocessing/LabelEncoder.ts:138

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Signature

get_metadata_routing(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.routing? any A MetadataRequest encapsulating routing information.

Returns

Promise<any>

Defined in: generated/preprocessing/LabelEncoder.ts:173

init()

Initializes the underlying Python resources.

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

Signature

init(py: PythonBridge): Promise<void>;

Parameters

Name Type
py PythonBridge

Returns

Promise<void>

Defined in: generated/preprocessing/LabelEncoder.ts:48

inverse_transform()

Transform labels back to original encoding.

Signature

inverse_transform(opts: object): Promise<ArrayLike>;

Parameters

Name Type Description
opts object -
opts.y? ArrayLike Target values.

Returns

Promise<ArrayLike>

Defined in: generated/preprocessing/LabelEncoder.ts:208

set_output()

Set output container.

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

Signature

set_output(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.transform? "default" | "pandas" Configure output of transform and fit\_transform.

Returns

Promise<any>

Defined in: generated/preprocessing/LabelEncoder.ts:245

transform()

Transform labels to normalized encoding.

Signature

transform(opts: object): Promise<ArrayLike>;

Parameters

Name Type Description
opts object -
opts.y? ArrayLike Target values.

Returns

Promise<ArrayLike>

Defined in: generated/preprocessing/LabelEncoder.ts:278

Properties

_isDisposed

boolean = false

Defined in: generated/preprocessing/LabelEncoder.ts:23

_isInitialized

boolean = false

Defined in: generated/preprocessing/LabelEncoder.ts:22

_py

PythonBridge

Defined in: generated/preprocessing/LabelEncoder.ts:21

id

string

Defined in: generated/preprocessing/LabelEncoder.ts:18

opts

any

Defined in: generated/preprocessing/LabelEncoder.ts:19

Accessors

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/preprocessing/LabelEncoder.ts:35

Signature

py(pythonBridge: PythonBridge): void;

Parameters

Name Type
pythonBridge PythonBridge

Returns

void

Defined in: generated/preprocessing/LabelEncoder.ts:39