Integrating SBQ

README.md

@@ -1,13 +1,14 @@
 Timescale Vector
 
-Say something chat gpt.
+A vector index for speeding up ANN search in `pgvector`.
 
 🔧 Tools Setup
-Building the extension requires valid rust (we build and test on 1.65), rustfmt, and clang installs, along with the postgres headers for whichever version of postgres you are running, and pgx. We recommend installing rust using the official instructions:
+
+Building the extension requires valid rust, rustfmt, and clang installs, along with the postgres headers for whichever version of postgres you are running, and pgx. We recommend installing rust using the official instructions:
 ```shell
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
-and build tools, the postgres headers, in the preferred manner for your system. You may also need to install OpenSSl. For Ubuntu you can follow the postgres install instructions then run
+and build tools, the postgres headers, in the preferred manner for your system. You may also need to install OpenSSL. For Ubuntu you can follow the postgres install instructions then run
 
 ```shell
 sudo apt-get install make gcc pkg-config clang postgresql-server-dev-16 libssl-dev
@@ -18,7 +19,7 @@ Next you need cargo-pgx, which can be installed with
 cargo install --locked cargo-pgrx
 ```
 
-You must reinstall cargo-pgx whenever you update your Rust compiler, since cargo-pgx needs to be built with the same compiler as Toolkit.
+You must reinstall cargo-pgx whenever you update your Rust compiler, since cargo-pgx needs to be built with the same compiler as Timescale Vector.
 
 Finally, setup the pgx development environment with
 ```shell
@@ -28,10 +29,11 @@ cargo pgrx init --pg16 pg_config
 Installing from source is also available on macOS and requires the same set of prerequisites and set up commands listed above.
 
 💾 Building and Installing the extension
+
 Download or clone this repository, and switch to the extension subdirectory, e.g.
 ```shell
 git clone https://github.com/timescale/timescale-vector && \
-cd timescale-vector/extension
+cd timescale-vector/timescale_vector
 ```
 
 Then run
@@ -41,9 +43,13 @@ cargo pgrx install --release
 
 To initialize the extension after installation, enter the following into psql:
 
+```sql
 CREATE EXTENSION timescale_vector;
+```
+
 ✏️ Get Involved
-The Timescale Vecotr project is still in the initial planning stage as we decide our priorities and what to implement first. As such, now is a great time to help shape the project's direction! Have a look at the list of features we're thinking of working on and feel free to comment on the features, expand the list, or hop on the Discussions forum for more in-depth discussions.
+
+The Timescale Vector project is still in it's early stage as we decide our priorities and what to implement. As such, now is a great time to help shape the project's direction! Have a look at the list of features we're thinking of working on and feel free to comment on the features, expand the list, or hop on the Discussions forum for more in-depth discussions.
 
 🔨 Testing
 See above for prerequisites and installation instructions.
@@ -52,7 +58,14 @@ You can run tests against a postgres version pg16 using
 ```shell
 cargo pgrx test ${postgres_version}
 ```
+
+To run all tests run:
+```shell
+cargo test -- --ignored && cargo pgrx test ${postgres_version}
+```
+
 🐯 About Timescale
+
 TimescaleDB is a distributed time-series database built on PostgreSQL that scales to over 10 million of metrics per second, supports native compression, handles high cardinality, and offers native time-series capabilities, such as data retention policies, continuous aggregate views, downsampling, data gap-filling and interpolation.
 
 TimescaleDB also supports full SQL, a variety of data types (numerics, text, arrays, JSON, booleans), and ACID semantics. Operationally mature capabilities include high availability, streaming backups, upgrades over time, roles and permissions, and security.

timescale_vector/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "timescale_vector"
-version = "0.0.2"
+version = "0.0.3-dev"
 edition = "2021"
 
 [lib]
-crate-type = ["cdylib"]
+crate-type = ["cdylib", "rlib"]
 
 [features]
 default = ["pg16"]
@@ -14,9 +14,9 @@ pg_test = []
 
 [dependencies]
 memoffset = "0.9.0"
-pgrx = "=0.11.1"
+pgrx = "=0.11.4"
 rkyv = { version="0.7.42", features=["validation"]}
-simdeez = {version = "1.0"}
+simdeez = {version = "1.0.8"}
 reductive = { version = "0.9.0"}
 ndarray = { version = "0.15.0", features = ["blas"] }
 blas-src = { version = "0.8", features = ["openblas"] }
@@ -26,10 +26,14 @@ rand_chacha = "0.3"
 rand_core = "0.6"
 rand_xorshift = "0.3"
 rayon = "1"
-
+timescale_vector_derive = { path = "timescale_vector_derive" }
+semver = "1.0.22"
 
 [dev-dependencies]
-pgrx-tests = "=0.11.1"
+pgrx-tests = "=0.11.4"
+pgrx-pg-config = "=0.11.4"
+criterion = "0.5.1"
+tempfile = "3.3.0"
 
 [profile.dev]
 panic = "unwind"
@@ -39,3 +43,12 @@ panic = "unwind"
 opt-level = 3
 lto = "fat"
 codegen-units = 1
+#debug = true
+
+[[bench]]
+name = "distance"
+harness = false
+
+[[bench]]
+name = "lsr"
+harness = false