[docs] feat: improve docstrings in seqlen_balancing.py (#1345) #4731
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the documentation quality of
verl/utils/seqlen_balancing.pyby adding comprehensive Google-style docstrings to core partitioning and utility functions.Functions Improved
calculate_workloadkarmarkar_karpgreedy_partitionceildivroundup_divisibleImprovements Include
list[int],torch.Tensor, return types)ArgsandReturnssectionsceildiv,roundup_divisible)Notesections for important implementation detailsSee Alsoreferences for algorithm documentationContext
The
seqlen_balancing.pymodule implements workload balancing algorithms for distributed training:Test plan
Contributes to #1345
🤖 Generated with Claude Code