Skip to content

Commit f3a8039

Browse files
prathikrPrathik RaoCopilot
authored
updates js docs to reflect new package structure (#604)
Co-authored-by: Prathik Rao <prathikrao@microsoft.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 285f189 commit f3a8039

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

sdk/js/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,17 @@ npm install foundry-local-sdk
2222

2323
## WinML: Automatic Hardware Acceleration (Windows)
2424

25-
On Windows, install with the `--winml` flag to enable automatic execution provider management. The SDK will automatically discover, download, and register hardware-specific execution providers (e.g., Qualcomm QNN for NPU acceleration) via the Windows App Runtime — no manual driver or EP setup required.
25+
On Windows, install the WinML package to enable automatic execution provider management. The SDK will automatically discover, download, and register hardware-specific execution providers (e.g., Qualcomm QNN for NPU acceleration) via the Windows App Runtime — no manual driver or EP setup required.
2626

27+
> **Note:** `foundry-local-sdk-winml` is a Windows-only package. Its install script downloads WinML artifacts during installation and may fail on macOS or Linux.
2728
```bash
28-
npm install foundry-local-sdk --winml
29+
npm install foundry-local-sdk-winml
2930
```
3031

3132
When WinML is enabled:
3233
- Execution providers like `QNNExecutionProvider`, `OpenVINOExecutionProvider`, etc. are downloaded and registered on the fly, enabling NPU/GPU acceleration without manual configuration
3334
- **No code changes needed** — your application code stays the same whether WinML is enabled or not
3435

35-
> **Note:** The `--winml` flag is only relevant on Windows. On macOS and Linux, the standard installation is used regardless of this flag.
36-
3736
### Explicit EP Management
3837

3938
You can explicitly discover and download execution providers using the `discoverEps()` and `downloadAndRegisterEps()` methods:

0 commit comments

Comments
 (0)