From b986e8329577c9e2594feb15a26241248b8204e8 Mon Sep 17 00:00:00 2001 From: Tyler Hutcherson Date: Fri, 1 Mar 2024 13:34:00 -0500 Subject: [PATCH 1/2] fix docs issues --- docs/conf.py | 3 +++ redisvl/index/index.py | 6 ++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 03f31800..4db4222e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,6 +14,9 @@ import sys sys.path.insert(0, os.path.abspath('.')) +print(f"Sphinx is using Python executable at: {sys.executable}", flush=True) +print(f"Python version: {sys.version}", flush=True) + # -- Project information ----------------------------------------------------- project = 'RedisVL' diff --git a/redisvl/index/index.py b/redisvl/index/index.py index 8ddad863..2162f4de 100644 --- a/redisvl/index/index.py +++ b/redisvl/index/index.py @@ -616,7 +616,8 @@ def paginate(self, query: BaseQuery, page_size: int = 30) -> Generator: TypeError: If the page_size argument is not of type int. ValueError: If the page_size argument is less than or equal to zero. - Example: + .. code-block:: python + # Iterate over paginated search results in batches of 10 for result_batch in index.paginate(query, page_size=10): # Process each batch of results @@ -993,7 +994,8 @@ async def paginate(self, query: BaseQuery, page_size: int = 30) -> AsyncGenerato TypeError: If the page_size argument is not of type int. ValueError: If the page_size argument is less than or equal to zero. - Example: + .. code-block:: python + # Iterate over paginated search results in batches of 10 async for result_batch in index.paginate(query, page_size=10): # Process each batch of results From c5e7fb866ca2189e9711f387ebb43bef0ee79e07 Mon Sep 17 00:00:00 2001 From: Tyler Hutcherson Date: Fri, 1 Mar 2024 14:03:26 -0500 Subject: [PATCH 2/2] add link to cohere user guide --- docs/user_guide/vectorizers_04.ipynb | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/user_guide/vectorizers_04.ipynb b/docs/user_guide/vectorizers_04.ipynb index cd173006..6201a97f 100644 --- a/docs/user_guide/vectorizers_04.ipynb +++ b/docs/user_guide/vectorizers_04.ipynb @@ -382,6 +382,13 @@ "print(test[:10])" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Learn more about using RedisVL and Cohere together through [this dedicated user guide](https://docs.cohere.com/docs/redis-and-cohere)." + ] + }, { "cell_type": "markdown", "metadata": {},