Added Windows ARM64 support (#79)

Picovoice · Jan 14, 2025 · 77d9ae7 · 77d9ae7
1 parent 4d934a7
commit 77d9ae7
Show file tree

Hide file tree

Showing 26 changed files with 50 additions and 36 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -55,7 +55,7 @@ body:
         - macOS (arm64, x86_64)
         - Raspberry Pi
         - Web (WASM)
-        - Windows (x86_64)
+        - Windows (x86_64, arm64)
     validations:
       required: true
   - type: input

diff --git a/.github/workflows/c-demos.yml b/.github/workflows/c-demos.yml
@@ -54,19 +54,22 @@ jobs:
           - xpu: gpu
             machine: pv-windows-igpu
             make_file: "MinGW Makefiles"
+          - xpu: cpu
+            machine: pv-windows-arm64
+            make_file: "MinGW Makefiles"
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup Python virtualenv (*nix)
-        if: ${{ matrix.machine != 'pv-windows' && matrix.machine != 'pv-windows-igpu' }}
+        if: ${{ matrix.machine != 'pv-windows' && matrix.machine != 'pv-windows-igpu' && matrix.machine != 'pv-windows-arm64' }}
         run: |
           python3 -m venv binding/python/.venv
           . binding/python/.venv/bin/activate
           echo PATH=$PATH >> $GITHUB_ENV
 
       - name: Setup Python virtualenv (windows)
-        if: ${{ matrix.machine == 'pv-windows' || matrix.machine == 'pv-windows-igpu' }}
+        if: ${{ matrix.machine == 'pv-windows' || matrix.machine == 'pv-windows-igpu' || matrix.machine == 'pv-windows-arm64' }}
         run: |
           python3 -m venv binding\python\.venv --symlinks
           binding\python\.venv\Scripts\activate

diff --git a/.github/workflows/nodejs-demos.yml b/.github/workflows/nodejs-demos.yml
@@ -30,7 +30,7 @@ jobs:
       fail-fast: false
       matrix:
         xpu: [ cpu ]
-        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows ]
+        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows, pv-windows-arm64 ]
         include:
           - xpu: gpu
             machine: pv-linux

diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml
@@ -32,7 +32,7 @@ jobs:
       fail-fast: false
       matrix:
         xpu: [ "cpu" ]
-        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows ]
+        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows, pv-windows-arm64 ]
         include:
           - xpu: gpu
             machine: pv-linux

diff --git a/.github/workflows/python-demos.yml b/.github/workflows/python-demos.yml
@@ -27,7 +27,7 @@ jobs:
       fail-fast: false
       matrix:
         xpu: [ cpu ]
-        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows ]
+        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows, pv-windows-arm64 ]
         include:
           - xpu: gpu
             machine: pv-linux
@@ -39,21 +39,21 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setup Python virtualenv (*nix)
-      if: ${{ matrix.machine != 'pv-windows' && matrix.machine != 'pv-windows-igpu' }}
+      if: ${{ matrix.machine != 'pv-windows' && matrix.machine != 'pv-windows-igpu' && matrix.machine != 'pv-windows-arm64' }}
       run: |
         python3 -m venv .venv
         . .venv/bin/activate
         echo PATH=$PATH >> $GITHUB_ENV
 
     - name: Setup Python virtualenv (windows)
-      if: ${{ matrix.machine == 'pv-windows' || matrix.machine == 'pv-windows-igpu' }}
+      if: ${{ matrix.machine == 'pv-windows' || matrix.machine == 'pv-windows-igpu' || matrix.machine == 'pv-windows-arm64' }}
       run: |
         python3 -m venv .venv --symlinks
         .venv\Scripts\activate
         echo PATH=$PATH >> $GITHUB_ENV
 
     - name: Install Python dependencies
-      run: python3 -m pip install -r requirements.txt
+      run: python3 -m pip install -r requirements.txt --force-reinstall
 
     - name: Download resource files
       run: curl http://${{secrets.PV_CICD_RES_SERVER_AUTHORITY}}/github/picollm/res/phi2-290.pllm/04-d5f2aa0/phi2-290.pllm -o phi2-290.pllm

diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -35,7 +35,7 @@ jobs:
       fail-fast: false
       matrix:
         xpu: [ "cpu" ]
-        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows ]
+        machine: [ rpi4-32, rpi4-64, rpi5-32, rpi5-64, pv-linux, pv-ios, pv-windows, pv-windows-arm64 ]
         include:
           - xpu: gpu
             machine: pv-linux
@@ -47,14 +47,14 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setup Python virtualenv (*nix)
-      if: ${{ matrix.machine != 'pv-windows' && matrix.machine != 'pv-windows-igpu' }}
+      if: ${{ matrix.machine != 'pv-windows' && matrix.machine != 'pv-windows-igpu' && matrix.machine != 'pv-windows-arm64' }}
       run: |
         python3 -m venv binding/python/.venv
         . binding/python/.venv/bin/activate
         echo PATH=$PATH >> $GITHUB_ENV
 
     - name: Setup Python virtualenv (windows)
-      if: ${{ matrix.machine == 'pv-windows' || matrix.machine == 'pv-windows-igpu' }}
+      if: ${{ matrix.machine == 'pv-windows' || matrix.machine == 'pv-windows-igpu' || matrix.machine == 'pv-windows-arm64' }}
       run: |
         python3 -m venv binding\python\.venv --symlinks
         binding\python\.venv\Scripts\activate

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ models. picoLLM Inference Engine is:
 - Accurate; picoLLM Compression improves GPTQ by [significant margins](https://picovoice.ai/blog/picollm-towards-optimal-llm-quantization/)
 - Private; LLM inference runs 100% locally.
 - Cross-Platform
-    - Linux (x86_64), macOS (arm64, x86_64), and Windows (x86_64)
+    - Linux (x86_64), macOS (arm64, x86_64), and Windows (x86_64, arm64)
     - Raspberry Pi (5 and 4)
     - Android and iOS
     - Chrome, Safari, Edge, and Firefox

diff --git a/binding/nodejs/README.md b/binding/nodejs/README.md
@@ -16,7 +16,7 @@ models. picoLLM Inference Engine is:
 ## Compatibility
 
 - Node.js 16+
-- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64), and Raspberry Pi (5 and 4).
+- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64, arm64), and Raspberry Pi (5 and 4).
 
 ## Installation
 

diff --git a/binding/nodejs/package.json b/binding/nodejs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@picovoice/picollm-node",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Picovoice picoLLM Node.js binding",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",

diff --git a/binding/nodejs/src/platforms.ts b/binding/nodejs/src/platforms.ts
@@ -73,6 +73,10 @@ SYSTEM_TO_LIBRARY_PATH.set(
   `${SYSTEM_WINDOWS}/${X86_64}`,
   `${PLATFORM_WINDOWS}/amd64/pv_picollm.node`
 );
+SYSTEM_TO_LIBRARY_PATH.set(
+  `${SYSTEM_WINDOWS}/${ARM_64}`,
+  `${PLATFORM_WINDOWS}/arm64/pv_picollm.node`
+);
 
 function absoluteLibraryPath(libraryPath: string): string {
   return path.resolve(__dirname, LIBRARY_PATH_PREFIX, libraryPath);
@@ -125,7 +129,7 @@ export function getPlatform(): string {
     return PLATFORM_MAC;
   }
 
-  if (system === SYSTEM_WINDOWS && arch === X86_64) {
+  if (system === SYSTEM_WINDOWS && (arch === X86_64 || arch === ARM_64)) {
     return PLATFORM_WINDOWS;
   }
 
@@ -176,9 +180,9 @@ export function getSystemLibraryPath(): string {
         break;
       }
       case SYSTEM_WINDOWS: {
-        if (arch === X86_64) {
+        if (arch === X86_64 || arch === ARM_64) {
           return absoluteLibraryPath(
-            SYSTEM_TO_LIBRARY_PATH.get(`${SYSTEM_WINDOWS}/${X86_64}`)
+            SYSTEM_TO_LIBRARY_PATH.get(`${SYSTEM_WINDOWS}/${arch}`)
           );
         }
         break;

diff --git a/binding/python/README.md b/binding/python/README.md
@@ -16,7 +16,7 @@ models. picoLLM Inference Engine is:
 ## Compatibility
 
 - Python 3.8+
-- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64), and Raspberry Pi (5 and 4).
+- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64, arm64), and Raspberry Pi (5 and 4).
 
 ## Installation
 

diff --git a/binding/python/_util.py b/binding/python/_util.py
@@ -82,8 +82,10 @@ def pv_library_path(relative: str) -> str:
                 relative,
                 'lib/raspberry-pi/%s/libpv_picollm.so' % _PV_MACHINE)
     elif _PV_SYSTEM == 'Windows':
-        library_file = os.path.join(os.path.dirname(__file__), relative, 'lib/windows/amd64/libpv_picollm.dll')
-        return library_file
+        if _PV_MACHINE.lower() == 'amd64':
+            return os.path.join(os.path.dirname(__file__), relative, 'lib/windows/amd64/libpv_picollm.dll')
+        elif _PV_MACHINE.lower() == 'arm64':
+            return os.path.join(os.path.dirname(__file__), relative, 'lib/windows/arm64/libpv_picollm.dll')
 
     raise NotImplementedError('Unsupported platform.')
 

diff --git a/binding/python/setup.py b/binding/python/setup.py
@@ -43,6 +43,7 @@
 include picollm/lib/mac/x86_64/*.dylib
 include picollm/lib/raspberry-pi/**/*.so
 include picollm/lib/windows/amd64/*.dll
+include picollm/lib/windows/arm64/*.dll
 """
 
 with open(os.path.join(os.path.dirname(__file__), 'MANIFEST.in'), 'w') as f:
@@ -53,7 +54,7 @@
 
 setuptools.setup(
     name="picollm",
-    version="1.2.3",
+    version="1.2.4",
     author="Picovoice",
     author_email="[email protected]",
     description="picoLLM Inference Engine",

diff --git a/demo/c/README.md b/demo/c/README.md
@@ -3,7 +3,7 @@
 ## Compatibility
 
 - C99-compatible compiler
-- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64), and Raspberry Pi (5 and 4).
+- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64, arm64), and Raspberry Pi (5 and 4).
 
 ## Requirements
 

diff --git a/demo/c/test/test_util.py b/demo/c/test/test_util.py
@@ -82,7 +82,10 @@ def pv_library_path(relative: str) -> str:
                 relative,
                 'lib/raspberry-pi/%s/libpv_picollm.so' % _PV_MACHINE)
     elif _PV_SYSTEM == 'Windows':
-        library_file = os.path.join(os.path.dirname(__file__), relative, 'lib/windows/amd64/libpv_picollm.dll')
+        if _PV_MACHINE.lower() == 'amd64':
+            library_file = os.path.join(os.path.dirname(__file__), relative, 'lib/windows/amd64/libpv_picollm.dll')
+        elif _PV_MACHINE.lower() == 'arm64':
+            library_file = os.path.join(os.path.dirname(__file__), relative, 'lib/windows/arm64/libpv_picollm.dll')
         os.environ["PATH"] += os.pathsep + os.path.join(os.path.dirname(library_file))
         return library_file
 

diff --git a/demo/nodejs/README.md b/demo/nodejs/README.md
@@ -16,7 +16,7 @@ models. picoLLM Inference Engine is:
 ## Compatibility
 
 - Node.js 16+
-- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64), and Raspberry Pi (5 and 4).
+- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64, arm64), and Raspberry Pi (5 and 4).
 
 ## Installation
 

diff --git a/demo/nodejs/package.json b/demo/nodejs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@picovoice/picollm-node-demo",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Picovoice PicoLLM Node.js chat and completion demos",
   "scripts": {
     "chat": "node chat.js",
@@ -19,7 +19,7 @@
   "author": "Picovoice Inc.",
   "license": "Apache-2.0",
   "dependencies": {
-    "@picovoice/picollm-node": "~1.2.3",
+    "@picovoice/picollm-node": "~1.2.4",
     "commander": "^6.1.0",
     "prettier": "^2.6.2"
   },

diff --git a/demo/nodejs/yarn.lock b/demo/nodejs/yarn.lock
@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@picovoice/picollm-node@~1.2.3":
-  version "1.2.3"
-  resolved "https://registry.yarnpkg.com/@picovoice/picollm-node/-/picollm-node-1.2.3.tgz#e987159a308ee44b5d947213ee4401d6ff30e6ed"
-  integrity sha512-WdtrmMbxAUS8SDr98VRG+LulGe8UvRclu0+bBnOnYdOfEG7+XWHzC1ddsXRyN9mdmpPJj5T0xxQ1uk9dN2j+aw==
+"@picovoice/picollm-node@~1.2.4":
+  version "1.2.4"
+  resolved "https://registry.yarnpkg.com/@picovoice/picollm-node/-/picollm-node-1.2.4.tgz#f0dc0db5195737d731df99c91dde3e4ce1bc4ca5"
+  integrity sha512-UlJtMkn8Rl9QdPklGCngGAJaCMwnVQQRHucinZ33gplezRWCsgFRW8SdqE7D7EyK8bILJwc67Ngdtg19kyI08w==
 
 commander@^6.1.0:
   version "6.2.1"

diff --git a/demo/python/README.md b/demo/python/README.md
@@ -16,7 +16,7 @@ models. picoLLM Inference Engine is:
 ## Compatibility
 
 - Python 3.8+
-- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64), and Raspberry Pi (5 and 4).
+- Runs on Linux (x86_64), macOS (arm64, x86_64), Windows (x86_64, arm64), and Raspberry Pi (5 and 4).
 
 ## Installation
 

diff --git a/demo/python/requirements.txt b/demo/python/requirements.txt
@@ -1 +1 @@
-picollm==1.2.3
+picollm==1.2.4
diff --git a/demo/python/setup.py b/demo/python/setup.py
@@ -27,15 +27,15 @@
 
 setuptools.setup(
     name="picollmdemo",
-    version="1.2.3",
+    version="1.2.4",
     author="Picovoice",
     author_email="[email protected]",
     description="picoLLM Inference Engine demos",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/Picovoice/picollm",
     packages=["picollmdemo"],
-    install_requires=["picollm==1.2.3"],
+    install_requires=["picollm==1.2.4"],
     include_package_data=True,
     classifiers=[
         "Development Status :: 5 - Production/Stable",

diff --git a/lib/node/windows/arm64/libomp.dll b/lib/node/windows/arm64/libomp.dll
diff --git a/lib/node/windows/arm64/pv_picollm.node b/lib/node/windows/arm64/pv_picollm.node
diff --git a/lib/windows/arm64/libomp.dll b/lib/windows/arm64/libomp.dll
diff --git a/lib/windows/arm64/libpv_picollm.dll b/lib/windows/arm64/libpv_picollm.dll
diff --git a/resources/.test/test_data.json b/resources/.test/test_data.json
@@ -135,7 +135,8 @@
         " Asset, and I am going to sing it,\n\n\n\nI will sing",
         " bread.\n\nThe song is a parody of the song \"Banana Bread\"",
         " bread.\n\nBanana bread is a delicious treat. It is made with bananas",
-        " bread.\n\nThe song is called \"Banana Bread\". It is about making"
+        " bread.\n\nThe song is called \"Banana Bread\". It is about making",
+        " bread.\n\nReferences\n\nExternal links\n\nAmerican folk songs\nAmerican folk"
       ]
     },
     "with-top-choices": {