From ea93258a6600f79d851b306864224595192edd51 Mon Sep 17 00:00:00 2001
From: Lidiya Murakhovs'ka <lidiya.murakhovskaya@gmail.com>
Date: Wed, 26 May 2021 22:18:09 +0000
Subject: [PATCH] Create README

---
 README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b02f6d6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,89 @@
+---
+language: en
+tags:
+- bart
+- seq2seq
+- summarization
+license: apache-2.0
+datasets:
+- samsum
+widget:
+- text: | 
+    Hannah: Hey, do you have Betty's number?
+    Amanda: Lemme check
+    Amanda: Sorry, can't find it.
+    Amanda: Ask Larry
+    Amanda: He called her last time we were at the park together
+    Hannah: I don't know him well
+    Amanda: Don't be shy, he's very nice
+    Hannah: If you say so..
+    Hannah: I'd rather you texted him
+    Amanda: Just text him 🙂
+    Hannah: Urgh.. Alright
+    Hannah: Bye
+    Amanda: Bye bye
+model-index:
+- name: bart-large-xsum-samsum
+  results:
+  - task: 
+      name: Abstractive Text Summarization
+      type: abstractive-text-summarization
+    dataset:
+      name: "SAMSum Corpus: A Human-annotated Dialogue Dataset for Abstractive Summarization" 
+      type: samsum
+    metrics:
+       - name: Validation ROGUE-1
+         type: rogue-1
+         value: 54.3921
+       - name: Validation ROGUE-2
+         type: rogue-2
+         value: 29.8078
+       - name: Validation ROGUE-L
+         type: rogue-l
+         value: 45.1543
+       - name: Test ROGUE-1
+         type: rogue-1
+         value: 53.3059
+       - name: Test ROGUE-2
+         type: rogue-2
+         value: 28.355
+       - name: Test ROGUE-L
+         type: rogue-l
+         value: 44.0953 
+---
+## `bart-large-xsum-samsum`
+This model was obtained by fine-tuning `facebook/bart-large-xsum` on [Samsum](https://huggingface.co/datasets/samsum) dataset.
+## Usage
+```python
+from transformers import pipeline
+
+summarizer = pipeline("summarization", model="lidiya/bart-large-xsum-samsum")
+conversation = '''Hannah: Hey, do you have Betty's number?
+Amanda: Lemme check
+Amanda: Sorry, can't find it.
+Amanda: Ask Larry
+Amanda: He called her last time we were at the park together
+Hannah: I don't know him well
+Amanda: Don't be shy, he's very nice
+Hannah: If you say so..
+Hannah: I'd rather you texted him
+Amanda: Just text him 🙂
+Hannah: Urgh.. Alright
+Hannah: Bye
+Amanda: Bye bye                                       
+'''
+summarizer(conversation)
+```
+## Training procedure
+- Colab notebook: https://colab.research.google.com/drive/1dul0Sg-TTMy9xZCJzmDRajXbyzDwtYx6?usp=sharing
+## Results
+| key | value |
+| --- | ----- |
+| eval_rouge1 | 54.3921 |
+| eval_rouge2 | 29.8078 |
+| eval_rougeL | 45.1543 |
+| eval_rougeLsum | 49.942 |
+| test_rouge1 | 53.3059 |
+| test_rouge2 | 28.355 |
+| test_rougeL | 44.0953 |
+| test_rougeLsum | 48.9246 |
\ No newline at end of file