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

Improve readability of the report scores when verbosity is on #538

Closed
npatki opened this issue Mar 4, 2024 · 0 comments · Fixed by #540
Closed

Improve readability of the report scores when verbosity is on #538

npatki opened this issue Mar 4, 2024 · 0 comments · Fixed by #540
Assignees
Labels
feature request Request for a new feature
Milestone

Comments

@npatki
Copy link
Contributor

npatki commented Mar 4, 2024

Problem Description

When running the Quality or Diagnostic report in verbose mode (default), the progress and scores are shown. They look something like this:

Generating report ...
(1/3) Evaluating Data Validity: : 100%|██████████████████████| 52/52 [00:00<00:00, 4764.17it/s]
(2/3) Evaluating Data Structure: : 100%|█████████████████████| 3/3 [00:00<00:00, 1566.40it/s]
(3/3) Evaluating Relationship Validity: : 100%|██████████████████████| 2/2 [00:00<00:00, 770.16it/s]

Overall Score: 94.67%

Properties:
- Data Validity: 84.01%
- Data Structure: 100.0%
- Relationship Validity: 100.0%

This is a bit hard to parse:

  1. The 100% at the very top refers to the progress (completion) not the overall property score
  2. The property scores printed at the bottom actually refer to the progress bar at the top
  3. The overall score is printed in the middle of all this and can be easy to miss

Expected behavior

A more intuitive approach is to (a) stop printing out the progress %, (b) print out each property score after completing it, and (c) end with the overall score. So the above report would look something like this:

Generating report ...
(1/3) Evaluating Data Validity: |██████████████████████| 52/52 [00:00<00:00, 4764.17it/s]
Score: 84.01%

(2/3) Evaluating Data Structure: |█████████████████████| 3/3 [00:00<00:00, 1566.40it/s]
Score: 100.0%

(3/3) Evaluating Relationship Validity: |██████████████████████| 2/2 [00:00<00:00, 770.16it/s]
Score: 100.0%

Overall Score (Average): 94.67%

Additional context

This same format should be used for the quality report and diagnostic report, for both multi- and single-table modalities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants