completed api functions

api.py

@@ -1,99 +1,169 @@
+import re
 import uvicorn
 from fastapi import FastAPI, Form, Request
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
-import re
-
 from src.inference import inferenceAPI
 from src.inference_t5 import inferenceAPI_t5
 
 
-# ------ INFERENCE MODEL ------------------------------------------------------
-# appel de la fonction inference, adaptee pour une entree txt
 def summarize(text: str):
-    if choisir_modele.var == "lstm":
-        return " ".join(inferenceAPI(text))
-    elif choisir_modele.var == "fineTunedT5":
+    """
+    Returns the summary of an input text.
+
+    Parameter
+    ---------
+    text : str
+        A text to summarize.
+
+    Returns
+    -------
+    :str
+        The summary of the input text.
+    """
+    if global_choose_model.var == "lstm":
+        text = " ".join(inferenceAPI(text))
+        return re.sub("^1|1$|<start>|<end>", "", text)
+    elif global_choose_model.var == "fineTunedT5":
         text = inferenceAPI_t5(text)
         return re.sub("<extra_id_0> ", "", text)
+    elif global_choose_model.var == "":
+        return "You have not chosen a model."
 
 
-# ----------------------------------------------------------------------------
+def global_choose_model(model_choice):
+    """This function allows to connect the choice of the
+    model and the summary function by defining global variables.
+    The aime is to access a variable outside of a function."""
+    if model_choice == "lstm":
+        global_choose_model.var = "lstm"
+    elif model_choice == "fineTunedT5":
+        global_choose_model.var = "fineTunedT5"
+    elif model_choice == "  ---  ":
+        global_choose_model.var = ""
 
 
-def choisir_modele(choixModele):
-    print("ON A RECUP LE CHOIX MODELE")
-    if choixModele == "lstm":
-        choisir_modele.var = "lstm"
-    elif choixModele == "fineTunedT5":
-        choisir_modele.var = "fineTunedT5"
+# definition of the main elements used in the script
+model_list = [
+    {"model": "  ---  ", "name": "  ---  "},
+    {"model": "lstm", "name": "LSTM"},
+    {"model": "fineTunedT5", "name": "Fine-tuned T5"},
+]
+selected_model = "  ---  "
+model_choice = ""
 
 
 # -------- API ---------------------------------------------------------------
 app = FastAPI()
 
-# static files pour envoi du css au navigateur
+# static files to send the css
 templates = Jinja2Templates(directory="templates")
 app.mount("/templates", StaticFiles(directory="templates"), name="templates")
 
 
 @app.get("/")
 async def index(request: Request):
+    """This function is used to create an endpoint for the
+    index page of the app."""
     return templates.TemplateResponse(
-        "index.html.jinja", {"request": request, "current_route": "/"}
+        "index.html.jinja",
+        {
+            "request": request,
+            "current_route": "/",
+            "model_list": model_list,
+            "selected_model": selected_model,
+        },
     )
 
 
 @app.get("/model")
 async def get_model(request: Request):
+    """This function is used to create an endpoint for
+    the model page of the app."""
     return templates.TemplateResponse(
-        "index.html.jinja", {"request": request, "current_route": "/model"}
+        "index.html.jinja",
+        {
+            "request": request,
+            "current_route": "/model",
+            "model_list": model_list,
+            "selected_model": selected_model,
+        },
     )
 
 
 @app.get("/predict")
 async def get_prediction(request: Request):
+    """This function is used to create an endpoint for
+    the predict page of the app."""
     return templates.TemplateResponse(
         "index.html.jinja", {"request": request, "current_route": "/predict"}
     )
 
 
 @app.post("/model")
-async def choix_model(request: Request, choixModel: str = Form(None)):
-    print(choixModel)
-    if not choixModel:
-        erreur_modele = "Merci de saisir un modèle."
+async def choose_model(request: Request, model_choice: str = Form(None)):
+    """This functions allows to retrieve the model chosen by the user. Then, it
+    can end to an error message if it not defined or it is sent to the
+    global_choose_model function which connects the user choice to the
+    use of a model."""
+    selected_model = model_choice
+    # print(selected_model)
+    if not model_choice:
+        model_error = "Please select a model."
         return templates.TemplateResponse(
-            "index.html.jinja", {"request": request, "text": erreur_modele}
+            "index.html.jinja",
+            {
+                "request": request,
+                "text": model_error,
+                "model_list": model_list,
+                "selected_model": selected_model,
+            },
         )
     else:
-        choisir_modele(choixModel)
-        print("C'est bon on utilise le modèle demandé")
+        global_choose_model(model_choice)
         return templates.TemplateResponse(
-            "index.html.jinja", {"request": request}
+            "index.html.jinja",
+            {
+                "request": request,
+                "model_list": model_list,
+                "selected_model": selected_model,
+            },
         )
 
 
-# retourner le texte, les predictions et message d'erreur si formulaire envoye
-# vide
 @app.post("/predict")
 async def prediction(request: Request, text: str = Form(None)):
+    """This function allows to retrieve the input text of the user.
+    Then, it can end to an error message or it can be sent to
+    the summarize function."""
     if not text:
-        error = "Merci de saisir votre texte."
+        text_error = "Please enter your text."
         return templates.TemplateResponse(
-            "index.html.jinja", {"request": request, "text": error}
+            "index.html.jinja",
+            {
+                "request": request,
+                "text": text_error,
+                "model_list": model_list,
+                "selected_model": selected_model,
+            },
         )
     else:
         summary = summarize(text)
         return templates.TemplateResponse(
             "index.html.jinja",
-            {"request": request, "text": text, "summary": summary},
+            {
+                "request": request,
+                "text": text,
+                "summary": summary,
+                "model_list": model_list,
+                "selected_model": selected_model,
+            },
         )
 
 
 # ------------------------------------------------------------------------------------
 
 
-# lancer le serveur et le recharger a chaque modification sauvegardee
+# launch the server and reload it each time a change is saved
 if __name__ == "__main__":
     uvicorn.run("api:app", port=8000, reload=True)

templates/index.html.jinja

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="fr">
+<html lang="en">
     <head>
         <title>Text summarization API</title>
         <meta charset="utf-8" />
@@ -8,28 +8,11 @@
         <script>
             function customReset()
             {
-                document.getElementById("my_form").value = "";
+                document.getElementById("text_form").value = "";
                 document.getElementById("text").value = "";
                 document.getElementById("summary").value = "";
             }
         </script>
-        <script>
-        function submitBothForms()
-            {
-            document.getElementById("my_form").submit();
-            document.getElementById("choixModel").submit();
-            }
-        </script>
-        <script>
-            function getValue() {
-                var e = document.getElementById("choixModel");
-                var value = e.value;
-                var text = e.options[e.selectedIndex].text;
-                return text}
-        </script>
-        <script type="text/javascript">
-            document.getElementById('choixModel').value = "<?php echo $_GET['choixModel'];?>";
-        </script>
     </head>
     <body>
         <div id="header">
@@ -44,22 +27,29 @@
             <hr/>
             </nav>
 
-            <div class="choixModel">
-                <form id="choixModel" method="post" action="/model">
+            <div class="model_choice">
+                <form id="model_choice" method="post" action="/model">
                     <label for="selectModel">Choose a model :</label>
-                    <select name="choixModel" class="selectModel" id="choixModel">
-                        <option value="lstm">LSTM</option>
-                        <option value="fineTunedT5" selected>Fine-tuned T5</option>
+                    <select name="model_choice" class="selectModel" id="model_choice">
+                        <!--A for jinja loop to retrieve option buttons from the api
+                        and to keep them selected when a choice is made. -->
+                        {% for x in model_list%}
+                            {%if selected_model == x.model%}
+                                <option value="{{x.model}}" selected>{{x.name}}</option>
+                            {%else%}
+                                <option value="{{x.model}}">{{x.name}}</option>
+                            {%endif%}
+                        {%endfor%}
                     </select>
                 </form>
-                <button form ="choixModel" class='search_bn' type="submit" class="btn btn-primary btn-block btn-large" rows="1" cols="50">Select model</button>
+                <button form ="model_choice" class='search_bn' type="submit" class="btn btn-primary btn-block btn-large" rows="1" cols="50">Select model</button>
             </div>
 
             <div>
                 <table>
                     <tr>
                         <td>
-                            <form id = "my_form" action="/predict"  method="post" class="formulaire">
+                            <form id = "text_form" action="/predict"  method="post" class="formulaire">
                                 <textarea id="text" name="text" placeholder="Enter your text here!" rows="15" cols="75">{{text}}</textarea>
                                 <input type="hidden" name="textarea_value" value="{{ text }}">
                             </form>
@@ -71,12 +61,12 @@
                 </table>
             </div>
             <div class="buttons">
+                <!--A if loop to disable Go and Reset button for the index page.-->
                 {% if current_route == "/" %}
-                <button>Merci de sélectionner un modèle</button>
+                <button>Please select a model</button>
                 {% else %}
-                 <!-- <button id="submit" type="submit" onclick=submitBothForms()>SUBMIT</button> -->
-                <button form ="my_form" class='search_bn' type="submit" class="btn btn-primary btn-block btn-large" rows="1" cols="50">Go !</button>
-                <button form ="my_form" type="button" value="Reset" onclick="customReset();">Reset</button>
+                <button form ="text_form" class='search_bn' type="submit" class="btn btn-primary btn-block btn-large" rows="1" cols="50">Go !</button>
+                <button form ="text_form" type="button" value="Reset" onclick="customReset();">Reset</button>
                 {% endif %}
             </div>
 
@@ -85,7 +75,7 @@
                         <li>&copy; Untitled. All rights reserved.</li>
                     </ul>
                     <ul>
-                        <li>Projet mené dans le cadre des cours du master 2 TAL (Traitement Automatique des Langues)</li>
+                        <li>University project as part of the NLP (Natural Language Processing) Master's program</li>
                         <li>Lingyun GAO -- Estelle SALMON -- Eve SAUVAGE</li>
                     </ul>
             </div>

templates/site_style/css/main.css

@@ -471,7 +471,4 @@ textarea {
 		margin-top: 20px;
 	  }
 
-	  html body div form select[name="choixModel"] {
-		width: 150px;
-	}
 	}