diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-linux.rst b/docs/articles_en/get-started/install-openvino/install-openvino-linux.rst index b5358beb3d5..62f2bc539d2 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-linux.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-linux.rst @@ -6,7 +6,7 @@ Install OpenVINO™ Runtime on Linux .. meta:: :description: Learn how to install OpenVINO™ Runtime on Linux operating system. - You can use an archive, a PyPi package, APT, YUM, Conda Forge, + You can use an archive, a PyPi package, npm package, APT, YUM, Conda Forge, Homebrew or a Docker image. @@ -23,6 +23,7 @@ Install OpenVINO™ Runtime on Linux Use Homebrew Use Conan Use Docker + Use npm If you want to install OpenVINO™ Runtime on Linux, you have the following options: @@ -36,6 +37,7 @@ If you want to install OpenVINO™ Runtime on Linux, you have the following opti * :doc:`Install OpenVINO using Homebrew ` * :doc:`Install OpenVINO using Docker ` * :doc:`Install OpenVINO using Conan Package Manager ` +* :doc:`Install OpenVINO using npm ` diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-macos.rst b/docs/articles_en/get-started/install-openvino/install-openvino-macos.rst index 5226322ad0e..ee6ce1e34b2 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-macos.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-macos.rst @@ -6,7 +6,7 @@ Install OpenVINO™ Runtime for macOS .. meta:: :description: Learn how to install OpenVINO™ Runtime on macOS operating - system. You can use an archive, a PyPi package, Conda Forge + system. You can use an archive, a PyPi package, npm package, Conda Forge or Homebrew. @@ -20,6 +20,7 @@ Install OpenVINO™ Runtime for macOS Use Conda Forge Use vcpkg Use Conan + Use npm If you want to install OpenVINO™ Runtime on macOS, you have the following options: @@ -31,6 +32,7 @@ If you want to install OpenVINO™ Runtime on macOS, you have the following opti * :doc:`Install OpenVINO using Homebrew ` * :doc:`Install OpenVINO using vcpkg ` * :doc:`Install OpenVINO using Conan Package Manager ` +* :doc:`Install OpenVINO using npm ` diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-npm.rst b/docs/articles_en/get-started/install-openvino/install-openvino-npm.rst new file mode 100644 index 00000000000..db8f8e6d286 --- /dev/null +++ b/docs/articles_en/get-started/install-openvino/install-openvino-npm.rst @@ -0,0 +1,61 @@ +.. {#openvino_docs_install_guides_installing_openvino_npm} + +Install Intel® Distribution of OpenVINO™ Toolkit from npm Registry +================================================================== + +.. meta:: + :description: Learn how to install OpenVINO™ Runtime on Windows, Linux, and + macOS operating systems, using the npm registry. + + +.. note:: + + Note that the npm distribution: + + * offers the JavaScript API only + * is dedicated to users of all major OSes: Windows, Linux, and macOS + (all x86_64 / arm64 architectures) + * macOS offers support only for CPU inference + +.. tab-set:: + + .. tab-item:: System Requirements + :sync: system-requirements + + - Windows, Linux, macOS + - x86, ARM (Windows ARM not supported) + + .. tab-item:: Software Requirements + :sync: software-requirements + + `Node.js version 20.5.1 and higher `__ + + +Installing OpenVINO Node.js +########################### + +1. Make sure that you have installed `Node.js and npm `__ + on your system. +2. Navigate to your project directory and run the following command in the terminal: + + .. code-block:: sh + + npm install openvino-node + +.. note:: + + The *openvino-node* npm package runs in Node.js environment only and provides + a subset of :doc:`OpenVINO Runtime C++ API <../../api/c_cpp_api/group__ov__cpp__api>`. + +What's Next? +#################### + +Now that you’ve installed OpenVINO npm package, you’re ready to run your own machine +learning applications! Explore :doc:`OpenVINO Node.js API <../../api/nodejs_api/nodejs_api>` +to learn more about how to integrate a model in Node.js applications. + +Additional Resources +#################### + +- Intel® Distribution of OpenVINO™ toolkit home page: https://software.intel.com/en-us/openvino-toolkit +- For IoT Libraries & Code Samples, see `Intel® IoT Developer Kit `__. diff --git a/docs/articles_en/get-started/install-openvino/install-openvino-windows.rst b/docs/articles_en/get-started/install-openvino/install-openvino-windows.rst index a7ca0c01e55..56c5ac6ce3a 100644 --- a/docs/articles_en/get-started/install-openvino/install-openvino-windows.rst +++ b/docs/articles_en/get-started/install-openvino/install-openvino-windows.rst @@ -6,7 +6,7 @@ Install OpenVINO™ Runtime on Windows .. meta:: :description: Learn how to install OpenVINO™ Runtime on Windows operating - system. You can use an archive, a PyPi package, Conda Forge, + system. You can use an archive, a PyPi package, npm package, Conda Forge, or a Docker image. @@ -20,7 +20,7 @@ Install OpenVINO™ Runtime on Windows Use vcpkg Use Docker Use Conan - + Use npm If you want to install OpenVINO™ Runtime on Windows, you have the following options: @@ -31,5 +31,6 @@ If you want to install OpenVINO™ Runtime on Windows, you have the following op * :doc:`Install OpenVINO using vcpkg ` * :doc:`Install OpenVINO using Docker ` * :doc:`Install OpenVINO using Conan Package Manager ` +* :doc:`Install OpenVINO using npm ` diff --git a/docs/sphinx_setup/api/nodejs_api/nodejs_api.rst b/docs/sphinx_setup/api/nodejs_api/nodejs_api.rst index c68bd751480..1f1b59b0f52 100644 --- a/docs/sphinx_setup/api/nodejs_api/nodejs_api.rst +++ b/docs/sphinx_setup/api/nodejs_api/nodejs_api.rst @@ -10,36 +10,6 @@ OpenVINO Node.js API is distributed as an *openvino-node* npm package that conta wrappers with TypeScript types descriptions and a script that downloads the OpenVINO Node.js bindings for current OS.⠀ -System requirements -################### - -.. list-table:: - :header-rows: 1 - - * - Operating System - - Architecture - - Software - * - Windows, Linux, macOS - - x86, ARM (Windows ARM not supported) - - `Node.js version 20.5.1 and higher `__ - - -Install openvino-node package -############################# - -To install the package, use the following command: - -.. code-block:: sh - - npm install openvino-node - - -.. note:: - - The *openvino-node* npm package runs in Node.js environment only and provides - a subset of :doc:`OpenVINO Runtime C++ API <../c_cpp_api/group__ov__cpp__api>`. - - Use openvino-node package #########################