Update

README.md

@@ -40,7 +40,32 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+The model can be used as follows:
+```python
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM, pipeline
+from arabert.preprocess import ArabertPreprocessor
+
+model_name="abdalrahmanshahrour/arabartsummarization"
+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
+>>> "تجددت الاشتباكات بين الجيش اللبناني ومحتجين في مدينة طرابلس شمالي لبنان."
+```
+
 
 ## Intended uses & limitations
 
@@ -48,7 +73,9 @@ More information needed
 
 ## Training and evaluation data
 
-More information needed
+42.21K row in total
+  - Training : 37.52K rows
+  - Evaluation : 4.69K rows
 
 ## Training procedure