Python bindings for pgvector.rs

Currently supports SQLAlchemy.

Usage

Install from PyPI:

pip install pgvecto_rs

See the usage examples:

• SQLAlchemy
• psycopg3

SQLAlchemy

Install SQLAlchemy and psycopg3

pip install "psycopg[binary]" sqlalchemy

Then write your code. See examples/sqlalchemy_example.py and tests/test_sqlalchemy.py for example.

All the operators include:

• squared_euclidean_distance
• negative_dot_product_distance
• negative_cosine_distance

psycopg3

Install psycopg3

pip install "psycopg[binary]"

Then write your code. See examples/psycopg_example.py and tests/test_psycopg.py for example.

Known issue:

• Can not check the length of an vector when inserting it into a table. See: #96.

Development

This package is managed by PDM.

Set up things:

pdm venv create
pdm use # select the venv inside the project path
pdm sync

Run lint:

pdm run format
pdm run check

Run test in current environment:

pdm run test

Test

Tox is used to test the package locally.

Run test in all environment:

tox run