Skip to content

Warn of upcoming sample and observe changes - #5334

Merged
khalatepradnya merged 4 commits into
NVIDIA:mainfrom
khalatepradnya:future-warning
Sep 1, 2026
Merged

Warn of upcoming sample and observe changes#5334
khalatepradnya merged 4 commits into
NVIDIA:mainfrom
khalatepradnya:future-warning

Conversation

@khalatepradnya

Copy link
Copy Markdown
Collaborator

Summary

  • Add a temporary advance notice for upcoming changes to the CUDA-Q sample and observe algorithmic primitives.
  • Python displays the notice on import cudaq. The nvq++ driver displays it when compiling or linking input.
  • Both messages link to a version-neutral documentation page.

Notify users at Python import and nvq++ compile entry points before the
algorithmic primitives change, without modifying compiler or runtime workflows.

Added a blank docs page; details TBD.

Signed-off-by: Pradnya Khalate <pkhalate@nvidia.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation python-lang Anything related to the Python CUDA Quantum language implementation driver (nvq++) The nvq++ compiler driver core compiler labels Aug 31, 2026
Comment thread cudaq/test/NVQPP/advance_notice.cpp Outdated
Comment thread cudaq/tools/nvq++/nvq++.in Outdated
@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown

CI Summary (push) — ✅ passed

Run #33449138683 · ✅ 7 · ⏩ 7 · ❌ 0 · ⛔ 0

Top-level jobs (14)
Job Result
binaries ⏩ skipped
build_and_test ✅ success
changes ✅ success
config_devdeps ✅ success
config_source_build ⏩ skipped
config_wheeldeps ✅ success
devdeps ✅ success
docker_image ⏩ skipped
gen_code_coverage ⏩ skipped
metadata ✅ success
python_metapackages ⏩ skipped
python_wheels ⏩ skipped
source_build ⏩ skipped
wheeldeps ✅ success
⏩ Skipped jobs (7) — intentionally skipped on PR builds; run on merge_group / workflow_dispatch
Job
binaries
config_source_build
docker_image
gen_code_coverage
python_metapackages
python_wheels
source_build
All sub-jobs (43) — every matrix leg, with links
Job Status Link
Build and test (amd64, gcc12, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, gcc12, openmpi) / Dev environment (Python) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Python) ✅ success view
CI Summary ❔ in_progress view
Check for stable CUDA-Q changes ✅ success view
Configure build (devdeps) ✅ success view
Configure build (source_build) ⏩ skipped view
Configure build (wheeldeps) ✅ success view
Create CUDA Quantum installer ⏩ skipped view
Create Docker images ⏩ skipped view
Create Python metapackages ⏩ skipped view
Create Python wheels ⏩ skipped view
Gen code coverage ⏩ skipped view
Load dependencies (amd64, gcc12) / Caching ✅ success view
Load dependencies (amd64, gcc12) / Finalize ✅ success view
Load dependencies (amd64, gcc12) / Metadata ✅ success view
Load dependencies (amd64, llvm) / Caching ✅ success view
Load dependencies (amd64, llvm) / Finalize ✅ success view
Load dependencies (amd64, llvm) / Metadata ✅ success view
Load dependencies (arm64, gcc12) / Caching ✅ success view
Load dependencies (arm64, gcc12) / Finalize ✅ success view
Load dependencies (arm64, gcc12) / Metadata ✅ success view
Load dependencies (arm64, llvm) / Caching ✅ success view
Load dependencies (arm64, llvm) / Finalize ✅ success view
Load dependencies (arm64, llvm) / Metadata ✅ success view
Load source build cache ⏩ skipped view
Load wheel dependencies (amd64, 12.6) / Caching ✅ success view
Load wheel dependencies (amd64, 12.6) / Finalize ✅ success view
Load wheel dependencies (amd64, 12.6) / Metadata ✅ success view
Load wheel dependencies (amd64, 13.0) / Caching ✅ success view
Load wheel dependencies (amd64, 13.0) / Finalize ✅ success view
Load wheel dependencies (amd64, 13.0) / Metadata ✅ success view
Load wheel dependencies (arm64, 12.6) / Caching ✅ success view
Load wheel dependencies (arm64, 12.6) / Finalize ✅ success view
Load wheel dependencies (arm64, 12.6) / Metadata ✅ success view
Load wheel dependencies (arm64, 13.0) / Caching ✅ success view
Load wheel dependencies (arm64, 13.0) / Finalize ✅ success view
Load wheel dependencies (arm64, 13.0) / Metadata ✅ success view
Prepare cache clean-up ❔ in_progress view
Retrieve PR info ✅ success view
✅ Required checks (6/6) — declared in .github/required-checks.yml for push
Required check Status Link
Build and test (amd64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (amd64, gcc12, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, gcc12, openmpi) / Dev environment (Python) ✅ success view

Signed-off-by: Pradnya Khalate <pkhalate@nvidia.com>
@github-actions github-actions Bot added the c++ bridge CUDA-Q in C++ bridge to MLIR compiler label Aug 31, 2026

@sacpis sacpis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM. Thanks @khalatepradnya.

Signed-off-by: Pradnya Khalate <pkhalate@nvidia.com>

@sacpis sacpis left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Seeing repeated text Upcoming changes to sample and observe

Image

@khalatepradnya

khalatepradnya commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator Author

Seeing repeated text Upcoming changes to sample and observe

I get this -
image

Note it is still local!

Signed-off-by: Pradnya Khalate <pkhalate@nvidia.com>
@sacpis

sacpis commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Seeing repeated text Upcoming changes to sample and observe

I get this - image

Note it is still local!

Yeah, I built the docs locally and checked it. I see the above (same as you) if I directly go to the link.

But when I search for migration in the search bar on the left, it shows me the text which I pasted before.

@khalatepradnya
khalatepradnya added this pull request to the merge queue Sep 1, 2026
@khalatepradnya

Copy link
Copy Markdown
Collaborator Author

Seeing repeated text Upcoming changes to sample and observe

Note it is still local!

Yeah, I built the docs locally and checked it. I see the above (same as you) if I directly go to the link.

But when I search for migration in the search bar on the left, it shows me the text which I pasted before.

Noted. It could be an artifact of the page being orphan (for now) or the search feature or local docs. I will revisit once this makes into the official docs.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown

CI Summary (merge_group) — ✅ passed

Run #33456890714 · ✅ 5 · ⏩ 9 · ❌ 0 · ⛔ 0

Fast merge queue — only the llvm dev-environment build+test legs ran.
Wheels, metapackages, installers, Docker images, and the gcc12 legs were skipped.
Set the repository variable MERGE_QUEUE_FAST to false to restore the full matrix.

Top-level jobs (14)
Job Result
binaries ⏩ skipped
build_and_test ✅ success
changes ✅ success
config_devdeps ✅ success
config_source_build ⏩ skipped
config_wheeldeps ⏩ skipped
devdeps ✅ success
docker_image ⏩ skipped
gen_code_coverage ⏩ skipped
metadata ✅ success
python_metapackages ⏩ skipped
python_wheels ⏩ skipped
source_build ⏩ skipped
wheeldeps ⏩ skipped
⏩ Skipped jobs (9) — intentionally skipped on PR builds; run on merge_group / workflow_dispatch
Job
binaries
config_source_build
config_wheeldeps
docker_image
gen_code_coverage
python_metapackages
python_wheels
source_build
wheeldeps
All sub-jobs (24) — every matrix leg, with links
Job Status Link
Build and test (amd64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Python) ✅ success view
CI Summary ❔ in_progress view
Check for stable CUDA-Q changes ✅ success view
Configure build (devdeps) ✅ success view
Configure build (source_build) ⏩ skipped view
Configure build (wheeldeps) ⏩ skipped view
Create CUDA Quantum installer ⏩ skipped view
Create Docker images ⏩ skipped view
Create Python metapackages ⏩ skipped view
Create Python wheels ⏩ skipped view
Gen code coverage ⏩ skipped view
Load dependencies (amd64, llvm) / Caching ✅ success view
Load dependencies (amd64, llvm) / Finalize ✅ success view
Load dependencies (amd64, llvm) / Metadata ✅ success view
Load dependencies (arm64, llvm) / Caching ✅ success view
Load dependencies (arm64, llvm) / Finalize ✅ success view
Load dependencies (arm64, llvm) / Metadata ✅ success view
Load source build cache ⏩ skipped view
Load wheel dependencies ⏩ skipped view
Prepare cache clean-up ❔ in_progress view
Retrieve PR info ✅ success view
✅ Required checks (4/4) — declared in .github/required-checks.yml for merge_group_fast
Required check Status Link
Build and test (amd64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (amd64, llvm, openmpi) / Dev environment (Python) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Debug) ✅ success view
Build and test (arm64, llvm, openmpi) / Dev environment (Python) ✅ success view

Merged via the queue into NVIDIA:main with commit 756fe8a Sep 1, 2026
75 checks passed
@khalatepradnya
khalatepradnya deleted the future-warning branch September 1, 2026 01:49
github-actions Bot pushed a commit that referenced this pull request Sep 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c++ bridge CUDA-Q in C++ bridge to MLIR compiler core compiler documentation Improvements or additions to documentation driver (nvq++) The nvq++ compiler driver python-lang Anything related to the Python CUDA Quantum language implementation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants