Updated error message and docstring

alteryx · Aug 21, 2023 · 996fd03 · 996fd03
1 parent 4a32c11
commit 996fd03
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/evalml/pipelines/utils.py b/evalml/pipelines/utils.py
@@ -1490,7 +1490,8 @@ def stack_X(X, series_id_name, time_index, starting_index=None, series_id_values
         starting_index (int): The starting index to use for the stacked DataFrame. If None, the starting index
             will match that of the input data. Defaults to None.
         series_id_values (set): The unique values of a series ID, used to generate the index. If None, values will
-            be generated from X column values. Defaults to None.
+            be generated from X column values. Required if X only has time index values and no exogenous values.
+            Defaults to None.
 
     Returns:
         pd.DataFrame: The restacked features.
@@ -1507,7 +1508,7 @@ def stack_X(X, series_id_name, time_index, starting_index=None, series_id_values
 
     if len(series_ids) == 0:
         raise ValueError(
-            "X has no exogenous variables and `series_id_values` is None.",
+            "Series ID values needs to be passed in X column values or as a set with the `series_id_values` parameter.",
         )
 
     time_index_col = X[time_index].repeat(len(series_ids)).reset_index(drop=True)

diff --git a/evalml/tests/pipeline_tests/test_pipeline_utils.py b/evalml/tests/pipeline_tests/test_pipeline_utils.py
@@ -1493,7 +1493,7 @@ def test_stack_X(
 
         with pytest.raises(
             ValueError,
-            match="X has no exogenous variables and `series_id_values` is None.",
+            match="Series ID values needs to be passed in X column values or as a set with the `series_id_values` parameter.",
         ):
             stack_X(X, "series_id", "date", starting_index=starting_index)