Introduce Named Data Classes for mlos_core #811
Closed
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
bpkroth
reviewed
Jul 31, 2024
bpkroth
reviewed
Jul 31, 2024
| elif left is not None and right is not None: | ||
| if not left.equals(right): | ||
| return False | ||
| return True |
There was a problem hiding this comment.
I think this can be simplified a bit:
if left is not None and right is not None and left.equals(right):
return True
return False
bpkroth
reviewed
Jul 31, 2024
bpkroth
reviewed
Sep 18, 2024
| def __repr__(self) -> str: | ||
| return ( | ||
| f"Observation(config={self.config}, score={self.score}," | ||
| + " context={self.context}, metadata={self.metadata})" |
bpkroth
reviewed
Sep 18, 2024
| scores: pd.DataFrame, | ||
| context: Optional[pd.DataFrame] = None, | ||
| metadata: Optional[pd.DataFrame] = None, | ||
| observation: Observation, |
There was a problem hiding this comment.
Suggested change
| observation: Observation, | |
| observations: Observations, |
bpkroth
reviewed
Sep 18, 2024
| @@ -150,7 +134,7 @@ def suggest( | |||
| *, | |||
| context: Optional[pd.DataFrame] = None, | |||
There was a problem hiding this comment.
Suggested change
| context: Optional[pd.DataFrame] = None, | |
| context: Optional[pd.Series] = None, |
Did this one get replacd by a Series elsewhere?
bpkroth
reviewed
Sep 18, 2024
| """ | ||
| pass # pylint: disable=unnecessary-pass # pragma: no cover | ||
|
|
||
| def get_observations(self) -> Tuple[pd.DataFrame, pd.DataFrame, Optional[pd.DataFrame]]: | ||
| def get_observations(self) -> Observation: |
There was a problem hiding this comment.
Suggested change
| def get_observations(self) -> Observation: | |
| def get_observations(self) -> Observations: |
docstring needs updating too
bpkroth
reviewed
Sep 18, 2024
| ).reset_index(drop=True) | ||
| return (configs, scores, contexts if len(contexts.columns) > 0 else None) | ||
| return Observation( |
There was a problem hiding this comment.
Suggested change
| return Observation( | |
| return Observations( |
bpkroth
reviewed
Sep 18, 2024
| return Observation( | ||
| config=configs, | ||
| score=scores, | ||
| context=contexts if len(contexts.columns) > 0 else None, |
There was a problem hiding this comment.
Suggested change
| context=contexts if len(contexts.columns) > 0 else None, | |
| context=contexts if len(contexts) > 0 else None, |
?
bpkroth
reviewed
Sep 18, 2024
|
|
||
| def get_best_observations( | ||
| self, | ||
| *, | ||
| n_max: int = 1, | ||
| ) -> Tuple[pd.DataFrame, pd.DataFrame, Optional[pd.DataFrame]]: | ||
| ) -> Observation: |
There was a problem hiding this comment.
Suggested change
| ) -> Observation: | |
| ) -> Observations: |
bpkroth
reviewed
Sep 18, 2024
| return (configs.loc[idx], scores.loc[idx], None if contexts is None else contexts.loc[idx]) | ||
| observations = self.get_observations() | ||
| idx = observations.score.nsmallest( | ||
| n_max, columns=self._optimization_targets, keep="first" |
There was a problem hiding this comment.
Suggested change
| n_max, columns=self._optimization_targets, keep="first" | |
| n_max, columns=self._optimization_targets, keep="first", |
trailing comma, format fixups
bpkroth
reviewed
Sep 20, 2024
|
|
||
|
|
||
| def compare_optional_dataframe( | ||
| left: Optional[pd.DataFrame], right: Optional[pd.DataFrame] |
There was a problem hiding this comment.
Suggested change
| left: Optional[pd.DataFrame], right: Optional[pd.DataFrame] | |
| left: Optional[pd.DataFrame], right: Optional[pd.DataFrame], |
nit: trailing comma and black reformat
|
Got confused and started commenting here again. I think #852 supercedes this one, so let's close this one. |
bpkroth
added a commit
that referenced
this pull request
Nov 25, 2024
## Title Refactor mlos_core APIs to encapsulate related data fields. ## Description Refactors the mlos_core Optimizer APIs to accept new data types `Observation`, `Observations` and return `Suggestion`, instead of a mess of `Tuple[DataFrame, DataFrame, Optional[DataFrame], Optional[DataFrame]]` that must be named and checked everywhere. Additionally, this makes it more explicit that `_register` is a bulk operation that is not actually supported currently by the underlying optimizers, though leaves notes on how we can do that in the future. ## Type of Change - Refactor --- ## Testing Usual CI plus some new unit tests for new data type operations. --- ## Additional Notes A more significant rewrite of named tuple support inside mlos_core. This is based on comments in #811 as well as conversations with @bpkroth --- --------- Co-authored-by: Brian Kroth <[email protected]> Co-authored-by: Brian Kroth <[email protected]>
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.
Introduces
@dataclasstypes for return values from mlos_core.Optimizers to improve code readability.See also: #751