Added test and docs for HNSW

ankane · ankane · commit 9c0c00f8ae99 · 2023-09-08T13:32:06.000-07:00
diff --git a/README.md b/README.md
@@ -98,6 +98,14 @@ class Item(models.Model):
                 fields=['embedding'],
                 lists=100,
                 opclasses=['vector_l2_ops']
+            ),
+            # or
+            HnswIndex(
+                name='my_index',
+                fields=['embedding'],
+                m=16,
+                ef_construction=64,
+                opclasses=['vector_l2_ops']
             )
         ]
 ```
@@ -151,6 +159,13 @@ index = Index('my_index', Item.embedding,
     postgresql_with={'lists': 100},
     postgresql_ops={'embedding': 'vector_l2_ops'}
 )
+# or
+index = Index('my_index', Item.embedding,
+    postgresql_using='hnsw',
+    postgresql_with={'m': 16, 'ef_construction': 64},
+    postgresql_ops={'embedding': 'vector_l2_ops'}
+)
+
 index.create(engine)
 ```
 
diff --git a/tests/test_sqlalchemy.py b/tests/test_sqlalchemy.py
@@ -55,14 +55,23 @@ def test_core(self):
         metadata.drop_all(engine)
         metadata.create_all(engine)
 
-        index = Index(
-            'my_core_index',
+        ivfflat_index = Index(
+            'ivfflat_core_index',
             item_table.c.embedding,
             postgresql_using='ivfflat',
             postgresql_with={'lists': 1},
             postgresql_ops={'embedding': 'vector_l2_ops'}
         )
-        index.create(engine)
+        ivfflat_index.create(engine)
+
+        hnsw_index = Index(
+            'hnsw_core_index',
+            item_table.c.embedding,
+            postgresql_using='hnsw',
+            postgresql_with={'m': 16, 'ef_construction': 64},
+            postgresql_ops={'embedding': 'vector_l2_ops'}
+        )
+        hnsw_index.create(engine)
 
     def test_orm(self):
         item = Item(embedding=np.array([1.5, 2, 3]))
