Skip to content

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

Merged
leofang merged 10 commits into
NVIDIA:mainfrom
shwina:add-cuda-core-getting-started
Jun 27, 2025
Merged

Add a "Getting Started" page to the documentation#720
leofang merged 10 commits into
NVIDIA:mainfrom
shwina:add-cuda-core-getting-started

Conversation

@shwina

@shwinashwina commented Jun 19, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

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.

@copy-pr-bot

copy-pr-botBot commented Jun 19, 2025

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.

@leofang
leofang self-requested a review June 23, 2025 00:40
@leofangleofang 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
@leofangleofang added this to the cuda.core beta 5 milestone Jun 23, 2025
@shwina
shwinaforce-pushed the add-cuda-core-getting-started branch from a48d819 to aa0e36fCompareJune 26, 2025 11:50
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
Comment threadcuda_core/docs/source/getting-started.md
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
Comment threadcuda_core/pyproject.toml
leofang
leofang previously approved these changes Jun 26, 2025
View reviewed changes

@leofangleofang 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.

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

@github-project-automationgithub-project-automationBot moved this from Todo to In Review in CCCLJun 26, 2025
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
Comment threadcuda_core/cuda/core/__init__.py
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
Comment threadcuda_core/docs/source/api.rst
@leofang

leofang commented Jun 26, 2025

Copy link
Copy Markdown
Member

/ok to test 4af0bb7

leofang
leofang reviewed Jun 26, 2025
View reviewed changes
Comment threadcuda_core/examples/cuda_graphs.py

@leofangleofangJun 26, 2025

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.

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

@leofangleofang mentioned this pull request Jun 26, 2025
Closed
@github-actions

This comment has been minimized.

Sign in to view
leofang
leofang reviewed Jun 26, 2025
View reviewed changes
Comment threadcuda_core/pyproject.toml
@leofang

leofang commented Jun 26, 2025

Copy link
Copy Markdown
Member

/ok to test 806b9a7

@leofang

leofang commented Jun 26, 2025•
edited
Loading

Copy link
Copy Markdown
Member

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:mainJun 27, 2025
101 of 102 checks passed
@github-project-automationgithub-project-automationBot moved this from In Review to Done in CCCLJun 27, 2025
@github-actions

github-actionsBot commented Jun 27, 2025

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

@leofangleofang mentioned this pull request Jun 28, 2025
Closed
1 task
CopilotAI mentioned this pull request Aug 21, 2025
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leofangleofangleofang approved these changes

Assignees

@shwinashwina

Labels

cuda.coreEverything related to the cuda.core moduledocumentationImprovements or additions to documentationP0High priority - Must do!

Projects

CCCL
Archived in project

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