[DOC] README Update
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Report incorrect documentation
Location of incorrect documentation
https://github.com/rapidsai/cuvs/blob/26377efa2cbd932c2d468a1fa3e58941b3eecdaa/README.md?plain=1#L41-L52
Describe the problems or issues found in the documentation
The installation guide incorrectly has users install pycuvs
Suggested fix for documentation
Update to cuvs.
While making this update, consider adding sample pip installation commands.
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
Open README.md and inspect lines 41-52, where the installation guide is located. Replace the incorrect pycuvs package name with cuvs and consider adding sample pip installation commands. Done means the documented installation instructions use the correct package name and include the requested examples.
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
- 50/100