From c2eb5d5dd271ef2a6b73e9b6b86c6d67d826e723 Mon Sep 17 00:00:00 2001 From: yatarkan Date: Thu, 8 Aug 2024 18:55:30 +0400 Subject: [PATCH 1/4] Add build instructions for extra module --- src/docs/BUILD.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/src/docs/BUILD.md b/src/docs/BUILD.md index 548309b7d7..28b517b04e 100644 --- a/src/docs/BUILD.md +++ b/src/docs/BUILD.md @@ -37,6 +37,37 @@ The preferred approach is to build both OpenVINO and OpenVINO GenAI from sources ## Build Instructions +### Build OpenVINO GenAI as OpenVINO Extra Module + +OpenVINO GenAI can be built as an extra module during the OpenVINO build process. This method simplifies the build process by integrating OpenVINO GenAI directly into the OpenVINO build. + +1. Clone OpenVINO repository: + > **NOTE**: The path to the OpenVINO repository is referred as `` throughout the document + ```sh + git clone --recursive https://github.com/openvinotoolkit/openvino.git + ``` +2. Clone OpenVINO GenAI repository: + > **NOTE**: The path to the OpenVINO GenAI repository is referred as `` throughout the document + ```sh + git clone --recursive https://github.com/openvinotoolkit/openvino_genai.git + ``` +3. Create a build directory: + > **NOTE**: The path to the OpenVINO build directory is referred as `` throughout the document + ```sh + mkdir + ``` +4. Configure CMake with OpenVINO extra modules: + ```sh + cmake -DOPENVINO_EXTRA_MODULES= -DCPACK_ARCHIVE_COMPONENT_INSTALL=OFF -S -B + ``` +5. Build OpenVINO with GenAI: + ```sh + cmake --build --target package + ``` + +After the build process completes, you should find the packaged OpenVINO with GenAI in the build directory ``. +Follow the OpenVINO [build instructions](https://github.com/openvinotoolkit/openvino/wiki#how-to-build) and [install instructions](https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/installing.md) for additional information. + ### Build OpenVINO, OpenVINO Tokenizers, and OpenVINO GenAI From Source 1. Build and install OpenVINO from sources following the [instructions](https://github.com/openvinotoolkit/openvino/wiki#how-to-build). From 76fd277932e327e72b0dc4173c9a43c70a0423ce Mon Sep 17 00:00:00 2001 From: yatarkan Date: Thu, 8 Aug 2024 19:38:26 +0400 Subject: [PATCH 2/4] Replace template paths with specific --- src/docs/BUILD.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/docs/BUILD.md b/src/docs/BUILD.md index 28b517b04e..272a556cc8 100644 --- a/src/docs/BUILD.md +++ b/src/docs/BUILD.md @@ -42,30 +42,27 @@ The preferred approach is to build both OpenVINO and OpenVINO GenAI from sources OpenVINO GenAI can be built as an extra module during the OpenVINO build process. This method simplifies the build process by integrating OpenVINO GenAI directly into the OpenVINO build. 1. Clone OpenVINO repository: - > **NOTE**: The path to the OpenVINO repository is referred as `` throughout the document ```sh git clone --recursive https://github.com/openvinotoolkit/openvino.git ``` 2. Clone OpenVINO GenAI repository: - > **NOTE**: The path to the OpenVINO GenAI repository is referred as `` throughout the document ```sh git clone --recursive https://github.com/openvinotoolkit/openvino_genai.git ``` 3. Create a build directory: - > **NOTE**: The path to the OpenVINO build directory is referred as `` throughout the document ```sh - mkdir + mkdir build ``` 4. Configure CMake with OpenVINO extra modules: ```sh - cmake -DOPENVINO_EXTRA_MODULES= -DCPACK_ARCHIVE_COMPONENT_INSTALL=OFF -S -B + cmake -DOPENVINO_EXTRA_MODULES=./openvino_genai -DCPACK_ARCHIVE_COMPONENT_INSTALL=OFF -S ./openvino -B ./build ``` 5. Build OpenVINO with GenAI: ```sh - cmake --build --target package + cmake --build ./build --target package ``` -After the build process completes, you should find the packaged OpenVINO with GenAI in the build directory ``. +After the build process completes, you should find the packaged OpenVINO with GenAI in the build directory. Follow the OpenVINO [build instructions](https://github.com/openvinotoolkit/openvino/wiki#how-to-build) and [install instructions](https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/installing.md) for additional information. ### Build OpenVINO, OpenVINO Tokenizers, and OpenVINO GenAI From Source From d3a72a57177c5f640bd0999ccd87bf0df27c9823 Mon Sep 17 00:00:00 2001 From: yatarkan Date: Thu, 8 Aug 2024 19:49:39 +0400 Subject: [PATCH 3/4] Fix review comments --- src/docs/BUILD.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/src/docs/BUILD.md b/src/docs/BUILD.md index 272a556cc8..668473e9cf 100644 --- a/src/docs/BUILD.md +++ b/src/docs/BUILD.md @@ -49,20 +49,16 @@ OpenVINO GenAI can be built as an extra module during the OpenVINO build process ```sh git clone --recursive https://github.com/openvinotoolkit/openvino_genai.git ``` -3. Create a build directory: - ```sh - mkdir build - ``` -4. Configure CMake with OpenVINO extra modules: +3. Configure CMake with OpenVINO extra modules: ```sh cmake -DOPENVINO_EXTRA_MODULES=./openvino_genai -DCPACK_ARCHIVE_COMPONENT_INSTALL=OFF -S ./openvino -B ./build ``` -5. Build OpenVINO with GenAI: +4. Build OpenVINO with GenAI: ```sh - cmake --build ./build --target package + cmake --build ./build --target package -j ``` -After the build process completes, you should find the packaged OpenVINO with GenAI in the build directory. +After the build process completes, you should find the packaged OpenVINO with GenAI in the `build` directory. Follow the OpenVINO [build instructions](https://github.com/openvinotoolkit/openvino/wiki#how-to-build) and [install instructions](https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/installing.md) for additional information. ### Build OpenVINO, OpenVINO Tokenizers, and OpenVINO GenAI From Source From e02ac5ebd041d1431a2a9260654889ab36d5b51e Mon Sep 17 00:00:00 2001 From: yatarkan Date: Fri, 9 Aug 2024 10:10:18 +0400 Subject: [PATCH 4/4] Merge git clone steps into one --- src/docs/BUILD.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/src/docs/BUILD.md b/src/docs/BUILD.md index 668473e9cf..a86056e3d5 100644 --- a/src/docs/BUILD.md +++ b/src/docs/BUILD.md @@ -41,19 +41,16 @@ The preferred approach is to build both OpenVINO and OpenVINO GenAI from sources OpenVINO GenAI can be built as an extra module during the OpenVINO build process. This method simplifies the build process by integrating OpenVINO GenAI directly into the OpenVINO build. -1. Clone OpenVINO repository: +1. Clone OpenVINO and OpenVINO GenAI repositories: ```sh git clone --recursive https://github.com/openvinotoolkit/openvino.git - ``` -2. Clone OpenVINO GenAI repository: - ```sh git clone --recursive https://github.com/openvinotoolkit/openvino_genai.git ``` -3. Configure CMake with OpenVINO extra modules: +2. Configure CMake with OpenVINO extra modules: ```sh cmake -DOPENVINO_EXTRA_MODULES=./openvino_genai -DCPACK_ARCHIVE_COMPONENT_INSTALL=OFF -S ./openvino -B ./build ``` -4. Build OpenVINO with GenAI: +3. Build OpenVINO archive with GenAI: ```sh cmake --build ./build --target package -j ```