Skip to content

Fix stale data generation comment in generate_input.hpp - #23816

Open
VaggelisGian wants to merge 3 commits into
NVIDIA:mainfrom
VaggelisGian:docs-generate-input-device-comment
Open

Fix stale data generation comment in generate_input.hpp#23816
VaggelisGian wants to merge 3 commits into
NVIDIA:mainfrom
VaggelisGian:docs-generate-input-device-comment

Conversation

@VaggelisGian

Copy link
Copy Markdown

Description

The file-level comment in cpp/benchmarks/common/generate_input.hpp claimed that random data generation happens on the CPU and is then copied to device memory. The implementation actually fills device buffers directly on the GPU (thrust::tabulate over the device policy in generate_input.cu), and docs/benchmarking.md already documents device-side generation. This corrects the stale comment so it matches the actual behavior.

Comment-only change: no code paths, build targets, or runtime behavior are affected.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

The file comment claimed input generation happens on the CPU before being
copied to device memory. The implementation fills rmm::device_uvectors with
thrust::tabulate on the device execution policy, so generation runs on the
device, which is also what the developer guide's benchmarking page already
documents. The comment predates the device-side generator introduced in
NVIDIA#10109 and was never updated.

Test Plan:
  Comment-only change; no code or build impact.
@VaggelisGian
VaggelisGian requested a review from a team as a code owner August 25, 2026 20:30
@copy-pr-bot

copy-pr-bot Bot commented Aug 25, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the libcudf Affects libcudf (C++/CUDA) code. label Aug 25, 2026
@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 401e09f4-ceee-4477-a3c1-f4ec927bbb50

📥 Commits

Reviewing files that changed from the base of the PR and between e1b2d27 and 5b3d82d.

📒 Files selected for processing (1)
  • cpp/benchmarks/common/generate_input.hpp
🚧 Files skipped from review as they are similar to previous changes (1)
  • cpp/benchmarks/common/generate_input.hpp

Included review availability: Your plan provides up to 12 included reviews per hour; 10 remain after this review.


📝 Walkthrough

Summary by CodeRabbit

  • Documentation
    • Clarified that random input generation occurs directly on the device, rather than on the host followed by a device-memory copy.

Walkthrough

The benchmark documentation retains the statement that input generation occurs on the device and removes the comparison with host-side column_wrapper generation.

Changes

Benchmark input generation

Layer / File(s) Summary
Device-side generation documentation
cpp/benchmarks/common/generate_input.hpp
The documentation removes the host-side column_wrapper comparison and retains the device-side input generation statement.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 5b3d8

This change only corrects an outdated benchmark comment and does not alter code paths or runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: mattgara

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: correcting a stale data-generation comment in generate_input.hpp.
Description check ✅ Passed The description accurately explains the stale comment, the actual device-side generation behavior, and the comment-only scope of the change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

Comment thread cpp/benchmarks/common/generate_input.hpp Outdated

@PointKernel PointKernel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for catching this.

Comment thread cpp/benchmarks/common/generate_input.hpp Outdated
Co-authored-by: David Wendt <45795991+davidwendt@users.noreply.github.com>
@PointKernel

Copy link
Copy Markdown
Member

/ok to test 5b3d82d

@PointKernel PointKernel added doc Documentation non-breaking Non-breaking change labels Aug 25, 2026
@PointKernel PointKernel changed the title benchmarks: correct stale data generation comment in generate_input.hpp Fix stale data generation comment in generate_input.hpp Aug 25, 2026
@PointKernel

Copy link
Copy Markdown
Member

/ok to test 14e9365

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants