Skip to main content

CatalogueEntry

Struct CatalogueEntry 

Source
pub struct CatalogueEntry {
Show 14 fields pub variant: String, pub display_name: String, pub family: String, pub params: Option<u64>, pub license: Option<License>, pub languages: Vec<String>, pub capabilities: Capabilities, pub headline_benchmark: Option<HeadlineBenchmark>, pub published_repo: Option<String>, pub downloads: Vec<Download>, pub speed_benchmarks: Vec<SpeedRow>, pub accuracy_benchmarks: Vec<AccuracyRow>, pub kind: EntryKind, pub download_count: Option<u64>,
}
Expand description

One variant’s catalogue entry.

Fields§

§variant: String§display_name: String

Missing falls back to the variant itself.

§family: String§params: Option<u64>

Parameter count of the upstream checkpoint, absent when the source publishes none - the Hub’s listing does not carry one. A count of zero is not a fact, and a row printing 0M params claims one.

§license: Option<License>§languages: Vec<String>§capabilities: Capabilities§headline_benchmark: Option<HeadlineBenchmark>§published_repo: Option<String>

The feed’s published Hugging Face repo for this variant (owner/name), which is where its README’s own download table lives when the docs tree has no per-variant page.

§downloads: Vec<Download>§speed_benchmarks: Vec<SpeedRow>§accuracy_benchmarks: Vec<AccuracyRow>§kind: EntryKind

What this entry is for. The speech feed’s documents never spell it - they are all speech models - and the Hub’s feed sets it for every entry it builds.

§download_count: Option<u64>

How many times the Hub has served the repo. The only pre-run signal a cleanup candidate has - the feed publishes no speed and no error for a normalizer - so it is what orders a sweep. The speech feed carries no count and leaves this None.

Implementations§

Source§

impl CatalogueEntry

Source

pub fn streaming(&self) -> bool

Whether the variant supports streaming recognition.

Source

pub fn download_for(&self, filename: &str) -> Option<&Download>

The download carrying this exact file name, which is how a pinned model is joined to its entry.

Source

pub fn m4_metal_speed_row(&self) -> Option<&SpeedRow>

The m4-max Metal row carrying the best wall-clock realtime factor, so the machine, backend and quant cross beside the number.

Source

pub fn m4_metal_xrt_wall(&self) -> Option<f64>

The best m4-max Metal wall-clock realtime factor across the quantised speed rows. None when the feed carries no such row.

Source

pub fn fleurs_en_wer(&self) -> Option<f64>

Word error rate on FLEURS English at the reference quant.

Source

pub fn headline_wer(&self) -> Option<f64>

Word error rate on the entry’s own headline benchmark.

Source

fn wer_for(&self, dataset: &str, split: &str, language: &str) -> Option<f64>

Trait Implementations§

Source§

impl Clone for CatalogueEntry

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CatalogueEntry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CatalogueEntry

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CatalogueEntry

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for CatalogueEntry

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CatalogueEntry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more