Skip to content

Commit

Permalink
[DOCS] Adding npm distribution to install guides (openvinotoolkit#23164)
Browse files Browse the repository at this point in the history
Adding npm distribution of OpenVINO™ Toolkit do install guides.

---------

Co-authored-by: Vishniakov Nikolai <[email protected]>
  • Loading branch information
sgolebiewski-intel and vishniakov-nikolai authored Mar 1, 2024
1 parent 06a669e commit dfff4e8
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 44 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ 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,
:description: Learn how to install OpenVINO™ Runtime on Linux operating system.
You can use an archive, a PyPi package, npm package, APT, YUM, Conda Forge,
Homebrew or a Docker image.


Expand All @@ -23,6 +23,7 @@ Install OpenVINO™ Runtime on Linux
Use Homebrew <openvino_docs_install_guides_installing_openvino_brew>
Use Conan <openvino_docs_install_guides_installing_openvino_conan>
Use Docker <openvino_docs_install_guides_installing_openvino_docker>
Use npm <openvino_docs_install_guides_installing_openvino_npm>


If you want to install OpenVINO™ Runtime on Linux, you have the following options:
Expand All @@ -36,8 +37,5 @@ If you want to install OpenVINO™ Runtime on Linux, you have the following opti
* :doc:`Install OpenVINO using Homebrew <openvino_docs_install_guides_installing_openvino_brew>`
* :doc:`Install OpenVINO using Docker <openvino_docs_install_guides_installing_openvino_docker>`
* :doc:`Install OpenVINO using Conan Package Manager <openvino_docs_install_guides_installing_openvino_conan>`




* :doc:`Install OpenVINO using npm <openvino_docs_install_guides_installing_openvino_npm>`

Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ 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
:description: Learn how to install OpenVINO™ Runtime on macOS operating
system. You can use an archive, a PyPi package, npm package, Conda Forge
or Homebrew.


Expand All @@ -20,7 +20,7 @@ Install OpenVINO™ Runtime for macOS
Use Conda Forge <openvino_docs_install_guides_installing_openvino_conda>
Use vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>
Use Conan <openvino_docs_install_guides_installing_openvino_conan>

Use npm <openvino_docs_install_guides_installing_openvino_npm>

If you want to install OpenVINO™ Runtime on macOS, you have the following options:

Expand All @@ -31,6 +31,5 @@ If you want to install OpenVINO™ Runtime on macOS, you have the following opti
* :doc:`Install OpenVINO using Homebrew <openvino_docs_install_guides_installing_openvino_brew>`
* :doc:`Install OpenVINO using vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>`
* :doc:`Install OpenVINO using Conan Package Manager <openvino_docs_install_guides_installing_openvino_conan>`


* :doc:`Install OpenVINO using npm <openvino_docs_install_guides_installing_openvino_npm>`

Original file line number Diff line number Diff line change
@@ -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 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 <https://github.com/intel-iot-devkit>`__.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ 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,
:description: Learn how to install OpenVINO™ Runtime on Windows operating
system. You can use an archive, a PyPi package, npm package, Conda Forge,
or a Docker image.


Expand All @@ -20,6 +20,7 @@ Install OpenVINO™ Runtime on Windows
Use vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>
Use Docker <openvino_docs_install_guides_installing_openvino_docker>
Use Conan <openvino_docs_install_guides_installing_openvino_conan>
Use npm <openvino_docs_install_guides_installing_openvino_npm>



Expand All @@ -31,5 +32,5 @@ If you want to install OpenVINO™ Runtime on Windows, you have the following op
* :doc:`Install OpenVINO using vcpkg <openvino_docs_install_guides_installing_openvino_vcpkg>`
* :doc:`Install OpenVINO using Docker <openvino_docs_install_guides_installing_openvino_docker>`
* :doc:`Install OpenVINO using Conan Package Manager <openvino_docs_install_guides_installing_openvino_conan>`

* :doc:`Install OpenVINO using npm <openvino_docs_install_guides_installing_openvino_npm>`

30 changes: 0 additions & 30 deletions docs/sphinx_setup/api/nodejs_api/nodejs_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
#########################

Expand Down

0 comments on commit dfff4e8

Please sign in to comment.