Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose index stats for debugging #617

Closed
changhiskhan opened this issue Feb 22, 2023 · 2 comments · Fixed by #1097
Closed

Expose index stats for debugging #617

changhiskhan opened this issue Feb 22, 2023 · 2 comments · Fixed by #1097
Labels
good first issue Good for newcomers help wanted Extra attention is needed python rust Rust related tasks vector Vector Search

Comments

@changhiskhan
Copy link
Contributor

changhiskhan commented Feb 22, 2023

we want to expose the vector index stats to the user (in python) for debugging purposes:

  1. index name, id, and file location
  2. index type
  3. if ivf_pq: num ivf partitions, num pq sub vectors, num pq bits
  4. if ivf_pq: for each partition, the centroid vector for the partition and the number of vectors in that partition.

on the python side, the api can look like:

dataset.list_index => [Index]

dataset.get_index("name") -> Index

Index should have:

  • index_type
  • name
  • index-id
  • uri

IvfPqIndex (subclass of Index) should have:

  • num ivf partitions
  • num pq sub vectors
  • num pq bits
  • each ivf centroid
  • num vectors in in partition
@changhiskhan changhiskhan added the rust Rust related tasks label Feb 22, 2023
@eddyxu eddyxu added good first issue Good for newcomers help wanted Extra attention is needed labels Feb 22, 2023
@Renkai
Copy link
Contributor

Renkai commented Mar 15, 2023

I will work on this.

@changhiskhan changhiskhan added python vector Vector Search labels Jul 2, 2023
@changhiskhan
Copy link
Contributor Author

This may also be useful for merging indices

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed python rust Rust related tasks vector Vector Search
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants