Description:
Add a new option that can be passed to any Evidently Report that would allow replacing “Current” and “Reference” display titles across the Report. For example, define it as current_title, and reference_title.
Context:
All Evidently Reports and Metrics refer to “Current” and “Reference” datasets. Reports can also be generated only for one (“Current”) dataset.
The names “Reference” and “Current” are visible side-by-side in Metric titles. Example:
They are also included in the render of the individual plots or as part of the visualization or legend. Examples for DataDriftTable:
Example for ColumnSummaryMetric
Sometimes users want to override the default titles and set different names for their dataset and models. For example, when generating a model comparison report for two models, you might want to call them “Model A” and “Model B”, or refer to your datasets as “training” and “testing” datasets, etc.
We want to add the functionality that allows changing the display title.
Note: the existing implementation of the reference and current names is not entirely consistent across Metrics. A thorough testing is required to ensure that changes propagate to all Metrics and renders.
Implementation:
- Implement a new
current_title and reference_title options that can be passed to all individual Reports. This is a Report-level render option. You can look at the implementation of “raw_data” or “color_schema” options for inspiration.
- Document the option by adding a new section titled “Changing the names of “Reference and Current” to this docs page.
- [OPTIONAL] add a how-to notebook showing the new functionality, similar to the other ones. The how-to notebook should include a very short example to show the usage of the parameter with a few different metrics and any of the metrics presets.
The option should work as the following:
report = Report(
metrics=[
RegressionQualityPreset(),
],
options={"render": {“current_title”:”ModelA”}}
)
report.run(reference_data=housing_ref, current_data=housing_cur)
report
Description:
Add a new option that can be passed to any Evidently Report that would allow replacing “Current” and “Reference” display titles across the Report. For example, define it as
current_title, andreference_title.Context:
All Evidently Reports and Metrics refer to “Current” and “Reference” datasets. Reports can also be generated only for one (“Current”) dataset.
The names “Reference” and “Current” are visible side-by-side in Metric titles. Example:
They are also included in the render of the individual plots or as part of the visualization or legend. Examples for
DataDriftTable:Example for
ColumnSummaryMetricSometimes users want to override the default titles and set different names for their dataset and models. For example, when generating a model comparison report for two models, you might want to call them “Model A” and “Model B”, or refer to your datasets as “training” and “testing” datasets, etc.
We want to add the functionality that allows changing the display title.
Note: the existing implementation of the reference and current names is not entirely consistent across Metrics. A thorough testing is required to ensure that changes propagate to all Metrics and renders.
Implementation:
current_titleandreference_titleoptions that can be passed to all individual Reports. This is a Report-level render option. You can look at the implementation of “raw_data” or “color_schema” options for inspiration.The option should work as the following: