Skip to content

Commit

Permalink
document ReRanker change
Browse files Browse the repository at this point in the history
  • Loading branch information
jbellis committed Jan 8, 2024
1 parent 0bed155 commit 5bc00f7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,17 @@

## Primary API changes

- GraphIndexBuilder M parameter now represents the maximum degree of the graph,
- `GraphIndexBuilder` `M` parameter now represents the maximum degree of the graph,
instead of half the maximum degree. (The former behavior was motivated by making
it easy to make apples-to-apples comparisons with Lucene HNSW graphs.) So,
if you were building a graph of M=16 with JVector2, you should build it with M=32
with JVector3.
- `NodeSimilarity.ReRanker` api has changed. The interface is no longer parameterized,
and the `similarityTo` method no longer takes a Map parameter (provided by `search` with
the full vectors associated with the nodes returned). This is because we discovered that
(in contrast with the original DiskANN design) it is more performant to read vectors lazily
from disk at reranking time, since this will only have to fetch vectors for the topK nodes
instead of all nodes visited.

## Other changes to public classes

Expand Down

0 comments on commit 5bc00f7

Please sign in to comment.