[MoE] add expert tensor parallelism support for NeMo2.0 MoE
State: open | Pull request: yes
Labels: name: core

name: NLP

name: Multi Modal

name: Run CICD

# What does this PR do ?

add expert tensor parallelism support for NeMo2.0 MoE and substitute get_data_modulo_expert_parallel_group with get_expert_data_parallel_group since the former one is going to be deprecated.

**Collection**: [Note which collection this PR will affect]

# Changelog 
- Add specific line by line info of high level changes in this PR.

# Usage
* You can potentially add a usage example below

```python
# Add a code snippet demonstrating how to use this 
```

# GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

# Before your PR is "Ready for review"
**Pre checks**:
- [ ] Make sure you read and followed [Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md)
- [ ] Did you write any new necessary tests?
- [ ] Did you add or update any necessary documentation?
- [ ] Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
  - [ ] Reviewer: Does the PR have correct import guards for all optional libraries?
  
**PR Type**:
- [ ] New Feature
- [ ] Bugfix
- [ ] Documentation

If you haven't finished some of the above items you can still open "Draft" PR.


## Who can review?

Anyone in the community is free to review the PR once the checks have passed. 
[Contributor guidelines](https://github.com/NVIDIA/NeMo/blob/main/CONTRIBUTING.md) contains specific people who can review PRs to various areas.

# Additional Information
* Related to # (issue)


<!-- pylint-output-strict-mode-false -->

beep boop 🤖: 🙏 The following files have warnings. In case you are familiar with these, please try helping us to improve the code base.

---

Your code was analyzed with PyLint. The following annotations have been identified:

```
************* Module nemo.collections.multimodal.models.vision_language_foundation.clip.megatron_clip_models
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:667:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:671:0: C0301: Line too long (149/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:723:0: C0301: Line too long (126/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:939:0: C0301: Line too long (131/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1405:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1420:0: C0301: Line too long (155/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1435:0: C0301: Line too long (137/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:111:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:169:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:273:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:281:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:323:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:337:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:382:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:391:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:413:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:422:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:438:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:448:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:468:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:572:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:877:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:881:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:935:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1158:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1192:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1198:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1220:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1310:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1313:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1317:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1444:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1480:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.nlp.models.language_modeling.megatron_lm_encoder_decoder_model
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:102:0: C0301: Line too long (144/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:138:0: C0301: Line too long (126/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:231:0: C0301: Line too long (123/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:253:0: C0301: Line too long (120/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:261:0: C0301: Line too long (180/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:263:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:537:0: C0301: Line too long (153/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:562:0: C0301: Line too long (146/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:563:0: C0301: Line too long (124/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:579:0: C0301: Line too long (180/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:619:0: C0301: Line too long (121/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:647:0: C0301: Line too long (150/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:648:0: C0301: Line too long (127/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:800:0: C0301: Line too long (120/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:924:0: C0301: Line too long (145/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:992:0: C0301: Line too long (136/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:993:0: C0301: Line too long (123/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1162:0: C0301: Line too long (125/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1228:0: C0301: Line too long (149/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1235:0: C0301: Line too long (121/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1248:0: C0301: Line too long (143/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1351:0: C0301: Line too long (129/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1353:0: C0301: Line too long (151/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1355:0: C0301: Line too long (166/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1356:0: C0301: Line too long (144/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1358:0: C0301: Line too long (138/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1359:0: C0301: Line too long (130/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1396:0: C0301: Line too long (149/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1422:0: C0301: Line too long (143/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1715:0: C0301: Line too long (125/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1743:0: C0301: Line too long (128/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:258:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:349:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:512:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:519:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:560:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:661:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:904:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1045:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1172:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_lm_encoder_decoder_model.py:1202:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.core.optim.optimizer_with_main_params
nemo/core/optim/optimizer_with_main_params.py:91:0: C0301: Line too long (140/119) (line-too-long)
nemo/core/optim/optimizer_with_main_params.py:96:0: C0301: Line too long (149/119) (line-too-long)
nemo/core/optim/optimizer_with_main_params.py:195:0: C0301: Line too long (140/119) (line-too-long)
nemo/core/optim/optimizer_with_main_params.py:200:0: C0301: Line too long (149/119) (line-too-long)
nemo/core/optim/optimizer_with_main_params.py:149:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:153:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:403:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:446:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:450:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:471:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:477:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:497:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:513:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:517:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/core/optim/optimizer_with_main_params.py:520:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.lightning._strategy_lib
nemo/lightning/_strategy_lib.py:577:0: C0301: Line too long (130/119) (line-too-long)
nemo/lightning/_strategy_lib.py:35:0: C0115: Missing class docstring (missing-class-docstring)
nemo/lightning/_strategy_lib.py:36:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/lightning/_strategy_lib.py:143:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/lightning/_strategy_lib.py:170:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/lightning/_strategy_lib.py:206:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/lightning/_strategy_lib.py:519:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/lightning/_strategy_lib.py:602:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/lightning/_strategy_lib.py:615:4: C0115: Missing class docstring (missing-class-docstring)
************* Module nemo.lightning.megatron_init
nemo/lightning/megatron_init.py:269:0: C0301: Line too long (122/119) (line-too-long)
nemo/lightning/megatron_init.py:270:0: C0301: Line too long (133/119) (line-too-long)
nemo/lightning/megatron_init.py:271:0: C0301: Line too long (121/119) (line-too-long)
nemo/lightning/megatron_init.py:374:0: C0301: Line too long (166/119) (line-too-long)
nemo/lightning/megatron_init.py:88:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.lightning.pytorch.strategies.megatron_strategy
nemo/lightning/pytorch/strategies/megatron_strategy.py:290:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.utils.app_state
nemo/utils/app_state.py:440:0: C0301: Line too long (138/119) (line-too-long)
nemo/utils/app_state.py:448:0: C0301: Line too long (135/119) (line-too-long)
nemo/utils/app_state.py:23:0: C0115: Missing class docstring (missing-class-docstring)
nemo/utils/app_state.py:29:0: C0115: Missing class docstring (missing-class-docstring)
nemo/utils/app_state.py:255:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:708:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:718:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:727:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:732:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:738:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:746:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/utils/app_state.py:754:4: C0116: Missing function or method docstring (missing-function-docstring)

-----------------------------------
Your code has been rated at 9.61/10
```

---

Mitigation guide:

* Add sensible and useful docstrings to functions and methods
* For trivial methods like getter/setters, consider adding `# pylint: disable=C0116` inside the function itself
* To disable multiple functions/methods at once, put a `# pylint: disable=C0116` before the first and a `# pylint: enable=C0116` after the last.

By applying these rules, we reduce the occurance of this message in future.

Thank you for improving NeMo's documentation!