Update README.md

README.md

@@ -34,62 +34,25 @@ language:
 ---
 # Model Card for mDeBERTa-v3-base-myXNLI
 
-<!-- Provide a quick summary of what the model is/does. -->
+mDeBERTa-v3-base-myXNLI is a transformer model for text classification English and Myanmar (Burmese).
 
-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).
+It is based on multilingual DeBERTa v3 model and fine-tuned  using myXNLI dataset on the Natural Language Inference task in English and Myanmar.
 
-## Model Details
-
-### Model Description
+Thus it is useful for Natural Language Inference and related tasks such as Zero-shot Text Classification on both English and Myanmar data.
 
-<!-- Provide a longer summary of what this model is. -->
+## Model Details
 
-- **Developed by:** Aung Kyaw Htet
 - **Model type:** Transformer Encoder
-- **Language(s) (NLP):** Fine-tuned for Myanmar (Burmese)
+- **Language(s) (NLP):** Fine-tuned for Myanmar (Burmese) and English
 - **License:** MIT
-- **Finetuned from model [optional]:** https://huggingface.co/microsoft/deberta-v3-base
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **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. -->
-
-### Direct Use
-
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-Natural Language Inference
-
-### 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. -->
-
-[More Information Needed]
+- **Finetuned from model:** mDeBERTa v3 base [https://huggingface.co/microsoft/mdeberta-v3-base]
+- **Paper :** For the foundation model mDeBERTa v3, please refer to the paper [https://arxiv.org/abs/2111.09543]
+- **Demo :** A demo of Zero-shot Text Classification in Myanmar can be found on this page.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+Please consult the papers for original foundation model DeBERTaV3 [https://arxiv.org/abs/2111.09543].
+<!-- Any limitations with myXNLI ? -->
 
 ## How to Get Started with the Model
 
@@ -99,31 +62,19 @@ Use the code below to get started with the model.
 
 ## Training Details
 
-### Training Data
+The model is fine-tuned on myXNLI dataset https://huggingface.co/datasets/akhtet/myXNLI
 
-<!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
+From this dataset, 4 different copies training data from myXNLI were concatenated, each with sentence pairs in en-en, en-my, my-en and my-my combinations.
 
-[More Information Needed]
+Training on cross-matched language data as above improved the NLI accuracy over training separately in each language. 
+This was inspired by the approach from another model [https://huggingface.co/joeddav/xlm-roberta-large-xnli]
 
 ### Training Procedure 
 
 <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
 
-#### Preprocessing [optional]
-
-[More Information Needed]
-
-
-#### Training Hyperparameters
-
 - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
 
-#### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
-
 ## Evaluation
 
 <!-- This section describes the evaluation protocols and provides the results. -->
@@ -165,10 +116,6 @@ https://my.wikipedia.org/wiki/%E1%80%A1%E1%80%B1%E1%80%AC%E1%80%84%E1%80%BA%E1%8
 
 [More Information Needed]
 
-**APA:**
-
-[More Information Needed]
-
 ## Model Card Contact
 
 [More Information Needed]