More precise type annotations for MultiObjectiveOptimizationConfig
#2620
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
Summary: Context: Type annotations imply that any `Objective` works with a `MultiObjectiveOptimizationConfig`, but the code makes clear that only a `MultiObjective` or `ScalarizedObjective` works, and even has tests for this. I was misled myself into trying to privde an `Objective` to a `MultiObjectiveOptimizationConfig`. This PR: * Changes annotations from `Objective` to `Union[MultiObjective, ScalarizedObjective]` * Adds a pyre-fixme: Inconsistent override. The indirect cause of why this is needed is that `Objective.clone_with_args` returns an `Objective` type even in subclasses unless the method is overriden, rather than a self type. * Added a couple pyre-fixmes in unit tests that were deliberately testing inappropriate types. Differential Revision: D60476566
facebook-github-bot
added
the
CLA Signed
|
This pull request was exported from Phabricator. Differential Revision: D60476566 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2620 +/- ##
=======================================
Coverage 95.22% 95.22%
=======================================
Files 492 492
Lines 47672 47673 +1
=======================================
+ Hits 45394 45395 +1
Misses 2278 2278 ☔ View full report in Codecov by Sentry. |
|
This pull request has been merged in f25b4ce. |
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.
Summary:
Context: Type annotations imply that any
Objectiveworks with aMultiObjectiveOptimizationConfig, but the code makes clear that only aMultiObjectiveorScalarizedObjectiveworks, and even has tests for this. I was misled myself into trying to privde anObjectiveto aMultiObjectiveOptimizationConfig.This PR:
ObjectivetoUnion[MultiObjective, ScalarizedObjective]Objective.clone_with_argsreturns anObjectivetype even in subclasses unless the method is overriden, rather than a self type.Differential Revision: D60476566