arize-phoenix 0.0.2rc3__py3-none-any.whl → 0.0.2rc5__py3-none-any.whl

phoenix/session/session.py

@@ -35,8 +35,16 @@ class Session:
         )
         self._is_colab = _is_colab()
 
-    def view(self, height: int = 500) -> "IFrame":
-        # Display the app in an iframe
+    def view(self, height: int = 1000) -> "IFrame":
+        """
+        Returns an IFrame that can be displayed in a notebook to view the app.
+
+        Parameters
+        ----------
+        height : int, optional
+            The height of the IFrame in pixels. Defaults to 1000.
+        """
+        print(f"📺 Opening a view to the Phoenix app. The app is running at {self.url}")
         return IFrame(src=self.url, width="100%", height=height)
 
     @cached_property
@@ -72,20 +80,54 @@ def _wait_for_boot(url: str, polling_interval_secs: int = 1, max_retries: int =
 
 
 def launch_app(
-    primary: Dataset, reference: Optional[Dataset], wait_for_boot: Optional[bool] = True
+    primary: Dataset, reference: Optional[Dataset] = None, wait_for_boot: Optional[bool] = True
 ) -> "Session":
-    "Launches the phoenix application"
+    """
+    Launches the phoenix application and returns a session to interact with.
+
+    Parameters
+    ----------
+    primary : Dataset required
+        The primary dataset to analyze
+    reference : Dataset, optional
+        The reference dataset to compare against.
+        If not provided, drift analysis will not be available.
+
+    Returns
+    -------
+    session : Session
+        The session object that can be used to view the application
+
+    Examples
+    --------
+    >>> import phoenix as px
+    >>> # construct a dataset to analyze
+    >>> dataset = px.Dataset(...)
+    >>> session = px.launch_app(dataset)
+    """
     global _session
 
     _session = Session(primary, reference, port=config.port)
     if wait_for_boot:
         _wait_for_boot(_session.url)
+    print(f"🌍 To view the Phoenix app in your browser, visit {_session.url}")
+    print("📺 To view the Phoenix app in a notebook, run `px.active_session().view()`")
+    print("📖 For more information on how to use Phoenix, check out https://docs.arize.com/phoenix")
+    return _session
+
 
+def active_session() -> Optional["Session"]:
+    """
+    Returns the active session if one exists, otherwise returns None
+    """
     return _session
 
 
 def close_app() -> None:
-    "Closes the phoenix application"
+    """
+    Closes the phoenix application.
+    The application server is shut down and will no longer be accessible.
+    """
     global _session
     if _session is None:
         print("No active session to close")
@@ -96,7 +138,7 @@ def close_app() -> None:
 
 
 def _get_url(port: int, is_colab: bool) -> str:
-    """Determines the iframe url based on whether this is in a Colab"""
+    """Determines the iframe url based on whether this is in a colab or in a local notebook"""
     if is_colab:
         from google.colab.output import eval_js  # type: ignore
 

phoenix/server/api/types/DataQualityTimeSeries.py

@@ -1,36 +0,0 @@
-import math
-from datetime import datetime
-from typing import Iterable, cast
-
-import pandas as pd
-import strawberry
-
-from phoenix.metrics import Metric
-
-from .TimeSeries import TimeSeries, TimeSeriesDataPoint
-
-
-@strawberry.type
-class DataQualityTimeSeries(TimeSeries):
-    """A time series of data quality metrics"""
-
-    ...
-
-
-def to_gql_timeseries(
-    df: pd.DataFrame, metric: Metric, timestamps: Iterable[datetime]
-) -> DataQualityTimeSeries:
-    data = []
-    for timestamp in timestamps:
-        try:
-            row = df.iloc[cast(int, df.index.get_loc(timestamp)), :].to_dict()
-        except KeyError:
-            row = {}
-        value = metric.get_value(row)
-        data.append(
-            TimeSeriesDataPoint(
-                timestamp=timestamp,
-                value=None if math.isnan(value) else value,
-            )
-        )
-    return DataQualityTimeSeries(data=sorted(data))

phoenix/server/api/types/DriftTimeSeries.py

@@ -1,10 +0,0 @@
-import strawberry
-
-from .TimeSeries import TimeSeries
-
-
-@strawberry.type
-class DriftTimeSeries(TimeSeries):
-    """A time series of drift metrics"""
-
-    ...