BranchPipeline

Defined in: ds/src/pipeline/BranchPipeline.js:18

Extends

Estimator

Constructors

Constructor

new BranchPipeline(options?): BranchPipeline

Defined in: ds/src/pipeline/BranchPipeline.js:25

Parameters

options?

branches

{ } = {}

Named branches (estimators or pipelines)

combiner

string | Function = 'vote'

How to combine results: ‘vote’, ‘average’, ‘max’, or custom function

weights

number[] = null

Optional weights for each branch (for weighted voting)

Returns

BranchPipeline

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

branches

branches: object

Defined in: ds/src/pipeline/BranchPipeline.js:27

branchNames

branchNames: string[]

Defined in: ds/src/pipeline/BranchPipeline.js:30

combiner

combiner: string | Function

Defined in: ds/src/pipeline/BranchPipeline.js:28

fitted

fitted: boolean

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

Inherited from

Estimator.fitted

params

params: any

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

Inherited from

Estimator.params

weights

weights: number[]

Defined in: ds/src/pipeline/BranchPipeline.js:29

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_

agreementScore()

agreementScore(X): number

Defined in: ds/src/pipeline/BranchPipeline.js:255

Get agreement score (how often branches agree)

Parameters

X

any[]

Data

Returns

number

Agreement score between 0 and 1

clearWarnings()

clearWarnings(): void

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

Clear all warnings

Returns

void

Inherited from

Estimator.clearWarnings

confidence()

confidence(X): number[]

Defined in: ds/src/pipeline/BranchPipeline.js:275

Get per-sample confidence (based on branch agreement)

Parameters

X

any[]

Data

Returns

number[]

Confidence scores between 0 and 1

fit()

fit(X, y?): BranchPipeline

Defined in: ds/src/pipeline/BranchPipeline.js:44

Fit all branches

Parameters

X

any[]

Training data

y?

any[] = null

Target labels (optional)

Returns

BranchPipeline

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(X): any[]

Defined in: ds/src/pipeline/BranchPipeline.js:62

Predict using all branches and combine results

Parameters

X

any[]

Data to predict

Returns

any[]

Combined predictions

Overrides

Estimator.predict

predictAll()

predictAll(X): object

Defined in: ds/src/pipeline/BranchPipeline.js:88

Get predictions from all branches without combining

Parameters

X

any[]

Data to predict

Returns

object

Predictions keyed by branch name

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?): BranchPipeline

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

Set parameters (mutates instance).

Parameters

params?

any = {}

Returns

BranchPipeline

Inherited from

Estimator.setParams

summary()

summary(): any

Defined in: ds/src/pipeline/BranchPipeline.js:300

Summary statistics

Returns

any

toJSON()

toJSON(): object

Defined in: ds/src/pipeline/BranchPipeline.js:313

Serialization

Returns

object

class

__class__: string = 'BranchPipeline'

branches

branches: string[]

combiner

combiner: string

fitted

fitted: boolean

weights

weights: number[]

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?): 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

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