forked from openvinotoolkit/openvino
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into coverity/fix-issues-in-istreams-executor
- Loading branch information
Showing
107 changed files
with
1,688 additions
and
561 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,10 @@ | ||
# Image Classification Async NodeJS Sample | ||
# Image Classification Async Node.js Sample | ||
|
||
Models with only 1 input and output are supported. | ||
|
||
Run: | ||
`node classification_sample_async.js -m *path_to_model_file* -i *path_to_img1* -i *path_to_img2* -d AUTO` | ||
```bash | ||
node classification_sample_async.js -m *path_to_model_file* -i *path_to_img1* -i *path_to_img2* -d AUTO | ||
``` | ||
|
||
Other details see in /samples/python/classification_sample_async/README.md | ||
Other details see in [../../../python/classification_sample_async/README.md](../../../python/classification_sample_async/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,10 @@ | ||
# Hello Classification NodeJS Sample | ||
# Hello Classification Node.js Sample | ||
|
||
Models with only 1 input and output are supported. | ||
|
||
Run: | ||
`node hello_classification.js *path_to_model_file* *path_to_img* AUTO` | ||
```bash | ||
node hello_classification.js *path_to_model_file* *path_to_img* AUTO | ||
``` | ||
|
||
Other details see in /samples/python/hello_classification/README.md | ||
Other details see in [../../../python/hello_classification/README.md](../../../python/hello_classification/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,11 @@ | ||
# Hello Reshape SSD NodeJS Sample | ||
# Hello Reshape SSD Node.js Sample | ||
|
||
Models with only 1 input and output are supported. | ||
|
||
Run: | ||
`node hello_reshape_ssd.js *path_to_model_file* *path_to_img* AUTO` | ||
```bash | ||
node hello_reshape_ssd.js *path_to_model_file* *path_to_img* AUTO | ||
``` | ||
|
||
Other details see in [../../../python/hello_reshape_ssd/README.md](../../../python/hello_reshape_ssd/README.md) | ||
|
||
Other details see in /samples/python/hello_reshape_ssd/README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
# OpenVINO™ JavaScript API | ||
|
||
- `./node` - openvino-node NPM package with Node.js bindings | ||
- [./node](./node) - **openvino-node** npm package with OpenVINO Node.js bindings |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,83 @@ | ||
# Javascript bindings | ||
# OpenVINO™ JavaScript Bindings | ||
|
||
## Folders | ||
|
||
- `./docs` - documentation | ||
- `./node` - openvino-node NPM package with Node.js bindings | ||
- `./node` - openvino-node npm package | ||
|
||
## openvino-node Package Developer Documentation | ||
|
||
### Components | ||
|
||
- [include](../node/include/) - header files for current API. | ||
- [lib](../node/lib/) - TypeScript sources for current API. | ||
- [src](../node/src/) - C++ sources for current API. | ||
- [tests](../node/tests/) - tests directory for current API. | ||
|
||
### Build | ||
|
||
- Make sure that all submodules are updated: | ||
```bash | ||
git submodule update --init --recursive | ||
``` | ||
- Create the *build* directory: | ||
```bash | ||
mkdir build && cd build | ||
``` | ||
- Configure building of the binaries: | ||
```bash | ||
cmake \ | ||
-DCMAKE_BUILD_TYPE=Release \ | ||
-DENABLE_FASTER_BUILD=ON \ | ||
-DCPACK_GENERATOR=NPM \ | ||
-DENABLE_SYSTEM_TBB=OFF -UTBB* \ | ||
-DENABLE_TESTS=OFF \ | ||
-DENABLE_SAMPLES=OFF \ | ||
-DENABLE_WHEEL=OFF \ | ||
-DENABLE_PYTHON=OFF \ | ||
-DENABLE_INTEL_GPU=OFF \ | ||
-DCMAKE_INSTALL_PREFIX=../src/bindings/js/node/bin \ | ||
.. | ||
``` | ||
- Build the bindings: | ||
```bash | ||
cmake --build . --config Release --verbose -j4 | ||
``` | ||
- Install binaries for the *openvino-node* package: | ||
```bash | ||
cmake --install . | ||
``` | ||
- Navigate to the *npm* package folder: | ||
```bash | ||
cd ../src/bindings/js/node | ||
``` | ||
- Now, you can install dependencies packages and transpile ts to js code: | ||
```bash | ||
npm install | ||
``` | ||
- Run tests to make sure that **openvino-node** has been built successfully: | ||
```bash | ||
npm run test | ||
``` | ||
|
||
## Usage | ||
|
||
- Add the **openvino-node** package to your project by specifying it in **package.json**: | ||
```json | ||
"openvino-node": "file:*path-to-current-directory*" | ||
``` | ||
- Make sure to require it: | ||
```js | ||
const { addon: ov } = require('openvino-node'); | ||
``` | ||
|
||
## Samples | ||
|
||
[OpenVINO™ Node.js Bindings Examples of Usage](../../../../samples/js/node/README.md) | ||
|
||
## See Also | ||
|
||
* [OpenVINO™ README](../../../../README.md) | ||
* [OpenVINO™ Core Components](../../../README.md) | ||
* [OpenVINO™ JavaScript API](../README.md) | ||
* [OpenVINO™ Node.js Bindings](../node/README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,7 @@ include | |
lib | ||
src | ||
tests | ||
thirdparty | ||
|
||
.eslintrc.js | ||
CMakeLists.txt | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,50 +1,35 @@ | ||
# OpenVINO Node.js API | ||
|
||
## Components | ||
|
||
- [include](./include/) - header files for current API. | ||
- [lib](./lib/) - TypeScript sources for current API. | ||
- [src](./src/) - C++ sources for current API. | ||
- [tests](./tests/) - tests directory for current API. | ||
|
||
## Build | ||
|
||
- Make sure that all submodules are updated `git submodule update --init --recursive` | ||
- Create build dir `mkdir build && cd build` | ||
- Configure binaries building: | ||
```bash | ||
cmake \ | ||
-DCMAKE_BUILD_TYPE=Release \ | ||
-DENABLE_FASTER_BUILD=ON \ | ||
-DCPACK_GENERATOR=NPM \ | ||
-DENABLE_SYSTEM_TBB=OFF -UTBB* \ | ||
-DENABLE_TESTS=OFF \ | ||
-DENABLE_SAMPLES=OFF \ | ||
-DENABLE_WHEEL=OFF \ | ||
-DENABLE_PYTHON=OFF \ | ||
-DENABLE_INTEL_GPU=OFF \ | ||
-DCMAKE_INSTALL_PREFIX=../src/bindings/js/node/bin \ | ||
.. | ||
``` | ||
- Build bindings: | ||
`cmake --build . --config Release --verbose -j4` | ||
- Install binaries for openvino-node package: | ||
`cmake --install .` | ||
- Go to npm package folder `cd ../src/bindings/js/node` | ||
- Now you can install dependencies packages and transpile ts to js code. Run `npm install` | ||
- Run tests `npm run test` to make sure that **openvino-node** built successfully | ||
# OpenVINO™ Node.js Bindings | ||
|
||
Use OpenVINO JavaScript API for your Node.js application. | ||
|
||
## Usage | ||
|
||
- Add `openvino-node` package in your project, specify in **package.json**: `"openvino-node": "file:*path-to-current-directory*"` | ||
- Require by: `const ov = require('openvino-node');` | ||
Install the **openvino-node** package: | ||
```bash | ||
npm install openvino-node | ||
``` | ||
|
||
Use the **openvino-node** package: | ||
```js | ||
const { addon: ov } = require('openvino-node'); | ||
``` | ||
|
||
## Build From Sources | ||
|
||
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) | ||
|
||
## Documentation & Samples | ||
|
||
- [OpenVINO™ Node.js API](https://docs.openvino.ai/2024/api/nodejs_api/nodejs_api.html) | ||
- [OpenVINO™ Node.js Bindings Examples of Usage](https://github.com/openvinotoolkit/openvino/blob/master/samples/js/node/README.md) | ||
|
||
## Samples | ||
## See Also | ||
|
||
[Samples & notebooks of OpenVINO Node.js API](../../../../samples/js/node/README.md) | ||
* [OpenVINO™ README](https://github.com/openvinotoolkit/openvino/blob/master/README.md) | ||
* [OpenVINO™ Core Components](https://github.com/openvinotoolkit/openvino/blob/master/src/README.md) | ||
* [OpenVINO™ Python API](https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/python/README.md) | ||
* [OpenVINO™ Other Bindings](https://github.com/openvinotoolkit/openvino/blob/master/src/bindings/README.md) | ||
|
||
## See also | ||
[License](https://github.com/openvinotoolkit/openvino/blob/master/LICENSE) | ||
|
||
* [OpenVINO™ README](../../../../README.md) | ||
* [OpenVINO™ Core Components](../../../README.md) | ||
* [OpenVINO™ JavaScript API](../README.md) | ||
Copyright © 2018-2024 Intel Corporation |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.