Update README.md

README.md

@@ -6,17 +6,24 @@ tags:
 - generated_from_trainer
 metrics:
 - rouge
+- accuracy
 model-index:
 - name: T5_Fine_Tuned_on_Arxiv_Dataset
   results: []
+datasets:
+- ccdv/arxiv-summarization
+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. -->
 
 # T5_Fine_Tuned_on_Arxiv_Dataset
 
-This model is a fine-tuned version of [t5-small](https://huggingface.co/t5-small) on an unknown dataset.
+
+## Model Description
+This model is a fine-tuned version of [t5-small](https://huggingface.co/t5-small) designed for summarizing research papers from the Arxiv dataset. It utilizes an abstractive summarization approach to generate concise summaries that capture the main findings and contributions of the papers, facilitating easier understanding of complex academic content.
+
+## Evaluation
 It achieves the following results on the evaluation set:
 - Loss: 2.7599
 - Rouge1: 0.1635
@@ -25,19 +32,22 @@ It achieves the following results on the evaluation set:
 - Rougelsum: 0.1311
 - Generated Length: 18.9852
 
-## Model description
-
-More information needed
-
-## Intended uses & limitations
-
-More information needed
-
-## Training and evaluation data
-
-More information needed
-
-## Training procedure
+## Model Overview
+- **Model Name**: Arxiv Summarization Model
+- **Model Type**: Summarization (Abstractive)
+- **Version**: 1.0
+- **Date**: [28-Sep-2024]
+- **Authors**: Muhammad Ibtisam Afzal
+- **Contact Information**: [email protected]
+
+## Dataset
+- **Dataset Name**: ccdv/arxiv-summarization
+- **Dataset Description**: This dataset consists of articles from the Arxiv repository, paired with their respective abstracts. It is intended for training and evaluating summarization models in the academic domain.
+- **Training/Validation/Test Split**: The dataset was split into training (80%), validation (10%), and test (10%) sets.
+- **Data Source**: Hugging Face Datasets Hub
+  
+## Limitations
+The model may struggle with highly technical content or specialized jargon that is not well-represented in the training dataset. Additionally, it may produce summaries that lack coherence or completeness for particularly long documents.
 
 ### Training hyperparameters
 
@@ -66,3 +76,7 @@ The following hyperparameters were used during training:
 - Pytorch 2.4.1+cu121
 - Datasets 3.0.1
 - Tokenizers 0.19.1
+
+## Acknowledgments
+Thanks to Hugging Face for providing the infrastructure and datasets necessary for developing and evaluating this model.
+