Docstring and fix generate grountruth #2377
Conversation
| python -m raft_ann_bench.generate_groundtruth --dataset /dataset/base.\ | ||
| fbin --output=groundtruth_dir --queries=/dataset/query.public.10K.fbin | ||
| python -m raft_ann_bench.generate_groundtruth --output=groundtruth_dir \ | ||
| --queries=/dataset/query.public.10K.fbin /dataset/base.fbin |
There was a problem hiding this comment.
What has changed here? I think we would like to keep the --dataset argument
There was a problem hiding this comment.
I think the change is correct, in the first version of this script dataset was a keyword argument, but it was later changed to a positional argument. Here the docstring is corrected to give dataset as a positional arg.
There was a problem hiding this comment.
Thanks @Kh4L for this PR! In the PR description you write that "sqeuclidean is not supported in raft-ann-bench". I think that is not correct, I have tested in 24.06 and 24.08, and it is supported in both cases. Therefore I would recommend to keep the default metric "sqeuclidean". The rest of the docstring change look good to me.
| python -m raft_ann_bench.generate_groundtruth --dataset /dataset/base.\ | ||
| fbin --output=groundtruth_dir --queries=/dataset/query.public.10K.fbin | ||
| python -m raft_ann_bench.generate_groundtruth --output=groundtruth_dir \ | ||
| --queries=/dataset/query.public.10K.fbin /dataset/base.fbin |
There was a problem hiding this comment.
I think the change is correct, in the first version of this script dataset was a keyword argument, but it was later changed to a positional argument. Here the docstring is corrected to give dataset as a positional arg.
python/raft-ann-bench/src/raft_ann_bench/generate_groundtruth/__main__.py
Outdated
Show resolved
Hide resolved
tfeher
added
documentation
Fix docstring