mlx-bun library API
    Preparing search index...

    Interface RegistryOptions

    interface RegistryOptions {
        isCompanion?: (modelType: string) => boolean;
        modelDirs?: readonly string[];
        supportTier?: (
            record: ModelRecord,
        ) => string | Promise<string | null> | null;
    }
    Index
    isCompanion? modelDirs? supportTier?
    isCompanion?: (modelType: string) => boolean

    Whether a model_type names a companion artifact (a speculative-decoding drafter) that is loaded by explicit path and is never selectable as a model on its own. The registry holds no model facts: the caller supplies this from the declaring layer. Default: none is.

    modelDirs?: readonly string[]

    Directories whose immediate subdirectories are plain model directories (config.json + weights, no hub layout). scan() indexes them beside the hub cache; each record's id is the subdirectory name.

    supportTier?: (record: ModelRecord) => string | Promise<string | null> | null

    The support tier of a snapshot, decided when it is indexed so listings never re-read config files. It sees the record and the snapshot directory (a family can share a model_type and differ only in its config). The registry holds no model facts: the caller supplies this from the declaring layer. Default: none.

    Settings
    Member Visibility

    On This Page
    Properties