Skip to content
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.

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

Expand and add more CUDA/HIP documentation #1309

Merged
merged 12 commits into from
Nov 26, 2024
Merged

Conversation

msimberg
Copy link
Contributor

@msimberg msimberg commented Nov 1, 2024

Adds documentation for classes that weren't yet documented and updates the existing documentation. Adds a section for pika/cuda.hpp to the API documentation.

Early stages, far from complete, but may require some discussion before continuing.

@msimberg msimberg self-assigned this Nov 1, 2024
Copy link

codacy-production bot commented Nov 1, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.13% (target: -1.00%) (target: 90.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (015302c) 18217 13754 75.50%
Head commit (c0ca2c9) 18217 (+0) 13731 (-23) 75.37% (-0.13%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#1309) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

docs/api.rst Show resolved Hide resolved
docs/api.rst Outdated Show resolved Hide resolved
docs/api.rst Outdated Show resolved Hide resolved
docs/api.rst Outdated Show resolved Hide resolved
docs/api.rst Show resolved Hide resolved
docs/api.rst Show resolved Hide resolved
@msimberg msimberg force-pushed the cuda-docs branch 5 times, most recently from 37b7898 to afec1e1 Compare November 7, 2024 14:41
@msimberg
Copy link
Contributor Author

msimberg commented Nov 7, 2024

I welcome more feedback on this PR now. I feel like some of the examples I've created are a bit forced/artificial in the name of showing off what's possible with the adaptors, so if you have suggestions on how to improve change them that's particularly welcome. I've also now documented the types of the CUDA/HIP sender adaptors so that we can document the parameters of them. I think it looks decent enough, but interested in hearing feedback from others.

@msimberg msimberg marked this pull request as ready for review November 7, 2024 14:46
docs/api.rst Outdated Show resolved Hide resolved
docs/api.rst Outdated Show resolved Hide resolved
examples/documentation/then_with_cublas_documentation.cu Outdated Show resolved Hide resolved
libs/pika/async_cuda/include/pika/async_cuda/cuda_pool.hpp Outdated Show resolved Hide resolved
@msimberg msimberg force-pushed the cuda-docs branch 4 times, most recently from 75a9371 to 3caadb0 Compare November 22, 2024 13:33
@msimberg msimberg added this to the 0.31.0 milestone Nov 22, 2024
@msimberg msimberg added this pull request to the merge queue Nov 25, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 25, 2024
@msimberg msimberg added this pull request to the merge queue Nov 26, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Nov 26, 2024
@msimberg msimberg merged commit f182d67 into pika-org:main Nov 26, 2024
39 checks passed
@msimberg msimberg deleted the cuda-docs branch November 26, 2024 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

3 participants