Skip to content
This repository was archived by the owner on Aug 5, 2024. It is now read-only.

Commit a1a6228

Browse files
committed
added more info to the readme, and the header image as well
1 parent 4079ffa commit a1a6228

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

Documentation/Images/fhe.jpg

108 KB
Loading

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
# IBM Fully Homomorphic Encryption (HELayers) SDK for Linux
33

4+
![HELayers](Documentation/Images/fhe.jpg)
5+
46
Last year, we introduced FHE to Linux with our FHE Toolkit. Today, we are announcing the next evolution of the FHE Toolkit called IBM HElayers, a software development kit (SDK) for the practical and efficient execution of encrypted workloads using fully homomorphic encrypted data. HElayers enables application developers and data scientists to seamlessly use advanced privacy preserving techniques without having to be a specialist in cryptography - all while working in a newly integrated Python environment. 
57

68
HELayers is packaged as Docker containers that make it easier to get started and experimenting with FHE. It is written in C++ and includes a Python API that enables data scientists and application developers to easily use the power of FHE by supporting a wide array of analytics such as linear regression, logistic regression, and neural networks.
@@ -25,27 +27,31 @@ For the C++ version:
2527

2628
./StartHELayers.sh cpp
2729

28-
The script will pull & download the latest version that works on your machine's architecture. It will run locally in its own container for you to view in your web browser. The script will tell you where to point your browser to in the Terminal after completing the setup. The c++ version uses VSCode integrated into the browser for an IDE, and the python relies on a self-contained jupyter notebook.
30+
The script will pull & download the latest version that works on your machine's architecture. It will run locally in its own container for you to view in your web browser. The script will tell you where to point your browser to in the Terminal after completing the setup. The c++ version uses VSCode integrated into the browser for an IDE, using port 8443, and the python relies on a self-contained jupyter notebook on port 8888.
2931

3032
To try HELayers out from Dockerhub directly, you can use these links below:
3133

3234
* Python
33-
[HELayers Python x86](https://hub.docker.com/r/ibmcom/helayers-pylab)
34-
[HELayers Python s390x](https://hub.docker.com/r/ibmcom/helayers-pylab-s390x)
35+
* [HELayers Python x86](https://hub.docker.com/r/ibmcom/helayers-pylab)
36+
* [HELayers Python s390x](https://hub.docker.com/r/ibmcom/helayers-pylab-s390x)
3537
* C++
36-
[HELayers C++ x86](https://hub.docker.com/r/ibmcom/helayers-lab)
37-
[HELayers C++ s390x](https://hub.docker.com/r/ibmcom/helayers-lab-s390x)
38+
* [HELayers C++ x86](https://hub.docker.com/r/ibmcom/helayers-lab)
39+
* [HELayers C++ s390x](https://hub.docker.com/r/ibmcom/helayers-lab-s390x)
3840

3941
### Take a look at our in-depth walkthrough video on how to download and get started with HElayers.
4042

4143
[![Fully Homomorphic Encryption](http://img.youtube.com/vi/_bEMWffloas/0.jpg)](https://www.youtube.com/watch?v=_bEMWffloas "Getting Started with HELayers")
4244

4345
To learn more about FHE in general, and what it can be used for, you can check out our [FAQ/Content Solutions page](https://www.ibm.com/support/z-content-solutions/fully-homomorphic-encryption/ ).
4446

47+
## System Requirements
48+
49+
HElayers is a Linux based Docker container and can be implemented entirely in software; there is no hardware dependency. The only software that is required is Docker version 19 or higher with the necessary user privileges to run `docker` commands. It is also assumed you have a working internet connection.
50+
51+
Runtimes tested include Linux, Linux on IBM Z (z15 and LinuxONE III and later), z/OS Container Extensions (v2.4 & v2.5), Windows 10 subsystem for Linux and MacOS. Today, the only distribution we support is Ubuntu 20.04 which is included as the base image.
4552

46-
## Supported Configurations
53+
Older versions have not been thoroughly tested and there are no plans to support older versions in the future.
4754

48-
At this time, the SDK supports many <a href="https://www.docker.com/resources/what-container" target="_blank">Docker</a> capable hosts such as most modern Linux distributions, macOS, <a href="https://docs.microsoft.com/en-us/windows/wsl/install-win10" target="_blank">Windows 10 Subsystem for Linux</a> and <a href="https://www.ibm.com/support/knowledgecenter/en/SSLTBW_2.4.0/com.ibm.zos.v2r4.izso100/izso100_whatisintro.htm" target="_blank">z/OS Container Extensions</a>. Other host operating systems with recent Docker software may work as well but are untested.
4955

5056
## License
5157

0 commit comments

Comments
 (0)