[DOC] Lucene: clarify codec behavior and Java test commands
Nobody has claimed this yet.
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Problem
The cuvs-lucene README currently describes every codec as gracefully falling back to CPU, calls the GPU-search codec an HNSW build/search path, and gives ambiguous Java-test instructions. Its example command is also labeled as a test command.
Proposed change
- Distinguish accelerated-HNSW CPU fallback from the GPU-search codec's cuVS requirement.
- Describe
CuVS2510GPUSearchCodecas CAGRA build and search. - Clarify that persisted accelerated codec names still require a compatible provider.
- Document the root
--run-java-testscommands, native-library prerequisite, and Surefire/Failsafe lifecycle. - Label the example command as an example rather than the test suite.
This is documentation-only and does not change code, APIs, defaults, artifacts, or persisted formats.
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 with the cuvs-lucene README and review its codec descriptions and Java test instructions. Check the root --run-java-tests commands, native-library prerequisite, and Surefire/Failsafe lifecycle, then update the README so codec requirements, CAGRA behavior, persisted codec compatibility, and the example-command label are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 82/100