Update README.md

README.md

@@ -26,34 +26,65 @@ model-index:
 
 ---
 
-This markdown file contains the spec for the modelcard metadata regarding evaluation parameters. When present, and only then, 'model-index', 'datasets' and 'license' contents will be verified when git pushing changes to your README.md file.
-Valid license identifiers can be found in [our docs](https://huggingface.co/docs/hub/repositories-licenses).
-
-For the full model card template, see: [modelcard_template.md file](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md).
----
-
-<!-- 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. -->
-
 # longformer_4096_qsi
 
-This model is a fine-tuned version of [mrm8488/longformer-base-4096-finetuned-squadv2](https://huggingface.co/mrm8488/longformer-base-4096-finetuned-squadv2) on an unknown dataset.
+This model is a fine-tuned version of [mrm8488/longformer-base-4096-finetuned-squadv2](https://huggingface.co/mrm8488/longformer-base-4096-finetuned-squadv2) on a tiny [NovelQSI](https://huggingface.co/datasets/Kkordik/NovelQSI) dataset.
 It achieves the following results on the evaluation set:
 - Loss: 2.9598
 
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
+This model is test model for my research project. The idea of the model is to understand which novel character said the requested quote. 
+It achieves a bit better results on the ´test´ split of the NovelQSI dataset than base longformer-base-4096-finetuned-squadv2 model on the same dataset split.
+
+**Base model results:**
+
+```
+{
+  "exact_match": {
+    "confidence_interval": [8.754452551305853, 14.718614718614718],
+    "score": 12.121212121212121,
+    "standard_error": 1.8579217243778676
+  },
+  "f1": {
+    "confidence_interval": [18.469101076147584, 28.28409063313956],
+    "score": 22.799422799422796,
+    "standard_error": 2.896728175757627
+  },
+  "latency_in_seconds": 0.7730605573419919,
+  "samples_per_second": 1.2935597224598967,
+  "total_time_in_seconds": 178.5769887460001
+}
+
+```
+
+ **Achieved results:**
+ 
+```
+{
+  "exact_match": {
+    "confidence_interval": [16.017316017316016, 24.242424242424242],
+    "score": 20.346320346320347,
+    "standard_error": 2.9434375492784994
+  },
+  "f1": {
+    "confidence_interval": [23.123469058324783, 31.823648733317036],
+    "score": 26.580086580086572,
+    "standard_error": 2.593030474995015
+  },
+  "latency_in_seconds": 0.8093855569913422,
+  "samples_per_second": 1.235505120349827,
+  "total_time_in_seconds": 186.96806366500005
+}
+```
 
 ## Training and evaluation data
 
-More information needed
+You can find training code in the github repo of my research:
+
+https://github.com/Kkordik/NovelQSI/tree/main
 
-## Training procedure
+It was trained and evaluated in notebooks, so it is easy to reproduce.
 
 ### Training hyperparameters