Edgewise API
    Preparing search index...

    Interface ForecastOptions

    Options shared by every verb.

    interface ForecastOptions {
        allowPreview?: boolean;
        context?: number;
        device?: DeviceOption;
        dtype?: Dtype | Record<string, Dtype>;
        horizon: number;
        model: ModelRef;
        onProgress?: (event: LoadEvent) => void;
        quantiles?: number[];
        series: SeriesInput | SeriesInput[];
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index
    allowPreview? context? device? dtype? horizon model onProgress? quantiles? series signal?
    allowPreview?: boolean

    Allow preview and experimental models.

    context?: number

    Use only the most recent N values.

    device?: DeviceOption

    Force a device. Default 'auto'.

    dtype?: Dtype | Record<string, Dtype>

    Force a dtype, such as 'q4'.

    horizon: number

    Steps to predict. Up to 64 in one pass; longer horizons repeat the forecast on its own median.

    model: ModelRef
    onProgress?: (event: LoadEvent) => void

    Receives load events while the model downloads and compiles.

    quantiles?: number[]

    Quantile levels to return, between 0.1 and 0.9. Default [0.1, 0.5, 0.9].

    series: SeriesInput | SeriesInput[]

    One series, or an array of series to forecast in one call.

    signal?: AbortSignal

    Abort download or inference.

    Settings
    Member Visibility

    On This Page
    Properties