Skip to content

Commit

Permalink
fixed. wrong python path on install doc (#1321)
Browse files Browse the repository at this point in the history
Summary: Pull Request resolved: #1321

Reviewed By: patricklabatut

Differential Revision: D22999873

Pulled By: beauby

fbshipit-source-id: 28696e8f7bb9e2bf6a8092b19853ac331415f810
  • Loading branch information
DeanLee2013 authored and facebook-github-bot committed Aug 7, 2020
1 parent b23cb28 commit bc52661
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ described separately (please see the [C interface installation file](c_api/INSTA
General compilation instructions
================================

TL;DR: `./configure && make (&& make install)` for the C++ library, and then `cd python; make && make install` for the python interface.
TL;DR: `./configure && make (&& make install)` for the C++ library, and then `cd faiss/python; make && make install` for the python interface.

1. `./configure`

Expand All @@ -66,11 +66,11 @@ found, or the CPU part only otherwise).

This installs the headers and libraries.

4. `make -C python` (or `make py`)
4. `make -C faiss/python` (or `make py`)

This builds the python interface.

5. `make -C python install`
5. `make -C faiss/python install`

This installs the python library.

Expand Down Expand Up @@ -168,16 +168,16 @@ The Python interface

The Python interface is compiled with

`make -C python` (or `make py`)
`make -C faiss/python` (or `make py`)

How it works
------------

The Python interface is provided via SWIG (Simple Wrapper and
Interface Generator) and an additional level of manual wrappers (in python/faiss.py).
Interface Generator) and an additional level of manual wrappers (in faiss/python/faiss.py).

SWIG generates two wrapper files: a Python file (`python/swigfaiss.py`) and a
C++ file that must be compiled to a dynamic library (`python/_swigfaiss.so`).
SWIG generates two wrapper files: a Python file (`faiss/python/swigfaiss.py`) and a
C++ file that must be compiled to a dynamic library (`faiss/python/_swigfaiss.so`).

Testing the Python wrapper
--------------------------
Expand Down

0 comments on commit bc52661

Please sign in to comment.