entrenar 0.7.12

Training & Optimization library with autograd, LoRA, quantization, and model merging
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

//! Model card generation for HuggingFace Hub
//!
//! Generates HF-compatible README.md with YAML front matter for model
//! metadata, metrics, and training details.

use crate::eval::evaluator::{EvalResult, Metric};

/// Model card for HuggingFace Hub (README.md with YAML front matter)
#[derive(Clone, Debug)]
pub struct ModelCard {
    /// Model name
    pub model_name: String,
    /// Model description
    pub description: String,
    /// License identifier (SPDX)
    pub license: Option<String>,
    /// Language codes (e.g., "en", "multilingual")
    pub language: Vec<String>,
    /// Tags for discoverability
    pub tags: Vec<String>,
    /// Evaluation metrics (name → value)
    pub metrics: Vec<(String, f64)>,
    /// Training details (free-form markdown)
    pub training_details: Option<String>,
    /// Base model repository ID
    pub base_model: Option<String>,
}

impl ModelCard {
    /// Create a model card from an `EvalResult`
    #[must_use]
    pub fn from_eval_result(result: &EvalResult) -> Self {
        let metrics: Vec<(String, f64)> = result
            .scores
            .iter()
            .map(|(metric, &value)| (metric_to_yaml_key(metric), value))
            .collect();

        Self {
            model_name: result.model_name.clone(),
            description: format!("Model: {}", result.model_name),
            license: None,
            language: Vec::new(),
            tags: vec!["entrenar".to_string()],
            metrics,
            training_details: None,
            base_model: None,
        }
    }

    /// Render the model card as markdown with YAML front matter
    #[must_use]
    pub fn to_markdown(&self) -> String {
        let mut out = String::new();
        out.push_str("---\n");

        // YAML front matter
        if let Some(license) = &self.license {
            out.push_str(&format!("license: {license}\n"));
        }

        if !self.language.is_empty() {
            out.push_str("language:\n");
            for lang in &self.language {
                out.push_str(&format!("- {lang}\n"));
            }
        }

        if !self.tags.is_empty() {
            out.push_str("tags:\n");
            for tag in &self.tags {
                out.push_str(&format!("- {tag}\n"));
            }
        }

        if let Some(base) = &self.base_model {
            out.push_str(&format!("base_model: {base}\n"));
        }

        if !self.metrics.is_empty() {
            out.push_str("model-index:\n");
            out.push_str(&format!("- name: {}\n", self.model_name));
            out.push_str("  results:\n");
            out.push_str("  - metrics:\n");
            for (name, value) in &self.metrics {
                out.push_str(&format!("    - type: {name}\n"));
                out.push_str(&format!("      value: {value}\n"));
            }
        }

        out.push_str("---\n\n");

        // Markdown body
        out.push_str(&format!("# {}\n\n", self.model_name));
        out.push_str(&format!("{}\n\n", self.description));

        if !self.metrics.is_empty() {
            out.push_str("## Evaluation Results\n\n");
            out.push_str("| Metric | Value |\n");
            out.push_str("|--------|-------|\n");
            for (name, value) in &self.metrics {
                out.push_str(&format!("| {name} | {value:.4} |\n"));
            }
            out.push('\n');
        }

        if let Some(details) = &self.training_details {
            out.push_str("## Training Details\n\n");
            out.push_str(details);
            out.push('\n');
        }

        out.push_str("\n---\n*Generated by [entrenar](https://github.com/paiml/entrenar)*\n");

        out
    }
}

/// Convert a `Metric` to a YAML-friendly key name
fn metric_to_yaml_key(metric: &Metric) -> String {
    match metric {
        Metric::WER => "wer".to_string(),
        Metric::RTFx => "rtfx".to_string(),
        Metric::BLEU => "bleu".to_string(),
        Metric::ROUGE(v) => format!("{v}").to_lowercase().replace('-', "_"),
        Metric::Perplexity => "perplexity".to_string(),
        Metric::MMLUAccuracy => "mmlu_accuracy".to_string(),
        Metric::PassAtK(k) => format!("pass_at_{k}"),
        Metric::NDCGAtK(k) => format!("ndcg_at_{k}"),
        other => other.name().to_lowercase(),
    }
}