github/concrete
1
1
Fork 0
mirror of https://github.com/zama-ai/concrete.git synced 2026-02-09 03:55:04 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve readme (#1308)

Browse Source 
Closes #1301
This commit is contained in:
Andrei Stoian
2022-01-06 14:49:24 +01:00
committed by GitHub
parent 226feec93b
commit 60170a3f03
1 changed files with 62 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@@ -1,41 +1,91 @@
# concrete-numpy
Concrete Numpy Python API - collection of tools to FHE all the things
<p align="center">
<h1 align="center">Concrete Numpy</h1>
</p>
Concrete Numpy is an open-source set of tools which aims to simplify the use of fully homomorphic encryption (FHE) for data scientists.
With Concrete Numpy, data scientists can implement machine learning models using a subset of numpy that compiles to FHE. They will be able to train models with popular machine learning libraries and then convert the prediction functions of these models to FHE with concrete-numpy.
<!-- TOC -->
- [concrete-numpy](#concrete-numpy)
- [Links](#links)
- [For end users](#for-end-users)
- [Using the project](#using-the-project)
- [Installation](#Installation)
- [A simple example](#a-simple-example-numpy-addition-in-fhe)
- [For developers](#for-developers)
- [Project setup](#project-setup)
- [Documenting](#documenting)
- [Developing](#developing)
- [Contributing](#contributing)
- [License](#license)
<!-- /TOC -->
# Links
## For end users
- [documentation](https://docs.zama.ai/concrete-numpy/main/)
- [community website](https://community.zama.ai/c/concrete-numpy/7)
- [machine learning examples](https://docs.zama.ai/concrete-numpy/main/user/advanced_examples/index.html)
# For end users
### Using the project
## Installation
To use the project you can check [INSTALLING.md](docs/user/howto/INSTALLING.md)
The preferred way to use concrete-numpy is through docker. You can get the concrete-numpy docker image by pulling the latest docker image:
## For developers
`docker pull zamafhe/concrete-numpy:latest`
To install Concrete Numpy from PyPi, run the following:
`pip install concrete-numpy`
You can find more detailed installation instructions in [installing.md](docs/user/basics/installing.md)
## A simple example: numpy addition in FHE
```python
import concrete.numpy as hnp
def f(x, y):
return x + y
inputset = [(2, 3), (0, 0), (1, 6), (7, 7), (7, 1), (3, 2), (6, 1), (1, 7), (4, 5), (5, 4)]
compiler = hnp.NPFHECompiler(
f, {"x": x, "y": y},
)
circuit = compiler.compile_on_inputset(inputset)
circuit.run(3, 4)
# 7
circuit.run(1, 2)
# 3
circuit.run(7, 7)
# 14
circuit.run(0, 0)
# 0
```
# For developers
### Project setup
Installation steps are described in [PROJECT_SETUP.md](docs/dev/howto/PROJECT_SETUP.md).
Information about how to use Docker for development are available in [DOCKER.md](docs/dev/howto/DOCKER.md).
Installation steps are described in [project_setup.md](docs/dev/howto/project_setup.md).
Information about how to use Docker for development are available in [docker.md](docs/dev/howto/docker.md).
### Documenting
Some information about how to build the documentation of `concrete-numpy` are available in [DOCUMENTING.md](docs/dev/howto/DOCUMENTING.md). Notably, our documentation is pushed to [https://docs.zama.ai/concrete-numpy/](https://docs.zama.ai/concrete-numpy/).
Some information about how to build the documentation of `concrete-numpy` are available in [documenting.md](docs/dev/howto/documenting.md). Notably, our documentation is pushed to [https://docs.zama.ai/concrete-numpy/](https://docs.zama.ai/concrete-numpy/).
### Developing
Some information about our terminology and the infrastructure of `concrete-numpy` are available in [TERMINOLOGY_AND_STRUCTURE.md](docs/dev/explanation/TERMINOLOGY_AND_STRUCTURE.md). An in-depth look at what is done in `concrete-numpy` is available in [COMPILATION.md](docs/dev/explanation/COMPILATION.md).
Some information about our terminology and the infrastructure of `concrete-numpy` are available in [terminology_and_structure.md](docs/dev/explanation/terminology_and_structure.md). An in-depth look at what is done in `concrete-numpy` is available in [compilation.md](docs/dev/explanation/compilation.md).
### Contributing
Information about how to contribute are available in [CONTRIBUTING.md](docs/dev/howto/CONTRIBUTING.md).
Information about how to contribute are available in [contributing.md](docs/dev/howto/contributing.md).
# License
This software is distributed under the BSD-3-Clause-Clear license. If you have any questions, please contact us at hello@zama.ai.