-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update installation guide with faiss and pytorch
requirements
- Loading branch information
Showing
1 changed file
with
6 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |