Sports Lib API - v21.3.0
    Preparing search index...

    Interface FitThreeDimensionalImpulseResponseOptions

    Bounds and data-sufficiency controls for fitting the three parallel response models.

    interface FitThreeDimensionalImpulseResponseOptions {
        maximumCalendarSpanDays?: number;
        maximumIterations?: number;
        maximumTimeConstantDays?: number;
        maximumValidationNormalizedRmse?: number;
        minimumFitnessToFatigueTimeConstantRatio?: number;
        minimumObservationCount?: number;
        minimumTimeConstantDays?: number;
        minimumTrainingObservationCount?: number;
        minimumTrainingSpanDays?: number;
        validationObservationCount?: number;
    }
    Index

    Properties

    maximumCalendarSpanDays?: number

    Maximum inclusive calendar span after zero-fill. Defaults to 3,660 days (roughly ten years), protecting callers from malformed dates creating unbounded allocations.

    maximumIterations?: number

    Maximum deterministic Nelder-Mead iterations per starting point. Defaults to 500.

    maximumTimeConstantDays?: number

    Upper bound for either response time constant. Defaults to 180 days.

    maximumValidationNormalizedRmse?: number

    Maximum held-out RMSE divided by the held-out mean performance measurement. Defaults to 0.10. This is a quality gate, not an athlete-specific model parameter.

    minimumFitnessToFatigueTimeConstantRatio?: number

    Enforces a fitness response no shorter than the fatigue response. Defaults to 1, so the fitness time constant must be at least as long as the fatigue time constant. Must be at least 1.

    minimumObservationCount?: number

    Minimum number of observations required for each output, including held-out observations. Defaults to 16.

    minimumTimeConstantDays?: number

    Lower bound for either response time constant. Defaults to 2 days.

    minimumTrainingObservationCount?: number

    Minimum observations used for parameter fitting before hold-out validation. Defaults to 12.

    minimumTrainingSpanDays?: number

    Minimum calendar span covered by the fitting observations. Defaults to 56 days.

    validationObservationCount?: number

    Number of latest observations reserved for chronological validation. Defaults to 4.