Files
concrete/docs/user/basics/installing.md
Arthur Meyre e522f22ce8 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
2022-01-04 09:12:18 +01:00

1.9 KiB

Installing

Python package

To install Concrete from PyPi, run the following:

pip install concrete-framework
Note that **concrete-framework** has `pygraphviz` as an optional dependency to draw graphs.
`pygraphviz` requires `graphviz` packages being installed on your OS, see <a href="https://pygraphviz.github.io/documentation/stable/install.html">https://pygraphviz.github.io/documentation/stable/install.html</a>
`graphviz` packages are binary packages that won't automatically be installed by pip.
Do check <a href="https://pygraphviz.github.io/documentation/stable/install.html">https://pygraphviz.github.io/documentation/stable/install.html</a> for instructions on how to install `graphviz` for `pygraphviz`.

You can install the extra python dependencies for drawing with:

pip install concrete-framework[full]
# you may need to force reinstallation
pip install --force-reinstall concrete-framework[full]

Docker image

You can also get the concrete-framework docker image by either pulling the latest docker image or a specific version:

docker pull zamafhe/concrete-framework:latest
# or
docker pull zamafhe/concrete-framework:v0.2.0

The image can be used with docker volumes, see the docker documentation here.

You can then use this image with the following command:

# Without local volume:
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/concrete-framework:v0.2.0

This will launch a Concrete enabled jupyter server in the docker, that you can access from your browser.

Alternatively, you can just open a shell in the docker with or without volumes:

docker run --rm -it zamafhe/concrete-framework:v0.2.0 /bin/bash