Update README.md

README.md

@@ -2,51 +2,80 @@
 license: apache-2.0
 base_model: google/mobilebert-uncased
 tags:
-- generated_from_trainer
+- dataset tools
+- books
+- book
+- genre
 metrics:
 - f1
 widget:
-  - text: The Quantum Chip
-    example_title: Science Fiction & Fantasy
-  - text: One Dollar's Journey
-    example_title: Business & Finance
-  - text: Timmy The Talking Tree
-    example_title: idk fiction
-  - text: The Cursed Canvas
-    example_title: Arts & Design
-  - text: Hoops and Hegel
-    example_title: Philosophy & Religion
-  - text: Overview of Streams in North Dakota
-    example_title: Nature
-  - text: Advanced Topology
-    example_title: Non-fiction/Math
-  - text: Cooking Up Love
-    example_title: Food & Cooking
-  - text: Dr. Doolittle's Extraplanatary Commute
-    example_title: Science & Technology
+- text: The Quantum Chip
+  example_title: Science Fiction & Fantasy
+- text: One Dollar's Journey
+  example_title: Business & Finance
+- text: Timmy The Talking Tree
+  example_title: idk fiction
+- text: The Cursed Canvas
+  example_title: Arts & Design
+- text: Hoops and Hegel
+  example_title: Philosophy & Religion
+- text: Overview of Streams in North Dakota
+  example_title: Nature
+- text: Advanced Topology
+  example_title: Non-fiction/Math
+- text: Cooking Up Love
+  example_title: Food & Cooking
+- text: Dr. Doolittle's Extraplanatary Commute
+  example_title: Science & Technology
+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. -->
 
-# mobilebert-uncased-goodreads-bookgenres-Book_cls-10e
+# mobilebert-uncased-title2genre
 
-This model is a fine-tuned version of [google/mobilebert-uncased](https://huggingface.co/google/mobilebert-uncased) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.2658
-- F1: 0.5395
+This model is a fine-tuned version of [google/mobilebert-uncased](https://huggingface.co/google/mobilebert-uncased) for multi-label classification (18 labels).
 
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
+This classifies one or more **genre** labels in a **multi-label** setting for a given book **title**.
+
+The 'standard' way of interpreting the predictions is that the predicted labels for a given example are **only the ones with a greater than 50% probability.**
+
+## Details
+
+### Labels
+
+There are 18 labels, these are already integrated into the `config.json` and should be output by the model:
+
+```json
+"id2label": {
+    "0": "History & Politics",
+    "1": "Health & Medicine",
+    "2": "Mystery & Thriller",
+    "3": "Arts & Design",
+    "4": "Self-Help & Wellness",
+    "5": "Sports & Recreation",
+    "6": "Non-Fiction",
+    "7": "Science Fiction & Fantasy",
+    "8": "Countries & Geography",
+    "9": "Other",
+    "10": "Nature & Environment",
+    "11": "Business & Finance",
+    "12": "Romance",
+    "13": "Philosophy & Religion",
+    "14": "Literature & Fiction",
+    "15": "Science & Technology",
+    "16": "Children & Young Adult",
+    "17": "Food & Cooking"
+  },
+```
+
+### Eval results (validation)
 
-More information needed
+It achieves the following results on the evaluation set:
+- Loss: 0.2658
+- F1: 0.5395
 
 ## Training procedure
 
@@ -64,25 +93,10 @@ The following hyperparameters were used during training:
 - lr_scheduler_warmup_ratio: 0.03
 - num_epochs: 10.0
 
-### Training results
-
-| Training Loss | Epoch | Step | Validation Loss | F1     |
-|:-------------:|:-----:|:----:|:---------------:|:------:|
-| 0.3118        | 0.99  | 123  | 0.2938          | 0.3004 |
-| 0.2732        | 2.0   | 247  | 0.2774          | 0.4601 |
-| 0.2705        | 3.0   | 371  | 0.2660          | 0.4703 |
-| 0.2671        | 3.99  | 494  | 0.2679          | 0.4754 |
-| 0.2529        | 5.0   | 618  | 0.2655          | 0.5163 |
-| 0.2395        | 6.0   | 742  | 0.2637          | 0.5213 |
-| 0.2469        | 6.99  | 865  | 0.2650          | 0.5235 |
-| 0.2301        | 8.0   | 989  | 0.2636          | 0.5251 |
-| 0.2273        | 9.0   | 1113 | 0.2648          | 0.5394 |
-| 0.2169        | 9.94  | 1230 | 0.2658          | 0.5395 |
-
 
 ### Framework versions
 
 - Transformers 4.35.0.dev0
 - Pytorch 2.0.1+cpu
 - Datasets 2.14.5
-- Tokenizers 0.14.0
+- Tokenizers 0.14.0