@faiss-node/native 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -39,12 +39,21 @@ sudo apt-get install -y cmake libopenblas-dev libomp-dev
|
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
**Windows:**
|
|
42
|
-
Windows
|
|
43
|
-
- **WSL2 (Recommended)**: Use Windows Subsystem for Linux 2 - see [WINDOWS.md](WINDOWS.md#option-1-wsl2-setup-recommended)
|
|
44
|
-
- **VS Code Dev Container**: Use the included `.devcontainer` configuration - see [WINDOWS.md](WINDOWS.md#option-2-vs-code-dev-container)
|
|
45
|
-
- **Docker Desktop**: Run the project in a container - see [WINDOWS.md](WINDOWS.md#option-3-docker-desktop-manual)
|
|
42
|
+
Windows native builds require FAISS to be installed, which can be complex. We recommend using one of these approaches:
|
|
46
43
|
|
|
47
|
-
|
|
44
|
+
1. **WSL2 (Recommended)**: Use Windows Subsystem for Linux 2 - see [WINDOWS.md](WINDOWS.md#option-1-wsl2-setup-recommended)
|
|
45
|
+
- After installing WSL2, follow the Linux instructions above
|
|
46
|
+
- Works seamlessly from Windows Terminal and VS Code
|
|
47
|
+
|
|
48
|
+
2. **VS Code Dev Container**: Use the included `.devcontainer` configuration - see [WINDOWS.md](WINDOWS.md#option-2-vs-code-dev-container)
|
|
49
|
+
- Best for teams and consistent development environments
|
|
50
|
+
- No manual setup required - just "Reopen in Container"
|
|
51
|
+
|
|
52
|
+
3. **Docker Desktop**: Run the project in a container - see [WINDOWS.md](WINDOWS.md#option-3-docker-desktop-manual)
|
|
53
|
+
- Full control over the container environment
|
|
54
|
+
- Works with any IDE or editor
|
|
55
|
+
|
|
56
|
+
**Note for npm users:** The npm package (`@faiss-node/native`) works on Windows when installed in WSL2, Dev Containers, or Docker. For Windows native development, see [WINDOWS.md](WINDOWS.md) for detailed setup instructions.
|
|
48
57
|
|
|
49
58
|
**Building FAISS from Source (Linux/WSL2):**
|
|
50
59
|
```bash
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@faiss-node/native",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "High-performance Node.js native bindings for Facebook FAISS - the fastest vector similarity search library. Supports FLAT_L2, IVF_FLAT, and HNSW index types with async operations, persistence, and batch search.",
|
|
3
|
+
"version": "0.1.8",
|
|
4
|
+
"description": "High-performance Node.js native bindings for Facebook FAISS - the fastest vector similarity search library. Supports FLAT_L2, IVF_FLAT, and HNSW index types with async operations, persistence, and batch search. Works on macOS, Linux, and Windows (via WSL2/Docker).",
|
|
5
5
|
"main": "src/js/index.js",
|
|
6
6
|
"types": "src/js/types.d.ts",
|
|
7
7
|
"repository": {
|