Skip to content

[STF] Fix C++ documentation inconsistencies#9757

Draft
caugonnet wants to merge 1 commit into
NVIDIA:mainfrom
caugonnet:fix/stf-doc-inconsistencies
Draft

[STF] Fix C++ documentation inconsistencies#9757
caugonnet wants to merge 1 commit into
NVIDIA:mainfrom
caugonnet:fix/stf-doc-inconsistencies

Conversation

@caugonnet

@caugonnet caugonnet commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Description

Ensure the documentation stays up to date with API changes in STF

closes

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@caugonnet caugonnet self-assigned this Jul 9, 2026
@caugonnet caugonnet added the stf Sequential Task Flow programming model label Jul 9, 2026
@copy-pr-bot

copy-pr-bot Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

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-project-automation github-project-automation Bot moved this to Todo in CCCL Jul 9, 2026
@cccl-authenticator-app cccl-authenticator-app Bot moved this from Todo to In Progress in CCCL Jul 9, 2026
updates it first with a regular CUDASTF task and then with ``parallel_for``, and
calls ``finalize()`` to write the result back to the original host allocation.

This is the canonical example built by the ``cudax.example.stf.custom_data_interface``

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

rephrase ?

Comment thread docs/cudax/stf.rst
g++ -I$(cudastf_path)
# Linking flags
g++ -lcuda -lcudart
export CCCL_ROOT=/path/to/cccl

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

exporting is probably not needed

Comment thread docs/cudax/stf.rst

.. code:: bash

./bin/cudax.cpp17.example.stf.01-axpy
ctest --preset cudax -R '^cudax.example.stf.01-axpy$' --output-on-failure

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

fix command

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

Labels

stf Sequential Task Flow programming model

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

1 participant