mlx-bun library API
    Preparing search index...

    Interface ModelFamily

    interface ModelFamily {
        capabilities: readonly string[];
        chatTemplateFallback?: TemplateFallback;
        embedding?: EmbeddingDeclaration;
        fidelity: FidelityTarget;
        generationDefaults?: GenerationDefaults;
        graph: string;
        label?: string;
        loader: ModelLoader;
        loop: GenerationLoop;
        mediaTokens?: MediaTokenTexts;
        moe?: (config: ModelConfig) => MoeDeclaration | null;
        profileId: string;
        sentinels?: SentinelTokenTexts;
        specialization: "dedicated" | "generic";
        tier: "generic" | "targeted";
        trainingDefaults?: TrainingDefaults;
        transcribes?: true;
        accepts(config: ModelConfig): boolean;
        hasModelType(modelType: string): boolean;
    }
    Index
    capabilities chatTemplateFallback? embedding? fidelity generationDefaults? graph label? loader loop mediaTokens? moe? profileId sentinels? specialization tier trainingDefaults? transcribes?
    accepts hasModelType
    capabilities: readonly string[]

    Capabilities the graph needs of the engine, beyond its loader and loop's own.

    chatTemplateFallback?: TemplateFallback

    Renders chats for artifacts that ship no template of their own.

    embedding?: EmbeddingDeclaration

    Present when the graph declares GraphCapabilities.embeddings.

    fidelity: FidelityTarget
    generationDefaults?: GenerationDefaults
    graph: string

    The graph this family runs: what profiles select, what an implementation registers under, and the key of every declaration below.

    label?: string

    Names a targeted family in the unsupported-model message.

    loader: ModelLoader
    loop: GenerationLoop
    mediaTokens?: MediaTokenTexts

    Soft-token markers of the graph's tower prompts.

    moe?: (config: ModelConfig) => MoeDeclaration | null
    profileId: string

    The family profile's id.

    sentinels?: SentinelTokenTexts

    Present when generated text delimits tool calls and reasoning with special tokens.

    specialization: "dedicated" | "generic"

    dedicated for a graph written for the family, generic for the universal one.

    tier: "generic" | "targeted"

    targeted: a dedicated forward with its own oracle path. generic: the universal module (L1 only).

    trainingDefaults?: TrainingDefaults
    transcribes?: true

    A speech-to-text family, served by the transcription engine.

    • Whether a bare model_type (a registry record, no config read) is this family's. False where the rule needs more than the type: MiniCPM5 shares llama and is told apart only by its dimensions.

      Parameters

      • modelType: string

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods