Skip to content
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

chore: update readme #4

Merged
merged 1 commit into from
Jan 24, 2024
Merged

chore: update readme #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
Supported databases/extensions:

- [x] [`pgvecto.rs`](https://github.com/tensorchord/pgvecto.rs)
- [ ] [`pgvector`](https://github.com/pgvector/pgvector)
- [x] [`pgvector`](https://github.com/pgvector/pgvector)
- [ ] [`qdrant`](https://github.com/qdrant/qdrant/)

Supported datasets:

- [x] random generated
- [x] GIST 960


## Installation

```bash
Expand All @@ -20,6 +19,16 @@ pip install vector_bench

## Run

### Server

Run the docker compose file under [`server`](server/) folder.

```base
cd server/pgvecto.rs && docker compose up -d
```

### Client

```bash
# help
vector_bench --help
Expand All @@ -30,3 +39,22 @@ vector_bench --query --url postgresql://postgres:password@localhost:5432/postgre
# insert and query the data
vector_bench --insert --query --url postgresql://postgres:password@localhost:5432/postgres -s gist_960_l2
```

## How to contribute

```bash
# install all the necessary dependencies:
make dev
# format code
make format
# lint
make lint
```

### Add more datasets

- Add new `DatasetConfig` to `vector_bench/dataset/source.py`

### Add more clients

- Inherit and implement the `BaseClient` class in `vector_bench/client/base.py`