Merge pull request #234 from openfheorg/dev

Updates to v1.3.1.0

Author: dsuponitskiy

CMakeLists.txt

@@ -4,18 +4,29 @@ project (OpenFHE-Python)
 
 set(OPENFHE_PYTHON_VERSION_MAJOR 1)
 set(OPENFHE_PYTHON_VERSION_MINOR 3)
-set(OPENFHE_PYTHON_VERSION_PATCH 0)
+set(OPENFHE_PYTHON_VERSION_PATCH 1)
 set(OPENFHE_PYTHON_VERSION_TWEAK 0)
 set(OPENFHE_PYTHON_VERSION ${OPENFHE_PYTHON_VERSION_MAJOR}.${OPENFHE_PYTHON_VERSION_MINOR}.${OPENFHE_PYTHON_VERSION_PATCH}.${OPENFHE_PYTHON_VERSION_TWEAK})
 
+# OpenFHE version can be specified externally (-DOPENFHE_REQUIRED_VERSION=1.3.1)
+if(NOT DEFINED OPENFHE_REQUIRED_VERSION)
+    set(OPENFHE_REQUIRED_VERSION "1.3.1" CACHE STRING "Required OpenFHE version")
+else()
+    # User provided OPENFHE_REQUIRED_VERSION via -D
+    message(STATUS "Using user-specified OpenFHE version: ${OPENFHE_REQUIRED_VERSION}")
+endif()
+
 set(CMAKE_CXX_STANDARD 17)
 option( BUILD_STATIC "Set to ON to include static versions of the library" OFF)
 
 if(APPLE)
     set(CMAKE_CXX_VISIBILITY_PRESET default)
 endif()
 
-find_package(OpenFHE 1.3.0 REQUIRED)
+find_package(OpenFHE ${OPENFHE_REQUIRED_VERSION} REQUIRED)
+message(STATUS "Building with OpenFHE version: ${OPENFHE_REQUIRED_VERSION}")
+
+set(PYBIND11_FINDPYTHON ON)
 find_package(pybind11 REQUIRED)
 
 # "CMAKE_INTERPROCEDURAL_OPTIMIZATION ON" (ON is the default value) causes link failure. see
@@ -65,20 +76,13 @@ pybind11_add_module(openfhe
 ### Python installation 
 # Allow the user to specify the path to Python executable (if not provided, find it)
 option(PYTHON_EXECUTABLE_PATH "Path to Python executable" "")
-
-if(NOT PYTHON_EXECUTABLE_PATH)
-    # Find Python and its development components
-    find_package(Python REQUIRED COMPONENTS Interpreter Development)
-else()
-    # Set Python_EXECUTABLE to the specified path
+if(PYTHON_EXECUTABLE_PATH)
     set(Python_EXECUTABLE "${PYTHON_EXECUTABLE_PATH}")
 endif()
-
-# Find Python interpreter
-find_package(PythonInterp REQUIRED)
+find_package(Python REQUIRED COMPONENTS Interpreter Development)
 
 # Check Python version
-if(${PYTHON_VERSION_MAJOR} EQUAL 3 AND ${PYTHON_VERSION_MINOR} GREATER_EQUAL 10)
+if(${Python_VERSION_MAJOR} EQUAL 3 AND ${Python_VERSION_MINOR} GREATER_EQUAL 10)
     execute_process(
         COMMAND "${Python_EXECUTABLE}" -c "from sys import exec_prefix; print(exec_prefix)"
         OUTPUT_VARIABLE PYTHON_SITE_PACKAGES
@@ -100,3 +104,5 @@ else()
 endif()
 message("***** INSTALL IS AT ${Python_Install_Location}; to change, run cmake with -DCMAKE_INSTALL_PREFIX=/your/path")
 install(TARGETS openfhe LIBRARY DESTINATION ${Python_Install_Location})
+install(FILES ${CMAKE_SOURCE_DIR}/__init__.py DESTINATION ${Python_Install_Location})
+

README.md

@@ -23,7 +23,7 @@ pip install openfhe==<openfhe_package_version>
 
 Once installed, any python example at https://github.com/openfheorg/openfhe-python/tree/main/examples can be executed.
 
-Note that Ubuntu LTS 20.04, 22.04, and 24.04 are currently supported. `pip uninstal` can be used to uninstall the openfhe package.
+Note that Ubuntu LTS 20.04, 22.04, and 24.04 are currently supported. `pip uninstall` can be used to uninstall the openfhe package.
 
 ## Running from Docker
 
@@ -35,7 +35,7 @@ Please see [Instructions for the Docker setup](docker/README.md)
 
 Before building, make sure you have the following dependencies installed:
 
-- [OpenFHE 1.3.0+](https://github.com/openfheorg/openfhe-development) by following the instructions in [OpenFHE Documentation](https://openfhe-development.readthedocs.io/en/latest/sphinx_rsts/intro/installation/installation.html)
+- [OpenFHE 1.3.1+](https://github.com/openfheorg/openfhe-development) by following the instructions in [OpenFHE Documentation](https://openfhe-development.readthedocs.io/en/latest/sphinx_rsts/intro/installation/installation.html)
 - [Python 3.6+](https://www.python.org/)
 - [pybind11](https://pybind11.readthedocs.io/en/stable/installing.html)
 
@@ -143,8 +143,9 @@ To get familiar with the OpenFHE Python API, check out the examples:
   <!-- - [Small-Precison Arbitrary Function Evaluation](examples/binfhe/eval-function.py) -->
 - Threshold FHE: 
   - [Code Example for BGV, BFV, and CKKS](examples/pke/threshold-fhe.py)
-  - [Simple Interactive Bootstrapping Example](examples/pke/tckks-interactive-mp-bootstrapping.py)
-  - [Interactive Bootstrapping after Chebyshev Approximation](examples/pke/tckks-interactive-mp-bootstrapping-Chebyschev.py)
+  - [2-party Interactive Bootstrapping Examples](examples/pke/interactive-bootstrapping.py)
+  - [Simple n-party Interactive Bootstrapping Example](examples/pke/tckks-interactive-mp-bootstrapping.py)
+  - [n-party Interactive Bootstrapping after Chebyshev Approximation](examples/pke/tckks-interactive-mp-bootstrapping-Chebyschev.py)
   - [Code Example for BFV with 5 parties](examples/pke/threshold-fhe-5p.py)
 
 ## OpenFHE Python Wrapper Documentation

__init__.py

@@ -0,0 +1,48 @@
+import os
+import ctypes
+
+
+def load_shared_library(libname, paths):
+    for path in paths:
+        lib_path = os.path.join(path, libname)
+        if os.path.exists(lib_path):
+            return ctypes.CDLL(lib_path, mode=ctypes.RTLD_GLOBAL)
+
+    raise FileNotFoundError(
+        f"Shared library {libname} not found in {paths}"
+    )
+
+# Search LD_LIBRARY_PATH
+ld_paths = os.environ.get("LD_LIBRARY_PATH", "").split(":")
+
+if not any(ld_paths):
+    # Path to the bundled `lib/` directory inside site-packages
+    package_dir = os.path.abspath(os.path.dirname(__file__))
+    internal_lib_dir = [os.path.join(package_dir, 'lib')]
+
+    # Shared libraries required
+    shared_libs = [
+        'libgomp.so',
+        'libOPENFHEcore.so.1',
+        'libOPENFHEbinfhe.so.1',
+        'libOPENFHEpke.so.1',
+    ]
+
+    for libname in shared_libs:
+        load_shared_library(libname, internal_lib_dir)
+
+    from .openfhe import *
+
+else:
+    # Shared libraries required
+    # skip 'libgomp.so' if LD_LIBRARY_PATH is set as we should get it from the libgomp.so location
+    shared_libs = [
+        'libOPENFHEcore.so.1',
+        'libOPENFHEbinfhe.so.1',
+        'libOPENFHEpke.so.1',
+    ]
+
+    for libname in shared_libs:
+        load_shared_library(libname, ld_paths)
+
+    # from .openfhe import *

docs/Makefile

@@ -13,6 +13,15 @@ help:
 
 .PHONY: help Makefile
 
+# I got the following warning running "make html":
+#     WARNING: html_static_path entry '_static' does not exist
+# The _static folder in a Sphinx project is used to store custom static files. We must either
+# suppress the warning by creating the folder or remove the entry from conf.py ("html_static_path = []").
+# Creating the folder may be safer.
+html:
+	@mkdir -p _static
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile

examples/pke/advanced-real-numbers-128.py

@@ -10,7 +10,7 @@ def automatic_rescale_demo(scal_tech):
     batch_size = 8
     parameters = CCParamsCKKSRNS()
     parameters.SetMultiplicativeDepth(6)
-    parameters.SetScalingModSize(90)
+    parameters.SetScalingModSize(89)
     parameters.SetScalingTechnique(scal_tech)
     parameters.SetBatchSize(batch_size)
 
@@ -70,7 +70,7 @@ def manual_rescale_demo(scal_tech):
     batch_size = 8
     parameters = CCParamsCKKSRNS()
     parameters.SetMultiplicativeDepth(5)
-    parameters.SetScalingModSize(90)
+    parameters.SetScalingModSize(89)
     parameters.SetBatchSize(batch_size)
 
     cc = GenCryptoContext(parameters)
@@ -133,7 +133,7 @@ def hybrid_key_switching_demo1():
     batch_size = 8
     parameters = CCParamsCKKSRNS()
     parameters.SetMultiplicativeDepth(5)
-    parameters.SetScalingModSize(90)
+    parameters.SetScalingModSize(89)
     parameters.SetBatchSize(batch_size)
     parameters.SetScalingTechnique(ScalingTechnique.FIXEDAUTO)
     parameters.SetNumLargeDigits(dnum)
@@ -176,7 +176,7 @@ def hybrid_key_switching_demo2():
     batch_size = 8
     parameters = CCParamsCKKSRNS()
     parameters.SetMultiplicativeDepth(5)
-    parameters.SetScalingModSize(90)
+    parameters.SetScalingModSize(89)
     parameters.SetBatchSize(batch_size)
     parameters.SetScalingTechnique(ScalingTechnique.FIXEDAUTO)
     parameters.SetNumLargeDigits(dnum)
@@ -219,7 +219,7 @@ def fast_rotation_demo1():
     batch_size = 8
     parameters = CCParamsCKKSRNS()
     parameters.SetMultiplicativeDepth(1)
-    parameters.SetScalingModSize(90)
+    parameters.SetScalingModSize(89)
     parameters.SetBatchSize(batch_size)
 
     cc = GenCryptoContext(parameters)
@@ -295,7 +295,7 @@ def fast_rotation_demo2():
 
     parameters = CCParamsCKKSRNS()
     parameters.SetMultiplicativeDepth(1)
-    parameters.SetScalingModSize(90)
+    parameters.SetScalingModSize(89)
     parameters.SetBatchSize(batch_size)
     parameters.SetScalingTechnique(ScalingTechnique.FIXEDAUTO)
     parameters.SetKeySwitchTechnique(KeySwitchTechnique.BV)