Unify DEM sampling entry-point name across Python and C++ APIs
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 117
- Forks
- 74
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 25
Description
The DEM sampling entry point is exposed as dem_sampling in Python (cudaq_qec.dem_sampling) but as sample_dem in C++ (cudaq::qec::dem_sampler::cpu::sample_dem). This naming inconsistency was raised during review of #511 and deferred to avoid an API-breaking change in that docs PR.
Follow-up: choose a single, verb-consistent name (e.g. sample_dem) and align both language bindings, deprecating the old name as needed.
Ref: https://github.com/NVIDIA/cudaqx/pull/511#discussion_r3623047016
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the Python cudaq_qec.dem_sampling entry point with the C++ cudaq::qec::dem_sampler::cpu::sample_dem entry point, including the discussion linked from #511. Decide the consistent verb-based name and determine the deprecation path for the old name; done means both bindings align without an undocumented API break.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100