[DOCS] Adding npm distribution to install guides for 24.0 (#23171)

Adding npm distribution of OpenVINO™ Toolkit do install guides.

Porting: https://github.com/openvinotoolkit/openvino/pull/23164

---------

Co-authored-by: Vishniakov Nikolai <nikolai.vishniakov@intel.com>
This commit is contained in:
Sebastian Golebiewski 2024-03-01 11:43:26 +01:00 committed by GitHub
parent c600170500
commit efbc1fd5f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 70 additions and 34 deletions

View File

@ -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 <install-openvino-brew>
Use Conan <install-openvino-conan>
Use Docker <install-openvino-docker-linux>
Use npm <install-openvino-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 <install-openvino-brew>`
* :doc:`Install OpenVINO using Docker <install-openvino-conan>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-docker-linux>`
* :doc:`Install OpenVINO using npm <install-openvino-npm>`

View File

@ -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 <install-openvino-conda>
Use vcpkg <install-openvino-vcpkg>
Use Conan <install-openvino-conan>
Use npm <install-openvino-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 <install-openvino-brew>`
* :doc:`Install OpenVINO using vcpkg <install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-conan>`
* :doc:`Install OpenVINO using npm <install-openvino-npm>`

View File

@ -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 <https://nodejs.org/en/download/>`__
Installing OpenVINO Node.js
###########################
1. Make sure that you have installed `Node.js and npm <https://nodejs.org/en/download>`__
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 youve installed OpenVINO npm package, youre 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 <https://github.com/intel-iot-devkit>`__.

View File

@ -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 <install-openvino-vcpkg>
Use Docker <install-openvino-docker-linux>
Use Conan <install-openvino-conan>
Use npm <install-openvino-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 <install-openvino-vcpkg>`
* :doc:`Install OpenVINO using Docker <install-openvino-docker-linux>`
* :doc:`Install OpenVINO using Conan Package Manager <install-openvino-conan>`
* :doc:`Install OpenVINO using npm <install-openvino-npm>`

View File

@ -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 <https://nodejs.org/en/download/>`__
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
#########################