NVIDIA / NVIDIA/cuda-python

[DOC]: Documentation for `getLocalRuntimeVersion()` is probably incorrect

Open
#1,062 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cuda.bindings cuda.core documentation P2
Dominant language
Cython
Stars
3.4k
Forks
329
Avg merge
1d 23h
Merged PRs (30d)
116

Description

Is this a duplicate?
Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

The documentation for cudaRuntimeGetVersion() and getLocalRuntimeVersion() is exactly the same. It is not explained what the difference between these two functions is.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

https://nvidia.github.io/cuda-python/cuda-bindings/latest/module/runtime.html#cuda.bindings.runtime.getLocalRuntimeVersion

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the runtime documentation at the linked getLocalRuntimeVersion() entry and compare it with cudaRuntimeGetVersion(). Read the surrounding descriptions and the function definitions they document to determine the distinction. Done means the two entries explain their different behavior rather than repeating identical text.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.