Update README.md

README.md

@@ -1,3 +1,146 @@
 ---
+language:
+- en
+library_name: nemo
+datasets:
+- the_pile
+tags:
+- text2text-generation
+- pytorch
+- seq2seq
+- masked language modeling
+- multilingual
 license: cc-by-4.0
+
 ---
+# NeMo Megatron-T5 3B
+
+<style>
+img {
+ display: inline;
+}
+</style>
+
+|[![Model architecture](https://img.shields.io/badge/Model%20Arch-Transformer%20Decoder-green)](#model-architecture)|[![Model size](https://img.shields.io/badge/Params-3B-green)](#model-architecture)|[![Language](https://img.shields.io/badge/Language-en--US-lightgrey#model-badge)](#datasets)
+
+
+## Model Description
+
+NeMo Megatron-mT5 3B is a *multilingual* transformer-based masked language model. [mT5](https://arxiv.org/abs/2010.11934) [1] is a class of encoder-decoder models trained with a span-based masked language modeling objective on a dataset comprising documents from many different languages. We follow the [T5v1.1](https://huggingface.co/docs/transformers/model_doc/t5v1.1) approach of pre-training using only the masked language modeling objective. It has Tensor Parallelism (TP) of 2, Pipeline Parallelism (PP) of 1 and should fit on a single NVIDIA GPU for inference and 2 A100 80G GPUs for finetuning.
+
+This model was trained with [NeMo Megatron](https://docs.nvidia.com/deeplearning/nemo/user-guide/docs/en/stable/nlp/nemo_megatron/intro.html).
+
+## List of Languages
+
+We pre-trained our mT5 model on the following languages from the [mC4](https://github.com/allenai/allennlp/discussions/5265) dataset.
+
+1. Japanese
+2. English
+3. Italian
+4. Latvian
+5. Russian
+6. Hungarian
+7. Chinese
+8. Polish
+9. Greek
+10. German
+11. Czech
+12. Korean
+13. Hindi
+14. Norwegian
+15. Danish
+16. Slovak
+17. French
+18. Portuguese
+19. Lithuanian
+20. Spanish
+21. Dutch
+22. Swedish
+23. Romanian
+24. Finnish
+
+*NOTE*: The English data used to train our model is the smaller "clean" version (C4) used in the [T5 paper](https://arxiv.org/abs/1910.10683) and not the larger one distributed as part of mC4.
+
+## Getting started
+
+### Step 1: Install NeMo and dependencies
+
+You will need to install NVIDIA Apex and NeMo. 
+
+```
+git clone https://github.com/ericharper/apex.git
+cd apex
+git checkout nm_v1.11.0
+pip install -v --disable-pip-version-check --no-cache-dir --global-option="--cpp_ext" --global-option="--cuda_ext" --global-option="--fast_layer_norm" --global-option="--distributed_adam" --global-option="--deprecated_fused_adam" ./
+```
+
+```
+pip install nemo_toolkit['nlp']==1.11.0
+``` 
+
+Alternatively, you can use NeMo Megatron training docker container with all dependencies pre-installed - [https://developer.nvidia.com/nemo-megatron-open-beta?nvid=nv-int-tblg-249896](https://developer.nvidia.com/nemo-megatron-open-beta)
+
+### Step 2: Run inference 
+
+**Note.** The model has been trained with Tensor Parallelism (TP) of 2 and Pipeline Parallelism (PP) of 1, but it should be possible to run inference with tensor parallel size 1 on most NVIDIA GPUs
+
+```
+git clone https://github.com/NVIDIA/NeMo.git 
+cd NeMo/examples/nlp/language_modeling
+git checkout v1.11.0
+python megatron_t5_eval.py \
+    --model_file /raid/Data/NMT/Models/t5_3b/nemo_megatron_mt5_3b_bf16_tp2.nemo \
+    --prompt "La capitale de la France est <mask>" --tensor_model_parallel_size 2 \
+    --tensor_model_parallel_size 2
+```
+
+The script will automatically replace all \<mask\> tokens with the appropriate sentinel tokens used while pre-training and attempt to fill them in autoregressively with greedy decoding.
+
+
+*Expected Response*:
+
+```
+{
+  'prompt': 'La capitale de la France est <mask>',
+  'completion': {
+    'text': 'Paris',
+    'tokens': [(4586, '▁Paris', 0.0)]},
+    'masked_input': '▁La ▁capital e ▁de ▁la ▁France ▁est ▁<extra_id_0>'
+}
+```
+
+- prompt: The provided raw prompt as input
+- completion:
+  - text: The final generated text from the model along with special/sentinel tokens besides \</s\>
+  - tokens: Each individual subword that is generated along with its log-probability.
+- masked_input: The original raw prompt with <mask> replaced with appropriate sentinel tokens.
+
+## Training Data
+
+The model was trained on the [mC4](https://github.com/allenai/allennlp/discussions/5265) dataset made available by AI2 and hosted on Huggingface.
+
+## Evaluation results
+
+Zero-shot language transformer performance on the [XNLI](https://arxiv.org/abs/1809.05053) dataset for a model fine-tuned on MNLI.
+
+| English | Spanish | German | French | Chinese|
+|---|---| ---|---|---|
+|89.4|86.4|84.5|85.8|79.9|
+
+## Limitations
+
+The model was trained on the data originally crawled from the Internet. This data contains toxic language and societal biases. Therefore, the model may amplify those biases and return toxic responses especially when prompted with toxic prompts.
+
+## References
+
+[1] [mT5: A massively multilingual pre-trained text-to-text transformer](https://arxiv.org/abs/2010.11934)
+
+[2] [Megatron-LM: Training Multi-Billion Parameter Language Models Using Model Parallelism](https://arxiv.org/pdf/1909.08053.pdf)
+
+[3] [NVIDIA NeMo Toolkit](https://github.com/NVIDIA/NeMo)
+
+[4] [XNLI: Evaluating Cross-lingual Sentence Representations](https://arxiv.org/abs/1809.05053)
+
+## Licence
+
+License to use this model is covered by the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/). By downloading the public and release version of the model, you accept the terms and conditions of the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) license.