romanbredehoft-zama commited on
Commit
6318eaa
β€’
1 Parent(s): 482af6f

Update readme

Browse files
Files changed (1) hide show
  1. README.md +59 -4
README.md CHANGED
@@ -1,12 +1,67 @@
1
  ---
2
  title: Credit Card Approval Prediction
3
- emoji: πŸ‘
4
- colorFrom: pink
5
- colorTo: purple
6
  sdk: gradio
7
  sdk_version: 3.40.0
8
  app_file: app.py
9
  pinned: false
 
 
 
 
 
 
 
 
 
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: Credit Card Approval Prediction
3
+ emoji: πŸ’³ βœ…
4
+ colorFrom: green
5
+ colorTo: green
6
  sdk: gradio
7
  sdk_version: 3.40.0
8
  app_file: app.py
9
  pinned: false
10
+ tags:
11
+ - FHE
12
+ - PPML
13
+ - privacy
14
+ - privacy preserving machine learning
15
+ - credit card approval
16
+ - credit score
17
+ - homomorphic encryption
18
+ - security
19
+ python_version: 3.10.11
20
  ---
21
 
22
+ # Credit card approval using FHE
23
+
24
+ ## Run the application locally
25
+
26
+ ### Install the dependencies
27
+
28
+ First, create a virtual env and activate it:
29
+
30
+ ```bash
31
+ python3 -m venv .venv
32
+ source .venv/bin/activate
33
+ ```
34
+
35
+ Then, install the required packages:
36
+
37
+ ```bash
38
+ pip3 install pip --upgrade
39
+ pip3 install -U pip wheel setuptools --ignore-installed
40
+ pip3 install -r requirements.txt --ignore-installed
41
+ ```
42
+
43
+ The above steps should only be done once.
44
+
45
+ ## Run the app
46
+
47
+ In a terminal, run:
48
+
49
+ ```bash
50
+ source .venv/bin/activate
51
+ python3 app.py
52
+ ```
53
+
54
+ ## Interact with the application
55
+
56
+ Open the given URL link (search for a line like `Running on local URL: http://127.0.0.1:8888/`).
57
+
58
+
59
+ ## Development
60
+
61
+ If the model, data-set or pre/post-processing is modified locally, it is possible to initialize,
62
+ fit and compile the model all at once using the following command. It will also save the deployment
63
+ files at the right places in order to make sure the app works properly :
64
+
65
+ ```bash
66
+ python3 development.py
67
+ ```