pixi install instructions

Author: mxmpl

.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true -diff

.gitignore

@@ -6,3 +6,5 @@ wheels/
 *.egg-info
 .venv
 *.jsonl
+.pixi/*
+!.pixi/config.toml

README.md

@@ -12,17 +12,15 @@ This package is available on PyPI:
 pip install speech-map
 ```
 
-It is much more efficient to use the Faiss backend for the k-NN, instead of the naive PyTorch backend.
-Since Faiss is not available on PyPI, you can install this package in a conda environment with your conda variant:
-
-- CPU version:
-    ```bash
-    micromamba create -f environment-cpu.yaml
-    ```
-- GPU version:
-    ```bash
-    CONDA_OVERRIDE_CUDA=12.6 micromamba create -f environment-gpu.yaml
-    ```
+The naive PyTorch backend for the k-NN is enough to compute the MAP over words quickly.
+
+You might want to use the Faiss backend if you compute the MAP over n-grams or if have a large number of
+embeddings. In this case, since Faiss is not available on PyPI, you can install this package in a pixi or conda
+environment. We recommand using pixi on Linux: clone this repository and run `pixi shell -e faiss-cpu` or
+`pixi shell -e faiss-gpu`.
+
+With conda, first install Faiss in your conda environment (be careful about your PyTorch and Faiss versions,
+and from which channel they come from), and then install `speech-map` using pip.
 
 ## Usage
 

environment-cpu.yaml

@@ -0,0 +1,22 @@
+[workspace]
+name = "speech-map"
+channels = ["pytorch", "conda-forge"]
+platforms = ["osx-arm64", "linux-64"]
+
+[pypi-dependencies]
+speech-map = { path = ".", editable = true }
+
+[environments]
+faiss-cpu = ["faiss-cpu"]
+faiss-gpu = ["faiss-gpu"]
+
+[feature.faiss-cpu]
+dependencies = { faiss-cpu = ">=1.13.2" }
+platforms = ["linux-64"]
+
+[feature.faiss-gpu]
+dependencies = { faiss-gpu = ">=1.13.2" }
+platforms = ["linux-64"]
+
+[dependencies]
+python = ">=3.12.12,<3.15"