Update README.md

README.md

@@ -7,30 +7,35 @@ model-index:
   results: []
 ---
 
-<!-- This model card has been generated automatically according to the information Keras had access to. You should
-probably proofread and complete it, then remove this comment. -->
-
 # bart-large-finetuned-filtered-spotify-podcast-summ
 
-This model is a fine-tuned version of [facebook/bart-large-cnn](https://huggingface.co/facebook/bart-large-cnn) on an unknown dataset.
+This model is a fine-tuned version of [facebook/bart-large-cnn](https://huggingface.co/facebook/bart-large-cnn) on on the [Spotify Podcast Dataset](https://arxiv.org/abs/2004.04270). Take a look to the [github repository](https://github.com/TheOnesThatWereAbroad/PodcastSummarization) of this project.
+
 It achieves the following results on the evaluation set:
 - Train Loss: 2.2967
 - Validation Loss: 2.8316
 - Epoch: 2
 
-## Model description
-
-More information needed
-
 ## Intended uses & limitations
 
-More information needed
+This model is intended to be used for automatic podcast summarisation. Given the podcast transcript in input, the objective is to provide a short text summary that a user might read when deciding whether to listen to a podcast. The summary should accurately convey the content of the podcast, be human-readable, and be short enough to be quickly read on a smartphone screen. 
 
 ## Training and evaluation data
 
-More information needed
+We split the filtered brass set into train/dev sets of 69,336/7,705 episodes. 
+The test set consists of 1,027 episodes. Only 1025 have been used because two of them did not contain an episode description.
+
+
+## How to use
 
-## Training procedure
+The model can be used for the summarization as follows:
+
+```python
+from transformers import pipeline
+summarizer = pipeline("summarization", model="gmurro/bart-large-finetuned-filtered-spotify-podcast-summ", tokenizer="gmurro/bart-large-finetuned-filtered-spotify-podcast-summ")
+summary = summarizer(podcast_transcript, min_length=39, max_length=250)
+print(summary[0]['summary_text'])
+```
 
 ### Training hyperparameters
 
@@ -53,3 +58,14 @@ The following hyperparameters were used during training:
 - TensorFlow 2.9.1
 - Datasets 2.3.1
 - Tokenizers 0.12.1
+
+
+## Authors
+
+|   Name    |  Surname  |                 Email                  |                       Username                        |
+| :-------: | :-------: | :------------------------------------: | :---------------------------------------------------: |
+| Giuseppe  |   Boezio  | `[email protected]`      | [_giuseppeboezio_](https://github.com/giuseppeboezio) |
+| Simone    |  Montali  |    `[email protected]`    |         [_montali_](https://github.com/montali)         |
+| Giuseppe  |    Murro  |    `[email protected]`    |         [_gmurro_](https://github.com/gmurro)         |
+
+