|
1 |
| -# OpenVINO Node.js API |
2 |
| - |
3 |
| -## Components |
4 |
| - |
5 |
| -- [include](./include/) - header files for current API. |
6 |
| -- [lib](./lib/) - TypeScript sources for current API. |
7 |
| -- [src](./src/) - C++ sources for current API. |
8 |
| -- [tests](./tests/) - tests directory for current API. |
9 |
| - |
10 |
| -## Build |
11 |
| - |
12 |
| -- Make sure that all submodules are updated `git submodule update --init --recursive` |
13 |
| -- Create build dir `mkdir build && cd build` |
14 |
| -- Configure binaries building: |
15 |
| - ```bash |
16 |
| - cmake \ |
17 |
| - -DCMAKE_BUILD_TYPE=Release \ |
18 |
| - -DENABLE_FASTER_BUILD=ON \ |
19 |
| - -DCPACK_GENERATOR=NPM \ |
20 |
| - -DENABLE_SYSTEM_TBB=OFF -UTBB* \ |
21 |
| - -DENABLE_TESTS=OFF \ |
22 |
| - -DENABLE_SAMPLES=OFF \ |
23 |
| - -DENABLE_WHEEL=OFF \ |
24 |
| - -DENABLE_PYTHON=OFF \ |
25 |
| - -DENABLE_INTEL_GPU=OFF \ |
26 |
| - -DCMAKE_INSTALL_PREFIX=../src/bindings/js/node/bin \ |
27 |
| - .. |
28 |
| - ``` |
29 |
| -- Build bindings: |
30 |
| - `cmake --build . --config Release --verbose -j4` |
31 |
| -- Install binaries for openvino-node package: |
32 |
| - `cmake --install .` |
33 |
| -- Go to npm package folder `cd ../src/bindings/js/node` |
34 |
| -- Now you can install dependencies packages and transpile ts to js code. Run `npm install` |
35 |
| -- Run tests `npm run test` to make sure that **openvino-node** built successfully |
| 1 | +# OpenVINO™ Node.js Bindings |
| 2 | + |
| 3 | +Use OpenVINO JavaScript API for your Node.js application. |
36 | 4 |
|
37 | 5 | ## Usage
|
38 | 6 |
|
39 |
| -- Add `openvino-node` package in your project, specify in **package.json**: `"openvino-node": "file:*path-to-current-directory*"` |
40 |
| -- Require by: `const ov = require('openvino-node');` |
| 7 | +Install the **openvino-node** package: |
| 8 | +```bash |
| 9 | +npm install openvino-node |
| 10 | +``` |
| 11 | + |
| 12 | +Use the **openvino-node** package: |
| 13 | +```js |
| 14 | +const { addon: ov } = require('openvino-node'); |
| 15 | +``` |
| 16 | + |
| 17 | +## Build From Sources |
| 18 | + |
| 19 | +For more details, refer to the [OpenVINO™ JavaScript API Developer Documentation](https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/js/docs/README.md#openvino-node-package-developer-documentation) |
| 20 | + |
| 21 | +## Documentation & Samples |
| 22 | + |
| 23 | +- [OpenVINO™ Node.js API](https://docs.openvino.ai/2024/api/nodejs_api/nodejs_api.html) |
| 24 | +- [OpenVINO™ Node.js Bindings Examples of Usage](https://github.com/openvinotoolkit/openvino/blob/master/samples/js/node/README.md) |
41 | 25 |
|
42 |
| -## Samples |
| 26 | +## See Also |
43 | 27 |
|
44 |
| -[Samples & notebooks of OpenVINO Node.js API](../../../../samples/js/node/README.md) |
| 28 | +* [OpenVINO™ README](https://github.com/openvinotoolkit/openvino/blob/master/README.md) |
| 29 | +* [OpenVINO™ Core Components](https://github.com/openvinotoolkit/openvino/blob/master/src/README.md) |
| 30 | +* [OpenVINO™ Python API](https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/python/README.md) |
| 31 | +* [OpenVINO™ Other Bindings](https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/README.md) |
45 | 32 |
|
46 |
| -## See also |
| 33 | +[License](https://github.com/openvinotoolkit/openvino/blob/master/LICENSE) |
47 | 34 |
|
48 |
| -* [OpenVINO™ README](../../../../README.md) |
49 |
| -* [OpenVINO™ Core Components](../../../README.md) |
50 |
| -* [OpenVINO™ JavaScript API](../README.md) |
| 35 | +Copyright © 2018-2024 Intel Corporation |
0 commit comments