cukks 0.1.0__tar.gz

cukks-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 CuKKS Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cukks-0.1.0/NOTICE

@@ -0,0 +1,118 @@
+CuKKS - CKKS Homomorphic Encryption with CUDA GPU Acceleration
+Copyright 2024 CuKKS Authors
+
+This product includes software developed by the CuKKS project
+(https://github.com/devUuung/CuKKS).
+
+================================================================================
+THIRD-PARTY LICENSES
+================================================================================
+
+This software includes the following third-party components:
+
+--------------------------------------------------------------------------------
+OpenFHE - Open-Source Fully Homomorphic Encryption Library
+--------------------------------------------------------------------------------
+Copyright (c) 2022 OpenFHE
+License: BSD 2-Clause "Simplified" License
+Source: https://github.com/openfheorg/openfhe-development
+
+BSD 2-Clause License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------------------------------------------------------------------------
+pybind11 - Seamless operability between C++11 and Python
+--------------------------------------------------------------------------------
+Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
+License: BSD 3-Clause "New" or "Revised" License
+Source: https://github.com/pybind/pybind11
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+--------------------------------------------------------------------------------
+cereal - A C++11 library for serialization
+--------------------------------------------------------------------------------
+Copyright (c) 2013-2022 Randolph Voorhies, Shane Grant
+License: BSD 3-Clause "New" or "Revised" License
+Source: https://github.com/USCiLab/cereal
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+================================================================================
+CUDA RUNTIME REDISTRIBUTION NOTICE
+================================================================================
+
+The GPU-accelerated packages (cukks-cu128) may include NVIDIA CUDA Runtime
+libraries. These libraries are redistributed under the NVIDIA CUDA EULA:
+https://docs.nvidia.com/cuda/eula/
+
+NVIDIA CUDA Runtime redistribution is permitted for applications that use
+CUDA APIs, as stated in the NVIDIA CUDA EULA Section 2.
+
+================================================================================

cukks-0.1.0/PKG-INFO

@@ -0,0 +1,326 @@
+Metadata-Version: 2.4
+Name: cukks
+Version: 0.1.0
+Summary: PyTorch-compatible encrypted deep learning inference using CKKS homomorphic encryption
+Author: CuKKS Team
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/devUuung/CuKKS
+Project-URL: Documentation, https://github.com/devUuung/CuKKS#readme
+Project-URL: Repository, https://github.com/devUuung/CuKKS
+Keywords: homomorphic encryption,CKKS,deep learning,PyTorch,privacy,secure inference
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Security :: Cryptography
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: torch>=2.0
+Requires-Dist: numpy>=1.23
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: ruff>=0.1; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Provides-Extra: cu118
+Requires-Dist: cukks-cu118; extra == "cu118"
+Provides-Extra: cu121
+Requires-Dist: cukks-cu121; extra == "cu121"
+Provides-Extra: cu124
+Requires-Dist: cukks-cu124; extra == "cu124"
+Provides-Extra: cu128
+Requires-Dist: cukks-cu128; extra == "cu128"
+Dynamic: license-file
+
+<p align="center">
+  <a href="README.md">English</a> |
+  <a href="README.ko.md">한국어</a>
+</p>
+
+<h1 align="center">CuKKS</h1>
+
+<p align="center">
+  <strong>GPU-accelerated CKKS Homomorphic Encryption for PyTorch</strong>
+</p>
+
+<p align="center">
+  <a href="https://github.com/devUuung/CuKKS/actions"><img src="https://github.com/devUuung/CuKKS/actions/workflows/build-wheels.yml/badge.svg" alt="Build Status"></a>
+  <a href="https://github.com/devUuung/CuKKS/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"></a>
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.11-blue.svg" alt="Python 3.11"></a>
+</p>
+
+<p align="center">
+  Run trained PyTorch models on <strong>encrypted data</strong> — preserving privacy while maintaining accuracy.<br>
+  Built on OpenFHE with CUDA acceleration.
+</p>
+
+---
+
+## Quick Start
+
+```python
+import torch.nn as nn
+import cukks
+
+# 1. Define and train your model (standard PyTorch)
+model = nn.Sequential(nn.Linear(784, 128), nn.ReLU(), nn.Linear(128, 10))
+
+# 2. Convert to encrypted model (polynomial ReLU approximation)
+enc_model, ctx = cukks.convert(model)
+
+# 3. Run encrypted inference
+enc_input = ctx.encrypt(test_input)
+enc_output = enc_model(enc_input)
+output = ctx.decrypt(enc_output)
+```
+
+## Installation
+
+### Automatic (Recommended)
+
+```bash
+pip install cukks        # Auto-detects PyTorch's CUDA and installs matching backend
+```
+
+`pip install cukks` detects the CUDA version your PyTorch was built with and automatically installs the matching `cukks-cuXXX` GPU backend. No manual version matching needed.
+
+### Manual
+
+```bash
+pip install cukks-cu121  # Explicitly install for CUDA 12.1
+```
+
+| Package | CUDA | Supported GPUs |
+|---------|------|----------------|
+| `cukks-cu118` | 11.8 | V100, T4, RTX 20/30/40xx, A100, H100 |
+| `cukks-cu121` | 12.1 | V100, T4, RTX 20/30/40xx, A100, H100 |
+| `cukks-cu124` | 12.4 | V100, T4, RTX 20/30/40xx, A100, H100 |
+| `cukks-cu128` | 12.8 | All above + **RTX 50xx** |
+
+Or use extras: `pip install cukks[cu121]`
+
+<details>
+<summary><strong>Post-install CLI & environment variables</strong></summary>
+
+```bash
+cukks-install-backend             # Auto-detect & install
+cukks-install-backend cu128       # Install specific backend
+cukks-install-backend --status    # Show CUDA compatibility status
+cukks-install-backend --dry-run   # Preview without installing
+```
+
+| Variable | Effect |
+|----------|--------|
+| `CUKKS_BACKEND=cukks-cu128` | Force a specific backend |
+| `CUKKS_NO_BACKEND=1` | Skip backend (CPU-only) |
+
+</details>
+
+<details>
+<summary><strong>Docker images</strong></summary>
+
+| CUDA | Compatible Docker Images |
+|------|-------------------------|
+| 11.8 | `pytorch/pytorch:2.1.0-cuda11.8-cudnn8-runtime` |
+| 12.1 | `pytorch/pytorch:2.2.0-cuda12.1-cudnn8-runtime` |
+| 12.4 | `pytorch/pytorch:2.4.0-cuda12.4-cudnn9-runtime` |
+| 12.8 | `nvidia/cuda:12.8.0-cudnn9-runtime-ubuntu22.04` |
+
+```bash
+docker run --gpus all -it pytorch/pytorch:2.2.0-cuda12.1-cudnn8-runtime bash
+pip install cukks  # auto-detects CUDA 12.1
+```
+
+</details>
+
+<details>
+<summary><strong>Build from source</strong></summary>
+
+```bash
+git clone https://github.com/devUuung/CuKKS.git && cd CuKKS
+pip install -e .
+
+# Build OpenFHE backend
+cd openfhe-gpu-public && mkdir build && cd build
+cmake .. -DWITH_CUDA=ON && make -j$(nproc)
+
+cd ../../bindings/openfhe_backend
+pip install -e .
+```
+
+</details>
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **PyTorch API** | Familiar interface — just call `cukks.convert(model)` |
+| **GPU Acceleration** | CUDA-accelerated HE operations via OpenFHE |
+| **Auto Optimization** | BatchNorm folding, BSGS matrix multiplication |
+| **Wide Layer Support** | Linear, Conv2d, ReLU/GELU/SiLU, Pool, LayerNorm, Attention |
+
+## Supported Layers
+
+| Layer | Encrypted Version | Notes |
+|-------|------------------|-------|
+| `nn.Linear` | `EncryptedLinear` | BSGS optimization |
+| `nn.Conv2d` | `EncryptedConv2d` | im2col method |
+| `nn.ReLU/GELU/SiLU` | Polynomial approx | Configurable degree |
+| `nn.AvgPool2d` | `EncryptedAvgPool2d` | Rotation-based |
+| `nn.BatchNorm` | Folded | Merged into prev layer |
+| `nn.LayerNorm` | `EncryptedLayerNorm` | Polynomial approx |
+| `nn.Attention` | `EncryptedApproxAttention` | seq_len=1 |
+
+<details>
+<summary><strong>Full layer support table</strong></summary>
+
+| PyTorch Layer | Encrypted Version | Notes |
+|--------------|-------------------|-------|
+| `nn.Linear` | `EncryptedLinear` | Full support with BSGS optimization |
+| `nn.Conv2d` | `EncryptedConv2d` | Via im2col method |
+| `nn.ReLU` | `EncryptedReLU` | Polynomial approximation |
+| `nn.GELU` | `EncryptedGELU` | Polynomial approximation |
+| `nn.SiLU` | `EncryptedSiLU` | Polynomial approximation |
+| `nn.Sigmoid` | `EncryptedSigmoid` | Polynomial approximation |
+| `nn.Tanh` | `EncryptedTanh` | Polynomial approximation |
+| `nn.AvgPool2d` | `EncryptedAvgPool2d` | Full support |
+| `nn.MaxPool2d` | `EncryptedMaxPool2d` | Approximate via polynomial |
+| `nn.Flatten` | `EncryptedFlatten` | Logical reshape |
+| `nn.BatchNorm1d/2d` | Folded | Merged into preceding layer |
+| `nn.Sequential` | `EncryptedSequential` | Full support |
+| `nn.Dropout` | `EncryptedDropout` | No-op during inference |
+| `nn.LayerNorm` | `EncryptedLayerNorm` | Pure HE polynomial approximation |
+| `nn.MultiheadAttention` | `EncryptedApproxAttention` | Polynomial softmax (seq_len=1) |
+
+</details>
+
+## Activation Functions
+
+CKKS only supports polynomial operations. CuKKS approximates activations (ReLU, GELU, SiLU, etc.) using polynomial fitting:
+
+```python
+# Default: degree-4 polynomial approximation (recommended)
+enc_model, ctx = cukks.convert(model)
+
+# Higher degree for better accuracy (costs more multiplicative depth)
+enc_model, ctx = cukks.convert(model, activation_degree=8)
+```
+
+The default `activation_degree=4` provides a good balance between accuracy and depth consumption. Higher degrees approximate the original activation more closely but require deeper circuits.
+
+## GPU Acceleration
+
+| Operation | Accelerated |
+|-----------|-------------|
+| Add/Sub/Mul/Square | ✅ GPU |
+| Rotate/Rescale | ✅ GPU |
+| Bootstrap | ✅ GPU |
+| Encrypt/Decrypt | CPU |
+
+```python
+from ckks.torch_api import CKKSContext, CKKSConfig
+
+config = CKKSConfig(poly_mod_degree=8192, scale_bits=40)
+ctx = CKKSContext(config, enable_gpu=True)  # GPU enabled by default
+```
+
+## Examples
+
+```bash
+# Quick demo (no GPU required)
+python -m cukks.examples.encrypted_inference --demo conversion
+
+# MNIST encrypted inference
+python examples/mnist_encrypted.py --hidden 64 --samples 5
+```
+
+<details>
+<summary><strong>CNN example</strong></summary>
+
+```python
+import torch.nn as nn
+import cukks
+
+class MNISTCNN(nn.Module):
+    def __init__(self):
+        super().__init__()
+        self.conv1 = nn.Conv2d(1, 8, kernel_size=3, padding=1)
+        self.act1 = nn.ReLU()
+        self.pool1 = nn.AvgPool2d(2)
+        self.flatten = nn.Flatten()
+        self.fc = nn.Linear(8 * 14 * 14, 10)
+    
+    def forward(self, x):
+        return self.fc(self.flatten(self.pool1(self.act1(self.conv1(x)))))
+
+model = MNISTCNN()
+enc_model, ctx = cukks.convert(model)
+
+enc_input = ctx.encrypt(image)
+prediction = ctx.decrypt(enc_model(enc_input)).argmax()
+```
+
+> **Note**: All operations in `forward()` must be layer attributes (e.g., `self.act1`), not inline operations like `x ** 2`.
+
+</details>
+
+<details>
+<summary><strong>Batch processing</strong></summary>
+
+```python
+# Pack multiple samples into a single ciphertext (SIMD)
+samples = [torch.randn(784) for _ in range(8)]
+enc_batch = ctx.encrypt_batch(samples)
+enc_output = enc_model(enc_batch)
+outputs = ctx.decrypt_batch(enc_output, num_samples=8)
+```
+
+</details>
+
+## Troubleshooting
+
+| Issue | Solution |
+|-------|----------|
+| Out of Memory | Reduce `poly_mod_degree` (8192 instead of 16384) |
+| Low Accuracy | Increase `activation_degree` (e.g., 8 or 16) for better approximation |
+| Slow Performance | Enable batch processing, reduce network depth |
+
+## Documentation
+
+- [API Reference](docs/api.md)
+- [GPU Acceleration Guide](docs/gpu-acceleration.md)
+- [CKKS Concepts](docs/concepts.md)
+
+## License
+
+Apache License 2.0
+
+## Citation
+
+```bibtex
+@software{cukks,
+  title = {CuKKS: PyTorch-compatible Encrypted Deep Learning},
+  year = {2024},
+  url = {https://github.com/devUuung/CuKKS}
+}
+```
+
+## Related
+
+### Libraries
+- [OpenFHE](https://github.com/openfheorg/openfhe-development) — Underlying HE library
+- [Microsoft SEAL](https://github.com/microsoft/SEAL) — Alternative HE library
+
+### Papers
+- [Homomorphic Encryption for Arithmetic of Approximate Numbers](https://eprint.iacr.org/2016/421) — Cheon et al. (CKKS)
+- [Bootstrapping for Approximate Homomorphic Encryption](https://eprint.iacr.org/2018/153) — Cheon et al.
+- [Faster Homomorphic Linear Transformations in HElib](https://eprint.iacr.org/2018/244) — Halevi & Shoup (BSGS)