MetricsCalculator¶
The computation core of the metrics pipeline. MetricsCalculator takes a standardized trade DataFrame (via from_iso_frame), builds the canonical series, and produces a MetricsResult containing all metric groups.
Metric Groups¶
| Dataclass | Key Fields |
|---|---|
RiskMetrics |
estimated_risk, cvar_1, cvar_5, var_99, var_95, var_90, capital_required |
ReturnMetrics |
mean_daily, median_daily, mean_monthly_30d, median_monthly_30d, mean_annual_365d, median_annual_365d, calendar_returns |
RatioMetrics |
sharpe_overall, sortino_overall, risk-adjusted ratios at daily/monthly/annual horizons |
DrawdownMetrics |
max_drawdown, max_drawdown_start, max_drawdown_end, max_drawdown_duration_days |
StreakMetrics |
win_rate_pct, max_win_streak, max_loss_streak, current_streak |
All metric dataclasses use slots=True for memory efficiency.
Metrics Calculator - Compute financial and risk metrics from trade data.
Classes¶
RiskMetrics
dataclass
¶
RiskMetrics(estimated_risk: float, cvar_1: float, cvar_5: float, var_99: float, var_95: float, var_90: float, capital_required: float | None)
Risk-related metrics.
ReturnMetrics
dataclass
¶
ReturnMetrics(mean_daily: float, median_daily: float, mean_monthly_30d: float, median_monthly_30d: float, mean_annual_365d: float, median_annual_365d: float, calendar_returns: dict[int, float], calendar_returns_risk_adjusted: dict[int, float] = dict())
Return-related metrics.
RatioMetrics
dataclass
¶
RatioMetrics(mean_daily_over_estimated_risk: float, median_daily_over_estimated_risk: float, mean_monthly_over_estimated_risk: float, median_monthly_over_estimated_risk: float, mean_annual_over_estimated_risk: float, median_annual_over_estimated_risk: float, sharpe_overall: float, sortino_overall: float, sharpe_by_year: dict[int, float], sortino_by_year: dict[int, float], mean_annual_calendar_over_estimated_risk: float, median_annual_calendar_over_estimated_risk: float)
Ratio metrics (returns divided by estimated risk).
DrawdownMetrics
dataclass
¶
DrawdownMetrics(worst_daily_loss: float, worst_daily_loss_date: Timestamp, worst_7d_loss: float, worst_7d_loss_start_date: Timestamp, worst_7d_loss_end_date: Timestamp, worst_1m_30d_loss: float, worst_1m_30d_loss_start_date: Timestamp, worst_1m_30d_loss_end_date: Timestamp, worst_3m_90d_loss: float, worst_3m_90d_loss_start_date: Timestamp, worst_3m_90d_loss_end_date: Timestamp, worst_6m_180d_loss: float, worst_6m_180d_loss_start_date: Timestamp, worst_6m_180d_loss_end_date: Timestamp, worst_12m_365d_loss: float, worst_12m_365d_loss_start_date: Timestamp, worst_12m_365d_loss_end_date: Timestamp, worst_daily_loss_over_estimated_risk: float, worst_7d_loss_over_estimated_risk: float, worst_1m_30d_loss_over_estimated_risk: float, worst_3m_90d_loss_over_estimated_risk: float, worst_6m_180d_loss_over_estimated_risk: float, worst_12m_365d_loss_over_estimated_risk: float, max_drawdown: float, max_drawdown_over_estimated_risk: float)
Drawdown and worst loss metrics.
StreakMetrics
dataclass
¶
StreakMetrics(worst_any_period_start_date: Timestamp, worst_any_period_end_date: Timestamp, worst_any_period_length_days: int, longest_loss_period_start_date: Timestamp, longest_loss_period_end_date: Timestamp, longest_loss_period_length_days: int, longest_period_loss: float, win_rate_pct: float, pct_1m_periods_with_loss: float, pct_3m_periods_with_loss: float, pct_6m_periods_with_loss: float, pct_12m_periods_with_loss: float)
Streak and probability metrics.
MetricsResult
dataclass
¶
MetricsResult(risk: RiskMetrics, returns: ReturnMetrics, ratios: RatioMetrics, drawdowns: DrawdownMetrics, streaks: StreakMetrics)
Container for all computed metrics.
Functions¶
to_frame
¶
Flatten all metrics into a DataFrame with 'metric' and 'value' columns.
Returns: DataFrame with columns ['metric', 'value']
Source code in src/progridpy/metrics/calculator.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
MetricsCalculator
¶
MetricsCalculator(df_std: DataFrame, schema: ISOTradeSchema)
Calculator for computing all metrics from trade data.
This class orchestrates the computation of all metric groups using a standardized DataFrame and ISO schema.
Initialize the calculator.
Args: df_std: Standardized DataFrame (output of schema.adapt_frame) schema: ISO schema used for adaptation
Source code in src/progridpy/metrics/calculator.py
Functions¶
from_iso_frame
classmethod
¶
from_iso_frame(df_iso: DataFrame, iso_name: str) -> MetricsCalculator
Create a MetricsCalculator from an ISO-specific DataFrame.
Args: df_iso: ISO-specific trade DataFrame iso_name: Name of the ISO (e.g., "MISO")
Returns: MetricsCalculator instance
Source code in src/progridpy/metrics/calculator.py
filtered_frame
¶
Return the DataFrame filtered to cleared trades only.
Filter: cleared == True
Returns: Filtered DataFrame
canonical_series
¶
canonical_series() -> CanonicalSeries
Build and cache the canonical time series.
Returns: CanonicalSeries with daily_gains, cumulative_gains, and drawdowns
Source code in src/progridpy/metrics/calculator.py
calculate_risk_metrics
¶
calculate_risk_metrics() -> RiskMetrics
Calculate risk metrics.
Includes: - Estimated Risk - CVaR 1%, CVaR 5% - VaR 99%, VaR 95%, VaR 90% - Capital Required (ISO-specific)
Returns: RiskMetrics dataclass
Source code in src/progridpy/metrics/calculator.py
calculate_return_metrics
¶
calculate_return_metrics() -> ReturnMetrics
Calculate return metrics.
Includes: - Mean/Median Daily Return - Mean/Median Monthly Return (30d) - Mean/Median Annual Return (365d) - Calendar Year Returns
Returns: ReturnMetrics dataclass
Source code in src/progridpy/metrics/calculator.py
calculate_ratio_metrics
¶
calculate_ratio_metrics(risk: RiskMetrics, returns: ReturnMetrics) -> RatioMetrics
Calculate ratio metrics (returns divided by estimated risk).
Args: risk: Previously computed RiskMetrics returns: Previously computed ReturnMetrics
Returns: RatioMetrics dataclass
Source code in src/progridpy/metrics/calculator.py
calculate_drawdown_metrics
¶
calculate_drawdown_metrics(risk: RiskMetrics) -> DrawdownMetrics
Calculate drawdown metrics.
Args: risk: Previously computed RiskMetrics (for risk-adjusted ratios)
Returns: DrawdownMetrics dataclass
Source code in src/progridpy/metrics/calculator.py
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 | |
calculate_streak_metrics
¶
calculate_streak_metrics(risk: RiskMetrics) -> StreakMetrics
Calculate streak and probability metrics.
Args: risk: Previously computed RiskMetrics
Returns: StreakMetrics dataclass
Source code in src/progridpy/metrics/calculator.py
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 | |
calculate_all
¶
calculate_all() -> MetricsResult
Calculate all metrics in the correct dependency order.
Returns: MetricsResult containing all metric groups