Added details to README.md

README.md

@@ -1,10 +1,10 @@
 ---
-license: apache-2.0
+license: mit
 base_model: microsoft/resnet-18
 tags:
 - generated_from_trainer
 datasets:
-- imagefolder
+- gaborcselle/font-examples
 metrics:
 - accuracy
 model-index:
@@ -23,10 +23,61 @@ model-index:
     - name: Accuracy
       type: accuracy
       value: 0.963265306122449
+widget:
+- text: What font is this?
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/ArchitectsDaughter-Regular_1.png
+  example_title: Architects Daughter
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Arial%20Bold_39.png
+  example_title: Arial Bold
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Courier_28.png
+  example_title: Courier
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Helvetica_3.png
+  example_title: Helvetica
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/IBMPlexSans-Regular_25.png
+  example_title: IBM Plex Sans
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Inter-Regular_43.png
+  example_title: Inter
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Lobster-Regular_25.png
+  example_title: Lobster
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Merriweather-Regular_1.png
+  example_title: Merriweather
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Poppins-Regular_22.png
+  example_title: Poppins
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/RobotoMono-Regular_38.png
+  example_title: Roboto Mono
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Times_New_Roman_Bold
+    Italic_26.png
+  example_title: Times New Roman Bold Italic
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Times_New_Roman_Italic_16.png
+  example_title: Times New Roman Italic
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/TitilliumWeb-Regular_5.png
+  example_title: Titillium Web
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Trebuchet_MS_Italic_47.png
+  example_title: Trebuchet MS Italic
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Trebuchet_MS_11.png
+  example_title: Trebuchet MS
+- src: >-
+    https://huggingface.co/gaborcselle/font-identifier/resolve/main/hf_samples/Verdana_Bold_43.png
+  example_title: Verdana Bold
+language:
+- en
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
 
 # font-identifier
 
@@ -37,15 +88,21 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+Identify the font used in an image. Visual classifier based on ResNet18.
+
+I built this project in 1 day, with a minute-by-minute journal:
+* [On Twitter/X](https://twitter.com/gabor/status/1722300841691103467)
+* [On Pebble.social](https://pebble.social/@gabor/111376050835874755)
+* [On Threads.net](https://www.threads.net/@gaborcselle/post/CzZJpJCpxTz)
+
 
 ## Intended uses & limitations
 
-More information needed
+Identify any of 48 standard fonts from the training data.
 
 ## Training and evaluation data
 
-More information needed
+Trained and eval'd on the [gaborcselle/font-examples](https://huggingface.co/datasets/gaborcselle/font-examples) dataset (80/20 split).
 
 ## Training procedure
 
@@ -123,4 +180,4 @@ The following hyperparameters were used during training:
 - Transformers 4.36.0.dev0
 - Pytorch 2.0.0
 - Datasets 2.12.0
-- Tokenizers 0.14.1
+- Tokenizers 0.14.1