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.

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

Validate that the metadata is always a dict #428

Closed
npatki opened this issue Aug 24, 2023 · 0 comments · Fixed by #466
Closed

Validate that the metadata is always a dict #428

npatki opened this issue Aug 24, 2023 · 0 comments · Fixed by #466
Assignees
Labels
feature:reports Related to any of the generated reports feature request Request for a new feature
Milestone

Comments

@npatki
Copy link
Contributor

npatki commented Aug 24, 2023

Problem Description

The diagnostic and quality reports always expect that the metadata is a dictionary. This can be confusing because in other libraries (such as the SDV), the metadata is actually its own object.

Expected behavior

If I don't pass in a dictionary into a report, provide a helpful error message.

from sdmetrics.reports.single_table import DiagnosticReport

report = DiagnosticReport()
report.generate(real_data, synthetic_data, metadata_object)
InvalidInputError: The provided metadata is not a dictionary.

Additional context

We cannot use metadata objects in SDMetrics because we are not using or importing the SDV.

@npatki npatki added feature request Request for a new feature feature:reports Related to any of the generated reports labels Aug 24, 2023
@rwedge rwedge added this to the 0.12.0 milestone Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature:reports Related to any of the generated reports feature request Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants