Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wrong chart title when generating a box plot for just the real data using get_column_pair_plot() #618

Merged
merged 2 commits into from
Aug 8, 2024
Merged

Wrong chart title when generating a box plot for just the real data using get_column_pair_plot() #618

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3cc4ea
def
R-Palazzo Aug 6, 2024
b1f4f94
tests
R-Palazzo Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions sdmetrics/visualization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ def _generate_heatmap_plot(all_data, columns):
)

title = ' vs. '.join(unique_values)
title += f" Data for columns '{columns[0]}' and '{columns[1]}"
title += f" Data for columns '{columns[0]}' and '{columns[1]}'"

fig.update_layout(
title_text=title,
Expand Down Expand Up @@ -141,8 +141,11 @@ def _generate_box_plot(all_data, columns):
},
)

unique_values = all_data['Data'].unique()
title = ' vs. '.join(unique_values)
title += f" Data for columns '{columns[0]}' and '{columns[1]}'"
fig.update_layout(
title=f"Real vs. Synthetic Data for columns '{columns[0]}' and '{columns[1]}'",
title=title,
plot_bgcolor=PlotConfig.BACKGROUND_COLOR,
font={'size': PlotConfig.FONT_SIZE},
)
Expand Down
44 changes: 39 additions & 5 deletions tests/unit/test_visualization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,11 @@ def test__generate_scatter_plot(px_mock):
color_discrete_map={'Real': '#000036', 'Synthetic': '#01E0C9'},
symbol='Data',
)
mock_figure.update_layout.assert_called_once()
mock_figure.update_layout.assert_called_once_with(
title="Real vs. Synthetic Data for columns 'col1' and 'col2'",
plot_bgcolor='#F5F5F8',
font={'size': 18},
)
assert fig == mock_figure


Expand Down Expand Up @@ -787,7 +791,11 @@ def test__generate_heatmap_plot(px_mock):
facet_col='Data',
histnorm='probability',
)
mock_figure.update_layout.assert_called_once()
mock_figure.update_layout.assert_called_once_with(
title_text="Real vs. Synthetic Data for columns 'col1' and 'col2'",
coloraxis={'colorscale': ['#000036', '#01E0C9']},
font={'size': 18},
)
mock_figure.for_each_annotation.assert_called_once()
assert fig == mock_figure

Expand Down Expand Up @@ -909,10 +917,37 @@ def test__generate_box_plot(px_mock):
color='Data',
color_discrete_map={'Real': '#000036', 'Synthetic': '#01E0C9'},
)
mock_figure.update_layout.assert_called_once()
mock_figure.update_layout.assert_called_once_with(
title="Real vs. Synthetic Data for columns 'col1' and 'col2'",
plot_bgcolor='#F5F5F8',
font={'size': 18},
)
assert fig == mock_figure


@patch('sdmetrics.visualization.px')
def test__generate_box_plot_title_one_dataset_only(px_mock):
"""Test the ``_generate_box_plot`` title when only one dataset is passed."""
# Setup
real_data = pd.DataFrame({
'col1': [1, 2, 3, 4],
'col2': ['a', 'b', 'c', 'd'],
'Data': ['Real'] * 4,
})
columns = ['col1', 'col2']
mock_figure = Mock()
px_mock.box.side_effect = [mock_figure, mock_figure]

# Run
fig_real = _generate_box_plot(real_data, columns)

# Assert
mock_figure.update_layout.assert_called_once_with(
title="Real Data for columns 'col1' and 'col2'", plot_bgcolor='#F5F5F8', font={'size': 18}
)
assert fig_real == mock_figure


def test_get_column_pair_plot_invalid_column_names():
"""Test ``get_column_pair_plot`` method with invalid ``column_names``."""
# Setup
Expand Down Expand Up @@ -1013,8 +1048,7 @@ def test_get_column_pair_plot_plot_single_data(mock__generate_scatter_plot):
assert synth_fig == 'mock_return_2'


@patch('sdmetrics.visualization._generate_scatter_plot')
def test_get_column_pair_plot_plot_no_data(mock__generate_scatter_plot):
def test_get_column_pair_plot_plot_no_data():
"""Test ``get_column_pair_plot`` with neither real or synthetic data"""
# Setup
columns = ['amount', 'price']
Expand Down
Loading