Skip to content
Snippets Groups Projects
Commit db22ed4d authored by Mathis "what could possibly go wrong" Randl's avatar Mathis "what could possibly go wrong" Randl
Browse files

Merge branch 'main' into 'dyn_tol'

# Conflicts:
#   README.md
parents 8f439198 a4a4d7d0
No related branches found
No related tags found
No related merge requests found
# Proximity
Proximity is a research project exploring the optimization approximate vector search in high-dimensional spaces.
Proximity is a research project exploring the optimization and speed-recall tradeoffs of approximate vector search in high-dimensional spaces.
We provide an approximate cache for vector databases that is written in Rust and exposes Python bindings.
Note: This code is in beta/development and is not recommended for production systems.
More information is available in our [EuroMLSys '25 publication](https://doi.org/10.1145/3721146.3721938).
Note: This code is under active development and is not recommended for production systems.
## Installation
......@@ -11,13 +13,15 @@ Note: This code is in beta/development and is not recommended for production sys
Ensure you have the following dependencies installed:
- the Rust toolkit (Cargo and rustup are encouraged)
- the Rust toolkit (Cargo and rustup are encouraged). For now, nightly is required, but a regular (non-nightly) install on your machine will automatically download the nightly compiler and use it only in this project, making this effectively transparent for the user.
- Python 3.8+
- maturin for Rust-Python interactions (we recommend installing through pip)
- Maturin for Rust-Python interactions (we recommend installing by running ```pip install maturin```)
## Build Instructions
```
python3 -m venv proxi-env
source proxi-env/bin/activate
git clone https://gitlab.epfl.ch/randl/proximity.git
cd proximity/bindings
maturin develop -r
......@@ -25,6 +29,8 @@ maturin develop -r
## Usage
todo
## Repository Structure
```proximity/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment