Interface CommonOptions

Options shared by every verb.

interface CommonOptions {
    allowPreview?: boolean;
    device?: DeviceOption;
    dtype?: Dtype | Record<string, Dtype>;
    onProgress?: (event: LoadEvent) => void;
    signal?: AbortSignal;
}

Hierarchy (View Summary)

CommonOptions

Index

Properties

allowPreview? device? dtype? onProgress? signal?

Properties

`Optional`allowPreview

allowPreview?: boolean

Allow preview and experimental models.

`Optional`device

device?: DeviceOption

Force a device. Default 'auto'.

`Optional`dtype

dtype?: Dtype | Record<string, Dtype>

Force a dtype, such as 'q4'.

`Optional`onProgress

onProgress?: (event: LoadEvent) => void

Receives load events while the model downloads and compiles.

`Optional`signal

signal?: AbortSignal

Abort download or inference.