archive

Author: Wovchena

.gitignore

@@ -1,5 +1,5 @@
 # They are copied to python folder during the build to allow skipping wheel installation
-src/python/openvino_genai/*generate_pipeline_lib*
+src/python/openvino_genai/*genai*
 src/python/openvino_genai/py_generate_pipeline*
 
 # build/artifact dirs

CMakeLists.txt

@@ -10,5 +10,14 @@ set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Release" "Debug" "RelWithD
 project(openvino_genai)
 
 add_subdirectory(./thirdparty/openvino_tokenizers/ "${CMAKE_CURRENT_BINARY_DIR}/openvino_tokenizers/")
+set(openvino_genai_VERSION 2024.1.0.0)
 add_subdirectory(src)
 add_subdirectory(text_generation/causal_lm/cpp)
+
+install(DIRECTORY text_generation/causal_lm/cpp/ DESTINATION samples/cpp/causal_lm COMPONENT cpp_samples_genai)
+
+install(FILES LICENSE third-party-programs.txt DESTINATION licenses_genai COMPONENT licensing_genai)  # TODO: how to merge with OPenvino
+
+set(CPACK_PACKAGE_VERSION ${openvino_genai_VERSION})
+set(CPACK_GENERATOR "ZIP")
+include(CPack)

pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
 [tool.scikit-build]
 cmake.source-dir = "./"
 cmake.build-type = "Release"
-cmake.targets = ["py_generate_pipeline", "generate_pipeline_lib"]
+cmake.targets = ["py_generate_pipeline", "genai"]
 install.components = ["genai", "genai_python"]
 sdist.cmake = true
 wheel.packages = ["src/python/openvino_genai"]

src/cpp/CMakeLists.txt

@@ -44,25 +44,68 @@ ov_genai_build_jinja2cpp()
 
 file(GLOB SOURCE_FILES "${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp")
 
-set(TARGET_NAME generate_pipeline_lib)
+set(TARGET_NAME genai)
 add_library(${TARGET_NAME} SHARED ${SOURCE_FILES})
 
 target_include_directories(${TARGET_NAME}
     # TODO: remove it, because beam_search algo should not be exposed to end users
-    PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/../../text_generation/causal_lm/cpp/
-    PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
+    PRIVATE "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../../text_generation/causal_lm/cpp/>"
+    PUBLIC "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>")
 
 target_link_libraries(${TARGET_NAME} PUBLIC openvino::runtime PRIVATE nlohmann_json::nlohmann_json jinja2cpp)
 
 target_compile_definitions(${TARGET_NAME} PRIVATE OPENVINO_TOKENIZERS_PATH=\"$<TARGET_FILE:openvino_tokenizers>\")
 
 target_compile_features(${TARGET_NAME} PUBLIC cxx_std_17)
 
-install(TARGETS ${TARGET_NAME} LIBRARY DESTINATION . COMPONENT genai RUNTIME DESTINATION . COMPONENT genai)
+install(TARGETS ${TARGET_NAME} LIBRARY DESTINATION . COMPONENT core_genai RUNTIME DESTINATION . COMPONENT core_genai)
 
 # Populate python with the libraries to allow skipping wheel installation
-add_custom_command(TARGET generate_pipeline_lib POST_BUILD
+add_custom_command(TARGET genai POST_BUILD
     COMMAND "${CMAKE_COMMAND}" -E copy
-        "$<TARGET_FILE:generate_pipeline_lib>"
-        "${CMAKE_CURRENT_SOURCE_DIR}/../python/openvino_genai/$<TARGET_FILE_NAME:generate_pipeline_lib>"
-    COMMENT "Copy generate_pipeline_lib to src/python/openvino_genai")
+        "$<TARGET_FILE:genai>"
+        "${CMAKE_CURRENT_SOURCE_DIR}/../python/openvino_genai/$<TARGET_FILE_NAME:genai>"
+    COMMENT "Copy genai to src/python/openvino_genai")
+
+export(TARGETS genai NAMESPACE openvino:: FILE "${CMAKE_BINARY_DIR}/openvino_genaiConfig.cmake")  # TODO: try to merge
+install(TARGETS ${TARGET_NAME} LIBRARY DESTINATION . COMPONENT core_genai RUNTIME DESTINATION . COMPONENT core_genai)
+
+include(GenerateExportHeader)
+
+generate_export_header(genai)
+set_property(TARGET genai PROPERTY VERSION ${openvino_genai_VERSION})
+set_property(TARGET genai PROPERTY SOVERSION 3)
+set_property(TARGET genai PROPERTY INTERFACE_genai_MAJOR_VERSION 3)
+set_property(TARGET genai APPEND PROPERTY COMPATIBLE_INTERFACE_STRING genai_MAJOR_VERSION)
+
+string(TOLOWER "${CMAKE_SYSTEM_PROCESSOR}" ARCH_FOLDER)
+if(X86_64)
+    set(ARCH_FOLDER intel64)
+elseif(X86)
+    set(ARCH_FOLDER ia32)
+elseif(MSVC AND ARM)
+    set(ARCH_FOLDER arm)
+elseif((MSVC OR APPLE) AND AARCH64)
+    set(ARCH_FOLDER arm64)
+elseif(UNIVERSAL2)
+    set(ARCH_FOLDER universal2)
+elseif(ARCH_FOLDER STREQUAL "x86_64" OR ARCH_FOLDER STREQUAL "amd64" # Windows detects Intel's 64-bit CPU as AMD64
+        OR CMAKE_OSX_ARCHITECTURES STREQUAL "x86_64")
+    set(ARCH_FOLDER intel64)
+endif()
+install(TARGETS genai EXPORT openvino_genaiTargets
+    LIBRARY DESTINATION runtime/lib/${ARCH_FOLDER}/${CMAKE_BUILD_TYPE} COMPONENT core_genai_dev
+    ARCHIVE DESTINATION runtime/lib/${ARCH_FOLDER}/${CMAKE_BUILD_TYPE} COMPONENT core_genai_dev
+    RUNTIME DESTINATION runtime/bin/${ARCH_FOLDER}/${CMAKE_BUILD_TYPE} COMPONENT core_genai_dev
+    INCLUDES DESTINATION runtime/include)
+install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/include/" DESTINATION runtime/include COMPONENT core_genai_dev)
+
+include(CMakePackageConfigHelpers)
+write_basic_package_version_file("${CMAKE_BINARY_DIR}/openvino_genaiConfigVersion.cmake" VERSION ${openvino_genai_VERSION} COMPATIBILITY AnyNewerVersion)
+
+export(EXPORT openvino_genaiTargets FILE "${CMAKE_BINARY_DIR}/openvino_genaiTargets.cmake" NAMESPACE openvino::)
+configure_file(cmake/openvino_genaiConfig.cmake "${CMAKE_BINARY_DIR}/openvino_genaiConfig.cmake" COPYONLY)
+
+install(EXPORT openvino_genaiTargets FILE openvino_genaiTargets.cmake NAMESPACE openvino:: DESTINATION runtime/cmake)
+install(FILES cmake/openvino_genaiConfig.cmake "${CMAKE_BINARY_DIR}/openvino_genaiConfigVersion.cmake"
+    DESTINATION runtime/cmake COMPONENT core_genai_dev)

src/cpp/cmake/openvino_genaiConfig.cmake

@@ -0,0 +1,4 @@
+include(CMakeFindDependencyMacro)
+find_dependency(OpenVINO COMPONENTS Runtime)
+
+include("${CMAKE_CURRENT_LIST_DIR}/openvino_genaiTargets.cmake")

src/cpp/include/openvino/genai/generation_config.hpp src/cpp/include/openvino_genai/generation_config.hpp

@@ -9,7 +9,7 @@
 
 #include "openvino/runtime/compiled_model.hpp"
 #include "openvino/runtime/infer_request.hpp"
-#include "openvino/genai/tokenizer.hpp"
+#include "openvino_genai/tokenizer.hpp"
 
 namespace ov {
 

src/cpp/include/openvino/genai/llm_pipeline.hpp src/cpp/include/openvino_genai/llm_pipeline.hpp

@@ -7,9 +7,9 @@
 #include <variant>
 
 #include <openvino/core/any.hpp>
-#include "openvino/genai/generation_config.hpp"
-#include "openvino/genai/tokenizer.hpp"
-#include "openvino/genai/streamer_base.hpp"
+#include "openvino_genai/generation_config.hpp"
+#include "openvino_genai/tokenizer.hpp"
+#include "openvino_genai/streamer_base.hpp"
 
 namespace ov {
 

src/cpp/include/openvino/genai/streamer_base.hpp src/cpp/include/openvino_genai/streamer_base.hpp

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "openvino/genai/tokenizer.hpp"
+#include "openvino_genai/tokenizer.hpp"
 
 namespace ov {
 

src/cpp/include/openvino/genai/tokenizer.hpp src/cpp/include/openvino_genai/tokenizer.hpp

@@ -7,14 +7,14 @@
 #include <vector>
 #include <initializer_list>
 #include <openvino/runtime/tensor.hpp>
-#include "openvino/genai/visibility.hpp"
+#include "openvino_genai/visibility.hpp"
 
 namespace ov {
 
 /**
 * @brief class is used to encode prompts and decode resulting tokens
 */
-class OPENVINO_GENAI_EXPORTS Tokenizer {
+class openvino_genai_EXPORTS Tokenizer {
 public:
     /**
     * @brief ov::Tokenizer constructor.

src/cpp/include/openvino/genai/visibility.hpp src/cpp/include/openvino_genai/visibility.hpp

@@ -7,7 +7,7 @@
 #include <nlohmann/json.hpp>
 #include <openvino/runtime/core.hpp>
 
-#include "openvino/genai/generation_config.hpp"
+#include "openvino_genai/generation_config.hpp"
 
 #include "generation_config_helper.hpp"
 

src/cpp/src/generation_config.cpp

@@ -3,7 +3,7 @@
 
 #pragma once
 
-#include "openvino/genai/generation_config.hpp"
+#include "openvino_genai/generation_config.hpp"
 
 namespace ov {
 

src/cpp/src/generation_config_helper.hpp

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "generation_config_helper.hpp"
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 #include "utils.hpp"
 
 namespace ov {

src/cpp/src/greedy_decoding.cpp

@@ -4,8 +4,8 @@
 #pragma once
 
 #include <openvino/runtime/tensor.hpp>
-#include "openvino/genai/generation_config.hpp"
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/generation_config.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 
 namespace ov {
     EncodedResults beam_search(ov::InferRequest& lm, ov::Tensor prompts, ov::Tensor attentin_mask, GenerationConfig sampling_params);

src/cpp/src/group_beam_searcher.hpp

@@ -10,8 +10,8 @@
 #include <jinja2cpp/template_env.h>
 
 #include <openvino/openvino.hpp>
-#include "openvino/genai/generation_config.hpp"
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/generation_config.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 #include "utils.hpp"
 #include "generation_config_helper.hpp"
 #include "group_beam_searcher.hpp"

src/cpp/src/llm_pipeline.cpp

@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 #pragma once
 
-#include "openvino/genai/streamer_base.hpp"
-#include "openvino/genai/tokenizer.hpp"
+#include "openvino_genai/streamer_base.hpp"
+#include "openvino_genai/tokenizer.hpp"
 
 namespace ov {
 

src/cpp/src/text_callback_streamer.hpp

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <openvino/openvino.hpp>
-#include "openvino/genai/tokenizer.hpp"
+#include "openvino_genai/tokenizer.hpp"
 #include "utils.hpp"
 
 namespace {

src/cpp/src/tokenizer.cpp

@@ -16,16 +16,17 @@ if(NOT pybind11_POPULATED)
 endif()
 
 pybind11_add_module(py_generate_pipeline py_generate_pipeline.cpp)
-target_link_libraries(py_generate_pipeline PRIVATE generate_pipeline_lib)
+target_link_libraries(py_generate_pipeline PRIVATE openvino_genai)
 
-install(TARGETS py_generate_pipeline LIBRARY DESTINATION . COMPONENT genai_python)
+# find_package(Python3 REQUIRED COMPONENTS Interpreter Development)
+install(TARGETS py_generate_pipeline LIBRARY DESTINATION . COMPONENT pygenai_${Python_VERSION_MAJOR}_${Python_VERSION_MINOR})
 
 # setting RPATH / LC_RPATH depending on platform
 if(LINUX)
-    # to find libgenerate_pipeline_lib.so in the same folder
+    # to find libgenai.so in the same folder
     set(rpaths "$ORIGIN")
 elseif(APPLE)
-    # to find libgenerate_pipeline_lib.dylib in the same folder
+    # to find libgenai.dylib in the same folder
     set(rpaths "@loader_path")
     if(DEFINED SKBUILD)
         # in case we build pip package, we need to refer to libopenvino.dylib from 'openvino' package

src/python/CMakeLists.txt

@@ -4,7 +4,7 @@
 #include <pybind11/pybind11.h>
 #include <pybind11/stl.h>
 #include <pybind11/functional.h>
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 
 namespace py = pybind11;
 using namespace ov;

src/python/py_generate_pipeline.cpp

@@ -4,23 +4,31 @@
 cmake_minimum_required(VERSION 3.15)
 project(causal_lm)
 
-if(NOT TARGET openvino_tokenizers)
-add_subdirectory(../../../thirdparty/openvino_tokenizers/ "${CMAKE_CURRENT_BINARY_DIR}/openvino_tokenizers/")
+if(TARGET openvino_tokenizers)
+    set(OPENVINO_TOKENIZERS_PATH $<TARGET_FILE:openvino_tokenizers>)
+else()
+    set(OPENVINO_TOKENIZERS_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../../bin/openvino_tokenizers.dll)  # TODO: I'll go away after the generate() gets a way to find openvino_tokenizers
 endif()
 
+if(openvino_genai_SOURCE_DIR)
+    set(openvino_genai_DIR "${CMAKE_BINARY_DIR}")
+endif()
+
+find_package(openvino_genai REQUIRED)
+
 add_executable(greedy_causal_lm greedy_causal_lm.cpp)
-target_compile_definitions(greedy_causal_lm PRIVATE OPENVINO_TOKENIZERS_PATH=\"$<TARGET_FILE:openvino_tokenizers>\")
-target_link_libraries(greedy_causal_lm PRIVATE generate_pipeline_lib)
+target_compile_definitions(greedy_causal_lm PRIVATE OPENVINO_TOKENIZERS_PATH="${OPENVINO_TOKENIZERS_PATH}")
+target_link_libraries(greedy_causal_lm PRIVATE openvino::genai)
 set_target_properties(greedy_causal_lm PROPERTIES CXX_STANDARD 17)
 set_target_properties(greedy_causal_lm PROPERTIES CXX_STANDARD_REQUIRED ON)
 
 add_executable(beam_search_causal_lm beam_search_causal_lm.cpp)
-target_link_libraries(beam_search_causal_lm PRIVATE generate_pipeline_lib)
+target_link_libraries(beam_search_causal_lm PRIVATE openvino::genai)
 set_target_properties(beam_search_causal_lm PROPERTIES CXX_STANDARD 17)
 set_target_properties(beam_search_causal_lm PROPERTIES CXX_STANDARD_REQUIRED ON)
 
 add_executable(speculative_decoding_lm speculative_decoding_lm.cpp)
-target_compile_definitions(speculative_decoding_lm PRIVATE OPENVINO_TOKENIZERS_PATH=\"$<TARGET_FILE:openvino_tokenizers>\")
+target_compile_definitions(speculative_decoding_lm PRIVATE OPENVINO_TOKENIZERS_PATH="${OPENVINO_TOKENIZERS_PATH}")
 target_include_directories(speculative_decoding_lm PRIVATE ./)
 find_package(OpenVINO REQUIRED COMPONENTS Runtime)
 target_link_libraries(speculative_decoding_lm PRIVATE openvino::runtime)
@@ -30,7 +38,7 @@ find_package(TBB REQUIRED COMPONENTS tbb)
 target_link_libraries(speculative_decoding_lm PRIVATE TBB::tbb)
 
 add_executable(prompt_lookup_decoding_lm prompt_lookup_decoding_lm.cpp)
-target_compile_definitions(prompt_lookup_decoding_lm PRIVATE OPENVINO_TOKENIZERS_PATH=\"$<TARGET_FILE:openvino_tokenizers>\")
+target_compile_definitions(prompt_lookup_decoding_lm PRIVATE OPENVINO_TOKENIZERS_PATH="${OPENVINO_TOKENIZERS_PATH}")
 target_include_directories(prompt_lookup_decoding_lm PRIVATE ./)
 find_package(OpenVINO REQUIRED COMPONENTS Runtime)
 target_link_libraries(prompt_lookup_decoding_lm PRIVATE openvino::runtime)
@@ -40,13 +48,13 @@ find_package(TBB REQUIRED COMPONENTS tbb)
 target_link_libraries(prompt_lookup_decoding_lm PRIVATE TBB::tbb)
 
 add_executable(generate_sample generate_pipeline/generate_sample.cpp)
-target_link_libraries(generate_sample PRIVATE generate_pipeline_lib)
+target_link_libraries(generate_sample PRIVATE openvino::genai)
 target_include_directories(generate_sample PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}")
 set_target_properties(generate_sample PROPERTIES CXX_STANDARD 17)
 set_target_properties(generate_sample PROPERTIES CXX_STANDARD_REQUIRED ON)
 
 add_executable(chat_sample generate_pipeline/chat_sample.cpp)
-target_link_libraries(chat_sample PRIVATE generate_pipeline_lib)
+target_link_libraries(chat_sample PRIVATE openvino::genai)
 target_include_directories(chat_sample PRIVATE "${CMAKE_CURRENT_SOURCE_DIR}")
 set_target_properties(chat_sample PROPERTIES CXX_STANDARD 17)
 set_target_properties(chat_sample PROPERTIES CXX_STANDARD_REQUIRED ON)

text_generation/causal_lm/cpp/CMakeLists.txt

@@ -1,7 +1,7 @@
 // Copyright (C) 2023-2024 Intel Corporation
 // SPDX-License-Identifier: Apache-2.0
 
-#include <openvino/genai/llm_pipeline.hpp>
+#include <openvino_genai/llm_pipeline.hpp>
 
 int main(int argc, char* argv[]) try {
     if (argc < 3) {

text_generation/causal_lm/cpp/beam_search_causal_lm.cpp

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <openvino/openvino.hpp>
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 
 using namespace std;
 

text_generation/causal_lm/cpp/generate_pipeline/chat_sample.cpp

@@ -1,7 +1,7 @@
 // Copyright (C) 2023-2024 Intel Corporation
 // SPDX-License-Identifier: Apache-2.0
 
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 
 using std::cout;
 using std::endl;

text_generation/causal_lm/cpp/generate_pipeline/generate_sample.cpp

@@ -1,7 +1,7 @@
 // Copyright (C) 2023-2024 Intel Corporation
 // SPDX-License-Identifier: Apache-2.0
 
-#include "openvino/genai/llm_pipeline.hpp"
+#include "openvino_genai/llm_pipeline.hpp"
 
 int main(int argc, char* argv[]) try {
     if (3 > argc || argc > 4)