Skip to content

[PyTorch] Add docstring for CP load balancing #1802

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

Merged
merged 2 commits into from
May 20, 2025

Conversation

cyanguwa
Copy link
Collaborator

Description

This PR adds some docstring to explain the requirement of using TE-PyTorch CP. Namely, it assumes token re-ordering to achieve the DualChunkSwap loading balancing strategy.

Type of change

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refactoring

Changes

Please list the changes introduced in this PR:

  • Add docstring for CP load balancing.

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Charlene Yang <[email protected]>
@cyanguwa cyanguwa requested a review from xrennvidia May 20, 2025 21:49
@cyanguwa cyanguwa added the 2.4.0 label May 20, 2025
@cyanguwa
Copy link
Collaborator Author

#1780 contains the changes in this PR but would take longer to get to the finish line. Merging this to TE 2.4 first.

No GitLab CI needed as it's only docstring change - it doesn't go into TE docs. But more (and more proper) documentation on CP should be expected in the future.

@cyanguwa cyanguwa merged commit d35afe1 into NVIDIA:main May 20, 2025
11 checks passed
KshitijLakhani pushed a commit that referenced this pull request May 21, 2025
add docstring for CP

Signed-off-by: Charlene Yang <[email protected]>
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.

2 participants