-
Notifications
You must be signed in to change notification settings - Fork 85
/
default_template.html.jinja
246 lines (246 loc) · 8.79 KB
/
default_template.html.jinja
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<!DOCTYPE html>
{% macro render_if_exist(name, value) %}
{% if value %}
<div>{{name}}: {{value}}</div>
{%- endif %}
{% endmacro %}
{% macro render_considerations(list) %}
{% if list %}
<ul>
{% for item in list %}
<li>{{ item.description }}</li>
{% endfor %}
</ul>
{%- endif %}
{% endmacro %}
{% macro render_uri_list(list) %}
{% if list %}
<ul>
{% for item in list %}
<li><a href="{{ item }}">{{ item }}</a></li>
{% endfor %}
</ul>
{%- endif %}
{% endmacro %}
{% macro render_all_datasets(datasets) %}
<div class="col card">
<h2>Datasets</h2>
{% for dataset in datasets %}
<div class="row">
<div class="col card">
{% if dataset.name %}<h3>{{ dataset.name }}</h3>{% endif %}
{% if dataset.description %}<p>{{ dataset.description }}</p>{% endif %}
{% if dataset.link %}<a href="{{ dataset.link }}">{{ dataset.link }}</a>{% endif %}
{% if dataset.graphics and dataset.graphics.collection %}
{{ render_graphics(dataset.graphics.collection) }}
{% endif %}
</div>
</div>
{% endfor %}
</div>
{% endmacro %}
{% macro render_graphics(graphics) %}
<div class="img-container">
{% if graphics.description %}<p>{{ graphics.description }}</p>{% endif %}
{% for graph in graphics %}
<div class="img-item">
<img src='data:image/jpeg;base64,{{ graph.image }}' alt='{{ graph.name }}' />
</div>
{% endfor %}
</div>
{% endmacro %}
{% macro render_license(license) %}
{% if license.identifier %}
<li>{{ license.identifier }}{% endif %}{% if license.custom_text %}{{ license.custom_text }}{% endif %}</li>
{% endmacro %}
{% macro metric_name(metric) %}
{{ metric.type }}{% if metric.threshold %}@{{ metric.threshold }}{% endif %}{% if metric.slice %}, {{ metric.slice }}{% endif %}
{% endmacro %}
{% macro metric_value(metric) %}
{{ metric.value }}{% if metric.confidence_interval %} ({{ metric.confidence_interval.lower_bound }}, {{ metric.confidence_interval.upper_bound }}){% endif %}
{% endmacro %}
{% macro render_quantitative_analysis(quantitative_analysis) %}
<div class="col card">
<h2>Quantitative Analysis</h2>
{% if quantitative_analysis.performance_metrics %}
{{ render_metrics_table(quantitative_analysis.performance_metrics )}}
{% endif %}
{% if quantitative_analysis.graphics.collection %}
{{ render_metrics_graphics(quantitative_analysis.graphics) }}
{% endif %}
</div>
{% endmacro %}
{% macro render_metrics_table(metrics) %}
<table class="center">
<caption>Performance Metrics</caption>
<tr><th>Name</th><th>Value</th></tr>
{% for metric in metrics %}
<tr><td>{{ metric_name(metric) }}</td><td>{{ metric_value(metric) }}</td></tr>
{% endfor %}
</table>
{% endmacro %}
{% macro render_metrics_graphics(graphics) %}
<div class="row">
<div class="col">
{% if graphics.description %}<p>{{ graphics.description }}</p>{% endif %}
{{ render_graphics(graphics.collection) }}
</div>
</div>
{% endmacro %}
<html lang="en">
<head>
<style>
h1 {text-align: center;}
.row {
display: flex;
}
.col {
flex: 1;
}
.card {
padding: 1em;
border: 1px solid #DADCE0;
margin: 10px;
}
.img-container {
display: flex;
flex-wrap: wrap;
justify-content: space-around;
text-align: center;
}
.img-item {
flex: 1;
}
.center {
margin-left: auto;
margin-right: auto;
}
table {
margin-bottom: 10px;
}
table th {
background: #eee;
}
table, th, td {
border: 1px solid black;
border-collapse: collapse;
}
th, td {
border: 1px solid #ccc;
height: 30px;
text-align: left;
padding: 5px 10px
}
caption { font-weight: bold; }
</style>
<title>
Model Card{% if model_details.name %} for {{ model_details.name }}{% endif %}
</title>
</head>
<body>
<h1>
Model Card{% if model_details.name %} for {{ model_details.name }}{% endif %}
</h1>
<div class="row">
{% if model_details %}
<div class="col card">
<h2>Model Details</h2>
{% if model_details.overview %}<h3>Overview</h3>
{{ model_details.overview }}{% endif %}
{% if model_details.version and model_details.version.name %}<h3>Version</h3>
{{ render_if_exist('name', model_details.version.name) }}
{{ render_if_exist('date', model_details.version.date) }}
{{ render_if_exist('diff', model_details.version.diff) }}
{% endif %}
{% if model_details.documentation %}<h3>Documentation</h3>
{{ model_details.documentation }}{% endif %}
{% if model_details.owners %}<h3>Owners</h3>
{% if model_details.owners|length > 1 %}
{% for owner in model_details.owners %}
<li>{{ owner.name }}, {{ owner.contact }}</li>
{% endfor %}
{% else %}
{{ model_details.owners[0].name }}, {{ model_details.owners[0].contact }}
{% endif %}
{% endif %}
{% if model_details.licenses %}
<h3>Licenses</h3>
<ul>{% for license in model_details.licenses %}{{ render_license(license) }}{% endfor %}
</ul>{% endif %}
{% if model_details.references %}
<h3>References</h3>
<ul>
{% for reference in model_details.references %}
<li><a href="{{ reference.reference }}">{{ reference.reference }}</a></li>
{% endfor %}
</ul>{% endif %}
{% if model_details.citations %}
<h3>Citations</h3>
<ul>
{% for citation in model_details.citations %}
<li>{{ citation.citation }}</li>
{% endfor %}
</ul>{% endif %}
</div>
{% endif %}
{% if model_parameters.model_architecture or model_parameters.input_format or model_parameters.input_format_map or model_parameters.output_format or model_parameters.output_format_map %}
<div class="col card">
<h2>Model Parameters</h2>
{% if model_parameters.model_architecture %}
<h3>Model Architecture</h3>
<div style="white-space:pre-wrap;">{{ model_parameters.model_architecture }}</div>{% endif %}
{% if model_parameters.input_format %}<h3>Input Format</h3>
<div style="white-space:pre-wrap;">{{ model_parameters.input_format }}</div>{% endif %}
{% if model_parameters.input_format_map %}
<h3>Input Format</h3>
<table>
<tr><th>Key</th><th>Value</th></tr>
{% for kv in model_parameters.input_format_map %}
<tr><td>{{ kv.key }}</td><td>{{ kv.value }}</td></tr>{% endfor %}</table>{% endif %}
{% if model_parameters.output_format %}<h3>Output Format</h3>
<div style="white-space:pre-wrap;">{{ model_parameters.output_format }}</div>{% endif %}
{% if model_parameters.output_format_map %}
<h3>Output Format</h3>
<table>
<tr><th>Key</th><th>Value</th></tr>
{% for kv in model_parameters.output_format_map %}
<tr><td>{{ kv.key }}</td><td>{{ kv.value }}</td></tr>{% endfor %}</table>{% endif %}
</div>
{% endif %}
{% if considerations and (considerations.users or considerations.use_cases or considerations.limitations or considerations.tradeoffs or considerations.ethical_considerations) %}
<div class="col card">
<h2>Considerations</h2>
{% if considerations.users %}
<h3>Intended Users</h3>
{{ render_considerations(considerations.users) }}
{% endif %}
{% if considerations.use_cases %}
<h3>Use Cases</h3>
{{ render_considerations(considerations.use_cases) }}
{% endif %}
{% if considerations.limitations %}
<h3>Limitations</h3>
{{ render_considerations(considerations.limitations) }}
{% endif %}
{% if considerations.tradeoffs %}
<h3>Tradeoffs</h3>
{{ render_considerations(considerations.tradeoffs) }}
{% endif %}
{% if considerations.ethical_considerations %}
<h3>Ethical Considerations</h3>
<ul>{% for risk in considerations.ethical_considerations %}
<li>
<div>Risk: {{ risk.name }}</div>
<div>Mitigation Strategy: {{ risk.mitigation_strategy }}</div>
</li>{% endfor %} </ul>{% endif %}
</div>
{% endif %}
</div>
{% if model_parameters.data %}
{{ render_all_datasets(model_parameters.data) }}
{% endif %}
{% if quantitative_analysis.performance_metrics or quantitative_analysis.graphics.collection %}
{{ render_quantitative_analysis(quantitative_analysis) }}
{% endif %}
</body>
</html>