fix: raise ValueError for empty top_k in HitRate#3722
Open
muhammadrashid4587 wants to merge 1 commit intopytorch:masterfrom
Open
fix: raise ValueError for empty top_k in HitRate#3722muhammadrashid4587 wants to merge 1 commit intopytorch:masterfrom
muhammadrashid4587 wants to merge 1 commit intopytorch:masterfrom
Conversation
HitRate(top_k=[]) silently passed validation because `any(k <= 0 for k in [])` returns False for empty lists, then crashed with an unhelpful IndexError during update(). Add an explicit check for empty top_k at construction time so users get a clear ValueError immediately. Fixes pytorch#3718
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
top_klist inHitRate.__init__()HitRate(top_k=[])now raises a clearValueErrorat construction time instead of crashing withIndexErrorduringupdate()Root cause
The existing check
any(k <= 0 for k in top_k)returnsFalsefor empty lists, sotop_k=[]passed validation. Later,self.top_k[-1]inupdate()raisesIndexError.Fixes #3718
Test plan
HitRate(top_k=[])now raisesValueError("top_k must not be empty.")HitRate(top_k=[1, 2, 3])unaffected