Refactor send files to server

app.py

@@ -10,7 +10,7 @@ from settings import (
     CHILDREN_MIN_MAX,
     INCOME_MIN_MAX,
     AGE_MIN_MAX,
-    EMPLOYED_MIN_MAX,
+    SALARIED_MIN_MAX,
     FAMILY_MIN_MAX,
     INCOME_TYPES,
     OCCUPATION_TYPES,
@@ -40,7 +40,7 @@ print("Starting the demo...")
 with demo:
     gr.Markdown(
         """
-        <h1 align="center">Credit Card Approval Prediction Using Fully Homomorphic Encryption</h1>
+        <h1 align="center">Encrypted Credit Card Approval Prediction Using Fully Homomorphic Encryption</h1>
         """
     )
 
@@ -57,10 +57,10 @@ with demo:
             gr.Markdown("### User")
             gender = gr.Radio(["Female", "Male"], label="Gender", value="Female")
             bool_inputs = gr.CheckboxGroup(["Car", "Property", "Work phone", "Phone", "Email"], label="What do you own ?")
-            num_children = gr.Slider(**CHILDREN_MIN_MAX, step=1, label="Number of children", info="How many children do you have (0 to 19) ?")
-            num_family = gr.Slider(**FAMILY_MIN_MAX, step=1, label="Family", info="How many members does your family have? (1 to 20) ?")
-            total_income = gr.Slider(**INCOME_MIN_MAX, label="Income", info="What's you total yearly income (in euros, 3780 to 220500) ?")
-            age = gr.Slider(**AGE_MIN_MAX, step=1, label="Age", info="How old are you (20 to 68) ?")
+            num_children = gr.Slider(**CHILDREN_MIN_MAX, step=1, label="Number of children", info="How many children do you have ?")
+            household_size = gr.Slider(**FAMILY_MIN_MAX, step=1, label="Household size", info="How many members does your family have? ?")
+            total_income = gr.Slider(**INCOME_MIN_MAX, label="Income", info="What's you total yearly income (in euros) ?")
+            age = gr.Slider(**AGE_MIN_MAX, step=1, label="Age", info="How old are you ?")
             income_type = gr.Dropdown(choices=INCOME_TYPES, value=INCOME_TYPES[0], label="Income type", info="What is your main type of income ?")
             education_type = gr.Dropdown(choices=EDUCATION_TYPES, value=EDUCATION_TYPES[0], label="Education", info="What is your education background ?")
             family_status = gr.Dropdown(choices=FAMILY_STATUS, value=FAMILY_STATUS[0], label="Family", info="What is your family status ?")
@@ -69,12 +69,12 @@ with demo:
 
         with gr.Column():
             gr.Markdown("### Bank ")
-            account_length = gr.Slider(**ACCOUNT_MIN_MAX, step=1, label="Account length", info="How long have this person had this account (in months, 0 to 60) ?")
+            account_length = gr.Slider(**ACCOUNT_MIN_MAX, step=1, label="Account length", info="How long have this person had this account (in months) ?")
 
         with gr.Column():
             gr.Markdown("### Third party ")
-            employed = gr.Radio(["Yes", "No"], label="Is the person employed ?", value="Yes")
-            years_employed = gr.Slider(**EMPLOYED_MIN_MAX, step=1, label="Years of employment", info="How long have this person been employed (in years, 0 to 43) ?")
+            salaried = gr.Radio(["Yes", "No"], label="Is the person salaried ?", value="Yes")
+            years_salaried = gr.Slider(**SALARIED_MIN_MAX, step=1, label="Years of employment", info="How long have this person been salaried (in years) ?")
 
 
     gr.Markdown("### Step 3: Encrypt  using FHE and send the inputs to the server.")
@@ -153,7 +153,7 @@ with demo:
     # side to the server
     encrypt_button_user.click(
         pre_process_encrypt_send_user,
-        inputs=[client_id, gender, bool_inputs, num_children, num_family, total_income, age, \
+        inputs=[client_id, gender, bool_inputs, num_children, household_size, total_income, age, \
                 income_type, education_type, family_status, occupation_type, housing_type],
         outputs=[encrypted_input_user],
     )
@@ -170,7 +170,7 @@ with demo:
     # client side to the server    
     encrypt_button_third_party.click(
         pre_process_encrypt_send_third_party,
-        inputs=[client_id, employed, years_employed],
+        inputs=[client_id, salaried, years_salaried],
         outputs=[encrypted_input_third_party],
     )
 

backend.py

@@ -103,7 +103,7 @@ def _get_client_file_path(name, client_id, client_type=None):
     """Get the file path for the client.
 
     Args:
-        name (str): The desired file name (either 'evaluation_key', 'encrypted_inputs') of 
+        name (str): The desired file name (either 'evaluation_key', 'encrypted_inputs' or 
             'encrypted_outputs').
         client_id (int): The client ID to consider.
         client_type (Optional[str]): The type of user to consider (either 'user', 'bank', 
@@ -122,33 +122,6 @@ def _get_client_file_path(name, client_id, client_type=None):
     return dir_path / f"{name}{client_type_suffix}"
 
 
-def _send_eval_key(client_id, evaluation_key_path):
-    """Send the evaluation key to the server.
-
-    Args:
-        client_id (int): The client ID to consider.
-        evaluation_key_path (Path): Path to the evaluation key to send.
-    """
-
-    # Define the data and files to post
-    data = {
-        "client_id": client_id,
-    }
-
-    files = [
-        ("files", open(evaluation_key_path, "rb")),
-    ]
-
-    # Send the evaluation key to the server
-    url = SERVER_URL + "send_eval_key"
-    with requests.post(
-        url=url,
-        data=data,
-        files=files,
-    ) as response:
-        return response.ok
-
-
 def keygen_send():
     """Generate the private and evaluation key, and send the evaluation key to the server.
     
@@ -170,41 +143,46 @@ def keygen_send():
     # Retrieve the serialized evaluation key
     evaluation_key = client.get_serialized_evaluation_keys()
 
+    file_name = "evaluation_key"
+
     # Save evaluation key as bytes in a file as it is too large to pass through regular Gradio
     # buttons (see https://github.com/gradio-app/gradio/issues/1877)
-    evaluation_key_path = _get_client_file_path("evaluation_key", client_id)
+    evaluation_key_path = _get_client_file_path(file_name, client_id)
 
     with evaluation_key_path.open("wb") as evaluation_key_file:
         evaluation_key_file.write(evaluation_key)
 
     # Send the evaluation key to the server
-    _send_eval_key(client_id, evaluation_key_path)
+    _send_to_server(client_id, None, file_name)
     
     return client_id, gr.update(value="Keys are generated and sent ✅")
 
 
-def _send_input(client_id, client_type):
-    """Send the encrypted inputs as well as the evaluation key to the server.
+def _send_to_server(client_id, client_type, file_name):
+    """Send the encrypted inputs or the evaluation key to the server.
 
     Args:
         client_id (int): The client ID to consider.
-        client_type (str): The type of client to consider (either 'user', 'bank' or 'third_party').
+        client_type (Optional[str]): The type of client to consider (either 'user', 'bank', 'third_party' or 
+            None).
+        file_name (str): File name to send (either 'evaluation_key' or 'encrypted_inputs').
     """
     # Get the paths to the encrypted inputs
-    encrypted_input_path = _get_client_file_path("encrypted_inputs", client_id, client_type)
+    encrypted_file_path = _get_client_file_path(file_name, client_id, client_type)
 
     # Define the data and files to post
     data = {
         "client_id": client_id,
         "client_type": client_type,
+        "file_name": file_name,
     }
 
     files = [
-        ("files", open(encrypted_input_path, "rb")),
+        ("files", open(encrypted_file_path, "rb")),
     ]
 
-    # Send the encrypted inputs and evaluation key to the server
-    url = SERVER_URL + "send_input"
+    # Send the encrypted inputs or evaluation key to the server
+    url = SERVER_URL + "send_file"
     with requests.post(
         url=url,
         data=data,
@@ -237,9 +215,11 @@ def _encrypt_send(client_id, inputs, client_type):
         input_slice=INPUT_SLICES[client_type],
     )
 
+    file_name = "encrypted_inputs"
+
     # Save encrypted_inputs to bytes in a file, since too large to pass through regular Gradio
     # buttons, https://github.com/gradio-app/gradio/issues/1877
-    encrypted_inputs_path = _get_client_file_path("encrypted_inputs", client_id, client_type)
+    encrypted_inputs_path = _get_client_file_path(file_name, client_id, client_type)
 
     with encrypted_inputs_path.open("wb") as encrypted_inputs_file:
         encrypted_inputs_file.write(encrypted_inputs)
@@ -247,7 +227,7 @@ def _encrypt_send(client_id, inputs, client_type):
     # Create a truncated version of the encrypted inputs for display
     encrypted_inputs_short = shorten_bytes_object(encrypted_inputs)
 
-    _send_input(client_id, client_type)
+    _send_to_server(client_id, client_type, file_name)
 
     return encrypted_inputs_short
 
@@ -263,7 +243,7 @@ def pre_process_encrypt_send_user(client_id, *inputs):
         (int, bytes): Integer ID representing the current client and a byte short representation of 
             the encrypted input to send. 
     """
-    gender, bool_inputs, num_children, num_family, total_income, age, income_type, education_type, \
+    gender, bool_inputs, num_children, household_size, total_income, age, income_type, education_type, \
         family_status, occupation_type, housing_type = inputs
     
     # Encoding given in https://www.kaggle.com/code/samuelcortinhas/credit-cards-data-cleaning 
@@ -285,7 +265,7 @@ def pre_process_encrypt_send_user(client_id, *inputs):
         "Phone": [phone],
         "Email": [email],
         "Num_children": num_children,
-        "Num_family": num_family,
+        "Num_family": household_size,
         "Total_income": total_income,
         "Age": age,
         "Income_type": income_type,
@@ -327,14 +307,14 @@ def pre_process_encrypt_send_third_party(client_id, *inputs):
         (int, bytes): Integer ID representing the current client and a byte short representation of 
             the encrypted input to send. 
     """
-    employed, years_employed = inputs
+    salaried, years_salaried = inputs
     
     # Original dataset contains an "unemployed" feature instead of "employed"
-    unemployed = employed == "No"
+    unemployed = salaried == "No"
 
     third_party_inputs = pandas.DataFrame({
         "Unemployed": [unemployed],
-        "Years_employed": [years_employed],
+        "Years_employed": [years_salaried],
     })
 
     preprocessed_third_party_inputs = PRE_PROCESSOR_THIRD_PARTY.transform(third_party_inputs)

server.py

@@ -1,7 +1,7 @@
 """Server that will listen for GET and POST requests from the client."""
 
 import time
-from typing import List
+from typing import List, Optional
 from fastapi import FastAPI, File, Form, UploadFile
 from fastapi.responses import JSONResponse, Response
 
@@ -44,33 +44,20 @@ def root():
     return {"message": "Welcome to Credit Card Approval Prediction server!"}
 
 
-@app.post("/send_eval_key")
-def send_eval_key(
+@app.post("/send_file")
+def send_file(
     client_id: str = Form(),
+    client_type: Optional[str] = Form(None),
+    file_name: str = Form(),
     files: List[UploadFile] = File(),
 ):
-    """Send the evaluation key to the server."""
-    # Retrieve the evaluation key path
-    evaluation_key_path = _get_server_file_path("evaluation_key", client_id)
-    
-    # Write the file using the above path
-    with evaluation_key_path.open("wb") as evaluation_key:
-        evaluation_key.write(files[0].file.read())
-
-
-@app.post("/send_input")
-def send_input(
-    client_id: str = Form(),
-    client_type: str = Form(),
-    files: List[UploadFile] = File(),
-):
-    """Send the inputs to the server."""
-    # Retrieve the encrypted inputs
-    encrypted_inputs_path = _get_server_file_path("encrypted_inputs", client_id, client_type)
+    """Send the files to the server."""
+    # Retrieve the encrypted inputs or evaluation key
+    encrypted_file_path = _get_server_file_path(file_name, client_id, client_type)
     
     # Write the file using the above path
-    with encrypted_inputs_path.open("wb") as encrypted_inputs:
-        encrypted_inputs.write(files[0].file.read())
+    with encrypted_file_path.open("wb") as encrypted_file:
+        encrypted_file.write(files[0].file.read())
 
 
 @app.post("/run_fhe")

settings.py

@@ -60,7 +60,7 @@ ACCOUNT_MIN_MAX = get_min_max(_data, "Account_length")
 CHILDREN_MIN_MAX = get_min_max(_data, "Num_children")
 INCOME_MIN_MAX = get_min_max(_data, "Total_income")
 AGE_MIN_MAX = get_min_max(_data, "Age")
-EMPLOYED_MIN_MAX = get_min_max(_data, "Years_employed")
+SALARIED_MIN_MAX = get_min_max(_data, "Years_employed")
 FAMILY_MIN_MAX = get_min_max(_data, "Num_family")
 
 # App data choices