zilliztech / zilliztech/VectorDBBench
Incorrect parameter description for `rbq_bits_query` in MilvusIVFRABITQTypedDict
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 438
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 1
Description
I think the parameter description for rbq_bits_query in the MilvusIVFRABITQTypedDict class is incorrect.
file path: vectordb_bench/backend/clients/milvus/cli.py
class MilvusIVFRABITQTypedDict(CommonTypedDict, MilvusTypedDict, MilvusIVFFlatTypedDict):
rbq_bits_query: Annotated[
int,
click.option(
"--rbq-bits-query",
type=int,
help="The magnification factor of refine compared to k.",
required=True,
),
]
Contributor guide
No contributing guide indexed for this repository
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 vectordb_bench/backend/clients/milvus/cli.py and inspect MilvusIVFRABITQTypedDict alongside related Milvus option definitions to determine the intended meaning of rbq_bits_query. Update the help text so it accurately describes the parameter, then verify the generated CLI option description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100