Documentation formatting and update (#99)

Update the documentation for 0.0.6 release.

Author: Sam Partee

docs/api/indexschema.rst

@@ -1,7 +1,7 @@
 
-*****
+***********
 IndexSchema
-*****
+***********
 
 IndexSchema
 ===========
@@ -19,10 +19,10 @@ IndexSchema
     IndexSchema.storage_type
     IndexSchema.fields
     IndexSchema.redis_fields
-    SearchIndex.add_field
-    SearchIndex.add_fields
-    SearchIndex.remove_field
-    SearchIndex.generate_fields
+    IndexSchema.add_field
+    IndexSchema.add_fields
+    IndexSchema.remove_field
+    IndexSchema.generate_fields
     IndexSchema.from_yaml
     IndexSchema.to_yaml
     IndexSchema.from_dict

docs/api/searchindex.rst

@@ -1,6 +1,6 @@
-*****
+***********
 SearchIndex
-*****
+***********
 
 SearchIndex
 ===========

docs/api/vectorizer.rst

@@ -63,7 +63,7 @@ VertexAITextVectorizer
 
 
 CohereTextVectorizer
-======================
+====================
 
 .. _coheretextvectorizer_api:
 

docs/overview/installation.md

@@ -5,7 +5,7 @@ myst:
       Installation instructions for RedisVL
 ---
 
-## Install RedisVL
+# Install RedisVL
 
 There are a few ways to install RedisVL. The easiest way is to use pip.
 

pyproject.toml

@@ -1,5 +1,5 @@
 [tool.black]
-target-version = ['py37', 'py38', 'py39', 'py310']
+target-version = ['py37', 'py38', 'py39', 'py310', 'py311']
 exclude = '''
 (
   | \.egg

redisvl/index.py

@@ -147,15 +147,24 @@ class SearchIndex:
     This class is a wrapper around the redis-py client that provides
     purpose-built methods for interacting with Redis as a vector database.
 
-    Example:
+    .. code-block:: python
+
         from redisvl.index import SearchIndex
+
+        # initialize the index object with schema from file
         index = SearchIndex.from_yaml("schema.yaml", redis_url="redis://localhost:6379")
+
+        # create the index
         index.create(overwrite=True)
-        index.load(data) # data is an iterable of dictionaries
-        # Use an async connection
+
+        # data is an iterable of dictionaries
+        index.load(data)
+
+        # Do the same with an an async connection
         index = SearchIndex.from_yaml("schema.yaml", redis_url="redis://localhost:6379", use_async=True)
         await index.acreate(overwrite=True)
         await index.aload(data)
+
     """
 
     _STORAGE_MAP = {
@@ -171,9 +180,8 @@ def __init__(
         connection_args: Dict[str, Any] = {},
         **kwargs,
     ):
-        """Initialize the RedisVL search index class with a schema,
-        redis_url, connection_args, and other kwargs.
-        """
+        """Initialize the RedisVL search index class with a schema, redis_url,
+        connection_args, and other kwargs."""
         # final validation on schema object
         if not schema or not isinstance(schema, IndexSchema):
             raise ValueError("Must provide a valid schema object")
@@ -221,7 +229,8 @@ def client(self) -> Optional[Union[redis.Redis, aredis.Redis]]:
     @classmethod
     def from_existing(cls):
         raise DeprecationWarning(
-            "This method is deprecated since 0.0.5. Use the from_yaml or from_dict constructors with an IndexSchema instead."
+            "This method is deprecated since 0.0.5. Use the from_yaml or\
+                from_dict constructors with an IndexSchema instead."
         )
 
     @classmethod
@@ -238,7 +247,8 @@ def from_yaml(
         Returns:
             SearchIndex: A RedisVL SearchIndex object.
 
-        Example:
+        .. code-block:: python
+
             from redisvl.index import SearchIndex
             index = SearchIndex.from_yaml("schema.yaml", redis_url="redis://localhost:6379")
             index.create(overwrite=True)
@@ -260,7 +270,8 @@ def from_dict(
         Returns:
             SearchIndex: A RedisVL SearchIndex object.
 
-        Example:
+        .. code-block:: python
+
             from redisvl.index import SearchIndex
             index = SearchIndex.from_dict({
                 "index": {
@@ -273,6 +284,7 @@ def from_dict(
                 }
             }, redis_url="redis://localhost:6379")
             index.create(overwrite=True)
+
         """
         schema = IndexSchema.from_dict(schema_dict)
         return cls(schema=schema, connection_args=connection_args, **kwargs)
@@ -304,11 +316,13 @@ def connect(
             ValueError: If the Redis URL is not provided nor accessible
                 through the `REDIS_URL` environment variable.
 
-        Example:
+        .. code-block:: python
+
             # standard sync Redis connection
             index.connect(redis_url="redis://localhost:6379")
             # async Redis connection
             index.connect(redis_url="redis://localhost:6379", use_async=True)
+
         """
         self._redis_conn.connect(redis_url, use_async, **kwargs)
         return self
@@ -332,8 +346,7 @@ def set_client(self, client: Union[redis.Redis, aredis.Redis]):
         Raises:
             TypeError: If the provided client is not valid.
 
-        Example:
-            import redis
+        .. code-block:: python
 
             r = redis.Redis.from_url("redis://localhost:6379")
             index.set_client(r)
@@ -343,6 +356,7 @@ def set_client(self, client: Union[redis.Redis, aredis.Redis]):
 
             r = aredis.Redis.from_url("redis://localhost:6379")
             index.set_client(r)
+
         """
         self._redis_conn.set_client(client)
         return self
@@ -421,9 +435,8 @@ def load(
         preprocess: Optional[Callable] = None,
         batch_size: Optional[int] = None,
     ) -> List[str]:
-        """
-        Load a batch of objects to Redis. Returns the list of keys loaded
-        to Redis.
+        """Load a batch of objects to Redis. Returns the list of keys loaded to
+        Redis.
 
         Args:
             data (Iterable[Any]): An iterable of objects to store.
@@ -446,7 +459,8 @@ def load(
             ValueError: If the length of provided keys does not match the length
                 of objects.
 
-        Example:
+        .. code-block:: python
+
             keys = index.load([{"test": "foo"}, {"test": "bar"}])
         """
         return self._storage.write(
@@ -460,10 +474,11 @@ def load(
         )
 
     def fetch(self, id: str) -> Dict[str, Any]:
-        """
-        Fetch an object from Redis by id. The id is typically either a
-        unique identifier, or derived from some domain-specific metadata
-        combination (like a document id or chunk id).
+        """Fetch an object from Redis by id.
+
+        The id is typically either a unique identifier,
+        or derived from some domain-specific metadata combination
+        (like a document id or chunk id).
 
         Args:
             id (str): The specified unique identifier for a particular
@@ -513,8 +528,10 @@ def query(self, query: BaseQuery) -> List[Dict[str, Any]]:
         Returns:
             List[Result]: A list of search results.
 
-        Example:
+        .. code-block:: python
+
             results = index.query(query)
+
         """
         return self._query(query)
 
@@ -537,10 +554,12 @@ def query_batch(self, query: BaseQuery, batch_size: int = 30) -> Generator:
             TypeError: If the batch size is not an integer
             ValueError: If the batch size is less than or equal to zero.
 
-        Example:
+        .. code-block:: python
+
             for batch in index.query_batch(query, batch_size=10):
                 # process batched results
                 pass
+
         """
         if not isinstance(batch_size, int):
             raise TypeError("batch_size must be an integer")
@@ -645,9 +664,8 @@ async def aload(
         preprocess: Optional[Callable] = None,
         concurrency: Optional[int] = None,
     ) -> List[str]:
-        """
-        Asynchronously load objects to Redis with concurrency control. Returns
-        the list of keys loaded to Redis.
+        """Asynchronously load objects to Redis with concurrency control.
+        Returns the list of keys loaded to Redis.
 
         Args:
             data (Iterable[Any]): An iterable of objects to store.
@@ -670,8 +688,10 @@ async def aload(
             ValueError: If the length of provided keys does not match the
                 length of objects.
 
-        Example:
+        .. code-block:: python
+
             keys = await index.aload([{"test": "foo"}, {"test": "bar"}])
+
         """
         return await self._storage.awrite(
             self._redis_conn.client,  # type: ignore
@@ -684,11 +704,9 @@ async def aload(
         )
 
     async def afetch(self, id: str) -> Dict[str, Any]:
-        """
-        Asynchronously etch an object from Redis by id. The id is typically
+        """Asynchronously etch an object from Redis by id. The id is typically
         either a unique identifier, or derived from some domain-specific
-        metadata
-        combination (like a document id or chunk id).
+        metadata combination (like a document id or chunk id).
 
         Args:
             id (str): The specified unique identifier for a particular
@@ -738,7 +756,8 @@ async def aquery(self, query: BaseQuery) -> List[Dict[str, Any]]:
         Returns:
             List[Result]: A list of search results.
 
-        Example:
+        .. code-block:: python
+
             results = await aindex.query(query)
         """
         return await self._aquery(query)
@@ -764,7 +783,8 @@ async def aquery_batch(
             TypeError: If the batch size is not an integer
             ValueError: If the batch size is less than or equal to zero.
 
-        Example:
+        .. code-block:: python
+
             async for batch in index.aquery_batch(query, batch_size=10):
                 # process batched results
                 pass

redisvl/llmcache/base.py

@@ -48,8 +48,8 @@ def store(
         vector: Optional[List[float]] = None,
         metadata: Optional[dict] = {},
     ) -> str:
-        """Stores the specified key-value pair in the cache along
-        with metadata."""
+        """Stores the specified key-value pair in the cache along with
+        metadata."""
         raise NotImplementedError
 
     def hash_input(self, prompt: str):

redisvl/llmcache/semantic.py

@@ -183,9 +183,10 @@ def set_threshold(self, distance_threshold: float) -> None:
         self._distance_threshold = float(distance_threshold)
 
     def set_vectorizer(self, vectorizer: BaseVectorizer) -> None:
-        """Sets the vectorizer for the LLM cache. Must be a valid subclass of
-           BaseVectorizer and have equivalent dimensions to the vector field
-           defined int he schema.
+        """Sets the vectorizer for the LLM cache.
+
+        Must be a valid subclass of BaseVectorizer and have equivalent
+        dimensions to the vector field defined in the schema.
 
         Args:
             vectorizer (BaseVectorizer): The RedisVL vectorizer to use for
@@ -210,14 +211,15 @@ def set_vectorizer(self, vectorizer: BaseVectorizer) -> None:
         self._vectorizer = vectorizer
 
     def clear(self) -> None:
-        """Clear the cache of all keys while preserving the index"""
+        """Clear the cache of all keys while preserving the index."""
         with self._index.client.pipeline(transaction=False) as pipe:  # type: ignore
             for key in self._index.client.scan_iter(match=f"{self._index.prefix}:*"):  # type: ignore
                 pipe.delete(key)
             pipe.execute()
 
     def delete(self) -> None:
-        """Clear the semantic cache of all keys and remove the underlying search index."""
+        """Clear the semantic cache of all keys and remove the underlying search
+        index."""
         self._index.delete(drop=True)
 
     def _refresh_ttl(self, key: str) -> None:
@@ -275,9 +277,8 @@ def check(
         num_results: int = 1,
         return_fields: Optional[List[str]] = None,
     ) -> List[Dict[str, Any]]:
-        """
-        Checks the semantic cache for results similar to the specified prompt or
-        vector.
+        """Checks the semantic cache for results similar to the specified prompt
+        or vector.
 
         This method searches the cache using vector similarity with
         either a raw text prompt (converted to a vector) or a provided vector as
@@ -303,7 +304,8 @@ def check(
             ValueError: If neither a `prompt` nor a `vector` is specified.
             TypeError: If `return_fields` is not a list when provided.
 
-        Example:
+        .. code-block:: python
+
             response = cache.check(
                 prompt="What is the captial city of France?"
             )
@@ -343,7 +345,8 @@ def store(
             ValueError: If neither prompt nor vector is specified.
             TypeError: If provided metadata is not a dictionary.
 
-        Example:
+        .. code-block:: python
+
             key = cache.store(
                 prompt="What is the captial city of France?",
                 response="Paris",