ts_benchmark.report package
Subpackages
ts_benchmark.report.report_csv module
Functions
|
Generate a report based on specified configuration parameters. |
- report(report_config: dict) None[source]
Generate a report based on specified configuration parameters.
- Parameters:
report_config – Configuration dictionary containing:
log_files_list (List[str]): A list of file paths for log files.
leaderboard_file_name (str): The name for the saved report file.
aggregate_type (str): Aggregation type for evaluation metrics.
report_metrics (Union[str, List[str]]): Metrics for the report, can be a string or list of strings.
fill_type (str): Type of fill for missing values.
null_value_threshold (float): Threshold value for null metrics.
- Raises:
ValueError – If all metrics have too many null values, making performance comparison impossible.
- Returns:
None. The function generates and saves a report to a CSV file.