Struct ModelManifest 

pub struct ModelManifest {
    pub name: String,
    pub task: String,
    pub description: Option<String>,
    pub license: String,
    pub hf_repo: Option<String>,
    pub files: Vec<ModelFile>,
}

A model manifest (models/*.toml).

Fields

name: String

task: String

Task tag: “asr”, “tts”, “ocr”, “vlm”.

description: Option<String>

license: String

The WEIGHTS’ license — surfaced to users because it may be more restrictive than FFai’s MIT/Apache code license.

hf_repo: Option<String>

Hugging Face repo id, e.g. “openai/whisper-tiny”.

files: Vec<ModelFile>

Implementations

impl ModelManifest

pub fn from_toml(text: &str) -> Result<Self>

pub fn load(path: &Path) -> Result<Self>

pub fn cache_path(&self) -> PathBuf

Directory this model’s files live in when placed manually.

pub fn is_cached(&self) -> bool

True when every listed file already resolves locally — no network.

pub fn local_path(&self, name: &str) -> Option<PathBuf>

Resolve one file without touching the network: a manual placement under Self::cache_path wins, otherwise the shared Hugging Face cache (the same one transformers/faster-whisper use, so a model downloaded by either side is not downloaded twice).

pub fn fetch(&self) -> Result<ResolvedModel>

Resolve every file, downloading from the Hugging Face hub as needed.

Downloads are cached, so this is cheap on repeat calls — but it is still network I/O the first time, which is why benchmarks warm the cache outside any timed region (see docs/benchmarking.md).

pub fn fetch_only(&self, needed: &[&str]) -> Result<ResolvedModel>

Self::fetch, for just the named files — the cache-and-download twin of Self::resolve_only_in.

A manifest can list files no engine loads (ppocrv5-mobile-det lists its training checkpoint, the source of the fused weights), and a hosted repo need not carry them. Fetching every declared file made the first download of the document engine fail on a file it never opens. A name the manifest does not declare is an error: it has no checksum.

pub fn resolve_in(&self, root: &Path) -> Result<ResolvedModel>

Resolve every file from root/<model name>/<file> and nowhere else — no cache lookup, no network, ever.

This is the production form for a scheduled or offline job: the caller states where weights live, a missing file is an error naming the exact path that was expected, and nothing is fetched mid-job (docs/plans/commercial-gaps.md, gap 7). Checksums are verified exactly as Self::fetch verifies them.

pub fn resolve_only_in( &self, root: &Path, needed: &[&str], ) -> Result<ResolvedModel>

Self::resolve_in, for just the named files.

A manifest documents provenance as well as runtime needs, so it can list files no engine loads. ppocrv5-mobile-det, for example, lists its training checkpoint, the source of the fused weights. An offline deployment must not be made to ship those, so a loader asks for what it will open. A name the manifest does not declare is an error, because it has no checksum to verify against.

pub fn verify(&self) -> Result<ResolvedModel>

Check that every file is already present locally and matches its checksum, without downloading anything — the verify half of prefetch/verify. Resolves exactly where Self::fetch would look.

Trait Implementations

impl Clone for ModelManifest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModelManifest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelManifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.