aiha 0.0.4

🦉 AIHA helps you to find the minimal requirements for any model on the 🤗 Hub.
Documentation 
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
133
134
135
136

//! Model File metadata struct
use std::fmt;

use serde::Deserialize;

/// Struct for storing the model file metadata
#[derive(Clone, Debug, Deserialize)]
pub struct ModelFile {
    /// The filename of the model file
    pub rfilename: String,
    /// The size of the model file
    pub size: Option<i64>,
    /// The file git OID
    pub oid: Option<String>,
}

/// Implement the `ModelFile` struct
impl ModelFile {
    /// Create a new ModelFile struct
    pub fn new(rfilename: String, size: Option<i64>, oid: Option<String>) -> Self {
        Self {
            rfilename,
            size,
            oid,
        }
    }
    /// Retrieve the filename of the model file
    pub fn get_rfilename(&self) -> &'_ String {
        &self.rfilename
    }
    /// Retrieve the size of the model file
    pub fn get_size(&self) -> Option<i64> {
        self.size
    }
    /// Retrieve the file git OID
    pub fn get_oid(&self) -> Option<&'_ String> {
        self.oid.as_ref()
    }
}

/// Implement partial equality for the ModelFile struct
impl PartialEq for ModelFile {
    fn eq(&self, other: &Self) -> bool {
        self.rfilename == other.rfilename && self.size == other.size && self.oid == other.oid
    }
}

/// Implement the display of the ModelFile struct
impl fmt::Display for ModelFile {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Model File: {:?}", self.rfilename)?;
        if let Some(size) = &self.size {
            write!(f, ", Size: {:?}", size)?;
        }
        if let Some(oid) = &self.oid {
            write!(f, ", OID: {:?}", oid)?;
        }
        Ok(())
    }
}

/// Implement the creation of the ModelFile struct from a serde_json::Value
impl From<serde_json::Value> for ModelFile {
    fn from(response_json: serde_json::Value) -> Self {
        ModelFile::new(
            response_json["rfilename"]
                .as_str()
                .map(|s| s.to_string())
                .unwrap_or_default(),
            serde_json::from_value(response_json["size"].clone()).unwrap_or_default(),
            serde_json::from_value(response_json["oid"].clone()).unwrap_or_default(),
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use pretty_assertions::assert_eq;
    use serde_json::json;

    #[test]
    fn test_modelfile_impl() {
        let rfilename = "rfilename".to_string();
        let size = Some(1);
        let oid = Some("oid".to_string());
        let modelfile = ModelFile::new(rfilename.clone(), size, oid.clone());
        assert_eq!(modelfile.rfilename, rfilename);
        assert_eq!(modelfile.size, size);
        assert_eq!(modelfile.oid, oid);

        assert_eq!(modelfile.get_rfilename(), &rfilename);
        assert_eq!(modelfile.get_size(), size);
    }

    #[test]
    fn test_modelfile_partial_eq() {
        let rfilename = "rfilename".to_string();
        let size = Some(1);
        let oid = Some("oid".to_string());
        let modelfile = ModelFile::new(rfilename.clone(), size, oid.clone());
        let modelfile2 = ModelFile::new(rfilename, size, oid);
        assert_eq!(modelfile, modelfile2);
    }

    #[test]
    fn test_modelfile_display() {
        let rfilename = "rfilename".to_string();
        let size = Some(1);
        let oid = Some("oid".to_string());
        let modelfile = ModelFile::new(rfilename, size, oid);
        assert_eq!(
            format!(
                "Model File: {:?}, Size: {:?}, OID: {:?}",
                "rfilename", 1, "oid"
            ),
            format!("{}", modelfile)
        );
    }

    #[test]
    fn test_modelfile_from_value() {
        let rfilename = "rfilename".to_string();
        let size = Some(1);
        let oid = Some("oid".to_string());
        let response_json = json!({
            "rfilename": rfilename,
            "size": size.clone(),
            "oid": oid,
        });
        let modelfile = ModelFile::from(response_json);
        assert_eq!(modelfile.rfilename, rfilename);
        assert_eq!(modelfile.size, size);
        assert_eq!(modelfile.oid, oid);
    }
}