Skip to main content

//clika-runtime/io.clika.modelverse/RegisteredFamily

RegisteredFamily

[common]
data class RegisteredFamily(val family: String, val vendor: String, val runnable: Boolean, val modelTypes: List<String>, val architectures: List<String>, val ggufArchitectures: List<String>, val inputModalities: List<String>, val outputModalities: List<String>, val description: String = "", val licenseUrl: String = "", val pipelineTags: List<String> = emptyList(), val identityOnlyPurpose: String = "")

One model family the model library registers, as Modelverse.registry 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[common]
constructor(family: String, vendor: String, runnable: Boolean, modelTypes: List<String>, architectures: List<String>, ggufArchitectures: List<String>, inputModalities: List<String>, outputModalities: List<String>, description: String = "", licenseUrl: String = "", pipelineTags: List<String> = emptyList(), identityOnlyPurpose: String = "")

Properties​

NameSummary
architectures[common]
val architectures: List<String>
The config.json``architectures[0] class names the family claims (Qwen3ForCausalLM).
description[common]
val description: String
The family's one-line description.
family[common]
val family: String
The family as the library names it (qwen, whisper).
ggufArchitectures[common]
val ggufArchitectures: List<String>
The GGUF general.architecture values the family claims (qwen3, llama).
identityOnlyPurpose[common]
val identityOnlyPurpose: String
What an identity-only family is for (it opens no model); empty for a runnable family.
inputModalities[common]
val inputModalities: List<String>
The input modalities the family declares, in the library's spellings (see Capabilities.inputModalities).
licenseUrl[common]
val licenseUrl: String
The family's license page, a full URL.
modelTypes[common]
val modelTypes: List<String>
The config.json``model_type values the family claims (qwen3, whisper).
outputModalities[common]
val outputModalities: List<String>
The output modalities the family declares, in the same spellings.
pipelineTags[common]
val pipelineTags: List<String>
The hub's pipeline tags the family serves.
runnable[common]
val runnable: Boolean
True when the family carries some runnable path.
vendor[common]
val vendor: String
The maker, as the library records it.