Struct Model 

pub struct Model {
    pub spec: LayaSpec,
    pub tensors: Tensors,
    pub graph: LayaGraph,
    pub index: Option<Index>,
    pub metadata: Option<Map<String, Value>>,
    /* private fields */
}

A loaded compat model: its spec, its tensors and the graph bound to them.

Fields

spec: LayaSpec

Both configs.

tensors: Tensors

The weights, mapped.

graph: LayaGraph

The graph, with every weight bound and checked.

index: Option<Index>

The .kime index, when loaded from one.

metadata: Option<Map<String, Value>>

__metadata__ of the source safetensors, kept so unpacking gives the same file back.

Implementations

impl Model

pub fn open(path: impl AsRef<Path>) -> Result<Self, Error>

Opens a Laya checkpoint directory or a .kime file. Tensor data is mapped, not read, and the .kime model hash is not checked here, see Model::verify.

Errors

Error::Io for a missing file, Error::Format for a malformed one and Error::Mismatch when the tensors do not match the config.

pub fn file(&self, name: &str) -> Option<&[u8]>

A carried file, such as tokenizer/tokenizer.json.

pub fn file_names(&self) -> Vec<&str>

Names of the carried files.

pub fn verify(&self) -> Result<(), Error>

Checks the .kime model hash against the data. A directory has no hash and always passes.

Errors

Error::Format if the data has changed since it was packed.

pub fn pack(&self, out: &mut impl Write) -> Result<String, Error>

Packs the model as .kime and returns the model hash.

Errors

Any error from out.

Panics

Never. Every name comes from the model’s own file list.

pub fn unpack(&self, dir: &Path) -> Result<(), Error>

Writes the model back out as a Laya directory: model.safetensors plus the carried files. Refuses to write into a directory that already has a model.safetensors.

Errors

Error::Io on any write failure or an existing checkpoint.

Panics

Never. Every name comes from the model’s own file list.

Trait Implementations

impl Debug for Model

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.