update

assignment.ipynb

@@ -16,6 +16,21 @@
     "* **At:** University of Texas Rio-Grande Valley"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "ca81ec95",
+   "metadata": {},
+   "source": [
+    "## Before you begin\n",
+    "The OpenAI API provides access to powerful LLMs like GPT-3.5 and GPT-4, enabling developers to leverage these models in their applications. To access the API, sign up for an API key on the OpenAI website and follow the documentation to make API calls.\n",
+    "\n",
+    "For enterprise: Azure OpenAI offers a robust and scalable platform for deploying LLMs in enterprise applications. It provides features like security, compliance, and support, making it an ideal choice for businesses looking to leverage LLMs.\n",
+    "    \n",
+    "Options:\n",
+    "* [[Free] Sign-up for access to my OpenAI service](https://huggingface.co/spaces/ericmichael/openai-playground-utrgv) - _requires your UTRGV email and student ID_\n",
+    "* [[Paid] Alternatively, sign-up for OpenAI API Access](https://platform.openai.com/signup)"
+   ]
+  },
   {
    "attachments": {},
    "cell_type": "markdown",
@@ -31,7 +46,7 @@
    "id": "01461871",
    "metadata": {},
    "source": [
-    "Setup your `OPENAI_API_BASE` key and `OPENAI_API_KEY`."
+    "Setup your `OPENAI_API_BASE` key and `OPENAI_API_KEY` in a file `.env` in this same folder."
    ]
   },
   {
@@ -40,10 +55,10 @@
    "id": "6f0f07b1",
    "metadata": {},
    "source": [
-    "```\n",
-    "# .env\n",
-    "OPENAI_API_BASE=<my API base>\n",
-    "OPENAI_API_KEY=<your API key to my service>\n",
+    "```sh\n",
+    "# example .env contents (copy paste this into a .env file)\n",
+    "OPENAI_API_BASE=yourapibase\n",
+    "OPENAI_API_KEY=yourapikey\n",
     "```"
    ]
   },
@@ -76,16 +91,7 @@
     }
    },
    "source": [
-    "## Step 1: Identify the Problem"
-   ]
-  },
-  {
-   "attachments": {},
-   "cell_type": "markdown",
-   "id": "aeba1d5a",
-   "metadata": {},
-   "source": [
-    "Describe the problem you want to solve using LLMs and put the description here. Describe what the user is going to input. Describe what the LLM should produce as output."
+    "## Step 1: The Game"
    ]
   },
   {
@@ -94,7 +100,7 @@
    "id": "1dfc8c5a",
    "metadata": {},
    "source": [
-    "**Problem I'm trying to solve:** Simulating a game of Simon Says"
+    "**Problem we are trying to solve:** Simulating a game of Simon Says"
    ]
   },
   {
@@ -234,7 +240,7 @@
    "id": "b3f4cd62",
    "metadata": {},
    "source": [
-    "Use the class playground to rapidly test and refine your prompt(s)."
+    "Use TDD to rapidly iterate and refine your prompts."
    ]
   },
   {
@@ -243,7 +249,7 @@
    "id": "4be91b31",
    "metadata": {},
    "source": [
-    "Make some calls to the OpenAI API here and see what the output is."
+    "Let's setup some code we will need"
    ]
   },
   {
@@ -421,7 +427,7 @@
     "    print(f\"Asserting that output '{output}' is equal to '{expected_value}' \")\n",
     "    assert output == expected_value\n",
     "        \n",
-    "\n",
+    "# this is a multi-line string\n",
     "prompt=\"\"\"\n",
     "You are bot created to simulate commands.\n",
     "\n",
@@ -434,11 +440,14 @@
     "\n",
     "#### Testing Typical Input\n",
     "\n",
+    "# this is also a multi-line string but used like a multi-line comment\n",
     "\"\"\"\n",
     "User: Simon says, jump!\n",
     "Expected AI Response: <is a string>\n",
     "\"\"\"\n",
     "input = \"Simon says, jump!\"\n",
+    "\n",
+    "# check output is atleast a string\n",
     "assert isinstance(get_ai_reply(input, system_message=prompt), str)\n",
     "\n",
     "\n",
@@ -586,9 +595,15 @@
     "    # Try to get the AI's reply using the get_ai_reply function\n",
     "    try:\n",
     "        prompt = \"\"\"\n",
-    "            <your prompt here>\n",
+    "        You are bot created to simulate commands.\n",
+    "\n",
+    "        Simulate doing a command using this notation:\n",
+    "        :: <command> ::\n",
+    "\n",
+    "        Simulate doing nothing with this notation:\n",
+    "        :: does nothing ::\n",
     "        \"\"\"\n",
-    "        ai_reply = get_ai_reply(message, model=model, system_message=prompt, message_history=history_state)\n",
+    "        ai_reply = get_ai_reply(message, model=model, system_message=prompt.strip(), message_history=history_state)\n",
     "            \n",
     "        # Append the user's message and the AI's reply to the chatbot_messages list\n",
     "        chatbot_messages.append((message, ai_reply))\n",
@@ -623,7 +638,6 @@
     "        return app\n",
     "        \n",
     "# Call the launch_chatbot function to start the chatbot interface using Gradio\n",
-    "# Set the share parameter to False, meaning the interface will not be publicly accessible\n",
     "app = get_chatbot_app()\n",
     "app.queue()  # this is to be able to queue multiple requests at once\n",
     "app.launch()"
@@ -822,7 +836,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.6"
+   "version": "3.11.3"
   }
  },
  "nbformat": 4,