fix: updated with sparse/dense encoder

6952c566 · “Daniel Griffiths” · 56f0465a · 6952c566
Commit 6952c566 authored 1 year ago by “Daniel Griffiths”
--- a/docs/examples/hybrid-layer.ipynb
+++ b/docs/examples/hybrid-layer.ipynb
@@ -30,11 +30,11 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
   "metadata": {},
   "outputs": [],
   "source": [
-    "!pip install -qU semantic-router==0.0.11"
+    "#!pip install -qU semantic-router==0.0.11"
   ]
  },
  {
@@ -46,11 +46,20 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 2,
   "metadata": {},
-   "outputs": [],
+   "outputs": [
-   "source": [
+    {
-    "from semantic_router.schema import Route\n",
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/Users/danielgriffiths/Coding_files/Aurelio_local/semantic-router/.venv/lib/python3.11/site-packages/tqdm/auto.py:21: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html\n",
+      "  from .autonotebook import tqdm as notebook_tqdm\n"
+     ]
+    }
+   ],
+   "source": [
+    "from semantic_router.route import Route\n",
    "\n",
    "politics = Route(\n",
    "    name=\"politics\",\n",
@@ -81,7 +90,7 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
   "metadata": {},
   "outputs": [],
   "source": [
@@ -119,7 +128,7 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 4,
   "metadata": {},
   "outputs": [],
   "source": [
@@ -145,9 +154,17 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 5,
   "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "\u001b[32m2024-01-03 11:00:59 INFO semantic_router.utils.logger Creating embeddings for all routes...\u001b[0m\n"
+     ]
+    }
+   ],
   "source": [
    "from semantic_router.hybrid_layer import HybridRouteLayer\n",
    "\n",
@@ -158,18 +175,40 @@
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 6,
   "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'politics'"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
   "source": [
    "dl(\"don't you love politics?\")"
   ]
  },
  {
   "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 7,
   "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'chitchat'"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
   "source": [
    "dl(\"how's the weather today?\")"
   ]

 %% Cell type:markdown id: tags:
 # Semantic Router: Hybrid Layer
 %% Cell type:markdown id: tags:
 The Hybrid Layer in the Semantic Router library can improve making performance particularly for niche use-cases that contain specific terminology, such as finance or medical. It helps us provide more importance to making based on the keywords contained in our utterances and user queries.
 %% Cell type:markdown id: tags:
 ## Getting Started
 %% Cell type:markdown id: tags:
 We start by installing the library:
 %% Cell type:code id: tags:
 ``` python
-!pip install -qU semantic-router==0.0.11
+#!pip install -qU semantic-router==0.0.11
 ```
 %% Cell type:markdown id: tags:
 We start by defining a dictionary mapping s to example phrases that should trigger those s.
 %% Cell type:code id: tags:
 ``` python
-from semantic_router.schema import Route
+from semantic_router.route import Route
 politics = Route(
    name="politics",
    utterances=[
        "isn't politics the best thing ever",
        "why don't you tell me about your political opinions",
        "don't you just love the president",
        "don't you just hate the president",
        "they're going to destroy this country!",
        "they will save the country!",
    ],
 )
 ```
+%% Output
+    /Users/danielgriffiths/Coding_files/Aurelio_local/semantic-router/.venv/lib/python3.11/site-packages/tqdm/auto.py:21: TqdmWarning: IProgress not found. Please update jupyter and ipywidgets. See https://ipywidgets.readthedocs.io/en/stable/user_install.html
+      from .autonotebook import tqdm as notebook_tqdm
 %% Cell type:markdown id: tags:
 Let's define another for good measure:
 %% Cell type:code id: tags:
 ``` python
 ```
 %% Cell type:code id: tags:
 ``` python
 chitchat = Route(
    name="chitchat",
    utterances=[
        "how's the weather today?",
        "how are things going?",
        "lovely weather today",
        "the weather is horrendous",
        "let's go to the chippy",
    ],
 )
 chitchat = Route(
    name="chitchat",
    utterances=[
        "how's the weather today?",
        "how are things going?",
        "lovely weather today",
        "the weather is horrendous",
        "let's go to the chippy",
    ],
 )
 routes = [politics, chitchat]
 ```
 %% Cell type:markdown id: tags:
 Now we initialize our embedding model:
 %% Cell type:code id: tags:
 ``` python
 import os
 from semantic_router.encoders import CohereEncoder, BM25Encoder, TfidfEncoder
 from getpass import getpass
 os.environ["COHERE_API_KEY"] = os.environ["COHERE_API_KEY"] or getpass(
    "Enter Cohere API Key: "
 )
 dense_encoder = CohereEncoder()
 # sparse_encoder = BM25Encoder()
 sparse_encoder = TfidfEncoder()
 ```
 %% Cell type:markdown id: tags:
 Now we define the `RouteLayer`. When called, the route layer will consume text (a query) and output the category (`Route`) it belongs to — to initialize a `RouteLayer` we need our `encoder` model and a list of `routes`.
 %% Cell type:code id: tags:
 ``` python
 from semantic_router.hybrid_layer import HybridRouteLayer
 dl = HybridRouteLayer(
    dense_encoder=dense_encoder, sparse_encoder=sparse_encoder, routes=routes
 )
 ```
+%% Output
+    [32m2024-01-03 11:00:59 INFO semantic_router.utils.logger Creating embeddings for all routes...[0m
 %% Cell type:code id: tags:
 ``` python
 dl("don't you love politics?")
 ```
+%% Output
+    'politics'
 %% Cell type:code id: tags:
 ``` python
 dl("how's the weather today?")
 ```
+%% Output
+    'chitchat'
 %% Cell type:markdown id: tags:
 ---