Fix bad headers and titles in NBs

wandb · Jan 6, 2025 · 1e94a1a · 1e94a1a
1 parent ea10431
commit 1e94a1a
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 26 deletions.
diff --git a/docs/docs/reference/gen_notebooks/audio_with_weave.md b/docs/docs/reference/gen_notebooks/audio_with_weave.md
@@ -1,6 +1,6 @@
-
-## title: Log Audio With Weave
-
+---
+title: Log Audio With Weave
+---
 
 
 :::tip[This is a notebook]
@@ -12,7 +12,7 @@
 :::
 
 
-## 
+
 <!--- @wandbcode{feedback-colab} -->
 
 
@@ -40,6 +40,15 @@ Start by installing the OpenAI (`openai`) and Weave (`weave`) dependencies, as w
 !pip install set-env-colab-kaggle-dotenv -q # for env var
 ```
 
+
+```python
+%%capture
+# Temporary workaround to fix bug in openai:
+# TypeError: Client.__init__() got an unexpected keyword argument 'proxies'
+# See https://community.openai.com/t/error-with-openai-1-56-0-client-init-got-an-unexpected-keyword-argument-proxies/1040332/15
+!pip install "httpx<0.28"
+```
+
 Next, load the required API keys for OpenAI and Weave. Here, we use set_env which is compatible with google colab's secret keys manager, and is an alternative to colab's specific `google.colab.userdata`. See: [here](https://pypi.org/project/set-env-colab-kaggle-dotenv/) for usage instructions.
 
 

diff --git a/docs/docs/reference/gen_notebooks/notdiamond_custom_routing.md b/docs/docs/reference/gen_notebooks/notdiamond_custom_routing.md
@@ -1,6 +1,6 @@
-
-## title: NotDiamond Custom Routing
-
+---
+title: NotDiamond Custom Routing
+---
 
 
 :::tip[This is a notebook]
@@ -12,7 +12,7 @@
 :::
 
 
-## 
+
 <!--- @wandbcode{intro-colab} -->
 
 
@@ -202,7 +202,7 @@ best_provider_model, nd_model = evaluate_router(
 
 ```python
 @weave.op()
-def is_correct(score: int, model_output: dict) -> dict:
+def is_correct(score: int, output: dict) -> dict:
     # We hack score, since we already have model responses
     return {"correct": score}
 

diff --git a/docs/docs/reference/gen_notebooks/online_monitoring.md b/docs/docs/reference/gen_notebooks/online_monitoring.md
@@ -1,6 +1,6 @@
-
-## title: Integrating with Weave - Production Dashboard
-
+---
+title: Integrating with Weave - Production Dashboard
+---
 
 
 :::tip[This is a notebook]
@@ -12,7 +12,7 @@
 :::
 
 
-## 
+
 <!--- @wandbcode{cod-notebook} -->
 
 

diff --git a/docs/docs/reference/gen_notebooks/weave_via_service_api.md b/docs/docs/reference/gen_notebooks/weave_via_service_api.md
@@ -1,3 +1,6 @@
+---
+title: Service API
+---
 
 
 :::tip[This is a notebook]
@@ -9,6 +12,9 @@
 :::
 
 
+
+<!--- @wandbcode{cod-notebook} -->
+
 # Use the Service API to Log and Query Traces
 
 In the following guide, you will learn how to use the Weave Service API to log traces. Specifically, you will use the Service API to:

diff --git a/docs/notebooks/audio_with_weave.ipynb b/docs/notebooks/audio_with_weave.ipynb
@@ -4,10 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## <!-- docusaurus_head_meta::start\n",
-    "\n",
-    "## title: Log Audio With Weave\n",
-    "\n",
+    "<!-- docusaurus_head_meta::start\n",
+    "---\n",
+    "title: Log Audio With Weave\n",
+    "---\n",
     "docusaurus_head_meta::end -->\n",
     "\n",
     "<!--- @wandbcode{feedback-colab} -->\n"

diff --git a/docs/notebooks/notdiamond_custom_routing.ipynb b/docs/notebooks/notdiamond_custom_routing.ipynb
@@ -4,10 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## <!-- docusaurus_head_meta::start\n",
-    "\n",
-    "## title: NotDiamond Custom Routing\n",
-    "\n",
+    "<!-- docusaurus_head_meta::start\n",
+    "---\n",
+    "title: NotDiamond Custom Routing\n",
+    "---\n",
     "docusaurus_head_meta::end -->\n",
     "\n",
     "<!--- @wandbcode{intro-colab} -->\n"

diff --git a/docs/notebooks/online_monitoring.ipynb b/docs/notebooks/online_monitoring.ipynb
@@ -4,10 +4,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## <!-- docusaurus_head_meta::start\n",
-    "\n",
-    "## title: Integrating with Weave - Production Dashboard\n",
-    "\n",
+    "<!-- docusaurus_head_meta::start\n",
+    "---\n",
+    "title: Integrating with Weave - Production Dashboard\n",
+    "---\n",
     "docusaurus_head_meta::end -->\n",
     "\n",
     "<!--- @wandbcode{cod-notebook} -->\n"

diff --git a/docs/notebooks/weave_via_service_api.ipynb b/docs/notebooks/weave_via_service_api.ipynb
@@ -5,7 +5,15 @@
    "metadata": {
     "id": "xSqO08zH3qRH"
    },
-   "source": []
+   "source": [
+    "<!-- docusaurus_head_meta::start\n",
+    "---\n",
+    "title: Service API\n",
+    "---\n",
+    "docusaurus_head_meta::end -->\n",
+    "\n",
+    "<!--- @wandbcode{cod-notebook} -->"
+   ]
   },
   {
    "cell_type": "markdown",