HCA

Defined in: ds/src/ml/estimators/HCA.js:11

Extends

Estimator

Constructors

Constructor

new HCA(params?): HCA

Defined in: ds/src/ml/estimators/HCA.js:12

Parameters

params?

Returns

HCA

Overrides

Estimator.constructor

Properties

_state

_state: object

Defined in: ds/src/core/estimators/estimator.js:27

Inherited from

Estimator._state

_warnings

_warnings: any[]

Defined in: ds/src/core/estimators/estimator.js:29

Inherited from

Estimator._warnings

fitted

fitted: boolean

Defined in: ds/src/core/estimators/estimator.js:25

Inherited from

Estimator.fitted

labels

labels: number[]

Defined in: ds/src/ml/estimators/HCA.js:17

model

model: any

Defined in: ds/src/ml/estimators/HCA.js:16

params

params: object

Defined in: ds/src/ml/estimators/HCA.js:15

k

k: any = null

linkage

linkage: string = 'average'

omit_missing

omit_missing: boolean = true

Inherited from

Estimator.params

Methods

_prepareArgsForFit()

_prepareArgsForFit(args?): { columns?: undefined; columnsX: any[]; prepared: boolean; raw?: undefined; rows: any[]; X: any[][]; y: any[]; } | { columns: any[]; columnsX?: undefined; prepared: boolean; raw?: undefined; rows: any[]; X: any[][]; y?: undefined; } | { columns?: undefined; columnsX?: undefined; prepared?: undefined; raw: any[]; rows?: undefined; X?: undefined; y?: undefined; }

Defined in: ds/src/core/estimators/estimator.js:367

Convenience helper: parse arguments passed to fit/predict/transform.

Supports declarative table-style inputs:

fit({ X, y, data, omit_missing })
fit({ data, columns, … })

Returns an object { X, y, prepared, rows } where X/y are numeric arrays if preparation was required, otherwise returns the original values.

Note: this helper only prepares numeric matrices/vectors using core table utilities; it does not perform encoding of categorical predictors.

Parameters

args?

any[] = []

Returns

{ columns?: undefined; columnsX: any[]; prepared: boolean; raw?: undefined; rows: any[]; X: any[][]; y: any[]; } | { columns: any[]; columnsX?: undefined; prepared: boolean; raw?: undefined; rows: any[]; X: any[][]; y?: undefined; } | { columns?: undefined; columnsX?: undefined; prepared?: undefined; raw: any[]; rows?: undefined; X?: undefined; y?: undefined; }

Inherited from

Estimator._prepareArgsForFit

_repr_html_()

_repr_html_(): string

Defined in: ds/src/core/estimators/estimator.js:201

Observable/Jupyter HTML representation

Returns

string

HTML representation

Inherited from

Estimator._repr_html_

clearWarnings()

clearWarnings(): void

Defined in: ds/src/core/estimators/estimator.js:139

Clear all warnings

Returns

void

Inherited from

Estimator.clearWarnings

cut()

cut(k): number[]

Defined in: ds/src/ml/estimators/HCA.js:76

Parameters

k

any

Returns

number[]

cutHeight()

cutHeight(height): number[]

Defined in: ds/src/ml/estimators/HCA.js:81

Parameters

height

any

Returns

number[]

fit()

fit(X, opts?): HCA

Defined in: ds/src/ml/estimators/HCA.js:29

Fit the hierarchical clustering model.

Parameters

X

any

Feature matrix (n observations × p features), or a declarative options object ({ data, columns/X, … }).

opts?

Optional fitting overrides.

k?

number

Optional number of clusters to cut the dendrogram into after fitting.

linkage?

string

Linkage method (e.g. ‘average’, ‘single’, ‘complete’).

omit_missing?

boolean

Whether to drop rows with missing values.

Returns

HCA

The fitted estimator (for chaining).

Overrides

Estimator.fit

getMemoryUsage()

getMemoryUsage(): string

Defined in: ds/src/core/estimators/estimator.js:97

Get memory usage in human-readable format

Returns

string

Memory usage string (e.g., “2.3 MB” or “145 KB”)

Inherited from

Estimator.getMemoryUsage

getParams()

getParams(): any

Defined in: ds/src/core/estimators/estimator.js:294

Get a shallow copy of parameters.

Returns

any

Inherited from

Estimator.getParams

getState()

getState(): any

Defined in: ds/src/core/estimators/estimator.js:65

Get comprehensive model state

Returns

any

State information including fitted status, memory estimate, warnings

Inherited from

Estimator.getState

getWarnings()

getWarnings(): any[]

Defined in: ds/src/core/estimators/estimator.js:124

Get all warnings

Returns

any[]

Array of warning objects

Inherited from

Estimator.getWarnings

getWarningsByType()

getWarningsByType(type): any[]

Defined in: ds/src/core/estimators/estimator.js:148

Get warnings of a specific type

Parameters

type

string

Warning type

Returns

any[]

Filtered warnings

Inherited from

Estimator.getWarningsByType

hasWarnings()

hasWarnings(): boolean

Defined in: ds/src/core/estimators/estimator.js:132

Check if model has warnings

Returns

boolean

Inherited from

Estimator.hasWarnings

isFitted()

isFitted(): boolean

Defined in: ds/src/core/estimators/estimator.js:36

Check if model is fitted

Returns

boolean

Inherited from

Estimator.isFitted

predict()

predict(): void

Defined in: ds/src/core/estimators/estimator.js:424

Predict should be implemented by supervised estimators.

Returns

void

Inherited from

Estimator.predict

save()

save(): string

Defined in: ds/src/core/estimators/estimator.js:329

Save model to JSON string

Returns

string

JSON representation of the model

Inherited from

Estimator.save

setParams()

setParams(params?): HCA

Defined in: ds/src/core/estimators/estimator.js:285

Set parameters (mutates instance).

Parameters

params?

any = {}

Returns

HCA

Inherited from

Estimator.setParams

summary()

summary(): object

Defined in: ds/src/ml/estimators/HCA.js:86

Returns

object

linkage

linkage: any

maxDistance

maxDistance: any

merges

merges: any = dendrogram.length

n

n: any

toJSON()

toJSON(): object

Defined in: ds/src/ml/estimators/HCA.js:109

Serialize minimal model metadata. Subclasses may override to include learned parameters.

Returns

object

class

__class__: string = 'HCA'

fitted

fitted: boolean

labels

labels: number[]

model

model: any

params

params: any

Overrides

Estimator.toJSON

transform()

transform(): void

Defined in: ds/src/core/estimators/estimator.js:431

Transform should be implemented by transformers.

Returns

void

Inherited from

Estimator.transform

fromJSON()

static fromJSON(obj?): HCA

Defined in: ds/src/ml/estimators/HCA.js:119

Basic deserialization. Subclasses should override if they need to restore learned arrays / matrices.

Parameters

obj?

Returns

HCA

Overrides

Estimator.fromJSON

load()

static load(jsonString): Estimator

Defined in: ds/src/core/estimators/estimator.js:346

Load model from JSON string

Parameters

jsonString

string

JSON representation

Returns

Estimator

Reconstructed estimator instance

Inherited from

Estimator.load