Skip to content

[JS] Setup genai nodejs bindings compilation for macos #1738

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ilya-lavrenov merged 5 commits into from
Mar 4, 2025
Merged

[JS] Setup genai nodejs bindings compilation for macos #1738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9a5984c
[JS] Setup genai nodejs bindings compilation for macos
Retribution98 Feb 13, 2025
b2dda61
Use latest_available_commit for ov-provider
Retribution98 Feb 27, 2025
79f3b52
Fix pathes
Retribution98 Feb 27, 2025
dab483f
Merge branch 'master' into CVS_161879
Retribution98 Mar 3, 2025
3164de1
Use separate ov-prvider for nodejs
Retribution98 Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 131 additions & 1 deletion .github/workflows/mac.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
ov_artifact_name: ${{ steps.openvino_download.outputs.ov_artifact_name }}
ov_wheel_source: ${{ steps.openvino_download.outputs.ov_wheel_source }}
ov_version: ${{ steps.openvino_download.outputs.ov_version }}
ov_latest_artifact_name: ${{ steps.openvino_latest_download.outputs.ov_artifact_name }}
timeout-minutes: 10
defaults:
run:
Expand All @@ -47,6 +48,13 @@ jobs:
platform: macos_12_6
commit_packages_to_provide: wheels
revision: latest_nightly

- uses: openvinotoolkit/openvino/.github/actions/openvino_provider@master
id: openvino_latest_download
with:
platform: macos_12_6
commit_packages_to_provide: openvino_js_package.tar.gz
revision: latest_available_commit
Copy link
Contributor

@ilya-lavrenov ilya-lavrenov Mar 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that latest available commit is available on macOS since we don't have precommit on macOS in OpenVINO GHA infra.

Copy link
Contributor

@mryzhov mryzhov Mar 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We introduced it here - openvinotoolkit/openvino#29086

Copy link
Contributor

@mryzhov mryzhov Mar 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but it would not be available for release package, @Retribution98, we would need to think about that too


genai_build_cmake:
name: Build cpack - ${{ matrix.build-type }}
Expand Down Expand Up @@ -268,7 +276,61 @@ jobs:
name: genai_samples_${{ matrix.build-type }}
path: ${{ env.INSTALL_DIR }}
if-no-files-found: 'error'


genai_build_nodejs:
name: Build Node.js bindings
strategy:
fail-fast: false
matrix:
build-type: [Release]
needs: [ openvino_download ]
timeout-minutes: 30
defaults:
run:
shell: bash
runs-on: macos-13

env:
SRC_DIR: ${{ github.workspace }}/openvino.genai
BUILD_DIR: ${{ github.workspace }}/build
INSTALL_DIR: ${{ github.workspace }}/openvino.genai/src/js/bin
OV_INSTALL_DIR: ${{ github.workspace }}/ov

steps:
- name: Clone openvino.genai
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
submodules: recursive
path: ${{ env.SRC_DIR }}

- name: Download OpenVINO package
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
with:
name: ${{ needs.openvino_download.outputs.ov_latest_artifact_name }}
path: ${{ env.OV_INSTALL_DIR }}
merge-multiple: true

- name: Install build dependencies
run: brew install coreutils

- name: Build GenAI Node.js bindings
run: |
source ${{ env.OV_INSTALL_DIR }}/setupvars.sh
cmake -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} \
-DENABLE_JS=ON -DCPACK_GENERATOR=NPM \
-DENABLE_PYTHON=OFF -DENABLE_WHEEL=OFF \
-S ${{ env.SRC_DIR }} -B ${{ env.BUILD_DIR }}
cmake --build ${{ env.BUILD_DIR }} --config ${{ matrix.build-type }} --parallel --verbose
cmake --install ${{ env.BUILD_DIR }} --config ${{ matrix.build-type }} --prefix ${{ env.INSTALL_DIR }}

- name: Upload Node.js bindings Build Package
if: always()
uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
with:
name: genai_nodejs_bindings
path: ${{ env.INSTALL_DIR }}
if-no-files-found: 'error'

genai_tests_wheel:
name: Python (${{ matrix.test.name}}) Tests (wheel)
needs: [ openvino_download, genai_build_wheel ]
Expand Down Expand Up @@ -397,6 +459,74 @@ jobs:
SAMPLES_PY_DIR: "${{ env.INSTALL_DIR }}/samples/python"
SAMPLES_CPP_DIR: "${{ env.INSTALL_DIR }}/samples_bin"

genai_nodejs_tests:
name: Node.js bindings tests
needs: [ openvino_download, genai_build_nodejs ]
timeout-minutes: 20
defaults:
run:
shell: bash
runs-on: macos-13

env:
SRC_DIR: ${{ github.workspace }}/openvino.genai
INSTALL_DIR: ${{ github.workspace }}/install
NODE_VERSION: 21

steps:
- name: Clone openvino.genai
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
path: ${{ env.SRC_DIR }}
submodules: recursive

- name: Download OpenVINO Artifacts
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
with:
name: ${{ needs.openvino_download.outputs.ov_latest_artifact_name }}
path: ${{ env.INSTALL_DIR }}
merge-multiple: true

- name: Download GenAI JS Bildings Artifacts
uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
with:
name: genai_nodejs_bindings
path: ${{ env.SRC_DIR }}/src/js/bin
merge-multiple: true

- name: Setup Node ${{ env.NODE_VERSION }}
uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
with:
node-version: ${{ env.NODE_VERSION }}

# JS pacakges uses the OpenVINO and OpenVINO GenAI libraries from the bin directory.
# Here we emulate the installation of the openvino-node package from NPM. The latest
# release of the openvino-node package is installed, and we need to update the binaries
# in the node_modules/openvino-node/bin directory to work correctly with GenAI
- name: Install npm package tests dependencies
working-directory: ${{ env.SRC_DIR }}/src/js
run: |
npm install --verbose
rm -rf node_modules/openvino-node/bin
cp -R ${{ env.INSTALL_DIR }}/openvino_js_package node_modules/openvino-node/bin

- name: Run npm package tests
working-directory: ${{ env.SRC_DIR }}/src/js
run: npm test

- name: Install openvino-genai-node samples dependencies
working-directory: ${{ env.SRC_DIR }}/samples/js/text_generation
run: |
npm install --verbose
rm -rf node_modules/openvino-node/bin
cp -R ${{ env.INSTALL_DIR }}/openvino_js_package node_modules/openvino-node/bin

- name: Run samples tests
working-directory: ${{ env.SRC_DIR }}/samples/js/text_generation
run: npm test
env:
MODEL_PATH: ${{ env.SRC_DIR }}/src/js/tests/models/Llama-3.1-8B-Instruct-FastDraft-150M-int8-ov

Overall_Status:
name: ci/gha_overall_status_macos
needs: [openvino_download, genai_build_cmake, genai_build_wheel, genai_build_samples, genai_tests_wheel, genai_samples_tests]
Expand Down
6 changes: 5 additions & 1 deletion src/cpp/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,8 +178,12 @@ if(CPACK_GENERATOR STREQUAL "NPM")
# to find libopenvino.so when installing from source
list(APPEND rpaths "$ORIGIN/../node_modules/openvino-node/bin")
elseif(APPLE)
# to find libopenvino.dylib in the same folder
# to find libopenvino_genai.dylib in the same folder
set(rpaths "@loader_path")
# to find libopenvino.dylib when installing from npm
list(APPEND rpaths "@loader_path/../../openvino-node/bin")
# to find libopenvino.dylib when installing from source
list(APPEND rpaths "@loader_path/../node_modules/openvino-node/bin")
endif()

if(rpaths)
Expand Down
4 changes: 4 additions & 0 deletions src/js/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ if(LINUX)
elseif(APPLE)
# to find libopenvino_genai.dylib in the same folder
set(rpaths "@loader_path")
# to find libopenvino.dylib when installing from npm
list(APPEND rpaths "@loader_path/../../openvino-node/bin")
# to find libopenvino.dylib when installing from source
list(APPEND rpaths "@loader_path/../node_modules/openvino-node/bin")
endif()

if(rpaths)
Expand Down
Loading