faiss-node
Node.js bindings for faiss
File Explorer
Download Latest Version (.zip)- bug_report.md
- build_release_alpine_arm64.yml
- build_release_alpine_x64.yml
- build_release_aws_arm64.yml
- build_release_aws_x64.yml
- build_release_darwin_x64.yml
- build_release_linux_arm64.yml
- build_release_linux_x64.yml
- build_release_linux_x64_openblas.yml
- build_release_windows_x64.yml
- install_mkl_windows.bat
- publish_docs.yml
- test_install_import.yml
- test_install_import_docker.yml
- test_install_import_docker_without_prebuild.yml
- unit_test.yml
- c_cpp_properties.json
- launch.json
- settings.json
- tasks.json
- faiss
- index-aws.js
- index.js
- index.d.ts
- index.js
- faiss.cc
- Index.test.js
- IndexFlatL2.test.js
- Dockerfile
- Dockerfile.withoutprebuild
- index.js
- package.json
- .dockerignore
- .gitignore
- .gitmodules
- .npmignore
- CMakeLists.txt
- Dockerfile.build
- Dockerfile.buildaws
- Dockerfile.buildawsarm64
- Dockerfile.buildlinux
- Dockerfile.buildlinuxamd64
- LICENSE
- package-lock.json
- package.json
- README.md
- tsconfig.json
# Installation Guide
1. Get the code
git clone https://github.com/ewfian/faiss-node
Downloads the entire project code from GitHub to your computer.
cd faiss-node
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f Dockerfile.build -t faiss-node .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 faiss-node
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. CMake
MediumPrerequisites
mkdir build && cd build
Creates a folder to hold the build output and moves into it.
cmake ..
Analyzes the source code and generates build configuration files (must be run inside the build folder).
make
Compiles the code based on the generated build configuration to produce an executable.
Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).
4. Node.js
EasyPrerequisites
$ npm install faiss-node
Downloads and installs the libraries listed in package.json.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)