python: better way to build and load shared libs (#66)

* fix: use find_library instead of assuming library extension

* Output all libraries in the root build dir

* Add scripts

* Install with cmake

---------

Co-authored-by: M. Yusuf Sarıgöz <[email protected]>

Author: denis-ismailaj

CMakeLists.txt

@@ -248,6 +248,8 @@ if (MSVC)
     add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
 endif()
 
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR})
+
 add_subdirectory(ggml)
 
 add_library(clip
@@ -264,6 +266,9 @@ if (BUILD_SHARED_LIBS)
     set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
     set_target_properties(clip PROPERTIES POSITION_INDEPENDENT_CODE ON)
     target_compile_definitions(clip PRIVATE CLIP_SHARED CLIP_BUILD)
+    set(CMAKE_INSTALL_PREFIX ${PROJECT_BINARY_DIR})
+    install(TARGETS ggml clip
+    LIBRARY DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/examples/python_bindings/clip_cpp)
 endif()
 
 add_subdirectory(models)

examples/python_bindings/clip_cpp/clip.py

@@ -1,4 +1,5 @@
 import ctypes
+from ctypes.util import find_library
 import os
 from typing import List, Dict, Any
 
@@ -8,11 +9,13 @@
 this_dir = os.path.abspath(os.path.dirname(__file__))
 
 # Load the shared library
-path_to_dll = os.environ.get("CLIP_DLL", this_dir)
-os.chdir(path_to_dll)
-ggml_lib = ctypes.CDLL("./libggml.so")
-clip_lib = ctypes.CDLL("./libclip.so")
-os.chdir(cur_dir)
+ggml_lib_path, clip_lib_path = find_library("ggml"), find_library("clip")
+if ggml_lib_path is None or clip_lib_path is None:
+    raise RuntimeError(f"Could not find shared libraries. Please copy to the current working directory or supply the "
+                       f"correct LD_LIBRARY_PATH/DYLD_LIBRARY_PATH.")
+
+ggml_lib = ctypes.CDLL(ggml_lib_path)
+clip_lib = ctypes.CDLL(clip_lib_path)
 
 
 # Define the ctypes structures

scripts/build-python.sh

@@ -0,0 +1,16 @@
+#/bin/bash
+
+# Change to the project directory
+cd "$(dirname "$0")"/..
+
+rm -rf ./build
+
+mkdir build
+
+cd build
+
+cmake -DBUILD_SHARED_LIBS=ON -DCLIP_NATIVE=OFF ..
+
+make
+
+make install

format.sh renamed to scripts/format.sh

@@ -1,2 +1,6 @@
 #/bin/bash
+
+# Change to the project directory
+cd "$(dirname "$0")"/..
+
 find . -type f \( -name '*.cpp' -o -name '*.hpp' -o -name '*.c' -o -name '*.h' \) ! -path "./ggml/*" ! -path "./build/*" -exec clang-format -i {} +