Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debug Apex distributed optimizer to handle Transformer Engine 2.0 #12004

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

timmoon10
Copy link
Collaborator

@timmoon10 timmoon10 commented Jan 31, 2025

What does this PR do ?

Transformer Engine 2.0 has made significant changes to its internal implementation to support alternate quantization schemes like MXFP8. This breaks the Apex distributed optimizer, which uses some internal features to perform FP8 casts. This PR fixes those issues, while maintaining backward compatibility with TE 1.x.

Collection: Core, NLP

Changelog

  • Update Apex distributed optimizer to work with Transformer Engine 2.0
  • Avoid initializing models with MXFP8 params

Usage

Run GPT, e.g. with the config at https://github.com/NVIDIA/NeMo/blob/main/examples/nlp/language_modeling/conf/megatron_gpt_config.yaml.

Some relevant options:

  • Distributed optimizer: model.optim.name=distributed_fused_adam
  • Transformer Engine: model.transformer_engine=True
  • FP8 support: model.fp8=True
  • FP8 params: model.fp8_params=True

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
  • 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 contains specific people who can review PRs to various areas.

Additional Information

@github-actions github-actions bot added core Changes to NeMo Core NLP Multi Modal labels Jan 31, 2025
Signed-off-by: Tim Moon <[email protected]>
Copy link
Contributor

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:668:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:672:0: C0301: Line too long (149/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:731:0: C0301: Line too long (126/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:947:0: C0301: Line too long (131/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1413:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1428:0: C0301: Line too long (155/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1443:0: C0301: Line too long (137/119) (line-too-long)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:112:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:170:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:274:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:282:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:324:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:338:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:383:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:392:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:414:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:423:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:439:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:449:0: C0115: Missing class docstring (missing-class-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:469:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:573:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:885:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:889:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:943:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1166:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1200:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1206:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1228:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1318:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1321:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1325:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1452:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/multimodal/models/vision_language_foundation/clip/megatron_clip_models.py:1488:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module nemo.collections.nlp.models.language_modeling.megatron_gpt_model
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:334:0: C0301: Line too long (149/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:374:0: C0301: Line too long (136/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:427:0: C0301: Line too long (126/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:474:0: C0301: Line too long (122/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:808:0: C0301: Line too long (131/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1123:0: C0301: Line too long (146/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1144:0: C0301: Line too long (168/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1354:0: C0301: Line too long (122/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1405:0: C0301: Line too long (122/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1462:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1644:0: C0301: Line too long (132/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1645:0: C0301: Line too long (136/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1647:0: C0301: Line too long (159/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1818:0: C0301: Line too long (128/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1838:0: C0301: Line too long (140/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1846:0: C0301: Line too long (155/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1867:0: C0301: Line too long (141/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1937:0: C0301: Line too long (125/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1964:0: C0301: Line too long (134/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:2013:0: C0301: Line too long (156/119) (line-too-long)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:141:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:154:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:180:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:199:0: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:252:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:290:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:294:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:306:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:314:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:483:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:486:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:718:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:722:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:804:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1121:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1194:12: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1243:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1272:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1475:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1611:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1619:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1628:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:1912:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:2074:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:2081:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:2087:4: C0116: Missing function or method docstring (missing-function-docstring)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:20:0: W0611: Unused fields imported from dataclasses (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:28:0: W0611: Unused _DataFetcherWrapper imported from lightning.pytorch.loops.fetchers (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:30:0: W0611: Unused OmegaConf imported from omegaconf (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:72:0: W0611: Unused activation_to_func imported from nemo.collections.nlp.parts.utils_funcs (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:81:4: W0611: Unused megatron.core imported as core (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:82:4: W0611: Unused tensor_parallel imported from megatron.core (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:101:4: W0611: Unused init_method_normal imported from megatron.core.utils (unused-import)
nemo/collections/nlp/models/language_modeling/megatron_gpt_model.py:101:4: W0611: Unused scaled_init_method_normal imported from megatron.core.utils (unused-import)

-----------------------------------
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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant