Skip to content

Refactor imports to PascalCase aliases and update docs #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
fkarg wants to merge 3 commits into from
Closed

Refactor imports to PascalCase aliases and update docs #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43535a6
Refactor imports to include HalfVector and SparseVector aliases
fkarg Aug 24, 2025
159c9e1
Add import alias for BIT and rearrange __all__ exports
fkarg Aug 27, 2025
e4ddda2
docs: make README consistent with PascalCase names like other libraries
fkarg Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ class Item(Base):
embedding = mapped_column(Vector(3))
```

Also supports `HALFVEC`, `BIT`, and `SPARSEVEC`
Also supports `HalfVector`, `Bit`, and `SparseVector`

Insert a vector

Expand Down Expand Up @@ -252,12 +252,12 @@ Use `vector_ip_ops` for inner product and `vector_cosine_ops` for cosine distanc
Index vectors at half-precision

```python
from pgvector.sqlalchemy import HALFVEC
from pgvector.sqlalchemy import HalfVector
from sqlalchemy.sql import func

index = Index(
'my_index',
func.cast(Item.embedding, HALFVEC(3)).label('embedding'),
func.cast(Item.embedding, HalfVector(3)).label('embedding'),
postgresql_using='hnsw',
postgresql_with={'m': 16, 'ef_construction': 64},
postgresql_ops={'embedding': 'halfvec_l2_ops'}
Expand All @@ -267,7 +267,7 @@ index = Index(
Get the nearest neighbors

```python
order = func.cast(Item.embedding, HALFVEC(3)).l2_distance([3, 1, 2])
order = func.cast(Item.embedding, HalfVector(3)).l2_distance([3, 1, 2])
session.scalars(select(Item).order_by(order).limit(5))
```

Expand Down Expand Up @@ -335,7 +335,7 @@ class Item(SQLModel, table=True):
embedding: Any = Field(sa_type=Vector(3))
```

Also supports `HALFVEC`, `BIT`, and `SPARSEVEC`
Also supports `HalfVector`, `Bit`, and `SparseVector`

Insert a vector

Expand Down
10 changes: 6 additions & 4 deletions pgvector/sqlalchemy/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
from .bit import BIT
from .bit import BIT as Bit
from .functions import avg, sum
from .halfvec import HALFVEC
from .halfvec import HALFVEC as HalfVector
from .sparsevec import SPARSEVEC
from .sparsevec import SPARSEVEC as SparseVector
from .vector import VECTOR
from .vector import VECTOR as Vector

# TODO remove
from .. import HalfVector, SparseVector

__all__ = [
'Vector',
'VECTOR',
'HALFVEC',
'Bit',
'BIT',
'SPARSEVEC',
'HalfVector',
'HALFVEC',
'SparseVector',
'SPARSEVEC',
'avg',
'sum'
]