plot_score_time_series¶
yohou.plotting.evaluation.plot_score_time_series(scorer, y_truth, y_pred, *, time_weight=None, step_weight=None, vintage_weight=None, compare_by='scorer', columns=None, groups=None, facet_by='member', facet_n_cols=2, color_palette=None, show_legend=True, title=None, x_label=None, y_label=None, width=None, height=None, connect_gaps=False, resampler=None, line_width=2.0, line_dash='solid', line_opacity=1.0, show_markers=False)
¶
Plot scorer values over time for one or more forecasts.
Evaluates forecast quality at each timestep by computing the scorer with componentwise aggregation, then plots the resulting score time series. Useful for identifying periods where forecast performance varies.
Parameters¶
| Name | Type | Description | Default |
|---|---|---|---|
scorer
|
BaseScorer or dict[str, BaseScorer]
|
Yohou scorer instance (e.g., MeanAbsoluteError, RootMeanSquaredError). Will be cloned and configured with aggregation_method="componentwise".
|
required |
y_truth
|
DataFrame
|
Ground truth values with 'time' column. |
required |
y_pred
|
DataFrame or dict[str, DataFrame]
|
Predicted values with 'vintage_time' and 'time' columns. - If DataFrame: single forecast to plot - If dict: multiple forecasts with keys as model names |
required |
time_weight
|
callable, pl.DataFrame, dict, or None
|
Time weighting function, DataFrame, or dict forwarded to
|
None
|
step_weight
|
callable, pl.DataFrame, dict, or None
|
Per-step weights forwarded to |
None
|
vintage_weight
|
callable, pl.DataFrame, dict, or None
|
Per-vintage weights forwarded to |
None
|
compare_by
|
str
|
When both
Ignored when either |
"scorer"
|
columns
|
str | list[str] | None
|
Target column name(s) to include in the score. When
groups is set, acts as a member postfix filter
(e.g. |
None
|
groups
|
list[str] | None
|
Panel group prefixes for faceted subplots. When provided, each
group gets its own subplot showing the score time series for that
group. Groups are resolved via |
None
|
facet_by
|
Literal['group', 'member', 'vintage'] | None
|
Faceting axis for panel data or vintage data. |
"member"
|
facet_n_cols
|
int
|
Number of columns in the facet grid when groups is used. |
2
|
color_palette
|
list[str] | None
|
Custom color palette as hex codes. If None, uses yohou palette. |
None
|
show_legend
|
bool
|
Whether to show legend when plotting multiple forecasts. |
True
|
title
|
str | None
|
Plot title. If None, generates title from scorer name. |
None
|
x_label
|
str | None
|
X-axis label. Defaults to "time". |
None
|
y_label
|
str | None
|
Y-axis label. If None, uses scorer class name. |
None
|
width
|
int | None
|
Plot width in pixels. |
None
|
height
|
int | None
|
Plot height in pixels. |
None
|
connect_gaps
|
bool
|
Whether to connect gaps in the data with lines. |
False
|
resampler
|
bool | Literal['widget'] | None
|
Enable plotly-resampler for large datasets. |
None
|
line_width
|
float
|
Width of score lines. |
2.0
|
line_dash
|
str
|
Dash style of score lines. |
"solid"
|
line_opacity
|
float
|
Opacity of score lines. |
1.0
|
show_markers
|
bool
|
Whether to show markers on the lines. |
False
|
Returns¶
| Type | Description |
|---|---|
Figure
|
Plotly figure object. |
Raises¶
| Type | Description |
|---|---|
TypeError
|
If y_truth or y_pred is not a Polars DataFrame. |
ValueError
|
If DataFrames are empty or missing required columns. |
Examples¶
>>> import polars as pl
>>> from datetime import datetime
>>> from yohou.metrics import MeanAbsoluteError
>>> from yohou.plotting import plot_score_time_series
>>> # Create sample data
>>> y_truth = pl.DataFrame({
... "time": [datetime(2020, 1, 1), datetime(2020, 1, 2), datetime(2020, 1, 3)],
... "value": [10.0, 20.0, 30.0],
... })
>>> y_pred = pl.DataFrame({
... "vintage_time": [datetime(2019, 12, 31)] * 3,
... "time": [datetime(2020, 1, 1), datetime(2020, 1, 2), datetime(2020, 1, 3)],
... "value": [12.0, 19.0, 28.0],
... })
>>> # Plot score time series for single forecast
>>> scorer = MeanAbsoluteError()
>>> fig = plot_score_time_series(scorer, y_truth, y_pred)
>>> len(fig.data)
1
>>> # Plot multiple forecasts
>>> y_pred2 = pl.DataFrame({
... "vintage_time": [datetime(2019, 12, 31)] * 3,
... "time": [datetime(2020, 1, 1), datetime(2020, 1, 2), datetime(2020, 1, 3)],
... "value": [11.0, 21.0, 29.0],
... })
>>> fig = plot_score_time_series(scorer, y_truth, {"Model A": y_pred, "Model B": y_pred2})
>>> len(fig.data)
2
See Also¶
plot_residuals : Plot residual diagnostics.
plot_forecast : Plot forecasts with historical data.
Notes¶
- Scorer is automatically configured with aggregation_method="componentwise"
- For interval scorers, use aggregation_method=["componentwise", "coveragewise"]
- Requires scorer to support componentwise aggregation
- All scores are computed independently at each timestep
- Use
facet_by="vintage"to compare score curves across forecast origins (requiresy_predwith multiplevintage_timevalues)
Source Code¶
Show/Hide source
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 | |
Tutorials¶
The following example notebooks use this component:
-
How to Wrap Functions as Transformers
Data-Features
Wrap arbitrary polars or numpy operations as sklearn transformers with FunctionTransformer, supporting stateful warmup, inverse transforms, and pipelines.
-
How to Use Scikit-learn Scalers
Data-Features
Wrap sklearn scalers (StandardScaler, MinMaxScaler, RobustScaler, PowerTransformer, PolynomialFeatures) for polars DataFrames with inverse transforms.
-
How to Score Class-Probability Forecasts
Evaluation-Search
Evaluate categorical forecasts with LogLoss, BrierScore, and Accuracy. Covers per-timestep scoring, aggregation modes, and reliability diagrams.
-
How to Use Conformity Scorers
Evaluation-Search
Compare Residual, AbsoluteResidual, GammaResidual, and AbsoluteGammaResidual conformity scorers with coverage/width analysis and DistanceSimilarity interaction.
-
How to Evaluate Interval Forecasts
Evaluation-Search
Evaluate prediction intervals with EmpiricalCoverage, IntervalScore, MeanIntervalWidth, PinballLoss, and CalibrationError across coverage levels.
-
How to Use Point Forecast Metrics
Evaluation-Search
Compare MAE, MAPE, MASE, RMSE, and other point metrics across multiple forecasters with componentwise and groupwise aggregation.
-
How to Forecast with CatBoost
Forecasting-Models
Plug CatBoostRegressor into PointReductionForecaster as a drop-in sklearn estimator, compare gradient-boosted versus Ridge linear baseline, and demonstrate the direct reduction strategy with tree-based models.
-
How to Forecast Class Probabilities
Forecasting-Models
Use ClassProbaReductionForecaster to produce calibrated probability forecasts and evaluate them with Brier score, log loss, and accuracy.
-
How to Combine Forecasters with VotingPointForecaster
Forecasting-Models
Build point ensembles with VotingPointForecaster using mean, weighted, and median aggregation strategies.
-
Conformal Prediction Intervals
Getting-Started
Build distribution-free prediction intervals with SplitConformalForecaster using calibration holdouts and configurable conformity scoring functions.
-
Naive Forecasters
Getting-Started
Baseline forecasting (the first portion of the First Forecast tutorial) with SeasonalNaive using different seasonality periods, the observe/predict streaming workflow, and rolling evaluation patterns.
-
Quickstart
Quickstart
Comprehensive end-to-end tour of yohou beyond the Getting Started tutorials, covering data loading, baseline forecasting, preprocessing pipelines, decomposition, cross-validation search, and interval prediction.
-
How to Visualize Forecast Evaluation Results
Visualization
Use plot_calibration, plot_score_per_step, and plot_forecast to diagnose forecast accuracy and interval calibration visually.