natas_hw
/
openvino
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[DOCS] Update nodejs_api with support for string element type (#24441) 

Adding info on support for string element type.
This commit is contained in:
Sebastian Golebiewski 2024-05-10 12:21:35 +02:00 committed by GitHub
parent bb331218e1
commit 5efb76b0e9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 39 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/sphinx_setup/api/nodejs_api/addon.rst
View File

@ -29,7 +29,9 @@ Property addon
PreProcessSteps <./openvino-node/interfaces/PreProcessSteps>
Tensor <./openvino-node/interfaces/Tensor>
TensorConstructor <./openvino-node/interfaces/TensorConstructor>
Dimension <./openvino-node/types/Dimension>
elementTypeString <./openvino-node/types/elementTypeString>
SupportedTypedArray <./openvino-node/types/SupportedTypedArray>
The **openvino-node** package exports ``addon`` which contains the following properties:

32
docs/sphinx_setup/api/nodejs_api/openvino-node/enums/element.rst
View File

@ -10,7 +10,7 @@ Enumeration element
f32: number
* **Defined in:**
`addon.ts:182 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L182>`__
`addon.ts:182 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L183>`__
.. rubric:: f64
@ -22,7 +22,7 @@ Enumeration element
f64: number
* **Defined in:**
`addon.ts:183 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L183>`__
`addon.ts:183 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L184>`__
.. rubric:: i16
@ -34,7 +34,7 @@ Enumeration element
i16: number
* **Defined in:**
`addon.ts:179 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L179>`__
`addon.ts:179 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L180>`__
.. rubric:: i32
@ -46,7 +46,7 @@ Enumeration element
i32: number
* **Defined in:**
`addon.ts:180 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L180>`__
`addon.ts:180 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L181>`__
.. rubric:: i64
@ -58,7 +58,7 @@ Enumeration element
i64: number
* **Defined in:**
`addon.ts:181 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L181>`__
`addon.ts:181 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L182>`__
.. rubric:: i8
@ -70,7 +70,19 @@ Enumeration element
i8: number
* **Defined in:**
`addon.ts:178 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L178>`__
`addon.ts:178 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L179>`__
.. rubric:: string
.. container:: m-4
.. code-block:: ts
string: string
* **Defined in:**
`addon.ts:176 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L185>`__
.. rubric:: u16
@ -82,7 +94,7 @@ Enumeration element
u16: number
* **Defined in:**
`addon.ts:176 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L176>`__
`addon.ts:176 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L177>`__
.. rubric:: u32
@ -94,7 +106,7 @@ Enumeration element
u32: number
* **Defined in:**
`addon.ts:175 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L175>`__
`addon.ts:175 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L176>`__
.. rubric:: u64
@ -106,7 +118,7 @@ Enumeration element
u64: number
* **Defined in:**
`addon.ts:177 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L177>`__
`addon.ts:177 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L178>`__
.. rubric:: u8
@ -118,5 +130,5 @@ Enumeration element
u8: number
* **Defined in:**
`addon.ts:174 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L174>`__
`addon.ts:174 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L175>`__

2
docs/sphinx_setup/api/nodejs_api/openvino-node/types/elementTypeString.rst
View File

@ -3,7 +3,7 @@ Type alias elementTypeString
.. code-block:: ts
elementTypeString: "u8" | "u32" | "u16" | "u64" | "i8" | "i64" | "i32" | "i16" | "f64" | "f32"
elementTypeString: "u8" | "u32" | "u16" | "u64" | "i8" | "i64" | "i32" | "i16" | "f64" | "f32" | "string"
* **Defined in:**
`addon.ts:11 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L11>`__

26
docs/sphinx_setup/index.rst
View File

@ -4,11 +4,11 @@ OpenVINO 2024.2
.. meta::
:google-site-verification: _YqumYQ98cmXUTwtzM_0WIIadtDc6r_TMYGbmGgNvrk
**OpenVINO is an open-source toolkit** for optimizing and deploying deep learning models from cloud
to edge. It accelerates deep learning inference across various use cases, such as generative AI, video,
audio, and language with models from popular frameworks like PyTorch, TensorFlow, ONNX, and more.
Convert and optimize models, and deploy across a mix of Intel® hardware and environments, on-premises
**OpenVINO is an open-source toolkit** for optimizing and deploying deep learning models from cloud
to edge. It accelerates deep learning inference across various use cases, such as generative AI, video,
audio, and language with models from popular frameworks like PyTorch, TensorFlow, ONNX, and more.
Convert and optimize models, and deploy across a mix of Intel® hardware and environments, on-premises
and on-device, in the browser or in the cloud.
Check out the `OpenVINO Cheat Sheet. <https://docs.openvino.ai/2024/_static/download/OpenVINO_Quick_Start_Guide.pdf>`__
@ -38,14 +38,14 @@ Check out the `OpenVINO Cheat Sheet. <https://docs.openvino.ai/2024/_static/down
<p class="ov-homepage-slide-title">OpenVINO via PyTorch 2.0 torch.compile()</p>
<p class="ov-homepage-slide-subtitle">Use OpenVINO directly in PyTorch-native applications!</p>
<a class="ov-homepage-banner-btn" href="https://docs.openvino.ai/2024/openvino-workflow/torch-compile.html">Learn more</a>
</li>
</li>
<li id="ov-homepage-slide4" class="splide__slide">
<p class="ov-homepage-slide-title">Do you like Generative AI?</p>
<p class="ov-homepage-slide-subtitle">You will love how it performs with OpenVINO!</p>
<a class="ov-homepage-banner-btn" href="https://docs.openvino.ai/2024/learn-openvino/interactive-tutorials-python.html">Check out our new notebooks</a>
</li>
<li id="ov-homepage-slide5" id class="splide__slide">
<p class="ov-homepage-slide-title">Boost your AI deep learning interface perfmormance.</p>
<p class="ov-homepage-slide-title">Boost your AI deep learning interface performance.</p>
<p class="ov-homepage-slide-subtitle">Use Intel's open-source OpenVino toolkit for optimizing and deploying deep learning models.</p>
<a class="ov-homepage-banner-btn" href="https://docs.openvino.ai/2024/openvino-workflow/model-preparation/convert-model-pytorch.html">Learn more</a>
</li>
@ -73,9 +73,9 @@ Places to Begin
:img-top: ./_static/images/home_begin_tile_01.png
:class-card: homepage_begin_tile
:shadow: none
This guide introduces installation and learning materials for Intel® Distribution of OpenVINO™ toolkit.
.. button-link:: get-started/install-openvino.html
:color: primary
:outline:
@ -120,7 +120,7 @@ Places to Begin
:outline:
Run Inference
.. grid-item-card:: Serving at scale
:img-top: ./_static/images/home_begin_tile_05.png
:class-card: homepage_begin_tile
@ -138,7 +138,7 @@ Places to Begin
:img-top: ./_static/images/home_begin_tile_06.png
:class-card: homepage_begin_tile
:shadow: none
Reach for performance with post-training and training-time compression with NNCF.
.. button-link:: openvino-workflow/model-optimization.html
@ -169,7 +169,7 @@ Key Features
:shadow: none
Write an application once, deploy it anywhere, achieving maximum performance from hardware. Automatic device discovery allows for superior deployment flexibility. OpenVINO Runtime supports Linux, Windows and MacOS and provides Python, C++ and C API. Use your preferred language and OS.
.. grid-item-card:: Lighter Deployment
:img-top: ./_static/images/home_key_feature_03.png
:class-card: homepage_begin_key
@ -181,7 +181,7 @@ Key Features
:img-top: ./_static/images/home_key_feature_04.png
:class-card: homepage_begin_key
:shadow: none
In applications where fast start-up is required, OpenVINO significantly reduces first-inference latency by using the CPU for initial inference and then switching to another device once the model has been compiled and loaded to memory. Compiled models are cached, improving start-up time even more.