Skip to main content

//clika-runtime/io.clika.modelverse/CheckOptions

CheckOptions

[common]
data class CheckOptions(val device: String? = null, val maxSeq: Long? = null, val imageWidth: Int = 0, val imageHeight: Int = 0, val devices: List<FitDevice> = emptyList(), val revision: String = "main", val cacheDir: String? = null, val token: String? = null, val offline: Boolean = false, val weights: String? = null, val dtype: String? = null) : SourceOptions

The knobs of Modelverse.check, the command line's check verb's and the Python modelverse.check's. device is the device judged: a label the devices listing prints (CPU:0), the runtime's spelling (cpu, vulkan:1), an api name alone (cuda, every device of that api), or a label of devices; null judges every device. maxSeq is the sequence length judged, null the model's own context length. imageWidth and imageHeight are the image an image generation pipeline is judged at (0 = its weights alone, with the largest square image that fits reported). devices names devices to judge instead of this machine's (a phone's memory, a step's remaining budget); empty takes this machine's inventory. The hub knobs (revision, cacheDir, token, offline, weights) are the ones every load reads; nothing is fetched beyond the model's small documents and its file listing, and nothing runs.

Constructors​

CheckOptions[common]
constructor(device: String? = null, maxSeq: Long? = null, imageWidth: Int = 0, imageHeight: Int = 0, devices: List<FitDevice> = emptyList(), revision: String = "main", cacheDir: String? = null, token: String? = null, offline: Boolean = false, weights: String? = null, dtype: String? = null)

Properties​

NameSummary
cacheDir[common]
open override val cacheDir: String? = null
device[common]
open override val device: String? = null
devices[common]
val devices: List<FitDevice>
dtype[common]
open override val dtype: String? = null
The precision the weights load at: "float16" or "bfloat16" casts a dense checkpoint's float weights at load (about half the memory of a float32 checkpoint; the cast is best effort, and the stored precision keeps the model as trained) and selects a quantized checkpoint's compute dtype; null keeps the checkpoint's own. A load that reads neither meaning refuses naming the loads that do. The same dtype the command line's --dtype reads.
imageHeight[common]
val imageHeight: Int = 0
imageWidth[common]
val imageWidth: Int = 0
maxSeq[common]
val maxSeq: Long? = null
offline[common]
open override val offline: Boolean = false
revision[common]
open override val revision: String
token[common]
open override val token: String? = null
weights[common]
open override val weights: String? = null
The weight option of a repository that ships several (a GGUF repository with many quantizations): a quantization tag (Q4_K_M), a repo-relative .gguf file name, or a glob over the option names. Null picks nothing: a repository with one option needs none, one with several refuses naming them. The same weights the command line's --weights reads.