📝 docstrings and upd inputs

Signed-off-by: Peter <74869040+pszemraj@users.noreply.github.com>

app.py

@@ -45,15 +45,15 @@ cwd = Path.cwd()
 my_cwd = str(cwd.resolve())  # string so it can be passed to os.path() objects
 
 
-def chat(prompt_message, temperature=0.7, top_p=0.95, top_k=50):
+def chat(prompt_message, temperature: float = 0.6, top_p: float = 0.95, top_k: int = 25)-> str:
     """
-    chat - helper function that makes the whole gradio thing work.
+    chat - the main function for the chatbot. This is the function that is called when the user
 
-    Args:
-        trivia_query (str): the question to ask the bot
-
-    Returns:
-        [str]: the bot's response
+    :param _type_ prompt_message: the message to send to the model
+    :param float temperature: the temperature value for the model, defaults to 0.6
+    :param float top_p: the top_p value for the model, defaults to 0.95
+    :param int top_k: the top_k value for the model, defaults to 25
+    :return str: the response from the model
     """
     history = []
     response = ask_gpt(
@@ -78,26 +78,26 @@ def ask_gpt(
     chat_pipe,
     speaker="person alpha",
     responder="person beta",
-    max_len=96,
+    min_length=4,
+    max_length=64,
     top_p=0.95,
     top_k=25,
     temperature=0.6,
-):
+) -> str:
     """
-
-    ask_gpt - a function that takes in a prompt and generates a response using the pipeline. This interacts the discussion function.
-
-    Parameters:
-        message (str): the question to ask the bot
-        chat_pipe (str): the chat_pipe to use for the bot (default: "pszemraj/Ballpark-Trivia-XL")
-        speaker (str): the name of the speaker (default: "person alpha")
-        responder (str): the name of the responder (default: "person beta")
-        max_len (int): the maximum length of the response (default: 128)
-        top_p (float): the top probability threshold (default: 0.95)
-        top_k (int): the top k threshold (default: 50)
-        temperature (float): the temperature of the response (default: 0.7)
+    ask_gpt - helper function that asks the GPT model a question and returns the response
+
+    :param str message: the question to ask the model
+    :param chat_pipe: the pipeline object for the model, created by the pipeline() function
+    :param str speaker: the name of the speaker, defaults to "person alpha"
+    :param str responder: the name of the responder, defaults to "person beta"
+    :param int min_length: the minimum length of the response, defaults to 4
+    :param int max_length: the maximum length of the response, defaults to 64
+    :param float top_p: the top_p value for the model, defaults to 0.95
+    :param int top_k: the top_k value for the model, defaults to 25
+    :param float temperature: the temperature value for the model, defaults to 0.6
+    :return str: the response from the model
     """
-
     st = time.perf_counter()
     prompt = clean(message)  # clean user input
     prompt = prompt.strip()  # get rid of any extra whitespace