Update README.md

README.md

@@ -1,9 +1,25 @@
 ---
+
 tags:
 - generated_from_trainer
 model-index:
 - name: pegasus-sports-titles
-  results: []
+widget:
+ - text: "Coutinho was just about to be introduced by Villa boss Gerrard midway through the second half when Bruno Fernandes slammed home
+his second goal of the game off the underside of the bar. But the Brazilian proved the catalyst for a memorable response.
+First he drove at the United defence, helping to create the space which Jacob Ramsey exploited to halve the deficit. Then Ramsey slid over an excellent
+cross from the left which Raphael Varane was unable to intercept as he slid back, leaving Coutinho to finish into an empty net.
+The goal brought celebrations at both ends of the pitch as Emiliano Martinez also went into the crowd in relief - it was the Argentine's horrible sixth-minute error that had gifted Fernandes the visitors' opener.
+Given his background - with Liverpool, Barcelona and Bayern Munich - Coutinho is a bold loan signing by Villa, and underlines the pedigree of the man they appointed as manager in November.
+Gerrard is not at Villa to learn how to avoid relegation.
+His demands remain as high as they were as a player and Coutinho's arrival is an example of that.
+Villa are a better team since Gerrard's arrival and, after a sluggish start against opponents they dominated but lost to in the FA Cup five days ago, they grew into the game.
+The club's other newboy, Lucas Digne, was among those denied by United keeper David de Gea at the end of the first half - in unorthodox fashion, with his knees.
+Ollie Watkins did not really test the Spain keeper when Villa broke after Edinson Cavani lost possession in his own half. However, Emi Buendia certainly did with a near-post header. Rooted to his line, De Gea's reactions were up to the job as he beat Buendia's effort away.
+When De Gea produced more saves after half-time to deny Ramsey and Digne again, it appeared the image of the night for Villa would be midfielder Morgan Sanson kicking a drinks bottle in fury after his error in gifting Fred possession to set up Fernandes for the visitors' second had been followed immediately by his substitution.
+However, as it was the prelude to Coutinho's arrival, it was the moment that changed the course of the game - and the acclaim for the Brazilian at the final whistle indicated Villa's fans are already firmly behind him."
+language: en 
+
 ---
 
 <!-- This model card has been generated automatically according to the information the Trainer had access to. You
@@ -11,21 +27,52 @@ should probably proofread and complete it, then remove this comment. -->
 
 # pegasus-sports-titles
 
-This model is a fine-tuned version of [AryanLala/autonlp-Scientific_Title_Generator-34558227](https://huggingface.co/AryanLala/autonlp-Scientific_Title_Generator-34558227) on an unknown dataset.
+This model is a fine-tuned version of [AryanLala/autonlp-Scientific_Title_Generator-34558227](https://huggingface.co/AryanLala/autonlp-Scientific_Title_Generator-34558227) on some **sports news articles scraped from the internet. (For educational purposes only)**. The model can generate titles for sports articles. Try it out using the inference API. 
 
 ## Model description
 
-More information needed
-
-## Intended uses & limitations
-
-More information needed
+A Pegasus model tuned on generating scientific titles has been further fine-tuned to generate titles for sports articles. While training articles on **Tennis, Football (Soccer), Cricket , Athletics and Rugby** were used to generate titles. I experimented training the Tokenizer from scratch but it did not give good results compared to the pre-trained tokenizer. 
+
+## Usage
+
+```python
+from transformers import pipeline
+#Feel free to play around with the generation parameters.
+#Reduce the beam width for faster inference
+#Note that the maximum length for the generated titles is 64
+gen_kwargs = {"length_penalty": 0.8, "num_beams":8, "max_length": 48} 
+pipe = pipeline("summarization", model="RajSang/pegasus-sports-titles")
+
+#Change the article according to your wish
+article="""
+Coutinho was just about to be introduced by Villa boss Gerrard midway through the second half when Bruno Fernandes slammed home
+his second goal of the game off the underside of the bar. But the Brazilian proved the catalyst for a memorable response.
+First he drove at the United defence, helping to create the space which Jacob Ramsey exploited to halve the deficit. Then Ramsey slid over an excellent
+cross from the left which Raphael Varane was unable to intercept as he slid back, leaving Coutinho to finish into an empty net.
+The goal brought celebrations at both ends of the pitch as Emiliano Martinez also went into the crowd in relief - it was the Argentine's horrible sixth-minute error that had gifted Fernandes the visitors' opener.
+Given his background - with Liverpool, Barcelona and Bayern Munich - Coutinho is a bold loan signing by Villa, and underlines the pedigree of the man they appointed as manager in November.
+Gerrard is not at Villa to learn how to avoid relegation.
+His demands remain as high as they were as a player and Coutinho's arrival is an example of that.
+Villa are a better team since Gerrard's arrival and, after a sluggish start against opponents they dominated but lost to in the FA Cup five days ago, they grew into the game.
+The club's other newboy, Lucas Digne, was among those denied by United keeper David de Gea at the end of the first half - in unorthodox fashion, with his knees.
+Ollie Watkins did not really test the Spain keeper when Villa broke after Edinson Cavani lost possession in his own half. However, Emi Buendia certainly did with a near-post header. Rooted to his line, De Gea's reactions were up to the job as he beat Buendia's effort away.
+When De Gea produced more saves after half-time to deny Ramsey and Digne again, it appeared the image of the night for Villa would be midfielder Morgan Sanson kicking a drinks bottle in fury after his error in gifting Fred possession to set up Fernandes for the visitors' second had been followed immediately by his substitution.
+However, as it was the prelude to Coutinho's arrival, it was the moment that changed the course of the game - and the acclaim for the Brazilian at the final whistle indicated Villa's fans are already firmly behind him.
+"""
+
+result=pipe(article, **gen_kwargs)[0]["summary_text"]
+
+print(result)
+
+```
+**Output: Steven Gerrard's first game in charge of Aston Villa ended in a remarkable comeback against Manchester United.**
 
-## Training and evaluation data
+## Training procedure
+While training, **short titles were combined with the subtitles for the articles to improve the quality of the generated titles and the subtitles were removed from the main body of the articles.**
 
-More information needed
+##Limitations
 
-## Training procedure
+In rare cases, if the opening few lines of a passage/article are descriptive enough, the model often just copies these lines instead of looking for information further down the articles, which may not be conducive in some cases.
 
 ### Training hyperparameters
 
@@ -43,7 +90,13 @@ The following hyperparameters were used during training:
 
 ### Training results
 
+**Rouge1:0.382315**
+
+**Rouge2: 0.186598**
+
+**RougueL: 0.317393**
 
+**RougeLsum: 0.317086**
 
 ### Framework versions