---
title: "RegisteredFamily"
sidebar_label: "RegisteredFamily"
description: "Kotlin binding reference: RegisteredFamily."
---
//[clika-runtime](../../../index.md)/[io.clika.modelverse](../index.md)/[RegisteredFamily](index.md)
# RegisteredFamily
[common]\
data class [RegisteredFamily](index.md)(val family: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val vendor: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), val runnable: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html), val modelTypes: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, val architectures: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, val ggufArchitectures: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, val inputModalities: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, val outputModalities: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, val description: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) = "", val licenseUrl: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) = "", val pipelineTags: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)> = emptyList(), val identityOnlyPurpose: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) = "")
One model family the model library registers, as [Modelverse.registry](../Modelverse/registry.md) lists it: the identity keys a checkpoint is matched by, whether the family carries a runnable path, and its modalities. A checkpoint whose `model_type` or `architectures[0]` (a `config.json`) or `general.architecture` (a GGUF header) is in no runnable family's keys has no template in this library and will be refused at load; a key that is listed names a template, and the load may still decline a checkpoint on its own facts (a weight format the runtime does not decode, a model type the family registers only to refuse). The per-release supported-models document is the measured verdict.
## Constructors
| | |
|---|---|
| [RegisteredFamily](RegisteredFamily.md) | [common]
constructor(family: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), vendor: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html), runnable: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html), modelTypes: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, architectures: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, ggufArchitectures: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, inputModalities: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, outputModalities: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>, description: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) = "", licenseUrl: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) = "", pipelineTags: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)> = emptyList(), identityOnlyPurpose: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html) = "") |
## Properties
| Name | Summary |
|---|---|
| [architectures](architectures.md) | [common]
val [architectures](architectures.md): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>
The `config.json``architectures[0]` class names the family claims (`Qwen3ForCausalLM`). |
| [description](description.md) | [common]
val [description](description.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
The family's one-line description. |
| [family](family.md) | [common]
val [family](family.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
The family as the library names it (`qwen`, `whisper`). |
| [ggufArchitectures](ggufArchitectures.md) | [common]
val [ggufArchitectures](ggufArchitectures.md): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>
The GGUF `general.architecture` values the family claims (`qwen3`, `llama`). |
| [identityOnlyPurpose](identityOnlyPurpose.md) | [common]
val [identityOnlyPurpose](identityOnlyPurpose.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
What an identity-only family is for (it opens no model); empty for a runnable family. |
| [inputModalities](inputModalities.md) | [common]
val [inputModalities](inputModalities.md): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>
The input modalities the family declares, in the library's spellings (see [Capabilities.inputModalities](../Capabilities/inputModalities.md)). |
| [licenseUrl](licenseUrl.md) | [common]
val [licenseUrl](licenseUrl.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
The family's license page, a full URL. |
| [modelTypes](modelTypes.md) | [common]
val [modelTypes](modelTypes.md): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>
The `config.json``model_type` values the family claims (`qwen3`, `whisper`). |
| [outputModalities](outputModalities.md) | [common]
val [outputModalities](outputModalities.md): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>
The output modalities the family declares, in the same spellings. |
| [pipelineTags](pipelineTags.md) | [common]
val [pipelineTags](pipelineTags.md): [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)>
The hub's pipeline tags the family serves. |
| [runnable](runnable.md) | [common]
val [runnable](runnable.md): [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)
True when the family carries some runnable path. |
| [vendor](vendor.md) | [common]
val [vendor](vendor.md): [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)
The maker, as the library records it. |