Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ENH] improved output type checking error messages in BaseTransformer.transform #5921

Merged
merged 2 commits into from Feb 23, 2024
Merged

[ENH] improved output type checking error messages in BaseTransformer.transform #5921

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01937c7
Update base.py
fkiraly Feb 9, 2024
f02fae1
Update base.py
fkiraly Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 18 additions & 6 deletions sktime/transformations/base.py
View file
Open in desktop
Expand Up @@ -1226,20 +1226,32 @@ def _convert_output(self, X, metadata, inverse=False):
else:
Xt_metadata_required = []

valid, msg, metadata = check_is_mtype(
ALLOWED_OUT_MTYPES = ["pd.DataFrame", "pd.Series", "np.ndarray"]
Xt_valid, Xt_msg, metadata = check_is_mtype(
Xt,
["pd.DataFrame", "pd.Series", "np.ndarray"],
ALLOWED_OUT_MTYPES,
msg_return_dict="list",
return_metadata=Xt_metadata_required,
)

if not valid:
raise TypeError(
if not Xt_valid:
Xtd = {k: v for k, v in Xt_msg.items() if k in ALLOWED_OUT_MTYPES}
msg_start = (
f"Type checking error in output of _transform of "
f"{self.__class__.__name__}, output"
)
msg_out = (
f"_transform output of {type(self)} does not comply "
"with sktime mtype specifications. See datatypes.MTYPE_REGISTER"
" for mtype specifications. Returned error message:"
f" {msg}. Returned object: {Xt}"
" for mtype specifications."
)
check_is_error_msg(
Xtd,
var_name=msg_start,
allowed_msg=msg_out,
raise_exception=True,
)

if X_input_mtype == "pd.Series" and not metadata["is_univariate"]:
X_output_mtype = "pd.DataFrame"
elif self.get_tags()["scitype:transform-input"] == "Panel":
Expand Down