Struct HfModelSource 

pub struct HfModelSource {
    pub repo_id: String,
    pub filename: String,
    pub revision: Option<String>,
}

HuggingFace Hub model source specification.

Supports parsing model identifiers like:

• “cool-japan/oxigaf-flame-2023” (default revision)
• “cool-japan/oxigaf-flame-2023:main” (branch/tag)
• “cool-japan/oxigaf-flame-2023@v1.0” (specific revision)

Fields

repo_id: String

Repository identifier (e.g., “cool-japan/oxigaf-flame”)

filename: String

Model filename within the repository

revision: Option<String>

Optional revision (branch, tag, or commit SHA)

Implementations

impl HfModelSource

pub fn parse(spec: &str) -> Result<Self>

Parse a HuggingFace model specification string.

Examples

let source = HfModelSource::parse("cool-japan/oxigaf-flame").unwrap();
assert_eq!(source.repo_id, "cool-japan/oxigaf-flame");
assert!(source.revision.is_none());

let source = HfModelSource::parse("cool-japan/oxigaf-flame:main").unwrap();
assert_eq!(source.revision, Some("main".to_string()));

pub fn with_filename(self, filename: String) -> Self

Set a custom filename instead of the default “model.safetensors”.

pub fn download(&self, token: Option<&str>) -> Result<PathBuf>

Download the model from HuggingFace Hub.

Arguments

• token - Optional HuggingFace authentication token for private models

Returns

The path to the downloaded model file in the HuggingFace cache directory.

Errors

Returns an error if:

• The API client cannot be initialized
• The repository or file is not found
• Network errors occur during download
• Authentication fails for private models