Fix readthedocs compilation

Author: ibarrond

Pyfhel/PyCtxt.pyx

@@ -93,7 +93,7 @@ cdef class PyCtxt:
 
     @property
     def scheme(self):
-        """scheme: returns the scheme type.
+        """scheme: returns the FHE scheme of this ciphertext.
 
         Can be set to: none, bfv, bgv (INTEGER) or ckks (FRACTIONAL).
 

docs/conf.py

@@ -75,7 +75,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -232,7 +232,6 @@
 intersphinx_mapping = {
     'python': ('https://docs.python.org/{.major}'.format(sys.version_info), None),
     'numpy': ('https://numpy.org/doc/stable/', None),
-    'np': ('https://numpy.org/doc/stable/', None),
     'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None),
     'Pyfhel': ('https://pyfhel.readthedocs.io/en/latest/', None),
 }

docs/source/getting_started/1_installation.rst

@@ -24,10 +24,13 @@ To uninstall, just run:
 **Installing a C/C++ Compiler**
 
 `Pyfhel` requires a C/C++ compiler with C++17 support. We have tested:
-- *gcc6* to *gcc12* in Linux/MacOS/Windows WSL. To install:
+- *gcc6* to *gcc14* in Linux/MacOS/Windows. To install:
+
    - Ubuntu: `sudo apt install gcc g++`
    - MacOS: `brew install gcc`. MacOS users must also set several environment variables by running:
-```bash
+
+.. code-block:: bash
+
         # Brew installs GCC in /opt/homebrew/bin on Apple Silicon and /usr/local/bin on Intel.
         if [[ $(uname -m) = "arm64" ]]; then BREW_GCC_PATH="/opt/homebrew/bin"; else BREW_GCC_PATH="/usr/local/bin"; fi
 
@@ -38,6 +41,7 @@ To uninstall, just run:
         # Set MACOSX_DEPLOYMENT_TARGET to avoid version mismatch warnings
         echo "MACOSX_DEPLOYMENT_TARGET=$(sw_vers -productVersion)" >> $GITHUB_ENV
         echo "MACOSX_DEPLOYMENT_TARGET=${{ env.MACOSX_DEPLOYMENT_TARGET }}"
-```
+
 - *MSVC2017* and *MSVC2019* in Windows. To install:
+
    - Install Visual C++ Build tools (Download `here <https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170>`, guide in `here <https://stackoverflow.com/questions/40504552>`)

examples/Demo_9_Integer_BGV.py

@@ -1,24 +1,17 @@
 """
 Integer FHE with BGV scheme
 ========================================
-//TODO
-"""
-
-# %%
-# 1. Imports
-# ---------------------------
-# We start by importing the library
-
-import numpy as np
-from Pyfhel import Pyfhel
 
-print("\n1. Pyfhel Import")
+This demo showcases the use of the BGV scheme for integer FHE operations.
+"""
 
 
 # %%
-# 2. BGV context and key setup
+# 1. BGV context and key setup
 # ------------------------------------------------------------------------------
 # We take a look at the different parameters that can be set for the BGV scheme.
+import numpy as np
+from Pyfhel import Pyfhel
 HE = Pyfhel()           # Creating empty Pyfhel object
 
 # HE.contextGen(scheme='bgv', n=2**14, t_bits=20)  # Generate context for 'bfv'/'bgv'/'ckks' scheme
@@ -42,12 +35,12 @@
 HE.rotateKeyGen()       # Rotate key generation --> Allows rotation/shifting
 HE.relinKeyGen()        # Relinearization key generation
 
-print("\n2. Pyfhel FHE context generation")
+print("\n1. Pyfhel FHE context generation")
 print(f"\t{HE}")
 
 
 # %%
-# 3. BGV Integer Encryption
+# 2. BGV Integer Encryption
 # ---------------------------
 # we will define two integers and encrypt them using `encryptBGV`:
 integer1 = np.array([127], dtype=np.int64)
@@ -63,20 +56,20 @@
 print(ctxt2)
 
 # %%
-# 4. Operating with encrypted integers in BGV
+# 3. Operating with encrypted integers in BGV
 # ---------------------------------------------
 # Relying on the context defined before, we will now operate
 # (addition, substaction, multiplication) the two ciphertexts:
 ctxtSum = ctxt1 + ctxt2         # `ctxt1 += ctxt2` for inplace operation
 ctxtSub = ctxt1 - ctxt2         # `ctxt1 -= ctxt2` for inplace operation
 ctxtMul = ctxt1 * ctxt2         # `ctxt1 *= ctxt2` for inplace operation
-print("\n4. Operating with encrypted integers")
+print("\n3. Operating with encrypted integers")
 print(f"Sum: {ctxtSum}")
 print(f"Sub: {ctxtSub}")
 print(f"Mult:{ctxtMul}")
 
 # %%
-# 5.  Decrypting BGV integers
+# 4.  Decrypting BGV integers
 # ------------------------------
 # Once we're finished with the encrypted operations, we can use
 # the Pyfhel instance to decrypt the results using `decryptBGV`:
@@ -85,14 +78,14 @@
 resSub = HE.decrypt(ctxtSub)    # `decrypt` function detects the scheme and
                                 #  calls the corresponding decryption function.
 resMul = HE.decryptBGV(ctxtMul)
-print("\n5. Decrypting result:")
+print("\n4. Decrypting BGV result:")
 print("     addition:       decrypt(ctxt1 + ctxt2) =  ", resSum)
 print("     substraction:   decrypt(ctxt1 - ctxt2) =  ", resSub)
 print("     multiplication: decrypt(ctxt1 + ctxt2) =  ", resMul)
 
 
 # %%
-# 6. Integer Array Encoding & Encryption
+# 5. BGV Integer Array Encoding & Encryption
 # ------------------------------------------------------------------------------
 # we will define two 1D integer arrays, encode and encrypt them:
 # arr1 = [0, 1, ... n-1] (length n)
@@ -121,7 +114,7 @@
 print("->\tarr2 ", arr2,'\n\t==> ptxt2 ', ptxt2,'\n\t==> ctxt2 ', ctxt2)
 
 # %%
-# 7. Securely operating on encrypted ingeger arrays
+# 6. BGV Integer Array Encoding & Encryption
 # ------------------------------------------------------------------------------
 # We try all the operations supported by Pyfhel.
 #  Note that, to operate, the ciphertexts/plaintexts must be built with the same
@@ -157,7 +150,7 @@
                             # `ctxt1 *= ctxt2` for inplace operation
 
 
-print("\n7. Secure operations")
+print("\n6. Secure BGV operations")
 print(" Ciphertext-ciphertext: ")
 print("->\tctxt1 + ctxt2 = ccSum: ", ccSum)
 print("->\tctxt1 - ctxt2 = ccSub: ", ccSub)
@@ -175,7 +168,7 @@
 
 
 # %%
-# 8. BGV Relinearization: What, why, when
+# 7. BGV Relinearization: What, why, when
 # ------------------------------------------------------------------------------
 # Ciphertext-ciphertext multiplications increase the size of the polynoms
 #  representing the resulting ciphertext. To prevent this growth, the
@@ -188,14 +181,14 @@
 #
 # Note that HE.power performs relinearization after every multiplication.
 
-print("\n8. Relinearization-> Right after each multiplication.")
+print("\n7. Relinearization-> Right after each multiplication.")
 print(f"ccMul before relinearization (size {ccMul.size()}): {ccMul}")
 ~ccMul    # Equivalent to HE.relinearize(ccMul). Relin always happens in-place.
 print(f"ccMul after relinearization (size {ccMul.size()}): {ccMul}")
 print(f"cPow after 2 mult&relin rounds:  (size {cPow.size()}): {cPow}")
 
 # %%
-# 9. Decrypt & Decode results
+# 8. Decrypt & Decode results
 # ------------------------------------------------------------------------------
 # Time to decrypt results! We use HE.decryptBGV for this.
 #  HE.decrypt() could also be used, in which case the decryption type would be
@@ -214,7 +207,7 @@
 rcpSub = HE.decryptBGV(cpSub)
 rcpMul = HE.decryptBGV(cpMul)
 
-print("\n9. Decrypting results")
+print("\n8. Decrypting results")
 print(" Original ciphertexts: ")
 print("   ->\tctxt1 --(decr)--> ", r1)
 print("   ->\tctxt2 --(decr)--> ", r2)