adding code documentation

app.py

@@ -43,6 +43,22 @@ client_cache = OrderedDict()
 MAX_CACHE_SIZE = 15
 default_client=Client("pi19404/ai-worker", hf_token=API_TOKEN)
 def get_client_for_ip(ip_address,x_ip_token):
+    """
+    Retrieve or create a client for the given IP address.
+
+    This function implements a caching mechanism to store up to MAX_CACHE_SIZE clients.
+    If a client for the given IP exists in the cache, it's returned and moved to the end
+    of the cache (marking it as most recently used). If not, a new client is created,
+    added to the cache, and the least recently used client is removed if the cache is full.
+
+    Args:
+        ip_address (str): The IP address of the client.
+        x_ip_token (str): The X-IP-Token header value for the client.
+
+    Returns:
+        Client: A Gradio client instance for the given IP address.
+    """
+
     if x_ip_token is None:
         x_ip_token=ip_address
 
@@ -55,6 +71,7 @@ def get_client_for_ip(ip_address,x_ip_token):
             # Move the accessed item to the end (most recently used)
             client_cache.move_to_end(x_ip_token)
             return client_cache[x_ip_token]
+
         # Create a new client
         new_client = Client("pi19404/ai-worker", hf_token=API_TOKEN, headers={"X-IP-Token": x_ip_token})
         # Add to cache, removing oldest if necessary
@@ -66,6 +83,21 @@ def get_client_for_ip(ip_address,x_ip_token):
     return new_client
 
 def set_client_for_session(request: gr.Request):
+    """
+    Set up a client for the current session and collect request headers.
+
+    This function is called when a new session is initiated. It retrieves or creates
+    a client for the session's IP address and collects all request headers for debugging.
+
+    Args:
+        request (gr.Request): The Gradio request object for the current session.
+
+    Returns:
+        tuple: A tuple containing:
+            - Client: The Gradio client instance for the session.
+            - str: A JSON string of all request headers.
+    """
+
     # Collect all headers in a dictionary
     all_headers = {header: value for header, value in request.headers.items()}
     
@@ -125,6 +157,16 @@ def my_inference_function(client,input_data, output_data,mode, max_length, max_n
             return json.dumps({"error": str(e)})
 
 with gr.Blocks() as demo:
+    """
+    Main Gradio interface setup.
+
+    This block sets up the Gradio interface, including:
+    - A State component to store the client for the session.
+    - A JSON component to display request headers for debugging.
+    - Other UI components (not shown in this snippet).
+    - A load event that calls set_client_for_session when the interface is loaded.
+    """
+    
     gr.Markdown("## LLM Safety Evaluation")
     client = gr.State()
     with gr.Tab("ShieldGemma2"):