Added index docs for Peewee [skip ci]

ankane · ankane · commit a7ce7bb7a73a · 2023-09-05T14:42:58.000-07:00
diff --git a/README.md b/README.md
@@ -308,6 +308,14 @@ Get items within a certain distance
 Item.select().where(Item.embedding.l2_distance([3, 1, 2]) < 5)
 ```
 
+Add an approximate index
+
+```python
+Item.add_index('embedding vector_l2_ops', using='hnsw')
+```
+
+Use `vector_ip_ops` for inner product and `vector_cosine_ops` for cosine distance
+
 ## History
 
 View the [changelog](https://github.com/pgvector/pgvector-python/blob/master/CHANGELOG.md)
diff --git a/tests/test_peewee.py b/tests/test_peewee.py
@@ -15,6 +15,8 @@ class Item(BaseModel):
     embedding = VectorField(dimensions=3)
 
 
+Item.add_index('embedding vector_l2_ops', using='hnsw')
+
 db.connect()
 db.execute_sql('CREATE EXTENSION IF NOT EXISTS vector')
 db.drop_tables([Item])
