Polish OpenAIMonitor and add it to the API reference

Author: gustavocidornelas

docs/source/reference/monitoring.rst

@@ -33,8 +33,24 @@ Openlayer project is what enables the monitoring mode.
 
 Publishing production data
 ----------------------------
-Production data is published to an inference pipeline on the Openlayer platform using
-the methods below.
+
+LLMs
+^^^^
+
+If you are using an OpenAI LLM, you can simply switch monitoring on and off with a
+single line of code.
+
+.. autosummary::
+   :toctree: api/
+   :template: class.rst
+
+   openlayer.llm_monitors.OpenAIMonitor
+
+Traditional ML models
+^^^^^^^^^^^^^^^^^^^^^
+
+For traditional ML models and other LLM providers, you can publish production data with
+the following methods.
 
 .. autosummary::
    :toctree: api/

examples/monitoring/quickstart/llms/openai_llm_monitor.ipynb

@@ -23,7 +23,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": null,
    "id": "f3f4fa13",
    "metadata": {},
    "outputs": [],
@@ -44,7 +44,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "id": "e60584fa",
    "metadata": {},
    "outputs": [],
@@ -64,19 +64,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": null,
    "id": "2cb5ce9b",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Monitoring is already on!\n",
-      "To stop it, call `stop_monitoring`.\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "openai_monitor.start_monitoring()"
    ]
@@ -91,7 +82,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "id": "fb648049-00bd-447c-8feb-ecf794d45ba7",
    "metadata": {},
    "outputs": [],
@@ -103,18 +94,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": null,
    "id": "7d1e8c74-c667-44a7-b8ea-8f5b83049ea7",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Data published!\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "completion = openai.ChatCompletion.create(\n",
     "  model=\"gpt-3.5-turbo\",\n",
@@ -127,18 +110,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "id": "58dd9603",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Data published!\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "completion = openai.ChatCompletion.create(\n",
     "  model=\"gpt-3.5-turbo\",\n",
@@ -159,89 +134,20 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": null,
    "id": "27bb2bdc",
    "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/html": [
-       "<div>\n",
-       "<style scoped>\n",
-       "    .dataframe tbody tr th:only-of-type {\n",
-       "        vertical-align: middle;\n",
-       "    }\n",
-       "\n",
-       "    .dataframe tbody tr th {\n",
-       "        vertical-align: top;\n",
-       "    }\n",
-       "\n",
-       "    .dataframe thead th {\n",
-       "        text-align: right;\n",
-       "    }\n",
-       "</style>\n",
-       "<table border=\"1\" class=\"dataframe\">\n",
-       "  <thead>\n",
-       "    <tr style=\"text-align: right;\">\n",
-       "      <th></th>\n",
-       "      <th>input</th>\n",
-       "      <th>output</th>\n",
-       "      <th>tokens</th>\n",
-       "      <th>latency</th>\n",
-       "    </tr>\n",
-       "  </thead>\n",
-       "  <tbody>\n",
-       "    <tr>\n",
-       "      <th>0</th>\n",
-       "      <td>How are you doing today?</td>\n",
-       "      <td>Thank you for asking! As an AI, I don't have f...</td>\n",
-       "      <td>62</td>\n",
-       "      <td>6400.212049</td>\n",
-       "    </tr>\n",
-       "    <tr>\n",
-       "      <th>1</th>\n",
-       "      <td>Is Python strongly typed?</td>\n",
-       "      <td>Yes, Python is considered a strongly typed lan...</td>\n",
-       "      <td>68</td>\n",
-       "      <td>7226.889133</td>\n",
-       "    </tr>\n",
-       "  </tbody>\n",
-       "</table>\n",
-       "</div>"
-      ],
-      "text/plain": [
-       "                       input  \\\n",
-       "0   How are you doing today?   \n",
-       "1  Is Python strongly typed?   \n",
-       "\n",
-       "                                              output  tokens      latency  \n",
-       "0  Thank you for asking! As an AI, I don't have f...      62  6400.212049  \n",
-       "1  Yes, Python is considered a strongly typed lan...      68  7226.889133  "
-      ]
-     },
-     "execution_count": 7,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
+   "outputs": [],
    "source": [
     "openai_monitor.data"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": null,
    "id": "f9139f2b",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Monitoring stopped.\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "openai_monitor.stop_monitoring()"
    ]

examples/monitoring/quickstart/discriminative-ml/monitoring-quickstart.ipynb renamed to examples/monitoring/quickstart/traditional-ml/monitoring-quickstart.ipynb

@@ -5,7 +5,7 @@
    "id": "ef55abc9",
    "metadata": {},
    "source": [
-    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/openlayer-ai/examples-gallery/blob/main/monitoring/quickstart/discriminative-ml/monitoring-quickstart.ipynb)\n",
+    "[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/openlayer-ai/examples-gallery/blob/main/monitoring/quickstart/traditional-ml/monitoring-quickstart.ipynb)\n",
     "\n",
     "\n",
     "# <a id=\"top\">Monitoring quickstart</a>\n",