Create README.md

README.md

@@ -0,0 +1,49 @@
+---
+language: 
+  - ar
+tags:
+  - Transformer
+  - MSA
+  - Arabic Text Summarization
+  - Arabic News Title Generation
+  - Arabic Paraphrasing
+widget:
+ - text: "شهدت مدينة طرابلس، مساء أمس الأربعاء، احتجاجات شعبية وأعمال شغب لليوم الثالث على التوالي، وذلك بسبب تردي الوضع المعيشي والاقتصادي. واندلعت مواجهات عنيفة وعمليات كر وفر ما بين الجيش اللبناني والمحتجين استمرت لساعات، إثر محاولة فتح الطرقات المقطوعة، ما أدى إلى إصابة العشرات من الطرفين."
+---
+
+# An Arabic abstractive text summarization model
+A Transformer-based encoder-decoder model which has been trained on a dataset of 384,764 paragraph-summary pairs.
+
+More details on the training of this model will be released later.
+
+The model can be used as follows:
+```python
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM, pipeline
+from arabert.preprocess import ArabertPreprocessor
+
+model_name="malmarjeh/transformer"
+preprocessor = ArabertPreprocessor(model_name="")
+
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+model = AutoModelForSeq2SeqLM.from_pretrained(model_name)
+pipeline = pipeline("text2text-generation",model=model,tokenizer=tokenizer)
+
+text = "شهدت مدينة طرابلس، مساء أمس الأربعاء، احتجاجات شعبية وأعمال شغب لليوم الثالث على التوالي، وذلك بسبب تردي الوضع المعيشي والاقتصادي. واندلعت مواجهات عنيفة وعمليات كر وفر ما بين الجيش اللبناني والمحتجين استمرت لساعات، إثر محاولة فتح الطرقات المقطوعة، ما أدى إلى إصابة العشرات من الطرفين."
+text = preprocessor.preprocess(text)
+
+result = pipeline(text,
+            pad_token_id=tokenizer.eos_token_id,
+            num_beams=3,
+            repetition_penalty=3.0,
+            max_length=200,
+            length_penalty=1.0,
+            no_repeat_ngram_size = 3)[0]['generated_text']
+result
+>>> 'احتجاجات شعبية في طرابلس لليوم الثالث على التوالي'
+```
+
+## Contact:
+**Mohammad Bani Almarjeh**: [Linkedin](https://www.linkedin.com/in/mohammad-bani-almarjeh/) | <banimarje@gmail.com>
+
+
+