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

Moe doc fixes #10077

Merged
merged 2 commits into from
Aug 9, 2024
Merged

Moe doc fixes #10077

merged 2 commits into from
Aug 9, 2024

Conversation

akoumpa
Copy link
Member

@akoumpa akoumpa commented Aug 7, 2024

What does this PR do ?

Add a one line overview of what this PR aims to accomplish.

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
# 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
  • 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

  • Related to # (issue)

@akoumpa akoumpa force-pushed the akoumparouli/moe_doc_fixes branch 2 times, most recently from 7d287fd to 499c4d2 Compare August 7, 2024 21:38
@akoumpa akoumpa self-assigned this Aug 7, 2024
@akoumpa akoumpa requested a review from jgerh August 7, 2024 21:40
@akoumpa akoumpa added the documentation Improvements or additions to documentation label Aug 7, 2024
@akoumpa akoumpa requested a review from ntajbakhsh August 7, 2024 22:43
Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
Copy link
Collaborator

@jgerh jgerh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Completed the review again of the moe.rst file. Please add all copyedits for grammar, punctuation, and NeMo Framework naming conventions. Also, make the requested heading changes for Overview, Use MoE, and Configure MoE-specific Loss Function.

docs/source/features/moe.rst Outdated Show resolved Hide resolved
@@ -4,7 +4,7 @@ Mixture of Experts
Overview
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this heading here. We will move it to another location.

Overview

docs/source/features/moe.rst Show resolved Hide resolved
@@ -52,16 +52,18 @@ Other options include:
1. ``moe_input_jitter_eps`` adds noise to the input tensor by applying jitter with a specified epsilon value.

2. ``moe_token_dropping`` enables selectively dropping and padding tokens for each expert to achieve
a specified capacity.
a specified capacity, similar to GShard, Switch-Transformer, and DeepSpeed-MoE. Briefly, if the number
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix run-on sentence.

moe_token_dropping enables selectively dropping and padding tokens for each expert to achieve a specified capacity. Similar to GShard, Switch-Transformer, and DeepSpeed-MoE. Briefly, if the number of tokens routed to an expert exceeds its capacity, then the exceeding tokens are dropped.

docs/source/features/moe.rst Outdated Show resolved Hide resolved
docs/source/features/moe.rst Outdated Show resolved Hide resolved
docs/source/features/moe.rst Outdated Show resolved Hide resolved
docs/source/features/moe.rst Outdated Show resolved Hide resolved
Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
@akoumpa akoumpa requested a review from jgerh August 9, 2024 18:04
Copy link
Collaborator

@jgerh jgerh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved changes.

@thomasdhc thomasdhc merged commit 86715c1 into main Aug 9, 2024
12 checks passed
@thomasdhc thomasdhc deleted the akoumparouli/moe_doc_fixes branch August 9, 2024 18:54
adityavavre pushed a commit to adityavavre/NeMo that referenced this pull request Sep 15, 2024
* Moe doc fixes

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>

* JG fixes

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>

---------

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
Signed-off-by: adityavavre <aditya.vavre@gmail.com>
monica-sekoyan pushed a commit that referenced this pull request Oct 14, 2024
* Moe doc fixes

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>

* JG fixes

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>

---------

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
hainan-xv pushed a commit to hainan-xv/NeMo that referenced this pull request Nov 5, 2024
* Moe doc fixes

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>

* JG fixes

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>

---------

Signed-off-by: Alexandros Koumparoulis <akoumparouli@nvidia.com>
Signed-off-by: Hainan Xu <hainanx@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants