chore: Update the readme.
Browse files
README.md
CHANGED
@@ -2,30 +2,17 @@
|
|
2 |
license: apache-2.0
|
3 |
---
|
4 |
|
5 |
-
#
|
6 |
|
7 |
-
|
8 |
|
9 |
-
|
10 |
-
- by ML practicioners, to create Concrete ML FHE-friendly models, and make them available to HF users
|
11 |
-
- by companies, institutions or people to deploy those models over HF inference endpoints
|
12 |
-
- by developers, to use these entry points to make applications on privacy-preserving ML
|
13 |
|
14 |
-
|
15 |
-
|
16 |
-
This is quite easy. Fork this template (maybe use this experimental tool https://huggingface.co/spaces/huggingface-projects/repo_duplicator for that), and then:
|
17 |
-
- install everything with: `pip install -r requirements.txt`
|
18 |
-
- edit `creating_models.py`, and fill the part between "# BEGIN: insert your ML task here" and
|
19 |
-
"# END: insert your ML task here"
|
20 |
-
- run the python file: `python creating_models.py`
|
21 |
-
|
22 |
-
At the end, if the script is successful, you'll have your compiled model ready in `compiled_model`. Now you can commit and push your repository (with in particular `compiled_model`, `handler.py`, `play_with_endpoint.py` and `requirements.txt`, but you can include the other files as well).
|
23 |
-
|
24 |
-
We recommend you to tag your Concrete ML compiled repository with `Concrete ML FHE friendly` tag, such that people can find them easily.
|
25 |
|
26 |
## Deploying a compiled model on HF inference endpoint
|
27 |
|
28 |
-
If you
|
29 |
- click on 'Deploy' button in HF interface
|
30 |
- chose "Inference endpoints"
|
31 |
- chose the right model repository
|
|
|
2 |
license: apache-2.0
|
3 |
---
|
4 |
|
5 |
+
# MNIST digit classification with a CNN with Concrete ML
|
6 |
|
7 |
+
In this repository, we classify MNIST digits, without seing digits! Indeed, digits are sent encrypted to the HF endpoints, and are classified without the server seeing the email in the clear, thanks to fully homomorphic encryption (FHE). This is done thanks to Zama's Concrete ML.
|
8 |
|
9 |
+
Concrete ML is Zama's open-source privacy-preserving ML package, FHE. We refer the reader to fhe.org or Zama's websites for more information on FHE.
|
|
|
|
|
|
|
10 |
|
11 |
+
This directory was creating from the template https://huggingface.co/zama-fhe/concrete-ml-template-alpha.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
12 |
|
13 |
## Deploying a compiled model on HF inference endpoint
|
14 |
|
15 |
+
If you would like to deploy, it is very easy.
|
16 |
- click on 'Deploy' button in HF interface
|
17 |
- chose "Inference endpoints"
|
18 |
- chose the right model repository
|