feat: Raise ValueError for alpha > 1 in sigmoid_focal_loss#8882
Merged
NicolasHug merged 3 commits intopytorch:mainfrom Feb 19, 2025
Merged
feat: Raise ValueError for alpha > 1 in sigmoid_focal_loss#8882NicolasHug merged 3 commits intopytorch:mainfrom
NicolasHug merged 3 commits intopytorch:mainfrom
Conversation
- Restrict alpha to (0, 1) or -1 for ignore, as per the original focal loss settings. - Add a check to raise ValueError when alpha exceeds 1. - This helps prevent invalid alpha values from silently causing unexpected behaviors.
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/vision/8882
Note: Links to docs will display an error until the docs builds have been completed. This comment was automatically generated by Dr. CI and updates every 15 minutes. |
facebook-github-bot
pushed a commit
that referenced
this pull request
Jul 9, 2025
…8882) Reviewed By: scotts Differential Revision: D77997070 fbshipit-source-id: be9289a4b3fab0447d17ae18ceeddd617cc9ab75 Co-authored-by: Nicolas Hug <contact@nicolas-hug.com> Co-authored-by: Nicolas Hug <nh.nicolas.hug@gmail.com>
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
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.
Overview
This PR updates the
sigmoid_focal_lossfunction to explicitly raise aValueErrorwhenalpha > 1.In the focal loss formulation,
alphais meant to balance positive and negative examples and shouldgenerally lie within the range
(0, 1)or be set to-1to ignore the balancing factor.Allowing
alphato exceed 1 can lead to unexpected behaviors.Changes
alpha > 1. If true, it raises aValueError.alphaare within(0, 1)or-1for ignoring.Reasoning
alphain the range of(0, 1)(or-1)is standard practice.
alphadoes not exceed 1 prevents users from accidentally passing invalid parameters,thus avoiding silent errors or unstable training behavior.
Additional Notes
However, for most applications, restricting
alphato(0, 1)or-1remains consistent with theoriginal focal loss approach.