NVIDIA / NVIDIA/raft

[FEA] Add runtime test for serialization format changes

Open
#1,998 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
Cuda
Stars
1k
Forks
251
Avg merge
1d 8h
Merged PRs (30d)
31

Description

We're removing the current static assertion that's being done because the actual struct for the ANN indexes doesn't align completely w/ the serialized data format and this is causing the build to fail with false positives whenever the underlying objects used inside the index are updated.

The next step is to create a pytest that tests a cached version of the serialized format against the current version and provides instructions on how to bump the serialization version number and re-cache.

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 static assertion for ANN index serialization and the existing pytest setup. Replace the false-positive check with a pytest that compares a cached serialized format against the current version, and document how to bump the serialization version and re-cache when the format intentionally changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.