prep optimizer docs

Author: tylerhutcherson

docs/api/index.md

@@ -22,5 +22,6 @@ reranker
 cache
 session_manager
 router
+threshold_optimizer
 ```
 

docs/api/session_manager.rst

@@ -2,7 +2,6 @@
 LLM Session Manager
 *******************
 
-
 SemanticSessionManager
 ======================
 

docs/api/threshold_optimizer.rst

@@ -0,0 +1,26 @@
+********************
+Threshold Optimizers
+********************
+
+CacheThresholdOptimizer
+=======================
+
+.. _cachethresholdoptimizer_api:
+
+.. currentmodule:: redisvl.utils.optimize.cache
+
+.. autoclass:: CacheThresholdOptimizer
+   :show-inheritance:
+   :members:
+
+
+RouterThresholdOptimizer
+========================
+
+.. _routerthresholdoptimizer_api:
+
+.. currentmodule:: redisvl.utils.optimize.router
+
+.. autoclass:: RouterThresholdOptimizer
+   :show-inheritance:
+   :members:

docs/user_guide/release_guide/0_5_0_release.ipynb

@@ -4,8 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "![Redis](https://redis.io/wp-content/uploads/2024/04/Logotype.svg?auto=webp&quality=85,75&width=120)\n",
-    "# RedisVL 0.5.0 Overview\n",
+    "# 0.5.0 Feature Overview\n",
     "\n",
     "This notebook provides an overview of what's new with the 0.5.0 release of redisvl. It also highlights changes and potential enhancements for existing usage.\n",
     "\n",

redisvl/utils/optimize/cache.py

@@ -76,12 +76,33 @@ class CacheThresholdOptimizer(BaseThresholdOptimizer):
     def __init__(
         self,
         cache: SemanticCache,
-        test_dict: List[Dict],
+        test_dict: List[Dict[str, Any]],
         opt_fn: Callable = _grid_search_opt_cache,
         eval_metric: str = "f1",
     ):
+        """Initialize the optimizer.
+
+        Args:
+            cache (SemanticCache): The RedisVL SemanticCache instance to optimize.
+            test_dict (List[Dict[str, Any]]): List of test cases.
+            opt_fn (Callable): Function to perform optimization. Defaults to
+                grid search.
+            eval_metric (str): Evaluation metric for threshold optimization.
+                Defaults to "f1" score.
+
+        .. code-block:: python
+
+            # TODO
+
+        """
         super().__init__(cache, test_dict, opt_fn, eval_metric)
 
     def optimize(self, **kwargs: Any):
-        """Optimize thresholds using the provided optimization function for cache case."""
+        """Optimize thresholds using the provided optimization function for cache case.
+
+        .. code-block:: python
+
+            # TODO
+
+        """
         self.opt_fn(self.optimizable, self.test_data, self.eval_metric, **kwargs)

redisvl/utils/optimize/router.py

@@ -95,13 +95,25 @@ class RouterThresholdOptimizer(BaseThresholdOptimizer):
     def __init__(
         self,
         router: SemanticRouter,
-        test_dict: List[Dict],
+        test_dict: List[Dict[str, Any]],
         opt_fn: Callable = _random_search_opt_router,
         eval_metric: str = "f1",
     ):
+        """
+        # TODO
+
+        .. code-block:: python
+
+        # TODO
+        """
         super().__init__(router, test_dict, opt_fn, eval_metric)
 
     def optimize(self, **kwargs: Any):
-        """Optimize thresholds using the provided optimization function for router case."""
+        """Optimize thresholds using the provided optimization function for router case.
+
+        .. code-block:: python
+
+            # TODO
+        """
         qrels = _format_qrels(self.test_data)
         self.opt_fn(self.optimizable, self.test_data, qrels, self.eval_metric, **kwargs)