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

docs: re-write documentation

Browse Source
This commit is contained in:
aquint-zama
2022-06-01 15:41:37 +02:00
committed by Umut
parent 546ed48765
commit 35e46aca69
53 changed files with 1505 additions and 1673 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
docs/dev/project_setup.md
View File

@@ -1,171 +1,93 @@
# Project Setup
{% hint style='info' %}
It is strongly recommended to use the development docker (see the [docker](./docker.md) guide). However you can setup the project on bare macOS and Linux provided you install the required dependencies (check Dockerfile.env for the required binary packages like make).
The project targets Python 3.8 through 3.9 inclusive.
{% hint style="info" %}
It is **strongly** recommended to use the development tool Docker. Though, you can set the project up on a bare Linux or macOS as long as you have the required dependencies. You can see the required dependencies in `Dockerfile.dev` under `docker` directory.
{% endhint %}
## Installing Python
## Installing `Python`
**concrete-numpy** is a `Python` library, so `Python` should be installed to develop **concrete-numpy**. `v3.8` and `v3.9` are the only supported versions.
**Concrete Numpy** is a `Python` library, so `Python` should be installed to develop it. `v3.8` and `v3.9` are, currently, the only supported versions.
You can follow [this](https://realpython.com/installing-python/) guide to install it (alternatively you can google `how to install python 3.8 (or 3.9)`).
You probably have Python already, but in case you don't, or in case you have an unsupported version, you can google `how to install python 3.8` and follow one of the results.
## Installing Poetry
## Installing `Poetry`
`Poetry` is our package manager. It drastically simplifies dependency and environment management.
You can follow [this](https://python-poetry.org/docs/#installation) official guide to install it.
{% hint style='danger' %}
As there is no `concrete-compiler` package for Windows, only the dev dependencies can be installed. This requires poetry >= 1.2.
## Installing `make`
At the time of writing (January 2022), there is only an alpha version of poetry 1.2 that you can install. In the meantime we recommend following [this link to setup the docker environment](./docker.md) on Windows.
{% endhint %}
`make` is used to launch various commands such as formatting and testing.
## Installing make
On Linux, you can install `make` using the package manager of your distribution.
The dev tools use `make` to launch the various commands.
On Linux you can install `make` from your distribution's preferred package manager.
On Mac OS you can install a more recent version of `make` via brew:
On macOS, you can install `gmake` via brew:
```shell
# check for gmake
which gmake
# If you don't have it, it will error out, install gmake
brew install make
# recheck, now you should have gmake
which gmake
```
It is possible to install `gmake` as `make`, check this [StackOverflow post](https://stackoverflow.com/questions/38901894/how-can-i-install-a-newer-version-of-make-on-mac-os) for more info.
On Windows check [this GitHub gist](https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058#make).
{% hint style='tip' %}
In the following sections, be sure to use the proper `make` tool for your system: `make`, `gmake`, or other.
{% hint style="info" %}
In the following sections, be sure to use the proper `make` tool for your system (i.e., `make`, `gmake`, etc).
{% endhint %}
## Cloning repository
## Cloning the repository
Now, it's time to get the source code of **concrete-numpy**.
Now, it's time to get the source code of **Concrete Numpy**.
Clone the code repository using the link for your favourite communication protocol (ssh or https).
Clone the git repository from GitHub using the protocol of your choice (ssh or https).
## Setting up environment on your host OS
## Setting up the environment
We are going to make use of virtual environments. This helps to keep the project isolated from other `Python` projects in the system. The following commands will create a new virtual environment under the project directory and install dependencies to it.
Virtual environments are utilized to keep the project isolated from other `Python` projects in the system.
{% hint style='danger' %}
The following command will not work on Windows if you don't have poetry >= 1.2. As poetry 1.2 is still in alpha we recommend following [this link to setup the docker environment](./docker.md) instead.
{% endhint %}
To create a new virtual environment and install dependencies, use the command:
```shell
cd concrete-numpy
make setup_env
```
## Activating the environment
Finally, all we need to do is to activate the newly created environment using the following command.
### macOS or Linux
To activate the newly created environment, use:
```shell
source .venv/bin/activate
```
### Windows
## Syncing the environment
From time to time, new dependencies will be added to the project and old ones will be removed.
The command below will make sure the project has the proper environment, so run it regularly.
```shell
source .venv/Scripts/activate
make sync_env
```
## Setting up environment on docker
## Troubleshooting
The docker automatically creates and sources a venv in ~/dev_venv/
### In native setups.
The venv persists thanks to volumes. We also create a volume for ~/.cache to speed up later reinstallations. You can check which docker volumes exist with:
```shell
docker volume ls
```
You can still run all `make` commands inside the docker (to update the venv, for example). Be mindful of the current venv being used (the name in parentheses at the beginning of your command prompt).
```shell
# Here we have dev_venv sourced
(dev_venv) dev_user@8e299b32283c:/src$ make setup_env
```
## Leaving the environment
After your work is done, you can simply run the following command to leave the environment.
If you are having issues in a native setup, you can try to re-create your environment like this:
```shell
deactivate
```
## Syncing environment with the latest changes
From time to time, new dependencies will be added to project or the old ones will be removed. The command below will make sure the project has the proper environment. So run it regularly!
```shell
make sync_env
```
## Troubleshooting your environment
### In your OS
If you are having issues, consider using the dev docker exclusively (unless you are working on OS specific bug fixes or features).
Here are the steps you can take on your OS to try and fix issues:
```shell
# Try to install the env normally
make setup_env
# If you are still having issues, sync the environment
make sync_env
# If you are still having issues on your OS delete the venv:
rm -rf .venv
# And re-run the env setup
make setup_env
source .venv/bin/activate
```
At this point you should consider using docker as nobody will have the exact same setup as you, unless you need to develop on your OS directly, in which case you can ask us for help but may not get a solution right away.
If the problem persists, you should consider using Docker. If you are working on a platform specific feature and Docker is not an option, you should create an issue so that we can take a look at your problem.
### In docker
### In docker setups.
Here are the steps you can take in your docker to try and fix issues:
If you are having issues in a docker setup, you can try to re-build the docker image:
```shell
# Try to install the env normally
make setup_env
# If you are still having issues, sync the environment
make sync_env
# If you are still having issues in docker delete the venv:
rm -rf ~/dev_venv/*
# Disconnect from the docker
exit
# And relaunch, the venv will be reinstalled
make docker_start
# If you are still out of luck, force a rebuild which will also delete the volumes
make docker_rebuild
# And start the docker which will reinstall the venv
make docker_start
```
If the problem persists at this point, you should consider asking for help. We're here and ready to assist!
If the problem persists, you should contact us for help.