Updated Auto-generated model card.

README.md

@@ -4,18 +4,32 @@ language: en
 tags:
 - bert-finetuned-mrpc
 - sequence-classification
-license: unknown
+license: Apache-2.0
+input : pair of sentence.
 ---
 
 # Bert-finetuned-mrpc Fine-tuned for Sequence classification
 
 This model is a fine-tuned version of [bert-finetuned-mrpc](https://huggingface.co/bert-finetuned-mrpc) for sequence classification tasks.
 
+## Model Description
+
+
+## Dataset
+
+- **Name**: MRPC (Microsoft Research Paraphrase Corpus)
+
+- **Description**: The MRPC dataset consists of sentence pairs automatically extracted from online news sources, with human annotations for whether the sentences in the pair are semantically equivalent.
+
+- **Source**: The dataset is part of the GLUE benchmark.
+
 ## Model description
 
+This model is a fine-tuned version of BERT-base-uncased, specifically trained to determine if two sentences are paraphrases of each other. The model outputs 1 if the sentences are equivalent and 0 if they are not.
+
 - Model architecture: BertForSequenceClassification
 - Task: sequence-classification
-- Training dataset: bert-finetuned-mrpc
+- Training dataset: glue mrpc dataset
 - Number of parameters: 109,483,778
 - Sequence length: 512
 - Vocab size: 30522
@@ -23,97 +37,31 @@ This model is a fine-tuned version of [bert-finetuned-mrpc](https://huggingface.
 - Number of attention heads: 12
 - Number of hidden layers: 12
 
-## Intended uses & limitations
+## Intended Uses & Limitations
+
+**Intended Uses**
 
-This model is intended for sequence classification tasks. It has been fine-tuned on a specific dataset, so its performance may vary on different datasets or domains.
+- Paraphrase Detection: This model can be used to determine if two sentences are paraphrases of each other, which is useful in applications like duplicate question detection in forums, semantic search, and text summarization.
+
+- Educational Purposes: Can be used for educational purposes to demonstrate fine-tuning of transformer models on specific tasks.
+
+**Limitations**
+
+- Dataset Bias: The MRPC dataset contains sentence pairs from specific news sources, which might introduce bias. The model might not perform well on text from other domains.
+
+- Context Limitations: The model evaluates sentences pairwise without considering broader context, which might lead to incorrect paraphrase detections in complex contexts.
 
 ## Training procedure
 
-The model was fine-tuned using the following hyperparameters:
-{
-  "return_dict": true,
-  "output_hidden_states": false,
-  "output_attentions": false,
-  "torchscript": false,
-  "torch_dtype": "float32",
-  "use_bfloat16": false,
-  "tf_legacy_loss": false,
-  "pruned_heads": {},
-  "tie_word_embeddings": true,
-  "chunk_size_feed_forward": 0,
-  "is_encoder_decoder": false,
-  "is_decoder": false,
-  "cross_attention_hidden_size": null,
-  "add_cross_attention": false,
-  "tie_encoder_decoder": false,
-  "max_length": 20,
-  "min_length": 0,
-  "do_sample": false,
-  "early_stopping": false,
-  "num_beams": 1,
-  "num_beam_groups": 1,
-  "diversity_penalty": 0.0,
-  "temperature": 1.0,
-  "top_k": 50,
-  "top_p": 1.0,
-  "typical_p": 1.0,
-  "repetition_penalty": 1.0,
-  "length_penalty": 1.0,
-  "no_repeat_ngram_size": 0,
-  "encoder_no_repeat_ngram_size": 0,
-  "bad_words_ids": null,
-  "num_return_sequences": 1,
-  "output_scores": false,
-  "return_dict_in_generate": false,
-  "forced_bos_token_id": null,
-  "forced_eos_token_id": null,
-  "remove_invalid_values": false,
-  "exponential_decay_length_penalty": null,
-  "suppress_tokens": null,
-  "begin_suppress_tokens": null,
-  "architectures": [
-    "BertForSequenceClassification"
-  ],
-  "finetuning_task": null,
-  "id2label": {
-    "0": "LABEL_0",
-    "1": "LABEL_1"
-  },
-  "label2id": {
-    "LABEL_0": 0,
-    "LABEL_1": 1
-  },
-  "tokenizer_class": null,
-  "prefix": null,
-  "bos_token_id": null,
-  "pad_token_id": 0,
-  "eos_token_id": null,
-  "sep_token_id": null,
-  "decoder_start_token_id": null,
-  "task_specific_params": null,
-  "problem_type": "single_label_classification",
-  "_name_or_path": "bert-finetuned-mrpc",
-  "transformers_version": "4.38.1",
-  "gradient_checkpointing": false,
-  "model_type": "bert",
-  "vocab_size": 30522,
-  "hidden_size": 768,
-  "num_hidden_layers": 12,
-  "num_attention_heads": 12,
-  "hidden_act": "gelu",
-  "intermediate_size": 3072,
-  "hidden_dropout_prob": 0.1,
-  "attention_probs_dropout_prob": 0.1,
-  "max_position_embeddings": 512,
-  "type_vocab_size": 2,
-  "initializer_range": 0.02,
-  "layer_norm_eps": 1e-12,
-  "position_embedding_type": "absolute",
-  "use_cache": true,
-  "classifier_dropout": null
-}
+- Optimizer: AdamW
+
+- Learning Rate: 5e-5
+
+- Epochs: 3
+
+- Batch Size: 8
 
 ## Evaluation results
 
-[Evaluation results to be added]
+{'accuracy': 0.8504901960784313, 'f1': 0.8942807625649913}