add dashboard command for debugging ragulate (#587)

Author: epinzur

libs/ragulate/ragstack_ragulate/cli.py

@@ -25,6 +25,7 @@ def main() -> None:
     cli_commands.setup_query(subparsers=subparsers)
     cli_commands.setup_compare(subparsers=subparsers)
     cli_commands.setup_run(subparsers=subparsers)
+    cli_commands.setup_dashboard(subparsers=subparsers)
 
     # Parse the command-line arguments
     args = parser.parse_args()

libs/ragulate/ragstack_ragulate/cli_commands/__init__.py

@@ -1,11 +1,13 @@
 from .compare import setup_compare
+from .dashboard import setup_dashboard
 from .download import setup_download
 from .ingest import setup_ingest
 from .query import setup_query
 from .run import setup_run
 
 __all__ = [
     "setup_compare",
+    "setup_dashboard",
     "setup_download",
     "setup_ingest",
     "setup_query",

libs/ragulate/ragstack_ragulate/cli_commands/compare.py

@@ -2,6 +2,8 @@
 
 from ragstack_ragulate.analysis import Analysis
 
+from .utils import remove_sqlite_extension
+
 
 def setup_compare(subparsers):
     """Setup the compare command."""
@@ -26,13 +28,6 @@ def setup_compare(subparsers):
     compare_parser.set_defaults(func=lambda args: call_compare(**vars(args)))
 
 
-def remove_sqlite_extension(s):
-    """Remove the .sqlite extension from a string."""
-    if s.endswith(".sqlite"):
-        return s[:-7]
-    return s
-
-
 def call_compare(
     recipe: List[str],
     output: Optional[str] = "box-plots",

libs/ragulate/ragstack_ragulate/cli_commands/dashboard.py

@@ -0,0 +1,36 @@
+from ragstack_ragulate.dashboard import run_dashboard
+
+from .utils import remove_sqlite_extension
+
+
+def setup_dashboard(subparsers):
+    """Setup the dashboard command."""
+    dashboard_parser = subparsers.add_parser(
+        "dashboard",
+        help="Show the tru-lens dashboard for a recipe. Can be helpful for debugging.",
+    )
+    dashboard_parser.add_argument(
+        "-r",
+        "--recipe",
+        type=str,
+        help="A recipe to see the dashboard for.",
+        required=True,
+    )
+    dashboard_parser.add_argument(
+        "-p",
+        "--port",
+        type=int,
+        help="Port to show the dashboard on, default 8501",
+        default=8501,
+    )
+    dashboard_parser.set_defaults(func=lambda args: call_dashboard(**vars(args)))
+
+
+def call_dashboard(
+    recipe: str,
+    port: int,
+    **_,
+):
+    """Runs the TruLens dashboard."""
+    recipe_name = remove_sqlite_extension(recipe)
+    run_dashboard(recipe_name=recipe_name, port=port)

libs/ragulate/ragstack_ragulate/cli_commands/utils.py

@@ -0,0 +1,5 @@
+def remove_sqlite_extension(s):
+    """Remove the .sqlite extension from a string."""
+    if s.endswith(".sqlite"):
+        return s[:-7]
+    return s

libs/ragulate/ragstack_ragulate/dashboard.py

@@ -0,0 +1,9 @@
+from typing import Optional
+
+from .utils import get_tru
+
+
+def run_dashboard(recipe_name: str, port: Optional[int] = 8501):
+    """Runs the TruLens dashboard."""
+    tru = get_tru(recipe_name=recipe_name)
+    tru.run_dashboard(port=port)