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

Expand documentation for data parallelism and distributed optimizer #9227

Merged
merged 6 commits into from
May 24, 2024

Conversation

timmoon10
Copy link
Collaborator

What does this PR do ?

This expands the documentation for data parallelism and the distributed optimizer

@erhoo82 This may also be a good place to add FSDP documentation.

Collection: NLP

Changelog

  • Expand documentation for data parallelism and the distributed optimizer

Usage

n/a

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

Signed-off-by: Tim Moon <tmoon@nvidia.com>
@timmoon10 timmoon10 added documentation Improvements or additions to documentation NLP labels May 17, 2024
@timmoon10 timmoon10 requested a review from erhoo82 May 17, 2024 00:34
@github-actions github-actions bot removed the NLP label May 17, 2024
Signed-off-by: Tim Moon <tmoon@nvidia.com>
@jgerh
Copy link
Collaborator

jgerh commented May 17, 2024

Hello, I assigned myself as a reviewer. I am the tech writer on the NeMo team and provided a review of #9184. I will make similar copyedits to the content. Thank you.

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.

I reviewed the changes and provided a few edits.

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.

I reviewed the file and added copyedits and formatting changes. Please review and implement the changes or ask me questions about the suggestions.

timmoon10 and others added 2 commits May 22, 2024 15:58
Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>
@ericharper ericharper merged commit cde0b2b into NVIDIA:main May 24, 2024
9 checks passed
BoxiangW pushed a commit to BoxiangW/NeMo that referenced this pull request Jun 5, 2024
…VIDIA#9227)

* Add distributed optimizer to docs

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Debug RST table

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Review suggestions from @jgerh

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Copyedits and formatting changes

Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>

---------

Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>
Signed-off-by: Boxiang Wang <boxiangw@nvidia.com>
janekl pushed a commit that referenced this pull request Jun 12, 2024
…9227)

* Add distributed optimizer to docs

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Debug RST table

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Review suggestions from @jgerh

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Copyedits and formatting changes

Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>

---------

Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>
Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
rohitrango pushed a commit to rohitrango/NeMo that referenced this pull request Jun 25, 2024
…VIDIA#9227)

* Add distributed optimizer to docs

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Debug RST table

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Review suggestions from @jgerh

Signed-off-by: Tim Moon <tmoon@nvidia.com>

* Copyedits and formatting changes

Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>

---------

Signed-off-by: Tim Moon <tmoon@nvidia.com>
Co-authored-by: Jennifer Gerhold <jgerhold@nvidia.com>
@ko3n1g ko3n1g mentioned this pull request Jul 18, 2024
2 tasks
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.

None yet

3 participants