microsoft / microsoft/SPTAG

Need more documentation for index parameters

Open
#57 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

answered question
Dominant language
C++
Stars
5k
Forks
622
Avg merge
8h 37m
Merged PRs (30d)
5

Description

I suppose there are about 19 parameters of BKT index in the code, which may influence the performance/accuracy tradeoff seriously. Can someone post a simpler guide to demonstrate how to tune these parameters?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the BKT index implementation and its parameter definitions in the SPTAG code, then identify how the roughly 19 parameters affect performance and accuracy. A completed change should provide a simpler tuning guide that explains the parameters and their tradeoffs; the issue does not name a specific file or test.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation, search
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.