Update README.md

README.md

@@ -6,24 +6,49 @@ model-index:
   results: []
 ---
 
-<!-- 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. -->
+## Model description
 
-# tim_expression_identify.2
+This model is a fine-tuned version of RoBERTa.
 
-This model is a fine-tuned version of [/misc/projdata17/infofil/syang/work_dir/temporal/pretrain_temporal/log/time_expression/tim_expression_identify.2](https://huggingface.co//misc/projdata17/infofil/syang/work_dir/temporal/pretrain_temporal/log/time_expression/tim_expression_identify.2) on an unknown dataset.
+## Intended uses & limitations
 
-## Model description
+For identifying time expressions in text. This model works in a NER-like manner but only focuses on time expressions.
 
-More information needed
 
-## Intended uses & limitations
+- You may try an example sentence using the hosted inference API on HuggingFace: 
 
-More information needed
+  *In Generation VII, Pokémon Sun and Moon were released worldwide for the 3DS on November 18, 2016 and on November 23, 2016 in Europe.*
+  
+  The JSON output would be like:
+  ```
+  [
+    {
+      "entity_group": "TIME",
+      "score": 0.9959897994995117,
+      "word": " November 18",
+      "start": 79,
+      "end": 90
+    },
+    {
+      "entity_group": "TIME",
+      "score": 0.996467113494873,
+      "word": " 2016",
+      "start": 92,
+      "end": 96
+    },
+    {
+      "entity_group": "TIME",
+      "score": 0.9942433834075928,
+      "word": " November 23, 2016",
+      "start": 104,
+      "end": 121
+    }
+  ]
+  ```
 
 ## Training and evaluation data
 
-More information needed
+TimeBank 1.2
 
 ## Training procedure