Struct WeightSource 

pub struct WeightSource {
    pub repo_id: &'static str,
    pub revision: Option<&'static str>,
    pub format: Format,
}

Where a model’s weights live on the HuggingFace hub, and how to read them.

Intended to be a const on each model enum:

const AMP120M: WeightSource = WeightSource::safetensors("chandar-lab/AMPLIFY_120M");

Fields

repo_id: &'static str

Full owner/name repo id.

revision: Option<&'static str>

Git revision; None means the hub default (main).

format: Format

On-disk format of the weight files.

Implementations

impl WeightSource

pub const fn safetensors(repo_id: &'static str) -> Self

A safetensors repo at the default revision.

pub const fn pth(repo_id: &'static str, root_key: Option<&'static str>) -> Self

A PyTorch-pickle repo at the default revision.

root_key names the sub-dictionary holding the tensors, or None if they sit at the root.

pub const fn at_revision(self, revision: &'static str) -> Self

Pin to a specific revision.

pub fn fetch(&self, filename: &str) -> Result<PathBuf>

Download filename, returning its cached path.

Errors name both the repo and the file — previously only ESM3 did this, so a failure elsewhere surfaced as a bare transport error.

pub fn fetch_optional(&self, filename: &str) -> Option<PathBuf>

Download filename, returning None if it is absent or unreachable.

For genuinely optional files such as ESM-2’s config.json, where the runner falls back to a built-in config.

pub fn var_builder( &self, filename: &str, opts: &LoadOptions, ) -> Result<VarBuilder<'static>>

pub fn var_builder_sharded( &self, index_filename: &str, opts: &LoadOptions, ) -> Result<VarBuilder<'static>>

Build a [VarBuilder] over a checkpoint split across several safetensors shards.

Large checkpoints ship as model-0000N-of-0000M.safetensors plus a model.safetensors.index.json whose weight_map says which shard holds each tensor. candle’s from_mmaped_safetensors already takes a slice of paths, so all this does is read the index, fetch every shard it names, and hand candle the lot (ferritin-100.24).

Shard order does not matter — candle indexes by tensor name — but the shards are deduplicated and sorted so the mmap set is deterministic.

pub fn var_builder_from_path( &self, path: &Path, opts: &LoadOptions, ) -> Result<VarBuilder<'static>>

Build a [VarBuilder] over an already-downloaded (or local) file.

Used by loaders that also accept a path directly, such as ProteinMPNNRunner::from_path.

Trait Implementations

impl Clone for WeightSource

fn clone(&self) -> WeightSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for WeightSource

impl Debug for WeightSource

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

Formats the value using the given formatter.