Skip to content

Commit

Permalink
add a subsection for installation from conda-forge (#1740)
Browse files Browse the repository at this point in the history
Summary:
After existing for close to a year and considering the quality (IMO) of the collaboration since then,
I believe it would be reasonable to also mention the conda-forge packages in `INSTALL.md`.

WDYT mdouze beauby?

Pull Request resolved: #1740

Reviewed By: mdouze

Differential Revision: D26870699

Pulled By: beauby

fbshipit-source-id: 17465cd5c9f138f041d394d61fccd086bcafc3c7
  • Loading branch information
h-vetinari authored and facebook-github-bot committed Mar 8, 2021
1 parent 189aecb commit ee701b9
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,33 @@ Nightly pre-release packages can be installed as follows:
# CPU-only version
$ conda install -c pytorch/label/nightly faiss-cpu

# GPU(+CPU) versoin
# GPU(+CPU) version
$ conda install -c pytorch/label/nightly faiss-gpu
```

## Installing from conda-forge

Faiss is also being packaged by [conda-forge](https://conda-forge.org/), the
community-driven packaging ecosystem for conda. The packaging effort is
collaborating with the Faiss team to ensure high-quality package builds.

Due to the comprehensive infrastructure of conda-forge, it may even happen that
certain build combinations are supported in conda-forge that are not available
through the pytorch channel. To install, use

``` shell
# CPU version
$ conda install -c conda-forge faiss-cpu

# GPU version
$ conda install -c conda-forge faiss-gpu
```

You can tell which channel your conda packages come from by using `conda list`.
If you are having problems using a package built by conda-forge, please raise
an [issue](https://github.com/conda-forge/faiss-split-feedstock/issues) on the
conda-forge package "feedstock".

# Building from source

Faiss can be built from source using CMake.
Expand Down

0 comments on commit ee701b9

Please sign in to comment.