Skip to main content

DatasetMetadata

Struct DatasetMetadata 

Source
pub struct DatasetMetadata {
    pub name: &'static str,
    pub description: &'static str,
    pub download_url: &'static str,
    pub domain: &'static str,
    pub language: &'static str,
    pub entity_types: &'static [&'static str],
    pub flags: DatasetFlags,
    pub citation: Option<&'static str>,
    pub license: Option<&'static str>,
    pub year: Option<u16>,
    pub paper_url: Option<&'static str>,
}
Expand description

Complete metadata for a single dataset.

All fields are static references for zero-cost access.

Fields§

§name: &'static str

Human-readable name

§description: &'static str

Short description (1-2 sentences)

§download_url: &'static str

Download URL (HuggingFace, GitHub, etc.)

§domain: &'static str

Primary domain (news, biomedical, social-media, etc.)

§language: &'static str

ISO 639-1/3 language code (en, de, zh, multilingual, etc.)

§entity_types: &'static [&'static str]

Entity types in this dataset

§flags: DatasetFlags

Capability flags (replaces all is_* methods)

§citation: Option<&'static str>

Academic citation (if available)

§license: Option<&'static str>

License (MIT, CC-BY, etc.)

§year: Option<u16>

Publication year

§paper_url: Option<&'static str>

Paper URL (arXiv, ACL Anthology, etc.)

Implementations§

Source§

impl DatasetMetadata

Source

pub const fn new( name: &'static str, description: &'static str, download_url: &'static str, ) -> Self

Create metadata with required fields only.

Source

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

Builder: set domain.

Source

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

Builder: set language.

Source

pub const fn entity_types(self, types: &'static [&'static str]) -> Self

Builder: set entity types.

Source

pub const fn flags(self, flags: DatasetFlags) -> Self

Builder: set flags.

Source

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

Builder: set citation.

Source

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

Builder: set license.

Source

pub const fn year(self, year: u16) -> Self

Builder: set year.

Source

pub const fn paper_url(self, url: &'static str) -> Self

Builder: set paper URL.

Source

pub const fn is_ner(&self) -> bool

Returns true if this dataset supports named entity recognition.

NER datasets provide entity span annotations with type labels.

Source

pub const fn is_coreference(&self) -> bool

Returns true if this dataset contains coreference annotations.

Coreference datasets provide mention clusters or entity chains indicating which mentions refer to the same entity.

Source

pub const fn is_intra_doc_coref(&self) -> bool

Returns true if this dataset contains within-document coreference.

Intra-document coreference datasets link mentions within a single document, forming coreference chains or clusters.

Source

pub const fn is_inter_doc_coref(&self) -> bool

Returns true if this dataset contains cross-document coreference.

Inter-document coreference datasets link entities across multiple documents, enabling cross-document entity resolution.

Source

pub const fn is_temporal_ner(&self) -> bool

Returns true if this dataset contains temporal entity annotations.

Temporal NER datasets include time expressions, events with temporal anchors, or entities with temporal attributes (e.g., historical entities).

Source

pub const fn is_biomedical(&self) -> bool

Returns true if this dataset is from the biomedical domain.

Biomedical datasets include medical, clinical, or life science text with specialized entity types (diseases, genes, proteins, chemicals).

Source

pub const fn is_social_media(&self) -> bool

Returns true if this dataset contains social media text.

Social media datasets include Twitter, Reddit, or other informal text with non-standard capitalization, abbreviations, and informal language.

Source

pub const fn is_specialized_domain(&self) -> bool

Returns true if this dataset is from a specialized domain.

Specialized domain datasets include technical, legal, financial, or other domain-specific text requiring specialized entity recognition.

Source

pub const fn is_relation_extraction(&self) -> bool

Returns true if this dataset supports relation extraction.

Relation extraction datasets provide entity-relation-entity triples, enabling evaluation of models that extract structured relationships.

Source

pub const fn is_historical(&self) -> bool

Returns true if this dataset contains historical text.

Historical datasets include ancient texts, historical documents, or diachronic corpora that test model robustness to language evolution.

Source

pub const fn is_bias_evaluation(&self) -> bool

Returns true if this dataset is designed for bias evaluation.

Bias evaluation datasets test for gender, demographic, or other biases in entity recognition and coreference resolution.

Source

pub const fn is_dialogue_coref(&self) -> bool

Returns true if this dataset contains dialogue coreference annotations.

Dialogue coreference datasets include multi-party conversations, meetings, or interviews where coreference resolution must handle speaker turns and dialogue-specific phenomena (e.g., prosody, gestures).

Source

pub const fn is_joint_ner_re(&self) -> bool

Returns true if this dataset supports joint NER and relation extraction.

Joint datasets provide both entity annotations and relation triples, enabling evaluation of models that perform both tasks simultaneously.

Source

pub const fn is_discontinuous_ner(&self) -> bool

Returns true if this dataset contains discontinuous entity annotations.

Discontinuous entities span non-contiguous tokens (e.g., “left and right ventricle” where “ventricle” is split). Requires specialized evaluation metrics beyond standard span-based NER.

Source

pub const fn is_few_shot(&self) -> bool

Returns true if this dataset is designed for few-shot learning evaluation.

Few-shot datasets typically have small training sets or are used to test zero-shot transfer from related domains.

Source

pub const fn is_multilingual(&self) -> bool

Returns true if this dataset covers multiple languages.

Multilingual datasets enable cross-lingual evaluation and testing of zero-shot transfer between languages.

Source

pub const fn is_constructed_language(&self) -> bool

Returns true if this dataset contains constructed/artificial languages.

Constructed languages (e.g., Esperanto, Klingon) test model generalization to languages with different structural properties than natural languages.

Source

pub const fn is_code_switching(&self) -> bool

Returns true if this dataset contains code-switched text.

Code-switching datasets include text where speakers mix multiple languages within the same utterance, requiring models to handle language boundaries.

Source

pub const fn is_african_language(&self) -> bool

Returns true if this dataset contains African languages.

African language datasets are important for evaluating model performance on under-resourced languages and diverse linguistic structures.

Trait Implementations§

Source§

impl Clone for DatasetMetadata

Source§

fn clone(&self) -> DatasetMetadata

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 Copy for DatasetMetadata

Source§

impl Debug for DatasetMetadata

Source§

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

Formats the value using the given formatter. Read more

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

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
Source§

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
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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