[DOC] Misleading comment in example 05_batched_gemm
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.5k
- Forks
- 2.1k
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 7
Description
Report incorrect documentation
Location of incorrect documentation
https://github.com/NVIDIA/cutlass/blob/e1976daacc7b030ba672217eb5d96f5a663df4ab/examples/05_batched_gemm/batched_gemm.cu#L246-L250
Describe the problems or issues found in the documentation
The comment says "Arbitrary problem size", which is misleading since batch_count here cannot be modified due to the fixed permutation here:
https://github.com/NVIDIA/cutlass/blob/e1976daacc7b030ba672217eb5d96f5a663df4ab/examples/05_batched_gemm/batched_gemm.cu#L356
Steps taken to verify documentation is incorrect
Change batch_count to other values and the compiled program will not be able to pass checks.
Suggested fix for documentation
Change "Arbitrary problem size" to "Arbitrary matrix shape" and add a blank line between k and batch_count to show that batch_count is not arbitrary here.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open examples/05_batched_gemm/batched_gemm.cu and inspect the comment at lines 246-250, then review the batch_count handling near line 356. Confirm the example's fixed permutation limits batch_count; done means the comment describes arbitrary matrix shape, separates k from batch_count with a blank line, and the example checks still pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100