diff --git "a/template.README.md" "b/template.README.md" new file mode 100644--- /dev/null +++ "b/template.README.md" @@ -0,0 +1,1403 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + model_card/template.README.md at master · huggingface/model_card · GitHub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Skip to content + + + + + + + + + + +
+ +
+ + + + + + +
+ + + +
+ + + + + + + + + + +
+
+
+ + + + + + + + + + + + + +
+ +
+ +
+

+ + + / + + model_card + + Public template +

+ + +
+ + + +
+ +
+
+ + + + +
+ + + +
+
+ + + + + + + + +
+ + + + Permalink + + + +
+ +
+
+ + + master + + + + +
+
+
+ Switch branches/tags + +
+ + + +
+ +
+ +
+ + +
+ +
+ + + + + + + + + + + + + + + + +
+ + + + +
+
+ +
+ +
+ +

+ model_card/template.README.md +

+ + Go to file + + +
+ + + + + + + + + +
    +
  • + + Go to file + +
    • +
  • +
    • +
  • +
  • + + + Copy path + +
    • +
  • + + + + Copy permalink + + +
    • +
+
+
+ + + + +
+ +
+
+
 
+
+ +
+
 
+ Cannot retrieve contributors at this time +
+
+ + + + + + + + + + +
+ +
+ +
+ + + + + + +
+ +
+ +
+ +
+ MyModelName + Model description + Intended uses & limitations + How to use + Limitations and bias + Training data + Training procedure + Eval results + BibTeX entry and citation info +
+
+ +
+ + +
+ + 54 lines (39 sloc) + + 778 Bytes +
+ +
+ +
+ + + Raw + + + + + + Blame + + + +
+ + +
+ +
+
+ + + + + +
+
+
+ + +
+
+ + + + + + + + + + + + + + + + + + + + +
languagethumbnailtagslicensedatasetsmetrics
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+ +

MyModelName

+

Model description

+

You can embed local or remote images using ![](...)

+

Intended uses & limitations

+

How to use

+
# You can include sample code which will be formatted
+

Limitations and bias

+

Provide examples of latent issues and potential remediations.

+

Training data

+

Describe the data you used to train the model. +If you initialized it with pre-trained weights, add a link to the pre-trained model card or repository with description of the pre-training data.

+

Training procedure

+

Preprocessing, hardware used, hyperparameters...

+

Eval results

+

BibTeX entry and citation info

+
@inproceedings{...,
+  year={2020}
+}
+
+
+ +
+ + + + + +
+ + +
+ + +
 +
+ + +
+ + + +
+
+ +
+
+ +
+ + + + + + + + + + + + + + + + + + + + +