Fix error bucket docs to correctly reflect indexes #1520
Merged
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
bhancock8
requested changes
Nov 23, 2019
snorkel/analysis/error_analysis.py
Outdated
| predicted label i and true label j. | ||
| true label i and predicted label j. | ||
|
|
||
| More generally, the returned indexes (i,j,k,...) match the order of labels passed |
There was a problem hiding this comment.
Confusing to use i and j here with a different meaning than i and j just two lines above. How about "The returned indices within each bucket refer to the order of the labels that were passed in."
There was a problem hiding this comment.
Agreed, this is clearer!
Codecov Report
@@ Coverage Diff @@
## master #1520 +/- ##
======================================
Coverage 97.6% 97.6%
======================================
Files 55 55
Lines 2047 2047
Branches 337 337
======================================
Hits 1998 1998
Misses 22 22
Partials 27 27
|
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.
Description of proposed changes
Documentation is incorrect for the
get_label_bucketsutilityFixes # (issue)
Spectrum issue specifying incorrect documentation: https://spectrum.chat/snorkel/tutorials/understanding-buckets-key-in-error-analysis-py~1b4f478f-78ab-44f4-9bfe-7c14532e88dd
Test plan
Need help on these? Just ask!
tox -e complexand/ortox -e sparkif appropriate.