Skip to content

Commit

Permalink
update installation guide with faiss and pytorch
Browse files Browse the repository at this point in the history
requirements
  • Loading branch information
rggdmonk committed Nov 9, 2023
1 parent 231abb2 commit 637d919
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# Installation

**NB!** The tool relies on [faiss](https://github.com/facebookresearch/faiss) for fast similarity search. To install faiss, please follow the [official installation guide](https://github.com/facebookresearch/faiss/blob/main/INSTALL.md)
**NB!**

=== "Latest (w/o faiss)"
* The tool relies on [**faiss**](https://github.com/facebookresearch/faiss) for fast similarity search. To install faiss, please follow the [official installation guide](https://github.com/facebookresearch/faiss/blob/main/INSTALL.md).
* [**pytorch**](https://pytorch.org/get-started/locally/) is also required.

=== "Latest (w/o faiss and pytorch)"
``` sh
pip install hadal
```

=== "Development"
``` sh
pip install hadal[dev]
pip install hadal[docs]
```

=== "No dependencies"
``` sh
pip install hadal --no-deps
```

=== "Ignore-installed"
``` sh
pip install hadal --ignore-installed LIBTOIGNORE1 LIBTOIGNORE2
```

0 comments on commit 637d919

Please sign in to comment.