Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Driver Compiler documents #39

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Update Driver Compiler documents #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f268319
update Driver Compiler doc for linux open source
DanLiu2Intel Oct 12, 2024
9c521e1
remove unused part
DanLiu2Intel Nov 26, 2024
4714d35
update tbb part
DanLiu2Intel Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 70 additions & 43 deletions CMakePresets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@
},

{
"name": "Cid",
"name": "cid",
"hidden": true,
"description": "Cid build necessary options. Please note the path of NPU plugin when use.",
"cacheVariables": {
Expand All @@ -233,86 +233,113 @@
}
},
{
"name": "NpuCidRelease",
"description": "Default configuration for NPU Driver Compiler target build. Please note: 1) Please make sure that NPU_PLUGIN_HOME environment variable is set to NPU plugin path. 2) build Cid is a static build which only build related targets and not include other unrelated options and targets to avoid getting big generated files.",
"name": "npuCidReleaseLinux",
"description": "Default configuration for NPU Driver Compiler target build on Linux. Please note: 1) Please make sure that NPU_PLUGIN_HOME environment variable is set to NPU plugin path. 2) build Cid is a static build which only build related targets and not include other unrelated options and targets to avoid getting big generated files.",
"binaryDir": "${sourceDir}/build-x86_64/Release",
"displayName": "NpuCidRelease",
"inherits": ["Cid", "BuildOptimization", "Disabler"],
"displayName": "npuCidRelease",
"inherits": ["cid", "BuildOptimization", "Disabler"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": {
"type": "STRING",
"value": "Release"
},

"ENABLE_MULTI": false,
"ENABLE_AUTO": false,
"ENABLE_AUTO_BATCH": false,
"ENABLE_PROXY": false,
"ENABLE_HETERO": false,
"ENABLE_INTEL_CPU": false,
"ENABLE_INTEL_GPU": false,
"ENABLE_TEMPLATE": false,
"ENABLE_LTO": false,
"ENABLE_FASTER_BUILD": false,
"ENABLE_CPPLINT": false,

"ENABLE_TESTS": false,
"ENABLE_FUNCTIONAL_TESTS": false,
"ENABLE_SAMPLES": false,

"ENABLE_JS": false,

"ENABLE_PYTHON": false,
"ENABLE_PYTHON_PACKAGING": false,
"ENABLE_WHEEL": false,

"ENABLE_OV_ONNX_FRONTEND": false,
"ENABLE_OV_PADDLE_FRONTEND": false,
"ENABLE_OV_PYTORCH_FRONTEND": false,
"ENABLE_OV_TF_FRONTEND": false,
"ENABLE_OV_TF_LITE_FRONTEND": false,
"ENABLE_OV_JAX_FRONTEND": false,

"ENABLE_SYSTEM_TBB": false,
"ENABLE_TBB_RELEASE_ONLY": false,
"ENABLE_OPENCV": false,

"ENABLE_BLOB_DUMP": false,
"ENABLE_TESTS": false,
"ENABLE_FUNCTIONAL_TESTS": false,
"ENABLE_MULTI": false,
"ENABLE_AUTO": false,
"ENABLE_AUTO_BATCH": false,
"ENABLE_PROXY": false,
"ENABLE_HETERO": false,
"ENABLE_INTEL_CPU": false,
"ENABLE_INTEL_GPU": false,
"ENABLE_TEMPLATE": false,

"ENABLE_SYSTEM_TBB": false,
"ENABLE_TBB_RELEASE_ONLY": false,
"ENABLE_JS": false,
"ENABLE_NPU_PROTOPIPE": false
"ENABLE_ZEROAPI_BACKEND": false,
"ENABLE_DRIVER_COMPILER_ADAPTER": false,
"ENABLE_INTEL_NPU_INTERNAL": false,

"ENABLE_NPU_PROTOPIPE": false,
"ENABLE_NPU_LSP_SERVER":false
}
},
{
"name": "ovNpuCidRelease",
"description": "Default configuration for NPU Driver Compiler target build. Please note: 1) it builds NPU plugin in OpenVINO project tree. Please make sure that NPU plugin is located inside OpenVINO repo in modules/vpux folder. 2) build Cid is a static build which only build related targets and not include other unrelated options and targets to avoid getting big generated files.",
"name": "npuCidReleaseWindows",
"description": "Default configuration for NPU Driver Compiler target build on Windows. Please note: 1) Please make sure that NPU_PLUGIN_HOME environment variable is set to NPU plugin path. 2) build Cid is a static build which only build related targets and not include other unrelated options and targets to avoid getting big generated files.",
"binaryDir": "${sourceDir}/build-x86_64/Release",
"displayName": "ovNpuCidRelease",
"inherits": ["Cid", "BuildOptimization", "Disabler"],
"displayName": "npuCidRelease",
"inherits": ["cid", "BuildOptimization", "Disabler"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": {
"type": "STRING",
"value": "Release"
},

"ENABLE_MULTI": false,
"ENABLE_AUTO": false,
"ENABLE_AUTO_BATCH": false,
"ENABLE_PROXY": false,
"ENABLE_HETERO": false,
"ENABLE_INTEL_CPU": false,
"ENABLE_INTEL_GPU": false,
"ENABLE_TEMPLATE": false,
"CMAKE_TOOLCHAIN_FILE":"${sourceDir}\\cmake\\toolchains\\onecoreuap.toolchain.cmake",

"ENABLE_LTO": false,
"ENABLE_FASTER_BUILD": false,
"ENABLE_CPPLINT": false,

"ENABLE_TESTS": false,
"ENABLE_FUNCTIONAL_TESTS": false,
"ENABLE_SAMPLES": false,

"ENABLE_JS": false,

"ENABLE_PYTHON": false,
"ENABLE_PYTHON_PACKAGING": false,
"ENABLE_WHEEL": false,

"ENABLE_OV_ONNX_FRONTEND": false,
"ENABLE_OV_PADDLE_FRONTEND": false,
"ENABLE_OV_PYTORCH_FRONTEND": false,
"ENABLE_OV_TF_FRONTEND": false,
"ENABLE_OV_TF_LITE_FRONTEND": false,
"ENABLE_OV_JAX_FRONTEND": false,

"ENABLE_SYSTEM_TBB": false,
"ENABLE_TBB_RELEASE_ONLY": false,
"ENABLE_OPENCV": false,

"ENABLE_BLOB_DUMP": false,
"ENABLE_TESTS": false,
"ENABLE_FUNCTIONAL_TESTS": false,
"ENABLE_MULTI": false,
"ENABLE_AUTO": false,
"ENABLE_AUTO_BATCH": false,
"ENABLE_PROXY": false,
"ENABLE_HETERO": false,
"ENABLE_INTEL_CPU": false,
"ENABLE_INTEL_GPU": false,
"ENABLE_TEMPLATE": false,

"ENABLE_SYSTEM_TBB": false,
"ENABLE_TBB_RELEASE_ONLY": false,
"ENABLE_JS": false,
"ENABLE_NPU_PROTOPIPE": false,
"ENABLE_ZEROAPI_BACKEND": false,
"ENABLE_DRIVER_COMPILER_ADAPTER": false,
"ENABLE_INTEL_NPU_INTERNAL": false,

"OPENVINO_EXTRA_MODULES": {
"type": "FILEPATH",
"value": "./modules/vpux"
}
"ENABLE_NPU_PROTOPIPE": false,
"ENABLE_NPU_LSP_SERVER":false
}
},
{
Expand Down
26 changes: 7 additions & 19 deletions src/vpux_driver_compiler/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,27 +59,15 @@ vclCompilerDestroy

## How to build related targets locally

Driver Compiler provides npu_driver_compiler, compilerTest, profilingTest and loaderTest to compile network and test. To build Driver Compiler related targets locally, refer to [How to build driver compiler](./docs/how_to_build_driver_compiler.md).
Driver Compiler provides npu_driver_compiler, compilerTest, profilingTest and loaderTest to compile network and test. To build Driver Compiler related targets locally, refer to

- (Recommended) build using CMake Presets, requiring CMake version 3.19 or higher.
- [linux](./docs/how_to_build_driver_compiler_withCmakePresets_on_linux.md)
- [windows](./docs/how_to_build_driver_compiler_withCmakePresets_on_windows.md)

## How to release Driver Compiler package

Unlike local build of Driver Compiler related targets, we need to apply some patches to [OpenVINO Project] and [NPU-Plugin Project] and also pack the elf, pdb and tbb files together to meet driver requirements.

To get more info about Driver Compiler package, refer to [introduction of Driver Compiler package](https://github.com/intel-innersource/applications.ai.vpu-accelerators.flex-cid-tools/blob/develop/docs/introductio-of-driver_compiler_package.md) in [CiD project] repo.

To build Driver Compiler package, refer to [How to Release Driver Compiler package.md](https://github.com/intel-innersource/applications.ai.vpu-accelerators.flex-cid-tools/blob/develop/docs/how-to-release-package.md) in [CiD project] repo.


## How to test

Please refer to [How to test](./docs/how_to_test.md).


## How to debug

Please refer to [How to debug](./docs/how_to_debug.md).
- build with cmake options
- [linux](./docs/how_to_build_driver_compiler_on_linux.md)
- [windows](./docs/how_to_build_driver_compiler_on_windows.md)

[OpenVINO Project]: https://github.com/openvinotoolkit/openvino
[NPU-Plugin Project]: https://github.com/intel-innersource/applications.ai.vpu-accelerators.vpux-plugin
[CiD Project]: https://github.com/intel-innersource/applications.ai.vpu-accelerators.flex-cid-tools
Loading