Class EarlyStopping`Abstract`

Abstract class for early stopping strategies.

Hierarchy (View Summary)

EarlyStopping

Index

Constructors

Properties

_earlyStop _logicalOperation _nItems _seMeasurements

Accessors

earlyStop evaluationCats logicalOperation nItems seMeasurements

Methods

_evaluateStoppingCondition _updateCats update

Constructors

constructor

new EarlyStopping(__namedParameters: EarlyStoppingInput): EarlyStopping
Parameters
- __namedParameters: EarlyStoppingInput
Returns EarlyStopping
- Defined in stopping.ts:43

Properties

`Protected`_earlyStop

_earlyStop: boolean

`Protected`_logicalOperation

_logicalOperation: "and" | "or" | "only"

`Protected`_nItems

_nItems: CatMap<number>

`Protected`_seMeasurements

_seMeasurements: CatMap<number[]>

Accessors

earlyStop

get earlyStop(): boolean
Returns boolean
- Defined in stopping.ts:56

`Abstract`evaluationCats

get evaluationCats(): string[]
Returns string[]
- Defined in stopping.ts:54

logicalOperation

get logicalOperation(): "and" | "or" | "only"
Returns "and" | "or" | "only"
- Defined in stopping.ts:68

nItems

get nItems(): CatMap<number>
Returns CatMap<number>
- Defined in stopping.ts:60

seMeasurements

get seMeasurements(): CatMap<number[]>
Returns CatMap<number[]>
- Defined in stopping.ts:64

Methods

`Protected` `Abstract`_evaluateStoppingCondition

_evaluateStoppingCondition(catToEvaluate: string): boolean
Abstract method to be implemented by subclasses to evaluate a single stopping condition.
Parameters
- catToEvaluate: string
  The name of the cat to evaluate for early stopping.
Returns boolean
- Defined in stopping.ts:93

`Protected`_updateCats

_updateCats(cats: CatMap<Cat>): void
Update the internal state of the early stopping strategy based on the provided cats.
Parameters
- cats: CatMap<Cat>
  A map of cats to update.
Returns void
- Defined in stopping.ts:76

update

update(cats: CatMap<Cat>, catToEvaluate?: string): void
Abstract method to be implemented by subclasses to update the early stopping strategy.
Parameters
- cats: CatMap<Cat>
  A map of cats to update.
- OptionalcatToEvaluate: string
Returns void
- Defined in stopping.ts:99