GAMRegressor

Defined in: ds/src/ml/estimators/GAM.js:223

Extends

Regressor

Constructors

Constructor

new GAMRegressor(opts?): GAMRegressor

Defined in: ds/src/ml/estimators/GAM.js:224

Parameters

opts?

Returns

GAMRegressor

Overrides

Regressor.constructor

Properties

_state

_state: object

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

Inherited from

Regressor._state

_warnings

_warnings: any[]

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

Inherited from

Regressor._warnings

fitted

fitted: boolean

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

Inherited from

Regressor.fitted

gam

gam: GAMBase

Defined in: ds/src/ml/estimators/GAM.js:226

params

params: any

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

Inherited from

Regressor.params

Methods

_buildPenaltyMatrix()

_buildPenaltyMatrix(): Matrix

Defined in: ds/src/ml/estimators/GAM.js:303

Returns

Matrix

_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

Regressor._prepareArgsForFit

_r2()

_r2(yTrue, yPred): number

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

Parameters

yTrue

any

yPred

any

Returns

number

Inherited from

Regressor._r2

_repr_html_()

_repr_html_(): string

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

Observable/Jupyter HTML representation

Returns

string

HTML representation

Inherited from

Regressor._repr_html_

clearWarnings()

clearWarnings(): void

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

Clear all warnings

Returns

void

Inherited from

Regressor.clearWarnings

fit()

fit(X, y?): GAMRegressor

Defined in: ds/src/ml/estimators/GAM.js:235

Fit the additive regression model on training data.

Parameters

X

any

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

y?

number[] = null

Continuous target values; omitted when using the declarative form.

Returns

GAMRegressor

The fitted estimator (for chaining).

Overrides

Regressor.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

Regressor.getMemoryUsage

getParams()

getParams(): any

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

Get a shallow copy of parameters.

Returns

any

Inherited from

Regressor.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

Regressor.getState

getWarnings()

getWarnings(): any[]

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

Get all warnings

Returns

any[]

Array of warning objects

Inherited from

Regressor.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

Regressor.getWarningsByType

hasWarnings()

hasWarnings(): boolean

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

Check if model has warnings

Returns

boolean

Inherited from

Regressor.hasWarnings

isFitted()

isFitted(): boolean

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

Check if model is fitted

Returns

boolean

Inherited from

Regressor.isFitted

predict()

predict(X): number[]

Defined in: ds/src/ml/estimators/GAM.js:335

Predict continuous target values for each sample.

Parameters

X

any

Feature matrix, or a declarative options object ({ data, X/columns, … }).

Returns

number[]

Predicted values (one per sample).

Overrides

Regressor.predict

predictWithInterval()

predictWithInterval(X, level?): any[]

Defined in: ds/src/ml/estimators/GAM.js:350

Get confidence intervals for predictions

Parameters

X

any[]

Input data

level?

number = 0.95

Confidence level (default: 0.95)

Returns

any[]

Array of { fitted, se, lower, upper } for each observation

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

Regressor.save

score()

score(yTrueOrOpts, yPred, _opts?, …args?): number

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

Default R^2 scoring implementation: 1 - SS_res / SS_tot

Accepts either:

arrays: score(yTrue, yPred)
table-style: score({ X, y, data }) where predict will be called internally

Parameters

yTrueOrOpts

any

yPred

any

_opts?

args?

…any[] = {}

Returns

number

Inherited from

Regressor.score

setParams()

setParams(params?): GAMRegressor

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

Set parameters (mutates instance).

Parameters

params?

any = {}

Returns

GAMRegressor

Inherited from

Regressor.setParams

summary()

summary(): any

Defined in: ds/src/ml/estimators/GAM.js:381

Returns

any

toJSON()

toJSON(): object

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

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

Returns

object

fitted

fitted: boolean

params

params: any

state

state: object

warnings

warnings: any[]

Inherited from

Regressor.toJSON

transform()

transform(): void

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

Transform should be implemented by transformers.

Returns

void

Inherited from

Regressor.transform

fromJSON()

static fromJSON(obj?): Estimator

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

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

Parameters

obj?

any = {}

Returns

Estimator

Inherited from

Regressor.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

Regressor.load