Skip to content

[DOC] Add temp_storage_bytes usage guide #6208

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[DOC] Add temp_storage_bytes usage guide #6208

wants to merge 2 commits into from
+70 −1

Conversation

@Aminsed
Copy link
Contributor

@Aminsed Aminsed commented Oct 13, 2025

Add documentation explaining temp_storage_bytes query pattern.

  • Clarify two-phase usage pattern
  • Document what arguments are required vs optional
  • Explain that pointers can be nullptr during query
  • Add example showing proper usage

Fixes #847

@Aminsed Aminsed requested a review from a team as a code owner October 13, 2025 15:18
@github-project-automation github-project-automation bot moved this to Todo in CCCL Oct 13, 2025
@Aminsed Aminsed requested a review from gonidelis October 13, 2025 15:18
@copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Oct 13, 2025

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.

@cccl-authenticator-app cccl-authenticator-app bot moved this from Todo to In Review in CCCL Oct 13, 2025
fbusato
fbusato reviewed Oct 13, 2025
View reviewed changes
docs/cub/api_docs/device_wide.rst
../api/device


Determining Temporary Storage Requirements
Copy link
Contributor

Choose a reason for hiding this comment

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

would be nice to also mention the single-phase API

@Aminsed Aminsed force-pushed the doc/temp_storage_bytes_guide branch from 1dc3643 to 11abc08 Compare October 13, 2025 20:09
@Aminsed Aminsed requested a review from fbusato October 13, 2025 20:10
gonidelis
gonidelis requested changes Oct 14, 2025
View reviewed changes
Copy link
Member

@gonidelis gonidelis left a comment

Choose a reason for hiding this comment

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

single phase APIs open up a whole new space of explanation for the documentation - the two phase clarifications though are much needed. Thanks a lot for taking the time to provide docs for it.

@github-project-automation github-project-automation bot moved this from In Review to In Progress in CCCL Oct 14, 2025
@Aminsed Aminsed requested a review from gonidelis October 26, 2025 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@fbusato fbusato Awaiting requested review from fbusato

@gonidelis gonidelis Awaiting requested review from gonidelis

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

CCCL
Status: In Progress

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Documentation (& code) regarding determining temp_storage_bytes not very clear

3 participants

@Aminsed @gonidelis @fbusato