Update README.md

README.md

@@ -12,38 +12,41 @@ probably proofread and complete it, then remove this comment. -->
 
 # GSahana/bert-finetuned-squad
 
-This model is a fine-tuned version of [bert-base-cased](https://huggingface.co/bert-base-cased) on an unknown dataset.
+This model is a fine-tuned version of [distilbert-base-cased](https://huggingface.co/bert-base-cased).
 It achieves the following results on the evaluation set:
 - Train Loss: 1.2736
-- Epoch: 0
+- Epoch: 3
 
 ## Model description
 
-More information needed
+BERT is a transformers model pretrained on a large corpus of English data in a self-supervised fashion. This means it was pretrained on the raw texts only, with no humans labelling them in any way 
+(which is why it can use lots of publicly available data) with an automatic process to generate inputs and labels from those texts. 
+More precisely, it was pretrained with two objectives:
+Masked language modeling (MLM): taking a sentence, the model randomly masks 15% of the words in the input then run the entire masked sentence through the model and has to predict the masked words. This is different from traditional recurrent neural networks (RNNs) that usually see the words one after the other, or from autoregressive models like GPT which internally mask the future tokens. It allows the model to learn a bidirectional representation of the sentence.
+Next sentence prediction (NSP): the models concatenates two masked sentences as inputs during pretraining. Sometimes they correspond to sentences that were next to each other in the original text, sometimes not. The model then has to predict if the two sentences were following each other or not.
+This way, the model learns an inner representation of the English language that can then be used to extract features useful for downstream tasks: if you have a dataset of labeled sentences for instance, you can train a standard classifier using the features produced by the BERT model as inputs.
+
+
+
+## Evaluation results
+{'exact_match': 81.18259224219489, 'f1': 88.67381321905516}
 
-## Intended uses & limitations
 
-More information needed
 
-## Training and evaluation data
 
-More information needed
 
-## Training procedure
 
 ### Training hyperparameters
+learning_rate: 2e-5,
+num_train_epochs = 3,
+batch_size=16
 
-The following hyperparameters were used during training:
-- optimizer: {'name': 'AdamWeightDecay', 'learning_rate': {'class_name': 'PolynomialDecay', 'config': {'initial_learning_rate': 2e-05, 'decay_steps': 16635, 'end_learning_rate': 0.0, 'power': 1.0, 'cycle': False, 'name': None}}, 'decay': 0.0, 'beta_1': 0.9, 'beta_2': 0.999, 'epsilon': 1e-08, 'amsgrad': False, 'weight_decay_rate': 0.01}
-- training_precision: mixed_float16
 
 ### Training results
 
 | Train Loss | Epoch |
 |:----------:|:-----:|
-| 1.2736     | 0     |
-
-
+| 1.2665     | 3   |
 ### Framework versions
 
 - Transformers 4.29.2