Struct ModelCard 

pub struct ModelCard {

    pub description: String,
    pub training_data: Option<DatasetReference>,
    pub training_recipe: Option<RecipeReference>,
    pub training_date: Option<DateTime<Utc>>,
    pub training_duration_secs: Option<i64>,
    pub metrics: HashMap<String, f64>,
    pub evaluation_data: Option<DatasetReference>,
    pub primary_uses: Vec<String>,
    pub out_of_scope_uses: Vec<String>,
    pub limitations: Vec<String>,
    pub ethical_considerations: Vec<String>,
    pub parent_model: Option<ModelReference>,
    pub derived_from: Vec<ModelReference>,
    pub extra: HashMap<String, Value>,
}

Model Card with standardized documentation.

Fields

description: String

Model description.

training_data: Option<DatasetReference>

Reference to training dataset.

training_recipe: Option<RecipeReference>

Reference to training recipe.

training_date: Option<DateTime<Utc>>

When training was performed.

training_duration_secs: Option<i64>

Training duration in seconds.

metrics: HashMap<String, f64>

Performance metrics (e.g., accuracy, F1 score).

evaluation_data: Option<DatasetReference>

Reference to evaluation dataset.

primary_uses: Vec<String>

Primary intended use cases.

out_of_scope_uses: Vec<String>

Out-of-scope use cases.

limitations: Vec<String>

Known limitations.

ethical_considerations: Vec<String>

Ethical considerations.

parent_model: Option<ModelReference>

Parent model (if fine-tuned).

derived_from: Vec<ModelReference>

Models this was derived from.

extra: HashMap<String, Value>

Additional metadata.

Implementations

impl ModelCard

pub fn builder() -> ModelCardBuilder

Create a new model card builder.

pub fn new(description: impl Into<String>) -> Self

Create a minimal model card with just a description.

pub fn training_duration(&self) -> Option<Duration>

Get training duration as a Duration.

pub fn add_metric(&mut self, name: impl Into<String>, value: f64)

Add a metric.

pub fn add_primary_use(&mut self, use_case: impl Into<String>)

Add a primary use case.

pub fn add_limitation(&mut self, limitation: impl Into<String>)

Add a limitation.

Trait Implementations

impl Clone for ModelCard

fn clone(&self) -> ModelCard

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelCard

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

Formats the value using the given formatter.

impl Default for ModelCard

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModelCard

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ModelCard

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

where __S: Serializer,

Serialize this value into the given Serde serializer.