lance-format/lance

Provide better guidance for users creating indices

Open

#961 opened on Jun 10, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (695 forks)github user discovery
A-pythondocumentationgood first issuehelp wanted

Repository metrics

Stars
 (6,582 stars)
PR merge metrics
 (Avg merge 6d 1h) (219 merged PRs in 30d)

Description

from discord:

We have varied vector dimensions so I keep seeing this error: num_sub_vectors % num_columns = 0. Do you have anyany suggestions on how to set num_sub_vectors? For context our vector dimensions vary from 30 - 1000, and currently i'm just setting it to num_sub_vectors = num_dims / 4

Currently guidance on SIMD alignment is only mention in one footnote in the documentation. Not obvious at all.

Contributor guide

Research direction
Review existing documentation on SIMD alignment for index creation and suggest improvements to include examples and rationale for num sub vectors setting.
Tech stack
rust
Domain
database
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80