docs: notebook linting (#14366)

Many jupyter notebooks didn't pass linting. List of these files are presented in the [tool.ruff.lint.per-file-ignores] section of the pyproject.toml . Addressed these bugs: - fixed bugs; added missed imports; updated pyproject.toml Only the `document_loaders/tensorflow_datasets.ipyn`, `cookbook/gymnasium_agent_simulation.ipynb` are not completely fixed. I'm not sure about imports. --------- Co-authored-by: Erick Friis <erick@langchain.dev>
langchain-ai · Dec 7, 2023 · 18aba7f · 18aba7f
1 parent 52052cc
commit 18aba7f
Show file tree

Hide file tree

Showing 38 changed files with 244 additions and 142 deletions.
diff --git a/cookbook/multi_modal_output_agent.ipynb b/cookbook/multi_modal_output_agent.ipynb
@@ -31,7 +31,7 @@
    "source": [
     "import re\n",
     "\n",
-    "from IPython.display import Image\n",
+    "from IPython.display import Image, display\n",
     "from steamship import Block, Steamship"
    ]
   },
@@ -180,7 +180,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

diff --git a/cookbook/qianfan_baidu_elasticesearch_RAG.ipynb b/cookbook/qianfan_baidu_elasticesearch_RAG.ipynb
@@ -37,7 +37,8 @@
    "source": [
     "#!pip install qianfan\n",
     "#!pip install bce-python-sdk\n",
-    "#!pip install elasticsearch == 7.11.0"
+    "#!pip install elasticsearch == 7.11.0\n",
+    "#!pip install sentence-transformers"
    ]
   },
   {
@@ -54,8 +55,10 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import sentence_transformers\n",
     "from baidubce.auth.bce_credentials import BceCredentials\n",
     "from baidubce.bce_client_configuration import BceClientConfiguration\n",
+    "from langchain.chains.retrieval_qa import RetrievalQA\n",
     "from langchain.document_loaders.baiducloud_bos_directory import BaiduBOSDirectoryLoader\n",
     "from langchain.embeddings.huggingface import HuggingFaceEmbeddings\n",
     "from langchain.llms.baidu_qianfan_endpoint import QianfanLLMEndpoint\n",
@@ -161,21 +164,28 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
   "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
    "name": "python",
-   "version": "3.9.17"
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.12"
   },
-  "orig_nbformat": 4,
   "vscode": {
    "interpreter": {
     "hash": "aee8b7b246df8f9039afb4144a1f6fd8d2ca17a180786b69acc140d282b71a49"
    }
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }
diff --git a/cookbook/retrieval_in_sql.ipynb b/cookbook/retrieval_in_sql.ipynb
@@ -133,7 +133,7 @@
     "from tqdm import tqdm\n",
     "\n",
     "for i in tqdm(range(len(title_embeddings))):\n",
-    "    title = titles[i].replace(\"'\", \"''\")\n",
+    "    title = song_titles[i].replace(\"'\", \"''\")\n",
     "    embedding = title_embeddings[i]\n",
     "    sql_command = (\n",
     "        f'UPDATE \"Track\" SET \"embeddings\" = ARRAY{embedding} WHERE \"Name\" ='\n",
@@ -681,9 +681,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.18"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }
diff --git a/cookbook/wikibase_agent.ipynb b/cookbook/wikibase_agent.ipynb
@@ -187,7 +187,7 @@
     "    for key in path:\n",
     "        try:\n",
     "            current = current[key]\n",
-    "        except:\n",
+    "        except KeyError:\n",
     "            return None\n",
     "    return current\n",
     "\n",

diff --git a/docs/docs/expression_language/how_to/fallbacks.ipynb b/docs/docs/expression_language/how_to/fallbacks.ipynb
@@ -91,7 +91,7 @@
     "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(openai_llm.invoke(\"Why did the chicken cross the road?\"))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },
@@ -114,7 +114,7 @@
     "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(llm.invoke(\"Why did the chicken cross the road?\"))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },
@@ -156,7 +156,7 @@
     "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(chain.invoke({\"animal\": \"kangaroo\"}))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },
@@ -190,10 +190,10 @@
     ")\n",
     "\n",
     "chain = prompt | llm\n",
-    "with patch(\"openai.ChatCompletion.create\", side_effect=error):\n",
+    "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(chain.invoke({\"animal\": \"kangaroo\"}))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },
@@ -291,7 +291,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

diff --git a/docs/docs/guides/fallbacks.ipynb b/docs/docs/guides/fallbacks.ipynb
@@ -93,7 +93,7 @@
     "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(openai_llm.invoke(\"Why did the chicken cross the road?\"))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },
@@ -116,7 +116,7 @@
     "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(llm.invoke(\"Why did the chicken cross the road?\"))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },
@@ -158,7 +158,7 @@
     "with patch(\"openai.resources.chat.completions.Completions.create\", side_effect=error):\n",
     "    try:\n",
     "        print(chain.invoke({\"animal\": \"kangaroo\"}))\n",
-    "    except:\n",
+    "    except RateLimitError:\n",
     "        print(\"Hit error\")"
    ]
   },

diff --git a/docs/docs/integrations/chat/google_vertex_ai_palm.ipynb b/docs/docs/integrations/chat/google_vertex_ai_palm.ipynb
@@ -45,7 +45,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -55,7 +55,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "metadata": {},
    "outputs": [
     {
@@ -64,7 +64,7 @@
        "AIMessage(content=\" J'aime la programmation.\")"
       ]
      },
-     "execution_count": 3,
+     "execution_count": 2,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -89,7 +89,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [
     {
@@ -98,7 +98,7 @@
        "AIMessage(content=' プログラミングが大好きです')"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -142,7 +142,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "metadata": {
     "tags": []
    },
@@ -198,7 +198,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 5,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -212,7 +212,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 6,
    "metadata": {},
    "outputs": [
     {
@@ -221,12 +221,17 @@
        "AIMessage(content=' Why do you love programming?')"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 6,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
+    "system = (\n",
+    "    \"You are a helpful assistant that translates {input_language} to {output_language}.\"\n",
+    ")\n",
+    "human = \"{text}\"\n",
+    "prompt = ChatPromptTemplate.from_messages([(\"system\", system), (\"human\", human)])\n",
     "chain = prompt | chat\n",
     "\n",
     "asyncio.run(\n",
@@ -251,7 +256,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [
     {

diff --git a/docs/docs/integrations/chat/promptlayer_chatopenai.ipynb b/docs/docs/integrations/chat/promptlayer_chatopenai.ipynb
@@ -129,12 +129,6 @@
     "**The above request should now appear on your [PromptLayer dashboard](https://www.promptlayer.com).**"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "05e9e2fe",
-   "metadata": {},
-   "source": []
-  },
   {
    "attachments": {},
    "cell_type": "markdown",
@@ -152,6 +146,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "import promptlayer\n",
+    "\n",
     "chat = PromptLayerChatOpenAI(return_pl_id=True)\n",
     "chat_results = chat.generate([[HumanMessage(content=\"I am a cat and I want\")]])\n",
     "\n",
@@ -172,7 +168,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "base",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -186,7 +182,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8 (default, Apr 13 2021, 12:59:45) \n[Clang 10.0.0 ]"
+   "version": "3.10.12"
   },
   "vscode": {
    "interpreter": {

diff --git a/docs/docs/integrations/chat_loaders/imessage.ipynb b/docs/docs/integrations/chat_loaders/imessage.ipynb
@@ -153,7 +153,7 @@
    "source": [
     "# Now all of the Tortoise's messages will take the AI message class\n",
     "# which maps to the 'assistant' role in OpenAI's training format\n",
-    "alternating_sessions[0][\"messages\"][:3]"
+    "chat_sessions[0][\"messages\"][:3]"
    ]
   },
   {
@@ -191,7 +191,7 @@
     }
    ],
    "source": [
-    "training_data = convert_messages_for_finetuning(alternating_sessions)\n",
+    "training_data = convert_messages_for_finetuning(chat_sessions)\n",
     "print(f\"Prepared {len(training_data)} dialogues for training\")"
    ]
   },
@@ -416,7 +416,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.5"
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,

diff --git a/docs/docs/integrations/document_loaders/arcgis.ipynb b/docs/docs/integrations/document_loaders/arcgis.ipynb
@@ -23,8 +23,18 @@
    "source": [
     "from langchain.document_loaders import ArcGISLoader\n",
     "\n",
-    "url = \"https://maps1.vcgov.org/arcgis/rest/services/Beaches/MapServer/7\"\n",
-    "loader = ArcGISLoader(url)"
+    "URL = \"https://maps1.vcgov.org/arcgis/rest/services/Beaches/MapServer/7\"\n",
+    "loader = ArcGISLoader(URL)\n",
+    "\n",
+    "docs = loader.load()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1e174ebd-bbbd-4a66-a644-51e0df12982d",
+   "metadata": {},
+   "source": [
+    "Let's measure loader latency."
    ]
   },
   {
@@ -261,7 +271,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "loader_geom = ArcGISLoader(url, return_geometry=True)"
+    "loader_geom = ArcGISLoader(URL, return_geometry=True)"
    ]
   },
   {