Skip to content

Add a "Getting Started" page to the documentation #720

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
Merged
merged 10 commits into from
Jun 27, 2025
Merged

Add a "Getting Started" page to the documentation #720

merged 10 commits into from
Jun 27, 2025

Conversation

shwina
Copy link
Contributor

@shwina shwina commented Jun 19, 2025 •
edited
Loading

Description

Closes #570.

Merge after #717

  • This PR adds a "getting started" page that explains what cuda.core is, walks through one of our simpler examples, and links to the examples directory. It's not a comprehensive introduction to cuda.core, but it's a start.
  • Also fixes up our dependencies so that the getting started example works out of the box.
  • Also adds a graph capture example as that seemed missing.

Checklist

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

@github-project-automation github-project-automation bot moved this to Todo in CCCL Jun 19, 2025
@copy-pr-bot copy-pr-bot
Copy link
Contributor

copy-pr-bot bot commented Jun 19, 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.

@leofang leofang self-requested a review June 23, 2025 00:40
@leofang leofang added documentation Improvements or additions to documentation P0 High priority - Must do! cuda.core Everything related to the cuda.core module labels Jun 23, 2025
@leofang leofang added this to the cuda.core beta 5 milestone Jun 23, 2025
@shwina shwina force-pushed the add-cuda-core-getting-started branch from a48d819 to aa0e36f Compare June 26, 2025 11:50
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
leofang
leofang previously approved these changes Jun 26, 2025
View reviewed changes
Copy link
Member

@leofang leofang left a comment

Choose a reason for hiding this comment

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

Looks very good! Thanks, Ashwin! I left some comments.

@github-project-automation github-project-automation bot moved this from Todo to In Review in CCCL Jun 26, 2025
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
@leofang
Copy link
Member

leofang commented Jun 26, 2025

/ok to test 4af0bb7

leofang
leofang reviewed Jun 26, 2025
View reviewed changes
cuda_core/examples/cuda_graphs.py Outdated
Copy link
Member

Choose a reason for hiding this comment

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

cc @vzhurba01 for vis (a new sample for CUDA graphs)

@leofang leofang mentioned this pull request Jun 26, 2025
Open
@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
@leofang
Copy link
Member

leofang commented Jun 26, 2025

/ok to test 806b9a7

@leofang
Copy link
Member

leofang commented Jun 26, 2025 •
edited
Loading

There's one flaky error, I'll restart it shortly.
https://github.com/NVIDIA/cuda-python/actions/runs/15913241364/job/44886309674?pr=720

@leofang leofang merged commit 12e8b07 into NVIDIA:main Jun 27, 2025
102 of 103 checks passed
@github-project-automation github-project-automation bot moved this from In Review to Done in CCCL Jun 27, 2025
@github-actions GitHub Actions
Copy link

Doc Preview CI
Preview removed because the pull request was closed or merged.

@leofang leofang mentioned this pull request Jun 28, 2025
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leofang leofang leofang approved these changes

Assignees

@shwina shwina

Labels
cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P0 High priority - Must do!
Projects
CCCL
Status: Done
Milestone
cuda.core beta 5
Development

Successfully merging this pull request may close these issues.

[DOC]: Add a Getting Started page to showcase cuda.core
2 participants
@shwina @leofang