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

Jump to bottom

README doesn't accurately describe the output of compute_metrics #126

Closed
fealho opened this issue May 10, 2022 · 2 comments
Closed

README doesn't accurately describe the output of compute_metrics #126

fealho opened this issue May 10, 2022 · 2 comments
Labels
documentation Docs, user guides or API resolution:obsolete This is no longer an issue

Comments

@fealho
Copy link
Member

fealho commented May 10, 2022 •
edited

The current README doesn't print the latest output. More specifically, the command sdmetrics.compute_metrics(metrics, real_data, synthetic_data, metadata=metadata) currently doesn't print the same as what the README prints (e.g. the current code produces a column named error containing None values which the README doesn't have, as well as other changes).
@fealho fealho added bug Something isn't working pending review This issue needs to be further reviewed, so work cannot be started documentation Docs, user guides or API and removed bug Something isn't working pending review This issue needs to be further reviewed, so work cannot be started labels May 10, 2022
@fealho fealho added the pending review This issue needs to be further reviewed, so work cannot be started label May 18, 2022
@npatki
Copy link
Contributor

npatki commented Jul 14, 2022

In addition to the error column, the newer version of SDMetrics will also include new metrics & changes to the names of the existing metrics.

@npatki npatki removed the pending review This issue needs to be further reviewed, so work cannot be started label Jul 14, 2022
@npatki npatki changed the title Rerun readme README doesn't accurately describe the output of compute_metrics Jul 14, 2022
@npatki
Copy link
Contributor

npatki commented Dec 8, 2022

Marking this as stale, as we've changed the README to include the newer reports functionality and their output.

@npatki npatki added the resolution:obsolete This is no longer an issue label Dec 8, 2022
@npatki npatki closed this as not planned Won't fix, can't repro, duplicate, stale Dec 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Docs, user guides or API resolution:obsolete This is no longer an issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@npatki @fealho