From 97a9620ae07a6faf6cd41c2ca565df84b27fcfb4 Mon Sep 17 00:00:00 2001
From: James Briggs <james.briggs@hotmail.com>
Date: Sun, 1 Sep 2024 17:54:29 +0200
Subject: [PATCH] fix: formatting issues
---
docs/source/route_layer/dynamic-routes.rst | 5 ++---
docs/source/route_layer/local-execution.rst | 4 ++--
docs/source/route_layer/save-load-from-file.rst | 6 +++---
docs/source/route_layer/sync.rst | 2 ++
4 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/docs/source/route_layer/dynamic-routes.rst b/docs/source/route_layer/dynamic-routes.rst
index 9856bbc2..7b144d03 100644
--- a/docs/source/route_layer/dynamic-routes.rst
+++ b/docs/source/route_layer/dynamic-routes.rst
@@ -15,7 +15,7 @@ associated with that route.
For example we could provide a dynamic route with associated utterances:
-::
+.. code:: python
"what is x to the power of y?"
"what is 9 to the power of 4?"
@@ -26,7 +26,7 @@ For example we could provide a dynamic route with associated utterances:
and we could also provide the route with a schema outlining key features
of the function:
-::
+.. code:: python
def power(base: float, exponent: float) -> float:
"""Raise base to the power of exponent.
@@ -79,7 +79,6 @@ it correctly.
-
.. parsed-literal::
'17:57'
diff --git a/docs/source/route_layer/local-execution.rst b/docs/source/route_layer/local-execution.rst
index 6e7696ef..b20aade8 100644
--- a/docs/source/route_layer/local-execution.rst
+++ b/docs/source/route_layer/local-execution.rst
@@ -147,7 +147,7 @@ hardware
Initializing Dynamic Routes
-===========================
+---------------------------
Similar to the ``02-dynamic-routes.ipynb`` notebook, we will be
initializing some dynamic routes that make use of LLMs for function
@@ -249,7 +249,7 @@ a ``HuggingFaceEncoder`` with ``sentence-transformers/all-MiniLM-L6-v2``
encoder = HuggingFaceEncoder()
``llama.cpp`` LLM
-=================
+-----------------
From here, we can go ahead and instantiate our ``llama-cpp-python``
``llama_cpp.Llama`` LLM, and then pass it to the
diff --git a/docs/source/route_layer/save-load-from-file.rst b/docs/source/route_layer/save-load-from-file.rst
index 6cce117f..2f13247c 100644
--- a/docs/source/route_layer/save-load-from-file.rst
+++ b/docs/source/route_layer/save-load-from-file.rst
@@ -28,7 +28,7 @@ The saved files contain all the information needed to initialize new
route layers. If we are using a remote index, we can use the
`sync features`_ to keep the route layer in sync with the index.
-.. _sync features: sync.rst
+.. _sync features: sync.html
Full Example
---------------
@@ -45,7 +45,7 @@ load a route layer from file.
We start by installing the library:
-.. code:: ipython3
+.. code:: none
!pip install -qU semantic-router
@@ -54,7 +54,7 @@ Define Route
First let's create a list of routes:
-.. code:: ipython3
+.. code:: python
from semantic_router import Route
diff --git a/docs/source/route_layer/sync.rst b/docs/source/route_layer/sync.rst
index ee471dc2..03204917 100644
--- a/docs/source/route_layer/sync.rst
+++ b/docs/source/route_layer/sync.rst
@@ -66,3 +66,5 @@ You can try this yourself by running the following:
)
rl = RouteLayer(encoder=encoder, routes=routes, index=pc_index)
+
+When initializing the `PineconeIndex` object, we can specify the `sync` parameter.
\ No newline at end of file
--
GitLab