Document supported and unsuppored SVS variants

Open Beginner friendly
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Review the installation steps and the supported PyPI SVS variant, then compare them with the unsupported variant at https://github.com/intel/ScalableVectorSearch. Update the documentation to identify the supported and unsupported variants and state that the unsupported one should be removed before installing svsbench.

Written by the indexing model from the issue text.

Description

documentation enhancement good first issue help wanted

Currently, the SVS variant on PyPI is supported and automatically installed when the installation steps are followed. The SVS variant at https://github.com/intel/ScalableVectorSearch is not supported and should be removed before installing svsbench. This should be documented.

Dominant language
Python
Stars
5
Forks
4
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.