mlx-bun library API
    Preparing search index...

    Interface SavedStateOptions

    Saved state under a directory the caller owns.

    interface SavedStateOptions {
        budget: SavedStateBudget;
        checkpointEveryTokens?: number;
        checkpointQueueBytes?: number;
        demoteIdleMs?: number;
        dir: string;
        identity: Pick<
            SsdStoreOptions,
            "configFingerprint"
            | "modelId"
            | "tokenizerHash",
        >;
        prefetch?: boolean;
        schedule?: (run: () => void, intervalMs: number) => () => void;
        storage?: Pick<KvWriteRequest, "layout" | "blockBytes" | "segmented">;
        verify?: boolean;
        writeBehind?: boolean;
    }
    Index
    budget checkpointEveryTokens? checkpointQueueBytes? demoteIdleMs? dir identity prefetch? schedule? storage? verify? writeBehind?
    budget: SavedStateBudget
    checkpointEveryTokens?: number

    Generation checkpoints every this many generated tokens; absent: none.

    checkpointQueueBytes?: number

    Bytes of checkpoint snapshots the writer may queue.

    demoteIdleMs?: number

    Demote RAM entries idle this long (milliseconds) to saved state; 0 never.

    dir: string

    The saved-state root; this store's directory is <dir>/<configFingerprint>/.

    identity: Pick<
        SsdStoreOptions,
        "configFingerprint"
        | "modelId"
        | "tokenizerHash",
    >

    Written into every file and enforced on scan and load.

    prefetch?: boolean

    Read a saved prefix ahead of admission (default true).

    schedule?: (run: () => void, intervalMs: number) => () => void
    storage?: Pick<KvWriteRequest, "layout" | "blockBytes" | "segmented">
    verify?: boolean

    Verify every tensor hash on load (--ssd-cache-verify).

    writeBehind?: boolean

    Write each kept prefix to saved state as it is kept (default true).

    Settings
    Member Visibility

    On This Page
    Properties