Merge branch 'main' into andrescrz/OPIK-71-resolve-dataset-name-in-ex…

…periments
comet-ml · Sep 11, 2024 · bc34ec4 · bc34ec4
2 parents 2614edc + daf1fa0
commit bc34ec4
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 10 deletions.
diff --git a/.github/workflows/documentation_cookbook_tests.yml b/.github/workflows/documentation_cookbook_tests.yml
@@ -1,4 +1,4 @@
-name: test-examples
+name: Documentation - Test cookbooks
 on:
   workflow_dispatch:
   schedule:
@@ -14,9 +14,9 @@ jobs:
         notebooks:
           - apps/opik-documentation/documentation/docs/cookbook/evaluate_hallucination_metric.ipynb
           - apps/opik-documentation/documentation/docs/cookbook/evaluate_moderation_metric.ipynb
-          - apps/opik-documentation/documentation/docs/cookbook/langchain.md
-          - apps/opik-documentation/documentation/docs/cookbook/llama-index.md
-          - apps/opik-documentation/documentation/docs/cookbook/openai.md
+          - apps/opik-documentation/documentation/docs/cookbook/langchain.ipynb
+          - apps/opik-documentation/documentation/docs/cookbook/llama-index.ipynb
+          - apps/opik-documentation/documentation/docs/cookbook/openai.ipynb
     env:
       NOTEBOOK_TO_TEST: ${{ matrix.notebooks }}
     steps:
@@ -50,5 +50,6 @@ jobs:
           cd "$TEST_DIRECTORY" || exit
           python -X faulthandler $(which ipython) "$TEST_NOTEBOOK"
         env:
+          OPENAI_API_KEY: ${{ secrets.DOCS_OPENAI_API_KEY }}
           OPIK_API_KEY: ${{ secrets.COMET_API_KEY }}
           OPIK_WORKSPACE: ${{ secrets.COMET_WORKSPACE }}
diff --git a/apps/opik-documentation/documentation/docs/cookbook/evaluate_hallucination_metric.ipynb b/apps/opik-documentation/documentation/docs/cookbook/evaluate_hallucination_metric.ipynb
@@ -67,7 +67,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%pip install pyarrow fsspec huggingface_hub --quiet"
+    "%pip install opik pyarrow fsspec huggingface_hub --upgrade --quiet "
    ]
   },
   {
@@ -108,7 +108,7 @@
     "\n",
     "    # Insert items into dataset\n",
     "    df = pd.read_parquet(\"hf://datasets/PatronusAI/HaluBench/data/test-00000-of-00001.parquet\")\n",
-    "    df = df.sample(n=500, random_state=42)\n",
+    "    df = df.sample(n=50, random_state=42)\n",
     "\n",
     "    dataset_records = [\n",
     "        DatasetItem(\n",

diff --git a/apps/opik-documentation/documentation/docs/cookbook/evaluate_moderation_metric.ipynb b/apps/opik-documentation/documentation/docs/cookbook/evaluate_moderation_metric.ipynb
@@ -63,6 +63,15 @@
     "First, we will install the necessary libraries and configure the OpenAI API key and download a reference moderation dataset."
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%pip install opik --upgrade --quiet"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -105,7 +114,7 @@
     "    response = requests.get(url)\n",
     "    df = pd.read_json(BytesIO(response.content), lines=True, compression='gzip')\n",
     "\n",
-    "    df = df.sample(n=500, random_state=42)\n",
+    "    df = df.sample(n=50, random_state=42)\n",
     "    \n",
     "    dataset_records = []\n",
     "    for x in df.to_dict(orient=\"records\"):\n",

diff --git a/apps/opik-documentation/documentation/docs/cookbook/llama-index.ipynb b/apps/opik-documentation/documentation/docs/cookbook/llama-index.ipynb
@@ -75,7 +75,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%pip install opik llama-index llama-index-agent-openai llama-index-llms-openai --quiet"
+    "%pip install opik llama-index llama-index-agent-openai llama-index-llms-openai --upgrade --quiet"
    ]
   },
   {

diff --git a/apps/opik-frontend/src/plugins/comet/UserMenu.tsx b/apps/opik-frontend/src/plugins/comet/UserMenu.tsx
@@ -4,6 +4,7 @@ import sortBy from "lodash/sortBy";
 import {
   Book,
   Copy,
+  GraduationCap,
   Grip,
   KeyRound,
   LogOut,
@@ -207,7 +208,7 @@ const UserMenu = () => {
             <a href={buildUrl("account-settings", workspaceName)}>
               <DropdownMenuItem className="cursor-pointer">
                 <Settings className="mr-2 size-4" />
-                <span>Account Settings</span>
+                <span>Account settings</span>
               </DropdownMenuItem>
             </a>
             {isOrganizationAdmin ? (
@@ -269,13 +270,20 @@ const UserMenu = () => {
           </DropdownMenuGroup>
           <DropdownMenuSeparator />
           <DropdownMenuGroup>
-            <a href={buildUrl("docs/opik/")}>
+            <Link to="/$workspaceName/get-started" params={{ workspaceName }}>
+              <DropdownMenuItem className="cursor-pointer">
+                <GraduationCap className="mr-2 size-4" />
+                <span>Get started guide</span>
+              </DropdownMenuItem>
+            </Link>
+            <a href={buildUrl("docs/opik/")} target="_blank" rel="noreferrer">
               <DropdownMenuItem className="cursor-pointer">
                 <Book className="mr-2 size-4" />
                 <span>Docs</span>
               </DropdownMenuItem>
             </a>
           </DropdownMenuGroup>
+          <DropdownMenuSeparator />
           <DropdownMenuGroup>
             <DropdownMenuSub>
               <DropdownMenuSubTrigger className="flex cursor-pointer items-center">