diff --git a/README.md b/README.md index e6b54c9..1885566 100644 --- a/README.md +++ b/README.md @@ -13,18 +13,16 @@ and the Sparse version of the DNC (the SDNC) described in [Scaling Memory-Augmen pip install dnc ``` -For using sparse DNCs, additional libraries are required: +### From source -### FAISS +``` +git clone https://github.com/ixaxaar/pytorch-dnc +cd pytorch-dnc +pip install -r ./requirements.txt +pip install -e . +``` -SDNCs require an additional library: [facebookresearch/faiss](https://github.com/facebookresearch/faiss). -A compiled version of the library with intel SSE + CUDA 8 support ships with this library. -If that does not work, one might need to install from source, as detailed below: - -#### Installing from source - -A script for building and installing this lib from source can be found at [scripts/install.sh](./scripts/install.sh). -Tested on `ubuntu 16.04`, `Arch / Manjaro` and `Fedora 27`. +`pytest` is required to run the test ## Architecure diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..7443ba3 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +pyflann3>=1.8.4.1 +torch>=0.2.0.post1 +numpy>=1.13.3 +pytest>=3.0.0 \ No newline at end of file