Skip to content

Update documentation (clarifications based on user feedback) #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 23, 2022
Merged

Update documentation (clarifications based on user feedback) #183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions cczoo/horizontal_fl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,7 @@ Recommendation System and Image Classification.
Please follow [this guide](https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script)
to install Docker engine.

- TensorFlow 2.4.2.

- Horizontal Federated Learning source package:
- CCZoo Horizontal Federated Learning source package:

```shell
git clone https://github.com/intel/confidential-computing-zoo.git
Expand All @@ -86,16 +84,20 @@ Recommendation System and Image Classification.
./setup_azure_vm.sh
```

After Intel SGX DCAP is setup, verify the Intel Architectural Enclave Service Manager is active (running)::
After Intel SGX DCAP is setup, verify the Intel Architectural Enclave Service Manager is active (running):

```shell
systemctl status aesmd
```

- EPC size: 64GB for image classification solution, 256GB for recommendation system solution

- Gramine. Follow [Quick Start](https://gramine.readthedocs.io/en/latest/quickstart.html)
to learn more about it.

### Solution Ingredients
This solution uses the following ingredients, which are installed as part of the container build process.
- TensorFlow 2.4.2
- [Gramine](https://gramine.readthedocs.io)


### Recommendation system
#### Configuration
Expand Down
18 changes: 10 additions & 8 deletions documents/readthedoc/docs/source/Solutions/horizontal-federated-learning/hfl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,7 @@ Recommendation System and Image Classification.
Please follow [this guide](https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script)
to install Docker engine.

- TensorFlow 2.4.2.

- Horizontal Federated Learning source package:
- CCZoo Horizontal Federated Learning source package:

```shell
git clone https://github.com/intel/confidential-computing-zoo.git
Expand All @@ -81,19 +79,23 @@ Recommendation System and Image Classification.

```shell
cd <horizontal_fl dir>
sudo ./setup_azure_vm.sh
./setup_azure_vm.sh
```

After Intel SGX DCAP is setup, verify the Intel Architectural Enclave Service Manager is active (running)::
After Intel SGX DCAP is setup, verify the Intel Architectural Enclave Service Manager is active (running):

```shell
sudo systemctl status aesmd
systemctl status aesmd
```

- EPC size: 64GB for image classification solution, 256GB for recommendation system solution

- Gramine. Follow [Quick Start](https://gramine.readthedocs.io/en/latest/quickstart.html)
to learn more about it.

### Solution Ingredients
This solution uses the following ingredients, which are installed as part of the container build process.
- TensorFlow 2.4.2
- [Gramine](https://gramine.readthedocs.io)


### Recommendation system
#### Configuration
Expand Down
16 changes: 9 additions & 7 deletions documents/readthedoc/docs/source/Solutions/tensorflow-serving-cluster/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,7 @@ Prerequisites
Please follow `this guide <https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script>`__
to install Docker engine.

- TensorFlow Serving. `TensorFlow Serving <https://www.TensorFlow.org/tfx/guide/serving>`__
is a flexible, high-performance serving system for machine learning models,

- TensorFlow Serving cluster scripts package. You can download the source package
- CCZoo TensorFlow Serving cluster scripts package. You can download the source package
``tensorflow-serving-cluster``::

git clone https://github.com/intel/confidential-computing-zoo.git
Expand All @@ -131,14 +128,19 @@ Prerequisites
After Intel SGX DCAP is setup, verify the Intel Architectural Enclave Service Manager is active (running)::

sudo systemctl status aesmd

- Gramine. Follow https://gramine.readthedocs.io for Gramine documentation.

Solution Ingredients
-------------
This solution uses the following ingredients, which are installed as described in the sections below.

- TensorFlow Serving. `TensorFlow Serving <https://www.TensorFlow.org/tfx/guide/serving>`__
is a flexible, high-performance serving system for machine learning models
- `Gramine <https://gramine.readthedocs.io>`__
- Kubernetes. `Kubernetes <https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/>`__
is an open-source system for automating deployment, scaling, and management of
containerized applications. In this tutorial, we will provide a script (``install_kubernetes.sh``)
to install Kubernetes in your machine.

We will start with the TensorFlow Serving service running in a container without the use of Kubernetes.
The TensorFlow Serving service provides confidentiality of the model file using encryption (handled by Gramine) and remote attestation from a secret provisioning server (run from a separate container).

Expand Down