Update README.md

README.md

@@ -17,21 +17,21 @@ base_model: facebook/bart-large
 
 
 
-- **Developed by:** [Nevidu Jayatilleke and Ruvan Weerasinghe]
+- **Developed by:** Nevidu Jayatilleke and Ruvan Weerasinghe
 <!-- - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed] -->
 <!-- - **Model type:** [More Information Needed] -->
-- **Language(s) (NLP):** [English]
+- **Language(s) (NLP):** English
 <!-- - **License:** [More Information Needed] -->
-- **Finetuned from model [optional]:** [facebook/bart-large]
+- **Finetuned from model [optional]:** facebook/bart-large
 
 ### Model Sources [optional]
 
 <!-- Provide the basic links for the model. -->
 
 <!-- - **Repository:** [More Information Needed] -->
-- **Paper [optional]:** [The model was published in "A Hybrid Architecture with Efficient Fine Tuning
-for Abstractive Patent Document Summarization" available in https://arxiv.org/abs/2503.10354]
+- **Paper [optional]:** The model was published in "A Hybrid Architecture with Efficient Fine Tuning
+for Abstractive Patent Document Summarization" available in https://arxiv.org/abs/2503.10354
 <!-- - **Demo [optional]:** [More Information Needed] -->
 
 <!-- ## Uses
@@ -42,32 +42,32 @@ for Abstractive Patent Document Summarization" available in https://arxiv.org/ab
 
 <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 <!-- ### Downstream Use [optional] -->
 
 <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 <!-- ### Out-of-Scope Use -->
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 <!-- ## Bias, Risks, and Limitations -->
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 <!-- ### Recommendations
 
 <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
- --> -->
+<!-- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations. -->
+ <!-- --> --> -->
 ## How to use the model
 
 <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
@@ -145,102 +145,107 @@ def summarize(text, max_tokens):
 summary = summarize(text, max_tokens)
 ```
 
-### Training Procedure 
+<!-- ### Training Procedure  -->
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
+<!-- #### Preprocessing [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
 
-#### Training Hyperparameters
+<!-- #### Training Hyperparameters -->
 
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+<!-- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision --> -->
 
-#### Speeds, Sizes, Times [optional]
+<!-- #### Speeds, Sizes, Times [optional] -->
 
 <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Evaluation
+<!-- ## Evaluation -->
 
 <!-- This section describes the evaluation protocols and provides the results. -->
 
-### Testing Data, Factors & Metrics
+<!-- ### Testing Data, Factors & Metrics -->
 
-#### Testing Data
+<!-- #### Testing Data -->
 
 <!-- This should link to a Dataset Card if possible. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Factors
+<!-- #### Factors -->
 
 <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Metrics
+<!-- #### Metrics -->
 
 <!-- These are the evaluation metrics being used, ideally with a description of why. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Results
+<!-- ### Results -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Summary
+<!-- #### Summary -->
 
 
 
-## Model Examination [optional]
+<!-- ## Model Examination [optional] -->
 
 <!-- Relevant interpretability work for the model goes here -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Environmental Impact
+<!-- ## Environmental Impact -->
 
 <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
 
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
+<!-- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700). -->
 
-- **Hardware Type:** [More Information Needed]
+<!-- - **Hardware Type:** [More Information Needed]
 - **Hours used:** [More Information Needed]
 - **Cloud Provider:** [More Information Needed]
 - **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
+- **Carbon Emitted:** [More Information Needed] -->
 
-## Technical Specifications [optional]
+<!-- ## Technical Specifications [optional] -->
 
-### Model Architecture and Objective
+<!-- ### Model Architecture and Objective -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-### Compute Infrastructure
+<!-- ### Compute Infrastructure -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Hardware
+<!-- #### Hardware -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-#### Software
-
-[More Information Needed]
+<!-- #### Software -->
 
+<!-- [More Information Needed]
+ -->
 ## Citation [optional]
 
 <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
 
 **BibTeX:**
 
-[More Information Needed]
+@article{jayatilleke2025hybrid,
+  title={A Hybrid Architecture with Efficient Fine Tuning for Abstractive Patent Document Summarization},
+  author={Jayatilleke, Nevidu and Weerasinghe, Ruvan},
+  journal={arXiv preprint arXiv:2503.10354},
+  year={2025}
+}
 
-**APA:**
+<!-- **APA:**
 
 [More Information Needed]
 
@@ -248,19 +253,19 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## More Information [optional]
+<!-- ## More Information [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Model Card Authors [optional]
+<!-- ## Model Card Authors [optional] -->
 
-[More Information Needed]
+<!-- [More Information Needed] -->
 
-## Model Card Contact
+<!-- ## Model Card Contact -->
 
-[More Information Needed]
+<!-- [More Information Needed] --> -->
 
 
 ### Framework versions