Skip to content

Commit ae4f420

Browse files
Further clarifying Model Card sections (#1052)
* Further clarifying Model Card sections * Capitalization consistency change. * add requested changes Co-authored-by: Lucain Pouget <[email protected]>
1 parent 7d8854c commit ae4f420

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/huggingface_hub/templates/modelcard_template.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
3. [Bias, Risks, and Limitations](#bias-risks-and-limitations)
1414
4. [Training Details](#training-details)
1515
5. [Evaluation](#evaluation)
16-
6. [Model Examination](#model-examination)
16+
6. [Model Examination](#model-examination-optional)
1717
7. [Environmental Impact](#environmental-impact)
1818
8. [Technical Specifications](#technical-specifications-optional)
19-
9. [Citation](#citation)
19+
9. [Citation](#citation-optional)
2020
10. [Glossary](#glossary-optional)
2121
11. [More Information](#more-information-optional)
2222
12. [Model Card Authors](#model-card-authors-optional)
@@ -33,12 +33,12 @@
3333
{{ model_description | default("", true) }}
3434

3535
- **Developed by:** {{ developers | default("[More Information Needed]", true)}}
36-
- **Shared by [Optional]:** {{ shared_by | default("[More Information Needed]", true)}}
36+
- **Shared by [optional]:** {{ shared_by | default("[More Information Needed]", true)}}
3737
- **Model type:** {{ model_type | default("[More Information Needed]", true)}}
3838
- **Language(s) (NLP):** {{ language | default("[More Information Needed]", true)}}
3939
- **License:** {{ license | default("[More Information Needed]", true)}}
40-
- **Related Models:** {{ related_models | default("[More Information Needed]", true)}}
41-
- **Parent Model:** {{ parent_model | default("[More Information Needed]", true)}}
40+
- **Related Models [optional]:** {{ related_models | default("[More Information Needed]", true)}}
41+
- **Parent Model [optional]:** {{ parent_model | default("[More Information Needed]", true)}}
4242
- **Resources for more information:** {{ more_resources | default("[More Information Needed]", true)}}
4343

4444
# Uses
@@ -51,7 +51,7 @@
5151

5252
{{ direct_use | default("[More Information Needed]", true)}}
5353

54-
## Downstream Use [Optional]
54+
## Downstream Use [optional]
5555

5656
<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
5757

@@ -83,7 +83,7 @@
8383

8484
{{ training_data | default("[More Information Needed]", true)}}
8585

86-
## Training Procedure
86+
## Training Procedure [optional]
8787

8888
<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
8989

@@ -125,7 +125,9 @@
125125

126126
{{ results | default("[More Information Needed]", true)}}
127127

128-
# Model Examination
128+
# Model Examination [optional]
129+
130+
<!-- Relevant interpretability work for the model goes here -->
129131

130132
{{ model_examination | default("[More Information Needed]", true)}}
131133

@@ -159,7 +161,7 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
159161

160162
{{ software | default("[More Information Needed]", true)}}
161163

162-
# Citation
164+
# Citation [optional]
163165

164166
<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
165167

0 commit comments

Comments
 (0)