Update README.md

README.md

@@ -7,7 +7,6 @@ pipeline_tag: text-generation
 
 <!-- Provide a quick summary of what the model is/does. -->
 
-This modelcard aims to be a base template for new models. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1).
 
 ## Model Details
 
@@ -20,37 +19,26 @@ This modelcard aims to be a base template for new models. It has been generated
 - **Developed by:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
 - **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Language(s) (NLP):** [Arabic]
 - **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
+- **Finetuned from model :** [https://huggingface.co/aubmindlab/aragpt2-mega]
 
-### Model Sources [optional]
 
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
 
 ## Uses
 
 <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+1. The model can be helpful for the arabic langauge students/researchers, since it provide the full sentence anaylsis (اعراب الجملة ) in arabic language.
+2. 
 
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-
-[More Information Needed]
 
 ### Out-of-Scope Use
 
 <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+1. This model can't be use for grammar check, since it dail with high level of arabic correct sentence as input
+2. Don't use arabic dailects in input sentence.
+3. 
+4. 
 
 [More Information Needed]
 
@@ -94,20 +82,25 @@ generation_args = {
     'do_sample': True,
     'repetition_penalty':2.0
 }
+
+##Pose Tagging
 input_text = f'<|startoftext|>Instruction: {prml[1]} {text}<|pad|>Answer:'
 input_ids = tokenizer.encode(input_text, return_tensors='pt').to("cuda")
 output_ids = model.generate(input_ids=input_ids,**generation_args)
 output_text = tokenizer.decode(output_ids[0],skip_special_tokens=True).split('Answer:')[1]
 answer_pose=pyarabic.trans.delimite_language(output_text, start="<token>", end="</token>")
 
-print(answer_pose)# <token>تعلم : تعلم</token>  : Verb  <token>من : من</token>  : Relative pronoun  <token>أخطائك : اخطا</token>  : Noun  <token>ك</token>  : Personal pronunction
+print(answer_pose)
+# <token>تعلم : تعلم</token>  : Verb  <token>من : من</token>  : Relative pronoun  <token>أخطائك : اخطا</token>  : Noun  <token>ك</token>  : Personal pronunction
 
+##Arabic Sentence Analysis
 input_text = f'<|startoftext|>Instruction: {prml[0]} {text}<|pad|>Answer:'
 input_ids = tokenizer.encode(input_text, return_tensors='pt').to("cuda")
 output_ids = model.generate(input_ids=input_ids,**generation_args)
 output_text = tokenizer.decode(output_ids[0],skip_special_tokens=True).split('Answer:')[1]
 
-print(output_text)#تعلم : تعلم : فعل ، مفرد المخاطب للمذكر ، فعل مضارع ، مرفوع من : من : حرف جر أخطائك : اخطا : اسم ، جمع المذكر ، مجرور ك : ضمير ، مفرد المتكلم
+print(output_text)
+#تعلم : تعلم : فعل ، مفرد المخاطب للمذكر ، فعل مضارع ، مرفوع من : من : حرف جر أخطائك : اخطا : اسم ، جمع المذكر ، مجرور ك : ضمير ، مفرد المتكلم
 ```
 
 ## Training Details
@@ -233,4 +226,4 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ## Model Card Contact
 
-[More Information Needed]
+[akram.alsubari87@gmail.com]