Class StopIfSEMeasurementBelowThreshold

Class implementing early stopping if the standard error of measurement drops below a certain threshold.

Hierarchy (View Summary)

EarlyStopping
- StopIfSEMeasurementBelowThreshold

Index

Constructors

Properties

_earlyStop _logicalOperation _nItems _patience _seMeasurements _seMeasurementThreshold _tolerance

Accessors

earlyStop evaluationCats logicalOperation nItems patience seMeasurements seMeasurementThreshold tolerance

Methods

_evaluateStoppingCondition _updateCats update

Constructors

constructor

new StopIfSEMeasurementBelowThreshold(
input: StopIfSEMeasurementBelowThresholdInput,
): StopIfSEMeasurementBelowThreshold
Parameters
- input: StopIfSEMeasurementBelowThresholdInput
Returns StopIfSEMeasurementBelowThreshold
Overrides EarlyStopping.constructor
- Defined in stopping.ts:213

Properties

`Protected`_earlyStop

_earlyStop: boolean

`Protected`_logicalOperation

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

`Protected`_nItems

_nItems: CatMap<number>

`Protected`_patience

_patience: CatMap<number>

`Protected`_seMeasurements

_seMeasurements: CatMap<number[]>

`Protected`_seMeasurementThreshold

_seMeasurementThreshold: CatMap<number>

`Protected`_tolerance

_tolerance: CatMap<number>

Accessors

earlyStop

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

evaluationCats

get evaluationCats(): string[]
Returns string[]
Overrides EarlyStopping.evaluationCats
- Defined in stopping.ts:232

logicalOperation

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

nItems

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

patience

get patience(): CatMap<number>
Returns CatMap<number>
- Defined in stopping.ts:220

seMeasurements

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

seMeasurementThreshold

get seMeasurementThreshold(): CatMap<number>
Returns CatMap<number>
- Defined in stopping.ts:228

tolerance

get tolerance(): CatMap<number>
Returns CatMap<number>
- Defined in stopping.ts:224

Methods

`Protected`_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
Overrides EarlyStopping._evaluateStoppingCondition
- Defined in stopping.ts:240

`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
Inherited from EarlyStopping._updateCats
- 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
Inherited from EarlyStopping.update
- Defined in stopping.ts:99