arize-phoenix 4.8.1__py3-none-any.whl → 4.10.0__py3-none-any.whl

phoenix/session/client.py

@@ -68,12 +68,12 @@ class Client(TraceDataExtractor):
 
         Args:
             endpoint (str, optional): Phoenix server endpoint, e.g.
-            http://localhost:6006. If not provided, the endpoint will be
-            inferred from the environment variables.
+                http://localhost:6006. If not provided, the endpoint will be
+                inferred from the environment variables.
 
             headers (Mapping[str, str], optional): Headers to include in each
-            network request. If not provided, the headers will be inferred from
-            the environment variables (if present).
+                network request. If not provided, the headers will be inferred from
+                the environment variables (if present).
         """
         if kwargs.pop("use_active_session_if_available", None) is not None:
             print(
@@ -133,7 +133,8 @@ class Client(TraceDataExtractor):
                 using environment variables. If not provided, falls back to the default project.
 
         Returns:
-            Union[pd.DataFrame, List[pd.DataFrame]]: A pandas DataFrame or a list of pandas
+            Union[pd.DataFrame, List[pd.DataFrame]]:
+                A pandas DataFrame or a list of pandas.
                 DataFrames containing the queried span data, or None if no spans are found.
         """
         project_name = project_name or get_env_project_name()
@@ -191,7 +192,8 @@ class Client(TraceDataExtractor):
                 default project.
 
         Returns:
-            List[Evaluations]: A list of Evaluations objects containing evaluation data. Returns an
+            List[Evaluations]:
+                A list of Evaluations objects containing evaluation data. Returns an
                 empty list if no evaluations are found.
         """
         project_name = project_name or get_env_project_name()
@@ -341,10 +343,10 @@ class Client(TraceDataExtractor):
             id (Optional[str]): An ID for the dataset.
 
             name (Optional[str]): the name for the dataset. If provided, the ID
-            is ignored and the dataset is retrieved by name.
+                is ignored and the dataset is retrieved by name.
 
             version_id (Optional[str]): An ID for the version of the dataset, or
-            None.
+                None.
 
         Returns:
             A dataset object.

phoenix/trace/trace_dataset.py

@@ -101,6 +101,14 @@ class TraceDataset:
     """
     A TraceDataset is a wrapper around a dataframe which is a flattened representation
     of Spans. The collection of spans trace the LLM application's execution.
+
+    Typical usage example::
+
+        from phoenix.trace.utils import json_lines_to_df
+
+        with open("trace.jsonl", "r") as f:
+            trace_ds = TraceDataset(json_lines_to_df(f.readlines()))
+        px.launch_app(trace=trace_ds)
     """
 
     name: str
@@ -122,15 +130,15 @@ class TraceDataset:
         Constructs a TraceDataset from a dataframe of spans. Optionally takes in
         evaluations for the spans in the dataset.
 
-        Parameters
-        __________
-        dataframe: pandas.DataFrame
-            the pandas dataframe containing the tracing data. Each row
-            represents a span.
-        evaluations: Optional[Iterable[SpanEvaluations]]
-            an optional list of evaluations for the spans in the dataset. If
-            provided, the evaluations can be materialized into a unified
-            dataframe as annotations.
+        Args:
+            dataframe (pandas.DataFrame): The pandas dataframe containing the
+                tracing data. Each row of which is a flattened representation
+                of a span.
+            name (str): The name used to identify the dataset in the application.
+                If not provided, a random name will be generated.
+            evaluations (Optional[Iterable[SpanEvaluations]]): An optional list of
+                evaluations for the spans in the dataset. If provided, the evaluations
+                can be materialized into a unified dataframe as annotations.
         """
         # Validate the the dataframe has required fields
         if missing_columns := set(REQUIRED_COLUMNS) - set(dataframe.columns):
@@ -225,12 +233,12 @@ class TraceDataset:
 
         Args:
             directory (Optional[Union[str, Path]], optional): An optional path
-            to a directory where the data will be written. If not provided, the
-            data will be written to a default location.
+                to a directory where the data will be written. If not provided, the
+                data will be written to a default location.
 
         Returns:
             UUID: The id of the trace dataset, which can be used as key to load
-            the dataset from disk using `load`.
+                the dataset from disk using `load`.
         """
         directory = Path(directory or TRACE_DATASETS_DIR)
         for evals in self.evaluations:
@@ -273,9 +281,9 @@ class TraceDataset:
             id (Union[str, UUID]): The ID of the trace dataset to be loaded.
 
             directory (Optional[Union[str, Path]], optional): The path to the
-            directory containing the persisted trace dataset parquet file. If
-            not provided, the parquet file will be loaded from the same default
-            location used by `save`.
+                directory containing the persisted trace dataset parquet file. If
+                not provided, the parquet file will be loaded from the same default
+                location used by `save`.
 
         Returns:
             TraceDataset: The loaded trace dataset.

phoenix/version.py

@@ -1 +1 @@
-__version__ = "4.8.1"
+__version__ = "4.10.0"