Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename maximum_hypervolume to optimal_value in MOO Benchmark Problems #2598

Closed
wants to merge 1 commit into from

Conversation

esantorella
Copy link
Contributor

Summary:
Context:

This will give single-objective and multi-objective benchmark problems a more consistent API, making it possible to simplify the inheritance structure in D60145193 and subsequent PRs.

Note: This breaks backwards compatibility, including for reading multi-objective benchmark problems stored as JSON. I think it's worthwhile because this will enable a lot of simplification in the future and because I expect we will want to break backward-compatibility again shortly. It would be possible to make this change BC, but I'm not sure it's worthwhile.

Note: Docstrings are updated in D60145193, so they are not updated here.

This PR:

  • Makes MultiObjectiveBenchmarkProblem.__init__ take an optimal_value argument, and removes its maximum_hypervolume argument.
  • Removes the optimal_value property of MultiObjectiveBenchmarkProblem, which pointed to maximum_hypervolume.
  • Does the same for surrogate benchmark problems.
  • Updates references to maximum_hypervolume.

Differential Revision: D60194654

…lems

Summary:
Context:

This will give single-objective and multi-objective benchmark problems a more consistent API, making it possible to simplify the inheritance structure in D60145193 and subsequent PRs.

Note: This breaks backwards compatibility, including for reading multi-objective benchmark problems stored as JSON. I think it's worthwhile because this will enable a lot of simplification in the future and because I expect we will want to break backward-compatibility again shortly. It would be possible to make this change BC, but I'm not sure it's worthwhile.

Note: Docstrings are updated in D60145193, so they are not updated here.

This PR:
* Makes `MultiObjectiveBenchmarkProblem.__init__` take an `optimal_value` argument, and removes its `maximum_hypervolume` argument.
* Removes the `optimal_value` property of `MultiObjectiveBenchmarkProblem`, which pointed to `maximum_hypervolume`.
* Does the same for surrogate benchmark problems.
* Updates references to `maximum_hypervolume`.

Differential Revision: D60194654
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Jul 24, 2024
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D60194654

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 95.21%. Comparing base (61a9f88) to head (a78ef22).

Files Patch % Lines
ax/benchmark/benchmark_problem.py 75.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2598      +/-   ##
==========================================
- Coverage   95.21%   95.21%   -0.01%     
==========================================
  Files         489      489              
  Lines       47679    47676       -3     
==========================================
- Hits        45399    45395       -4     
- Misses       2280     2281       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@facebook-github-bot
Copy link
Contributor

This pull request has been merged in 20507df.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity. fb-exported Merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants