Documentation of `cupyx.lapack.posv()` is inaccurate
- Dominant language
- Python
- Stars
- 12.3k
- Forks
- 1.1k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 45
Description
Discovered during another internal discussion 😅 This line in the docstring:
https://github.com/cupy/cupy/blob/89430ec6c80373177bb5f8a58fa55f29bc08910d/cupyx/lapack.py#L274
is only applicable to [`cusolverDnpotrsBatched()`](https://docs.nvidia.com/cuda/cusolver/index.html#cuSolverDN-lt-t-gt-batchpotrs), which is called with a batch of pairs `A` and `b`. For [`cusolverDnpotrs()`](https://docs.nvidia.com/cuda/cusolver/index.html#cuSolverDN-lt-t-gt-potrs), `nrhs` can be arbitrary (corresponding to the same matrix A and a batch of vectors b). Since `cupyx.lapack.posv()` supports both use cases, we should get it modified.
Contributor guide
Research direction
Open cupyx/lapack.py around line 274 and read the posv() docstring alongside the linked cuSolver potrs and potrsBatched references. Update the documentation so it accurately covers both supported use cases, then verify that the wording distinguishes arbitrary nrhs from batched pairs of A and b.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100