Struct ModelDescriptor 

#[non_exhaustive]
pub struct ModelDescriptor {

    pub id: String,
    pub family: Family,
    pub dim: usize,
    pub default_max_length: usize,
    pub pooling: Pooling,
    pub normalize: bool,
    pub query_template: Option<String>,
    pub passage_template: Option<String>,
    pub default_instruction: Option<String>,
    pub dense_dirs: Vec<String>,
    pub mrl: bool,
    pub layer_norm_after_pooling: bool,
    pub license: String,
    pub size_gb: f32,
    pub gated: bool,
    pub phase: u8,
    pub backends: BackendSupport,
    pub default_dtype: DType,
    pub dtype_backends: DtypeBackendSupport,
}

Everything the library needs to know about a model beyond its weights. Build one with new, then assign fields.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

family: Family

dim: usize

default_max_length: usize

pooling: Pooling

normalize: bool

query_template: Option<String>

passage_template: Option<String>

default_instruction: Option<String>

dense_dirs: Vec<String>

mrl: bool

layer_norm_after_pooling: bool

license: String

size_gb: f32

gated: bool

phase: u8

backends: BackendSupport

default_dtype: DType

The dtype the builder loads when the caller sets none; BF16 on CPU falls back to F32.

dtype_backends: DtypeBackendSupport

Per-dtype support on each device, derived from the entry’s statuses; every builder refuses from this row.

Implementations

impl ModelDescriptor

pub fn new( id: impl Into<String>, family: Family, dim: usize, pooling: Pooling, ) -> Self

The four facts with no safe default; the rest is what a snapshot outside the catalog starts from: 512 tokens, unit-length rows, no template or Dense module, F32, untested everywhere, and catalog fields marked unknown.

Trait Implementations

impl Clone for ModelDescriptor

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 ModelDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelDescriptor

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ModelDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelDescriptor