Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ _run:
-f tools/make/envoy.mk \
-f tools/make/golang.mk \
-f tools/make/rust.mk \
-f tools/make/openvino.mk \
-f tools/make/build-run-test.mk \
-f tools/make/docs.mk \
-f tools/make/linter.mk \
Expand Down
48 changes: 48 additions & 0 deletions openvino-binding/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Build artifacts
build/
*.so
*.dylib
*.dll
*.a
*.lib

# CMake
CMakeCache.txt
CMakeFiles/
cmake_install.cmake
Makefile
compile_commands.json

# Go
*.test
*.out
*.exe

# IDE
.vscode/
.idea/
*.swp
*.swo
*~

# OS
.DS_Store
Thumbs.db

# Temporary files
*.log
*.tmp
*.temp

# Models (too large for git)
models/
*.xml
*.bin
*.onnx
*.pt
*.pth
*.safetensors

# Test outputs
test_output/
results/
233 changes: 233 additions & 0 deletions openvino-binding/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
cmake_minimum_required(VERSION 3.13)
project(openvino_semantic_router VERSION 0.1.0 LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

# Suppress undefined variable warnings in generated Makefiles
set(CMAKE_COLOR_MAKEFILE ON)
set(CMAKE_VERBOSE_MAKEFILE OFF)

# Find OpenVINO - try multiple approaches
find_package(OpenVINO QUIET COMPONENTS Runtime)

if(NOT OpenVINO_FOUND)
message(STATUS "OpenVINO not found via find_package, trying Python site-packages...")

# Try to find OpenVINO in Python site-packages
find_package(Python3 COMPONENTS Interpreter)
if(Python3_FOUND)
execute_process(
COMMAND "${Python3_EXECUTABLE}" -c "import openvino; print(openvino.__path__[0])"
OUTPUT_VARIABLE OPENVINO_PYTHON_PATH
OUTPUT_STRIP_TRAILING_WHITESPACE
RESULT_VARIABLE PYTHON_IMPORT_RESULT
)

if(PYTHON_IMPORT_RESULT EQUAL 0 AND EXISTS "${OPENVINO_PYTHON_PATH}")
message(STATUS "Found OpenVINO Python installation at: ${OPENVINO_PYTHON_PATH}")

# Set paths for CMake
set(OpenVINO_DIR "${OPENVINO_PYTHON_PATH}/cmake")
set(CMAKE_PREFIX_PATH "${CMAKE_PREFIX_PATH};${OPENVINO_PYTHON_PATH}/cmake")

# Try to find OpenVINO again with the Python path
find_package(OpenVINO QUIET COMPONENTS Runtime PATHS "${OPENVINO_PYTHON_PATH}/cmake" NO_DEFAULT_PATH)

if(OpenVINO_FOUND)
message(STATUS "Successfully configured OpenVINO from Python site-packages")
else()
# Manual configuration fallback
message(STATUS "Manual OpenVINO configuration from Python site-packages")
set(OpenVINO_FOUND TRUE)
set(OPENVINO_INCLUDE_DIRS "${OPENVINO_PYTHON_PATH}/runtime/include")
set(OPENVINO_LIBRARY_DIRS "${OPENVINO_PYTHON_PATH}/libs")

# Create imported target manually
add_library(openvino::runtime SHARED IMPORTED)
set_target_properties(openvino::runtime PROPERTIES
IMPORTED_LOCATION "${OPENVINO_LIBRARY_DIRS}/libopenvino.so"
INTERFACE_INCLUDE_DIRECTORIES "${OPENVINO_INCLUDE_DIRS}"
)
endif()
endif()
endif()
endif()

if(NOT OpenVINO_FOUND)
message(FATAL_ERROR "OpenVINO not found. Please install OpenVINO or set OpenVINO_DIR environment variable.")
endif()

message(STATUS "OpenVINO found and configured successfully")

# Find OpenVINO Tokenizers library
set(OPENVINO_TOKENIZERS_LIB_DIR "")
if(Python3_FOUND AND OPENVINO_PYTHON_PATH)
# Check if openvino_tokenizers exists in same Python installation
execute_process(
COMMAND "${Python3_EXECUTABLE}" -c "import openvino_tokenizers; print(openvino_tokenizers.__path__[0])"
OUTPUT_VARIABLE OPENVINO_TOKENIZERS_PATH
OUTPUT_STRIP_TRAILING_WHITESPACE
RESULT_VARIABLE TOKENIZERS_IMPORT_RESULT
)

if(TOKENIZERS_IMPORT_RESULT EQUAL 0 AND EXISTS "${OPENVINO_TOKENIZERS_PATH}")
set(OPENVINO_TOKENIZERS_LIB_DIR "${OPENVINO_TOKENIZERS_PATH}/lib")
message(STATUS "Found OpenVINO Tokenizers: ${OPENVINO_TOKENIZERS_LIB_DIR}")

# Verify library files exist
if(EXISTS "${OPENVINO_TOKENIZERS_LIB_DIR}/libopenvino_tokenizers.so")
message(STATUS " ✓ libopenvino_tokenizers.so found")
endif()
if(EXISTS "${OPENVINO_TOKENIZERS_LIB_DIR}/libcore_tokenizers.so")
message(STATUS " ✓ libcore_tokenizers.so found")
endif()
endif()
endif()

if(NOT OPENVINO_TOKENIZERS_LIB_DIR OR NOT EXISTS "${OPENVINO_TOKENIZERS_LIB_DIR}")
message(WARNING "OpenVINO Tokenizers library not found. Install with: pip install openvino-tokenizers")
endif()

# Library sources (modular architecture)
set(SOURCES
# Utils module
cpp/src/utils/math_utils.cpp
cpp/src/utils/preprocessing.cpp

# Core module
cpp/src/core/model_manager.cpp
cpp/src/core/tokenizer.cpp

# Classifiers module
cpp/src/classifiers/text_classifier.cpp
cpp/src/classifiers/token_classifier.cpp
cpp/src/classifiers/lora_adapter.cpp
cpp/src/classifiers/lora_classifier.cpp

# Embeddings module
cpp/src/embeddings/embedding_generator.cpp

# FFI layer (C API for Go CGO)
cpp/src/ffi/openvino_semantic_router_ffi.cpp
)

set(HEADERS
# C API header (public interface)
cpp/include/openvino_semantic_router.h

# Core headers
cpp/include/core/types.h
cpp/include/core/model_manager.h
cpp/include/core/tokenizer.h

# Classifier headers
cpp/include/classifiers/text_classifier.h
cpp/include/classifiers/token_classifier.h
cpp/include/classifiers/lora_adapter.h
cpp/include/classifiers/lora_classifier.h

# Embedding headers
cpp/include/embeddings/embedding_generator.h

# Utility headers
cpp/include/utils/math_utils.h
cpp/include/utils/preprocessing.h
)

# Create shared library
add_library(${PROJECT_NAME} SHARED ${SOURCES} ${HEADERS})

# Include directories
target_include_directories(${PROJECT_NAME}
PUBLIC
$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/cpp/include>
$<INSTALL_INTERFACE:include>
PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/cpp/src
)

# Link OpenVINO and OpenVINO Tokenizers
target_link_libraries(${PROJECT_NAME}
PUBLIC
openvino::runtime
)

# Link OpenVINO Tokenizers if available
if(OPENVINO_TOKENIZERS_LIB_DIR AND EXISTS "${OPENVINO_TOKENIZERS_LIB_DIR}/libopenvino_tokenizers.so")
target_link_libraries(${PROJECT_NAME}
PRIVATE
${OPENVINO_TOKENIZERS_LIB_DIR}/libopenvino_tokenizers.so
)

# Add rpath so the library can be found at runtime
set_target_properties(${PROJECT_NAME} PROPERTIES
BUILD_RPATH "${OPENVINO_TOKENIZERS_LIB_DIR}"
INSTALL_RPATH "${OPENVINO_TOKENIZERS_LIB_DIR}"
)

message(STATUS "Linked OpenVINO Tokenizers library")
endif()

# Compiler options
target_compile_options(${PROJECT_NAME} PRIVATE
$<$<CXX_COMPILER_ID:GNU,Clang,AppleClang>:-Wall -Wextra -Wpedantic>
$<$<CXX_COMPILER_ID:MSVC>:/W4>
)

# Set library output properties
set_target_properties(${PROJECT_NAME} PROPERTIES
VERSION ${PROJECT_VERSION}
SOVERSION 0
PUBLIC_HEADER "${HEADERS}"
)

# Installation rules
include(GNUInstallDirs)

install(TARGETS ${PROJECT_NAME}
EXPORT ${PROJECT_NAME}Targets
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)

install(EXPORT ${PROJECT_NAME}Targets
FILE ${PROJECT_NAME}Targets.cmake
NAMESPACE ${PROJECT_NAME}::
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
)

# Create package configuration files
include(CMakePackageConfigHelpers)

configure_package_config_file(
"${CMAKE_CURRENT_SOURCE_DIR}/cmake/${PROJECT_NAME}Config.cmake.in"
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
)

write_basic_package_version_file(
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
VERSION ${PROJECT_VERSION}
COMPATIBILITY AnyNewerVersion
)

install(FILES
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}
)

# Print configuration summary
message(STATUS "========================================")
message(STATUS "OpenVINO Semantic Router Configuration")
message(STATUS "========================================")
message(STATUS "Version: ${PROJECT_VERSION}")
message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
message(STATUS "C++ standard: ${CMAKE_CXX_STANDARD}")
message(STATUS "Install prefix: ${CMAKE_INSTALL_PREFIX}")
message(STATUS "========================================")

90 changes: 90 additions & 0 deletions openvino-binding/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# OpenVINO Binding for Semantic Router

High-performance Go bindings for semantic routing using Intel® OpenVINO™ Toolkit. This binding provides BERT-based text embeddings, similarity search, and classification capabilities optimized for Intel CPUs and accelerators.

## Features

- 🚀 **High Performance**: Optimized inference with OpenVINO on Intel hardware
- 🔍 **Semantic Search**: BERT embeddings and cosine similarity
- 📊 **Classification**: Text classification with confidence scores
- 🧩 **LoRA Adapter Support**: Parameter-efficient fine-tuning for BERT and ModernBERT
- 🏷️ **Token Classification**: Named entity recognition and PII detection
- 🔄 **Batch Processing**: Efficient batch similarity computation
- 💻 **Multi-Device**: Support for CPU, GPU, VPU, and other Intel accelerators
- 🔌 **CGO Bindings**: Native C++ integration with Go

## Environment Variables

The following environment variables are required or recommended:

- **`OPENVINO_TOKENIZERS_LIB`** (Required): Path to `libopenvino_tokenizers.so`

```bash
export OPENVINO_TOKENIZERS_LIB="/path/to/libopenvino_tokenizers.so"
```

- **`OPENVINO_MODEL_PATH`** (Optional): Path to OpenVINO model XML file
- Default: `../../test_models/category_classifier_modernbert/openvino_model.xml`

- **`CANDLE_MODEL_PATH`** (Optional): Path to Candle model directory (for benchmarks)
- Default: `../../../models/category_classifier_modernbert-base_model`

- **`LD_LIBRARY_PATH`** (Required): Include the path to the built library

```bash
export LD_LIBRARY_PATH="/path/to/openvino-binding/build:$LD_LIBRARY_PATH"
```

## Building

### 1. Build C++ Library

```bash
cd openvino-binding

# Create build directory
mkdir -p build
cd build

# Configure with CMake
cmake .. -DCMAKE_BUILD_TYPE=Release

# Build
cmake --build . -j$(nproc)

# Install (optional)
sudo cmake --install .
```

### 2. Build Go Bindings

```bash
# Go back to openvino-binding directory
cd ..

# Test Go bindings
go build -v ./...

# Run tests (if available)
go test -v ./...
```

## Running Benchmarks

The benchmark compares OpenVINO and Candle implementations:

```bash
# Set up environment variables
export OPENVINO_TOKENIZERS_LIB="/path/to/libopenvino_tokenizers.so"
export OPENVINO_MODEL_PATH="/path/to/openvino_model.xml"
export CANDLE_MODEL_PATH="/path/to/candle/model"
export LD_LIBRARY_PATH="/path/to/openvino-binding/build:/path/to/candle-binding/target/release:$LD_LIBRARY_PATH"

# Run benchmark
cd cmd/benchmark
go run main.go
```

## Converting Models to OpenVINO IR Format

OpenVINO requires models in Intermediate Representation (IR) format (`.xml` and `.bin` files).
10 changes: 10 additions & 0 deletions openvino-binding/cmake/openvino_semantic_routerConfig.cmake.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
@PACKAGE_INIT@

include(CMakeFindDependencyMacro)

find_dependency(OpenVINO REQUIRED COMPONENTS Runtime)

include("${CMAKE_CURRENT_LIST_DIR}/openvino_semantic_routerTargets.cmake")

check_required_components(openvino_semantic_router)

Loading
Loading