More Experimental annotations

jbellis · Feb 7, 2024 · 9791307 · 9791307
1 parent 9f20561
commit 9791307
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/jvector-base/src/main/java/io/github/jbellis/jvector/disk/CachingADCGraphIndex.java b/jvector-base/src/main/java/io/github/jbellis/jvector/disk/CachingADCGraphIndex.java
@@ -16,6 +16,7 @@
 
 package io.github.jbellis.jvector.disk;
 
+import io.github.jbellis.jvector.annotations.Experimental;
 import io.github.jbellis.jvector.graph.ADCView;
 import io.github.jbellis.jvector.graph.ApproximateScoreProvider;
 import io.github.jbellis.jvector.graph.GraphIndex;
@@ -33,9 +34,11 @@
 import java.io.UncheckedIOException;
 
 /**
+ * Experimental!
  * Specialized CachingGraphIndex for OnDiskADCGraphIndex.
  * TODO: Refactor so that caching is pluggable for different GraphIndex implementations.
  */
+@Experimental
 public class CachingADCGraphIndex implements GraphIndex<VectorFloat<?>>, AutoCloseable, Accountable
 {
     private static final int CACHE_DISTANCE = 3;

diff --git a/jvector-base/src/main/java/io/github/jbellis/jvector/disk/OnDiskADCGraphIndex.java b/jvector-base/src/main/java/io/github/jbellis/jvector/disk/OnDiskADCGraphIndex.java
@@ -44,6 +44,7 @@
 import java.util.stream.IntStream;
 
 /**
+ * Experimental!
  * A GraphIndex that is stored on disk.  This is a read-only index. This index fuses information about the encoded
  * neighboring vectors along with each ordinal, permitting accelerated ADC computation.
  * <p>

diff --git a/...or-native/src/main/java/io/github/jbellis/jvector/vector/NativeVectorizationProvider.java b/...or-native/src/main/java/io/github/jbellis/jvector/vector/NativeVectorizationProvider.java
@@ -16,12 +16,15 @@
 
 package io.github.jbellis.jvector.vector;
 
+import io.github.jbellis.jvector.annotations.Experimental;
 import io.github.jbellis.jvector.vector.cnative.LibraryLoader;
 import io.github.jbellis.jvector.vector.types.VectorTypeSupport;
 
 /**
+ * Experimental!
  * VectorizationProvider implementation that assumes OffHeap vectors and prefers native/Panama SIMD.
  */
+@Experimental
 public class NativeVectorizationProvider extends VectorizationProvider {
     private final VectorUtilSupport vectorUtilSupport;
     private final VectorTypeSupport vectorTypeSupport;