---
title: "clika_runtime.modelverse"
sidebar_label: "clika_runtime.modelverse"
description: "The clika_runtime.modelverse module, introspected from the installed wheel."
---

<!-- Generated by tools/api_reference/generate_api_docs.py. Do not edit. -->

clika_runtime.modelverse: the Modelverse model library.

Load a model by name and run it::

    import clika_runtime.modelverse as mv

    model = mv.AutoModelForCausalLM.from_pretrained(
        "Qwen/Qwen2.5-0.5B-Instruct", device="cpu", dtype="bfloat16")
    print(model.generate("hello", max_new_tokens=64))
    for piece in model.stream_generate("hello"):
        print(piece, end="", flush=True)
    print(model.chat([{"role": "user", "content": "hi"}]))
    server = mv.serve(model, port=8000)          # the OpenAI-compatible API

The model library ships in the clika-runtime package beside the inference
engine. Importing it loads the engine first (the parent package), then the
model library's extension, which the same release builds.

``from_pretrained`` takes a hub repository id (the snapshot downloads into the
Hugging Face hub cache the other tooling on the machine shares; a gated
repository takes its ``token`` argument), a local directory (it
passes through untouched, the offline path) or a ``.gguf`` file.
``snapshot_download(repo_id)`` downloads without loading and returns the
local directory; ``list_models()`` enumerates the families this library
serves; ``check(source)`` says whether a model fits a device before anything
downloads; ``info(source)`` reads what a model is from its documents alone.
Every model run needs the runtime's license credential (``CLIKA_RT_LICENSE``
or the per-user file, see :mod:`clika_runtime`); without one the first call
raises with the code name ``LICENSE_FAILED``.

| Name | Kind |
| --- | --- |
| [`AttentionKind`](./AttentionKind.md) | class |
| [`AudioChunk`](./AudioChunk.md) | class |
| [`AutoConfig`](./AutoConfig.md) | class |
| [`AutoModel`](./AutoModel.md) | class |
| [`AutoModelForCausalLM`](./AutoModelForCausalLM.md) | class |
| [`AutoModelForDepthEstimation`](./AutoModelForDepthEstimation.md) | class |
| [`AutoModelForImageTextToText`](./AutoModelForImageTextToText.md) | class |
| [`AutoModelForObjectDetection`](./AutoModelForObjectDetection.md) | class |
| [`AutoModelForSeq2SeqLM`](./AutoModelForSeq2SeqLM.md) | class |
| [`AutoModelForSpeechSeq2Seq`](./AutoModelForSpeechSeq2Seq.md) | class |
| [`AutoModelForTextToWaveform`](./AutoModelForTextToWaveform.md) | class |
| [`AutoModelForZeroShotObjectDetection`](./AutoModelForZeroShotObjectDetection.md) | class |
| [`AutoProcessor`](./AutoProcessor.md) | class |
| [`AutoTokenizer`](./AutoTokenizer.md) | class |
| [`ChatCard`](./ChatCard.md) | class |
| [`ChatOutcome`](./ChatOutcome.md) | class |
| [`ChatSession`](./ChatSession.md) | class |
| [`DepthModel`](./DepthModel.md) | class |
| [`Detection`](./Detection.md) | class |
| [`DetectionModel`](./DetectionModel.md) | class |
| [`Detections`](./Detections.md) | class |
| [`DiarizationModel`](./DiarizationModel.md) | class |
| [`EmbeddingModel`](./EmbeddingModel.md) | class |
| [`FetchResult`](./FetchResult.md) | class |
| [`FetchedCompanion`](./FetchedCompanion.md) | class |
| [`FinishReason`](./FinishReason.md) | class |
| [`FitVerdict`](./FitVerdict.md) | class |
| [`GenerationConfig`](./GenerationConfig.md) | class |
| [`GenerationReport`](./GenerationReport.md) | class |
| [`GenerativeModel`](./GenerativeModel.md) | class |
| [`ImageEmbeddingModel`](./ImageEmbeddingModel.md) | class |
| [`ImageGenerationModel`](./ImageGenerationModel.md) | class |
| [`InferRunner`](./InferRunner.md) | class |
| [`LoadOptions`](./LoadOptions.md) | class |
| [`ModelEntry`](./ModelEntry.md) | class |
| [`ModelIdentity`](./ModelIdentity.md) | class |
| [`ModelMetaData`](./ModelMetaData.md) | class |
| [`ModelRegistry`](./ModelRegistry.md) | class |
| [`ModelVariant`](./ModelVariant.md) | class |
| [`MultimodalEmbeddingModel`](./MultimodalEmbeddingModel.md) | class |
| [`OcrModel`](./OcrModel.md) | class |
| [`Pooling`](./Pooling.md) | class |
| [`PretrainedConfig`](./PretrainedConfig.md) | class |
| [`RerankerModel`](./RerankerModel.md) | class |
| [`SegmentationModel`](./SegmentationModel.md) | class |
| [`Seq2SeqBudgetLimit`](./Seq2SeqBudgetLimit.md) | class |
| [`Seq2SeqModel`](./Seq2SeqModel.md) | class |
| [`Seq2SeqResult`](./Seq2SeqResult.md) | class |
| [`Seq2SeqStop`](./Seq2SeqStop.md) | class |
| [`ServedCheckpoints`](./ServedCheckpoints.md) | class |
| [`Server`](./Server.md) | class |
| [`SpeakerSegment`](./SpeakerSegment.md) | class |
| [`StageEvent`](./StageEvent.md) | class |
| [`StageEventKind`](./StageEventKind.md) | class |
| [`SttModel`](./SttModel.md) | class |
| [`ToolCall`](./ToolCall.md) | class |
| [`TranscriptEvent`](./TranscriptEvent.md) | class |
| [`TranscriptEventKind`](./TranscriptEventKind.md) | class |
| [`TranscriptWord`](./TranscriptWord.md) | class |
| [`TtsModel`](./TtsModel.md) | class |
| [`VideoGenerationModel`](./VideoGenerationModel.md) | class |
| [`WeightOption`](./WeightOption.md) | class |
| [functions](./functions.md) | module functions |