Standardize data check messages by adding default "rows" and "columns" metadata #2869
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ml into 2792_standardize_dc_cleanup
angela97lin
changed the title
angela97lin
requested review from
eccabay,
chukarsten,
freddyaboulton,
bchen1116 and
dsherry
bchen1116
approved these changes
Oct 15, 2021
| @@ -86,14 +86,14 @@ def validate(self, X, y): | |||
| >>> y = pd.Series([10, 42, 31, 51, 40]) | |||
| >>> target_leakage_check = TargetLeakageDataCheck(pct_corr_threshold=0.95) | |||
| >>> assert target_leakage_check.validate(X, y) == { | |||
| ... "warnings": [{"message": "Column 'leak' is 95.0% or more correlated with the target", | |||
| ... "warnings": [{"message": "Columns 'leak' are 95.0% or more correlated with the target", | |||
There was a problem hiding this comment.
It feels weird that this is plural when there's only one column. Not a nit, but would be nice to fix this
…ml into 2792_standardize_dc_cleanup
ParthivNaresh
approved these changes
Oct 18, 2021
| ).to_dict(), | ||
| DataCheckWarning( | ||
| message="Column 'd' is 80.0% or more correlated with the target", | ||
| message="Columns 'a', 'b', 'c', 'd' are 80.0% or more correlated with the target", |
There was a problem hiding this comment.
The beauty of consolidation
| results["actions"].append( | ||
| DataCheckAction( | ||
| DataCheckActionCode.DROP_ROWS, | ||
| metadata={"indices": all_rows_with_indices}, | ||
| metadata={"rows": all_rows_with_indices}, |
There was a problem hiding this comment.
I guess a follow up comment, do we want to repeat the all_rows_with_indices over here? Maybe it should exist only in the DataCheckAction and not the Warning?
There was a problem hiding this comment.
Oof I missed this comment before merging, but I'm pretty indifferent about this either way!
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2792.
I still need to update docstring tests, will wait until #2933 is merged to avoid unnecessary changes and conflicts.