Join the newly launched Discord
community for real-time discussions, peer support, and direct interaction with the Meridian team!
meridian.analysis.summarizer.Summarizer
Stay organized with collections
Save and categorize content based on your preferences.
Generates HTML summary visualizations from the model fitting.
meridian
.
analysis
.
summarizer
.
Summarizer
(
meridian
:
meridian
.
model
.
model
.
Meridian
)
Methods
output_model_results_summary
View source
output_model_results_summary
(
filename
:
str
,
filepath
:
str
,
start_date
:
meridian
.
data
.
time_coordinates
.
Date
=
None
,
end_date
:
meridian
.
data
.
time_coordinates
.
Date
=
None
)
Generates and saves the HTML results summary output.
filename
The filename for the generated HTML output.
filepath
The path to the directory where the file will be saved.
start_date
Optional start date selector, inclusive
, in yyyy-mm-dd
format.
end_date
Optional end date selector, inclusive
in yyyy-mm-dd
format.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-05 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-05 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eSummarizer\u003c/code\u003e class generates HTML summary visualizations from model fitting results.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eoutput_model_results_summary\u003c/code\u003e method creates and saves an HTML summary of the results.\u003c/p\u003e\n"],["\u003cp\u003eUsers can specify the output filename and filepath for the generated HTML file.\u003c/p\u003e\n"],["\u003cp\u003eThe summary generation can be filtered by specifying optional \u003ccode\u003estart_date\u003c/code\u003e and \u003ccode\u003eend_date\u003c/code\u003e parameters in \u003cem\u003eyyyy-mm-dd\u003c/em\u003e format.\u003c/p\u003e\n"]]],["The `Summarizer` class generates HTML summary visualizations from model fitting results. The `output_model_results_summary` method creates and saves the HTML output. Key actions include specifying the `filename` and `filepath` for the HTML file. Users can optionally define a `start_date` and `end_date` to filter data within a specific time range. The dates should be formatted as yyyy-mm-dd, with start being inclusive and end exclusive.\n"],null,["\u003cbr /\u003e\n\n|------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/google/meridian/blob/v1.2.0/meridian/analysis/summarizer.py#L59-L532) |\n\nGenerates HTML summary visualizations from the model fitting. \n\n meridian.analysis.summarizer.Summarizer(\n meridian: ../../../meridian/model/model/Meridian.md\n )\n\nMethods\n\n`output_model_results_summary`\n\n[View source](https://github.com/google/meridian/blob/v1.2.0/meridian/analysis/summarizer.py#L74-L92) \n\n output_model_results_summary(\n filename: str,\n filepath: str,\n start_date: ../../../meridian/data/time_coordinates.md#Date = None,\n end_date: ../../../meridian/data/time_coordinates.md#Date = None\n )\n\nGenerates and saves the HTML results summary output.\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ||\n|--------------|---------------------------------------------------------------------|\n| `filename` | The filename for the generated HTML output. |\n| `filepath` | The path to the directory where the file will be saved. |\n| `start_date` | Optional start date selector, *inclusive* , in *yyyy-mm-dd* format. |\n| `end_date` | Optional end date selector, *inclusive* in *yyyy-mm-dd* format. |\n\n\u003cbr /\u003e"]]
