helayers-pylab is based on HELayers which is written in C++ and includes a Python API that is designed to enable application developers and data scientists to seamlessly apply advanced privacy preserving techniques without requiring specialized skills in cryptography - all while working in a newly integrated Python environment. HElayers is engineered to support a wide array of analytics such as linear regression, logistic regression, and neural networks so that application developers and data scientists can use the power of FHE. It is delivered as an open platform that is capable of using the latest FHE schemes and libraries for a given use case and ships with a multitude of tutorials and sample applications that highlight the basics of FHE and how to use this technology in a practical way. Sample applications include credit card fraud detection, encrypted database search, text classification, and various examples from the healthcare industry.
The demos use three backends: SEAL, HELib, and HEaaN. For most demos it is easy to switch between different backends, and explore which works best in each case.
HElayers is a Linux based Docker image. The only requirement is a system that is capable of running a container, such as Docker, with the necessary user privileges to run docker commands. It is also assumed you have a working internet connection.
This image is built to run on all x86 64-bit architectures including Linux, macOS, and Windows. When the container is running, interactions are through a Python Jupyter notebook accessed via the browser.
This image is provided under a community edition license for non-commercial use; see license. For commercial deployments and access to the source code, please contact email@example.com for the Premium Edition license.
Call to Action
To help us create the best possible offering tailored to your needs, please provide feedback by taking the HElayers Experience Survey
For more information on FHE, please visit our Content Solutions Page
For more information on IBM HElayers, please visit our IBM Developer Blog
To get started with HElayers, follow our instructional setup video or continue to the Installation section.
Note: Do not expose the HElayers containers to unauthorized access. Anyone with access to the container web interface will be able to execute code inside it. Only start the HElayers containers on local personal computers or on servers with controlled access.
Step 1: Pull the Docker image
In your terminal pull this image from IBM Container Registry to your local repository.
docker pull icr.io/helayers/helayers-pylab:latest
If you specify
:latest, it will always pull the most recent version. However, if you are looking for a specific version you can replace
:latest with the version number, such as
If the fetch is successful, it will download the image and you will now have an image in your local repository named
icr.io/helayers/helayers-pylab:latest. Check that this image exists with
Step 2: Run the image
Once the image download is complete,
run the image as a container in Docker...
docker run -p 8888:8888 -d --rm --name helayers-pylab icr.io/helayers/helayers-pylab:latest
This command runs the image and sets the container to be accessed via port 8888. It also gives the container a name called
helayers-pylab, which we can use to find it in the list of other running containers.
Step 3: Access HElayers
Open a web browser on your host machine (not the docker container instance), and browse to http://127.0.0.1:8888/lab/?token=demo-experience-with-fhe-and-python . This will connect you to the welcome page of the Juptyer notebook.
Note: if you run the web browser in different machine than the docker container, then you need to change the IP address of the URL.
Step 4: Get started with the tutorials and demo applications
Open the first notebook, by double clicking the one titled
00_Getting_Started.ipynb. This is a notebook that contains information about the different tutorials that are available, as well as instructions on how to run each one.