Created model card for my extreme summarization model (#5839)

* Created model card for my extreme summarization model * Update model_cards/yuvraj/xSumm/README.md Co-authored-by: Julien Chaumond <chaumond@gmail.com>
2020-07-21 03:54:57 -04:00
parent abf5c56e9d
commit d32279438a
1 changed files with 26 additions and 0 deletions
@@ -0,0 +1,26 @@
+---
+language: "en"
+tags:
+- summarization
+- extreme summarization
+---
+
+## Model description
+
+BartForConditionalGenerationModel for extreme summarization- creates a one line abstractive summary of a given article
+
+## How to use
+
+PyTorch model available
+
+```python
+from transformers import AutoTokenizer, AutoModelWithLMHead, pipeline
+
+tokenizer = AutoTokenizer.from_pretrained("yuvraj/xSumm")			
+model = AutoModelWithLMHead.from_pretrained("yuvraj/xSumm")
+
+xsumm = pipeline('summarization', model=model, tokenizer=tokenizer)
+xsumm("<text to be summarized>")
+
+## Limitations and bias
+Trained on a small fraction of the xsumm training dataset