mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
chore: rename package
- poetry lock required to update package name - related Makefile and licenses update to keep consistency (will be removed once the PyPi package is available) - modified compile_torch_model to only accept datasets with one input mypy error with better numpy typing hints appeared closes #1252
This commit is contained in:
@@ -5,11 +5,11 @@
|
||||
To install **Concrete** from PyPi, run the following:
|
||||
|
||||
```shell
|
||||
pip install concretefhe
|
||||
pip install concrete-framework
|
||||
```
|
||||
|
||||
```{note}
|
||||
Note that **concretefhe** has `pygraphviz` as an optional dependency to draw graphs.
|
||||
Note that **concrete-framework** has `pygraphviz` as an optional dependency to draw graphs.
|
||||
```
|
||||
|
||||
```{WARNING}
|
||||
@@ -24,19 +24,19 @@ Do check <a href="https://pygraphviz.github.io/documentation/stable/install.html
|
||||
You can install the extra python dependencies for drawing with:
|
||||
|
||||
```shell
|
||||
pip install concretefhe[full]
|
||||
pip install concrete-framework[full]
|
||||
# you may need to force reinstallation
|
||||
pip install --force-reinstall concretefhe[full]
|
||||
pip install --force-reinstall concrete-framework[full]
|
||||
```
|
||||
|
||||
## Docker image
|
||||
|
||||
You can also get the **concretefhe** docker image by either pulling the latest docker image or a specific version:
|
||||
You can also get the **concrete-framework** docker image by either pulling the latest docker image or a specific version:
|
||||
|
||||
```shell
|
||||
docker pull zamafhe/concretefhe:latest
|
||||
docker pull zamafhe/concrete-framework:latest
|
||||
# or
|
||||
docker pull zamafhe/concretefhe:v0.2.0
|
||||
docker pull zamafhe/concrete-framework:v0.2.0
|
||||
```
|
||||
|
||||
The image can be used with docker volumes, [see the docker documentation here](https://docs.docker.com/storage/volumes/).
|
||||
@@ -45,10 +45,10 @@ You can then use this image with the following command:
|
||||
|
||||
```shell
|
||||
# Without local volume:
|
||||
docker run --rm -it -p 8888:8888 zamafhe/concretefhe:v0.2.0
|
||||
docker run --rm -it -p 8888:8888 zamafhe/concrete-framework:v0.2.0
|
||||
|
||||
# With local volume to save notebooks on host:
|
||||
docker run --rm -it -p 8888:8888 -v /host/path:/data zamafhe/concretefhe:v0.2.0
|
||||
docker run --rm -it -p 8888:8888 -v /host/path:/data zamafhe/concrete-framework:v0.2.0
|
||||
```
|
||||
|
||||
This will launch a **Concrete** enabled jupyter server in the docker, that you can access from your browser.
|
||||
@@ -56,5 +56,5 @@ This will launch a **Concrete** enabled jupyter server in the docker, that you c
|
||||
Alternatively, you can just open a shell in the docker with or without volumes:
|
||||
|
||||
```shell
|
||||
docker run --rm -it zamafhe/concretefhe:v0.2.0 /bin/bash
|
||||
docker run --rm -it zamafhe/concrete-framework:v0.2.0 /bin/bash
|
||||
```
|
||||
|
||||
@@ -20,11 +20,11 @@ The drawing package required is `pygraphviz` which needs `graphviz` packages ins
|
||||
|
||||
To install the required drawing packages once you have `graphviz` installed run:
|
||||
|
||||
`pip install concretefhe[full]`
|
||||
`pip install concrete-framework[full]`
|
||||
|
||||
You may need to force reinstallation
|
||||
|
||||
`pip install --force-reinstall concretefhe[full]`
|
||||
`pip install --force-reinstall concrete-framework[full]`
|
||||
```
|
||||
|
||||
To draw your circuit, you can do the following:
|
||||
|
||||
Reference in New Issue
Block a user