Skip to content
epftoolbox2

TerminalExporter

TerminalExporter

Displays evaluation results as formatted tables in the terminal using Rich.

Basic Usage

from epftoolbox2.exporters import TerminalExporter


exporter = TerminalExporter()

Parameters

ParameterTypeDefaultDescription
showList[str]["summary", "horizon"]Tables to display

Show Options

  • "summary" - Overall metrics per model
  • "hour" - Breakdown by hour
  • "horizon" - Breakdown by forecast horizon
  • "hour_horizon" - Hour × Horizon matrix
  • "year" - Breakdown by year
  • "year_horizon" - Year × Horizon matrix

Example

# Show all available tables
exporter = TerminalExporter(show=["summary", "hour", "horizon", "year"])


# Show only summary
exporter = TerminalExporter(show=["summary"])

Output

Summary
┏━━━━━━━━━━┳━━━━━━━━━┓
┃ model    ┃ MAE     ┃
┡━━━━━━━━━━╇━━━━━━━━━┩
│ OLS      │ 26.0199 │
│ LassoCV  │ 28.1098 │
└──────────┴─────────┘


By Horizon
┏━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃ model    ┃ horizon  ┃ MAE     ┃
┡━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ OLS      │ 1        │ 18.5432 │
│ OLS      │ 2        │ 22.1234 │
└──────────┴──────────┴─────────┘

In Pipeline

from epftoolbox2.pipelines import ModelPipeline
from epftoolbox2.models import OLSModel
from epftoolbox2.evaluators import MAEEvaluator
from epftoolbox2.exporters import TerminalExporter


pipeline = (
    ModelPipeline()
    .add_model(OLSModel(predictors=predictors, name="OLS"))
    .add_evaluator(MAEEvaluator())
    .add_exporter(TerminalExporter(show=["summary", "horizon"]))
)