Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/chronos/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ def predict_df(
target: str = "target",
prediction_length: int | None = None,
quantile_levels: list[float] = [0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9],
validate_inputs: bool = True,
**predict_kwargs,
) -> "pd.DataFrame":
"""
Expand All @@ -162,6 +163,8 @@ def predict_df(
Number of steps to predict for each time series
quantile_levels
Quantile levels to compute
validate_inputs
When True, the dataframe(s) will be validated before prediction
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention what exactly is validated?

Suggested change
When True, the dataframe(s) will be validated before prediction
When True, the dataframe(s) will be validated before prediction, ensuring that timestamps have a regular frequency, and item IDs match between past and future data. Setting to False disables these checks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is optional - feel free to ignore

**predict_kwargs
Additional arguments passed to predict_quantiles

Expand Down Expand Up @@ -196,6 +199,7 @@ def predict_df(
timestamp_column=timestamp_column,
target_columns=[target],
prediction_length=prediction_length,
validate_inputs=validate_inputs,
)

# NOTE: any covariates, if present, are ignored here
Expand Down