Commit
·
5a9d2a3
1
Parent(s):
a13c444
Clarify readme steps
Browse files
README.md
CHANGED
|
@@ -14,16 +14,14 @@ python_version: 3.8.16
|
|
| 14 |
|
| 15 |
# Image filtering using FHE
|
| 16 |
|
| 17 |
-
##
|
| 18 |
|
| 19 |
In this directory, ie `image_filtering`, you can do the following steps.
|
| 20 |
|
| 21 |
-
###
|
| 22 |
|
| 23 |
First, create a virtual env and activate it:
|
| 24 |
|
| 25 |
-
<!--pytest-codeblocks:skip-->
|
| 26 |
-
|
| 27 |
```bash
|
| 28 |
python3 -m venv .venv
|
| 29 |
source .venv/bin/activate
|
|
@@ -31,42 +29,43 @@ source .venv/bin/activate
|
|
| 31 |
|
| 32 |
Then, install required packages:
|
| 33 |
|
| 34 |
-
<!--pytest-codeblocks:skip-->
|
| 35 |
-
|
| 36 |
```bash
|
| 37 |
pip3 install pip --upgrade
|
| 38 |
pip3 install -U pip wheel setuptools --ignore-installed
|
| 39 |
pip3 install -r requirements.txt --ignore-installed
|
| 40 |
```
|
| 41 |
|
| 42 |
-
|
| 43 |
-
See section [Generating new files](#generating-new-files).
|
| 44 |
|
|
|
|
| 45 |
|
| 46 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 47 |
|
| 48 |
-
In a terminal, run:
|
| 49 |
|
| 50 |
-
|
|
|
|
|
|
|
| 51 |
|
| 52 |
```bash
|
| 53 |
source .venv/bin/activate
|
| 54 |
python3 app.py
|
| 55 |
```
|
| 56 |
|
| 57 |
-
##
|
| 58 |
|
| 59 |
Open the given URL link (search for a line like `Running on local URL: http://127.0.0.1:8888/`).
|
| 60 |
|
| 61 |
|
| 62 |
-
##
|
| 63 |
|
| 64 |
It is also possible to manually add some new filters in `filters.py`. Yet, in order to be able to use
|
| 65 |
them interactively in the app, you first need to update the `AVAILABLE_FILTERS` list found in `common.py`
|
| 66 |
and then compile them by running :
|
| 67 |
|
| 68 |
-
<!--pytest-codeblocks:skip-->
|
| 69 |
-
|
| 70 |
```bash
|
| 71 |
python3 generate_dev_filters.py
|
| 72 |
```
|
|
|
|
| 14 |
|
| 15 |
# Image filtering using FHE
|
| 16 |
|
| 17 |
+
## Run the application on your machine
|
| 18 |
|
| 19 |
In this directory, ie `image_filtering`, you can do the following steps.
|
| 20 |
|
| 21 |
+
### Install dependencies
|
| 22 |
|
| 23 |
First, create a virtual env and activate it:
|
| 24 |
|
|
|
|
|
|
|
| 25 |
```bash
|
| 26 |
python3 -m venv .venv
|
| 27 |
source .venv/bin/activate
|
|
|
|
| 29 |
|
| 30 |
Then, install required packages:
|
| 31 |
|
|
|
|
|
|
|
| 32 |
```bash
|
| 33 |
pip3 install pip --upgrade
|
| 34 |
pip3 install -U pip wheel setuptools --ignore-installed
|
| 35 |
pip3 install -r requirements.txt --ignore-installed
|
| 36 |
```
|
| 37 |
|
| 38 |
+
The above steps should only be done once.
|
|
|
|
| 39 |
|
| 40 |
+
## Generate development files
|
| 41 |
|
| 42 |
+
If you are not on Linux, you will need to re-generate the development files manually before launching the app.
|
| 43 |
+
|
| 44 |
+
```bash
|
| 45 |
+
python3 generate_dev_filters.py
|
| 46 |
+
```
|
| 47 |
|
|
|
|
| 48 |
|
| 49 |
+
## Run the app
|
| 50 |
+
|
| 51 |
+
In a terminal, run:
|
| 52 |
|
| 53 |
```bash
|
| 54 |
source .venv/bin/activate
|
| 55 |
python3 app.py
|
| 56 |
```
|
| 57 |
|
| 58 |
+
## Interact with the application
|
| 59 |
|
| 60 |
Open the given URL link (search for a line like `Running on local URL: http://127.0.0.1:8888/`).
|
| 61 |
|
| 62 |
|
| 63 |
+
## Generate new filters
|
| 64 |
|
| 65 |
It is also possible to manually add some new filters in `filters.py`. Yet, in order to be able to use
|
| 66 |
them interactively in the app, you first need to update the `AVAILABLE_FILTERS` list found in `common.py`
|
| 67 |
and then compile them by running :
|
| 68 |
|
|
|
|
|
|
|
| 69 |
```bash
|
| 70 |
python3 generate_dev_filters.py
|
| 71 |
```
|