Skip to content

Commit d481f34

Browse files
[DOCS] Updating NodeJS API docs (#26445)
Adding info on: `Model.getOutputElementType`, `Model.clone`, `CompiledModel.getProperty`, `CompiledModel.setProperty`.
1 parent 5807ed4 commit d481f34

20 files changed

+186
-90
lines changed

docs/articles_en/get-started/install-openvino/install-openvino-npm.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Install Intel® Distribution of OpenVINO™ Toolkit from npm Registry
2828
.. tab-item:: Software Requirements
2929
:sync: software-requirements
3030

31-
`Node.js version 20.5.1 and higher <https://nodejs.org/en/download/>`__
31+
`Node.js version 21.0.0 and higher <https://nodejs.org/en/download/>`__
3232

3333

3434
Installing OpenVINO Node.js

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

+11-11
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Enumeration element
1010
f32: number
1111
1212
* **Defined in:**
13-
`addon.ts:580 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L580>`__
13+
`addon.ts:640 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L640>`__
1414

1515

1616
.. rubric:: f64
@@ -22,7 +22,7 @@ Enumeration element
2222
f64: number
2323
2424
* **Defined in:**
25-
`addon.ts:581 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L581>`__
25+
`addon.ts:641 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L641>`__
2626

2727

2828
.. rubric:: i16
@@ -34,7 +34,7 @@ Enumeration element
3434
i16: number
3535
3636
* **Defined in:**
37-
`addon.ts:577 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L577>`__
37+
`addon.ts:637 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L637>`__
3838

3939

4040
.. rubric:: i32
@@ -46,7 +46,7 @@ Enumeration element
4646
i32: number
4747
4848
* **Defined in:**
49-
`addon.ts:578 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L578>`__
49+
`addon.ts:638 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L638>`__
5050

5151

5252
.. rubric:: i64
@@ -58,7 +58,7 @@ Enumeration element
5858
i64: number
5959
6060
* **Defined in:**
61-
`addon.ts:579 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L579>`__
61+
`addon.ts:639 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L639>`__
6262

6363

6464
.. rubric:: i8
@@ -70,7 +70,7 @@ Enumeration element
7070
i8: number
7171
7272
* **Defined in:**
73-
`addon.ts:576 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L576>`__
73+
`addon.ts:636 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L636>`__
7474

7575

7676
.. rubric:: string
@@ -82,7 +82,7 @@ Enumeration element
8282
string: string
8383
8484
* **Defined in:**
85-
`addon.ts:582 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L582>`__
85+
`addon.ts:642 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L642>`__
8686

8787

8888
.. rubric:: u16
@@ -94,7 +94,7 @@ Enumeration element
9494
u16: number
9595
9696
* **Defined in:**
97-
`addon.ts:574 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L574>`__
97+
`addon.ts:634 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L634>`__
9898

9999

100100
.. rubric:: u32
@@ -106,7 +106,7 @@ Enumeration element
106106
u32: number
107107
108108
* **Defined in:**
109-
`addon.ts:573 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L573>`__
109+
`addon.ts:633 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L633>`__
110110

111111

112112
.. rubric:: u64
@@ -118,7 +118,7 @@ Enumeration element
118118
u64: number
119119
120120
* **Defined in:**
121-
`addon.ts:575 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L575>`__
121+
`addon.ts:635 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L635>`__
122122

123123

124124
.. rubric:: u8
@@ -130,5 +130,5 @@ Enumeration element
130130
u8: number
131131
132132
* **Defined in:**
133-
`addon.ts:572 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L572>`__
133+
`addon.ts:632 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L632>`__
134134

docs/sphinx_setup/api/nodejs_api/openvino-node/enums/resizeAlgorithm.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Enumeration resizeAlgorithm
1010
RESIZE_CUBIC: number
1111
1212
- **Defined in:**
13-
`addon.ts:587 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L587>`__
13+
`addon.ts:647 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L647>`__
1414

1515

1616
.. rubric:: RESIZE_LINEAR
@@ -22,7 +22,7 @@ Enumeration resizeAlgorithm
2222
RESIZE_LINEAR: number
2323
2424
- **Defined in:**
25-
`addon.ts:588 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L588>`__
25+
`addon.ts:648 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L648>`__
2626

2727

2828
.. rubric:: RESIZE_NEAREST
@@ -34,5 +34,5 @@ Enumeration resizeAlgorithm
3434
RESIZE_NEAREST: number
3535
3636
- **Defined in:**
37-
`addon.ts:586 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L586>`__
37+
`addon.ts:646 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L646>`__
3838

docs/sphinx_setup/api/nodejs_api/openvino-node/interfaces/CompiledModel.rst

+66-11
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Interface CompiledModel
66
interface CompiledModel {
77
inputs: Output[];
88
outputs: Output[];
9+
getProperty(propertyName): string | number | boolean;
910
createInferRequest(): InferRequest;
1011
exportModelSync(): Buffer;
1112
input(): Output;
@@ -14,13 +15,14 @@ Interface CompiledModel
1415
output(): Output;
1516
output(index): Output;
1617
output(name): Output;
18+
setProperty(properties: {[propertyName: string]: string | number | boolean}): void;
1719
}
1820
1921
CompiledModel represents a model that is compiled for a specific device by applying
2022
multiple optimization transformations, then mapping to compute kernels.
2123

2224
* **Defined in:**
23-
`addon.ts:272 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L272>`__
25+
`addon.ts:303 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L303>`__
2426

2527

2628
Properties
@@ -38,7 +40,7 @@ Properties
3840
It gets all inputs of a compiled model.
3941

4042
- **Defined in:**
41-
`addon.ts:274 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L274>`__
43+
`addon.ts:305 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L305>`__
4244

4345

4446
.. rubric:: outputs
@@ -52,13 +54,37 @@ Properties
5254
It gets all outputs of a compiled model.
5355

5456
- **Defined in:**
55-
`addon.ts:276 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L276>`__
57+
`addon.ts:307 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L307>`__
5658

5759

5860
Methods
5961
#####################
6062

6163

64+
.. rubric:: getProperty
65+
:name: getProperty
66+
67+
*
68+
69+
.. code-block:: ts
70+
71+
getProperty(propertyName): string | number | boolean
72+
73+
It gets the property for the current compiled model.
74+
75+
* **Parameters:**
76+
77+
- propertyName: string
78+
79+
A string to get the property value.
80+
81+
* **Returns:** string | number | boolean
82+
83+
* **Defined in:**
84+
`addon.ts:313 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L313>`__
85+
86+
87+
6288
.. rubric:: createInferRequest
6389
:name: createInferRequest
6490

@@ -73,7 +99,7 @@ Methods
7399
* **Returns:** :doc:`InferRequest <InferRequest>`
74100

75101
- **Defined in:**
76-
`addon.ts:281 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L281>`__
102+
`addon.ts:318 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L318>`__
77103

78104

79105
.. rubric:: exportModelSync
@@ -88,7 +114,7 @@ Methods
88114
* **Returns:** Buffer
89115

90116
- **Defined in:**
91-
`addon.ts:288 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L288>`__
117+
`addon.ts:325 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L325>`__
92118

93119

94120
.. rubric:: input
@@ -107,7 +133,7 @@ Methods
107133
A compiled model input.
108134

109135
* **Defined in:**
110-
`addon.ts:312 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L312>`__
136+
`addon.ts:349 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L349>`__
111137

112138

113139
.. code-block:: ts
@@ -127,7 +153,7 @@ Methods
127153
A compiled model input.
128154

129155
* **Defined in:**
130-
`addon.ts:318 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L318>`__
156+
`addon.ts:355 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L355>`__
131157

132158

133159
.. code-block:: ts
@@ -147,7 +173,7 @@ Methods
147173
A compiled model input.
148174

149175
* **Defined in:**
150-
`addon.ts:324 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L324>`__
176+
`addon.ts:361 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L361>`__
151177

152178

153179
.. rubric:: output
@@ -165,7 +191,7 @@ Methods
165191
A compiled model output.
166192

167193
* **Defined in:**
168-
`addon.ts:294 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L294>`__
194+
`addon.ts:331 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L331>`__
169195

170196

171197
.. code-block:: ts
@@ -189,7 +215,7 @@ Methods
189215
A compiled model output.
190216

191217
* **Defined in:**
192-
`addon.ts:300 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L300>`__
218+
`addon.ts:337 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L337>`__
193219

194220

195221
.. code-block:: ts
@@ -213,5 +239,34 @@ Methods
213239
A compiled model output.
214240

215241
* **Defined in:**
216-
`addon.ts:306 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L306>`__
242+
`addon.ts:343 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L343>`__
243+
244+
245+
.. rubric:: setProperty
246+
247+
*
248+
249+
.. code-block:: ts
250+
251+
setProperty(properties): void
252+
253+
It sets properties for the current compiled model. Properties can be retrieved via
254+
:ref:`CompiledModel.getProperty <getProperty>`
255+
256+
* **Parameters:**
257+
258+
-
259+
260+
.. code-block:: ts
261+
262+
properties: {
263+
[propertyName: string]: string | number | boolean;
264+
}
265+
266+
An object with the key-value pairs (property name, property value).
267+
268+
* **Returns:** void
269+
270+
* **Defined in:**
271+
`addon.ts:368 <https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/node/lib/addon.ts#L368>`__
217272

0 commit comments

Comments
 (0)