Skip to content

Conversation

@swryan
Copy link
Owner

@swryan swryan commented May 31, 2024

Summary

This is the first of several implementation changes in support of POEM 094.

Users were finding the fact that run_driver returned True if something had failed to be confusing.

To address this, a new DriverResult object has been added, containing the information previously stored in driver.opt_result.
This DriverResult object exists for all drivers, including non-optimization ones, so it is now stored in Driver.result.
Previously, ScipyOptimizeDriver stored scipy's OptimizeResult object as driver.result, but this is now changed to scipy_optimize_result.

DOEDriver now successfully populates the attributes of DriverResult.
Hooks have been added, though not yet implemented, to allow drivers to add driver/optimizer-specific attributes to the DriverResults object.

DriverResult currently overrides __bool__ with a deprecation warning to retain existing behavior.

Related Issues

Backwards incompatibilities

ScipyOptimizeDriver.result is now a DriverResults object. Scipy-specific OptimizeResult objects are now stored in ScipyOptimizeDriver._scipy_optimize_result, though some of this information will be added to the DriverResult object.

New Dependencies

None

@swryan swryan closed this May 31, 2024
@swryan swryan reopened this May 31, 2024
@swryan swryan closed this May 31, 2024
@swryan swryan reopened this May 31, 2024
@coveralls
Copy link

coveralls commented May 31, 2024

Coverage Status

coverage: 87.196%. first build
when pulling 83bb310 on poem_integ
into 91f809e on master.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions
Copy link

This pull request will transition POEM_094 to Integrated

@swryan swryan merged commit 332aed3 into master Jun 10, 2024
@swryan swryan deleted the poem_integ branch September 26, 2024 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

POEM 094 Part I: DriverResults

6 participants