Struct CatalogModel 

pub struct CatalogModel {
    pub name: &'static str,
    pub display_name: &'static str,
    pub description: &'static str,
    pub repo: &'static str,
    pub base_url: &'static str,
    pub license_id: &'static str,
    pub license_url: &'static str,
    pub gated: bool,
    pub format: ModelFormat,
    pub files: &'static [CatalogFile],
}

A catalog entry: an upstream, already-hosted model the user may install.

Fields

name: &'static str

Stable catalog id used on the CLI and in config (guard_model).

display_name: &'static str

Human-facing name.

description: &'static str

One-line description.

repo: &'static str

Upstream repository id (e.g. a Hugging Face org/repo).

base_url: &'static str

Base URL files are resolved against ({base}/{remote}).

license_id: &'static str

SPDX-ish license identifier.

license_url: &'static str

URL where the license / acceptable-use terms can be read.

gated: bool

true when the upstream requires authentication + license acceptance (e.g. a gated Hugging Face repo). Install then requires HF_TOKEN.

format: ModelFormat

Weight format.

files: &'static [CatalogFile]

Files to fetch. The first whose dest ends in the format extension is the weight file; the rest are tokenizer/config.

Implementations

impl CatalogModel

pub fn url_for(&self, file: &CatalogFile) -> String

Resolve the absolute download URL for file.

pub fn total_size(&self) -> Option<u64>

Total advertised download size, when every file advertises one.

Trait Implementations

impl Clone for CatalogModel

fn clone(&self) -> CatalogModel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CatalogModel

impl Debug for CatalogModel

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

Formats the value using the given formatter.