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

DOC: Optimize: update DE documentation #17495

Merged
merged 5 commits into from Aug 26, 2023
Merged

Conversation

mkiffer
Copy link
Contributor

@mkiffer mkiffer commented Nov 27, 2022

Reference issue

Closes #17398

What does this implement/fix?

Additional information

Documentation has been added regarding the use of evolution strategies.

I believe this update may need some assistance. I was not able to check my documentation fits the style requirements. I will submit this pull request and welcome any and all feedback.
I used the paper as posted by @andyfaff which had some fantastic information. However I am not totally clear on the differences between binomial and exponential implementation of DE optimisation.

@mkiffer mkiffer marked this pull request as draft November 27, 2022 09:10
@j-bowhay j-bowhay added scipy.optimize Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Nov 27, 2022


where the integers :math:`r1, r2, r3, r4 and r5` are chosen randomly
from the interval [1, NP] and are different from the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NP is defined a couple lines below. I think it's worth defining what NP is around about L80.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not totally sure of the definition of NP.

Is it popsize*N as described in L80 or is it just the size of our target vector b'?

scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
scipy/optimize/_differentialevolution.py Outdated Show resolved Hide resolved
@mkiffer
Copy link
Contributor Author

mkiffer commented Nov 30, 2022

@andyfaff thanks for feedback will update these things now. will update PR when complete.

@mkiffer mkiffer marked this pull request as ready for review March 6, 2023 04:57
@j-bowhay j-bowhay changed the title update optimize.DE documentation Doc: Optimize: update DE documentation Mar 23, 2023
@j-bowhay j-bowhay changed the title Doc: Optimize: update DE documentation DOC: Optimize: update DE documentation Mar 24, 2023
@andyfaff
Copy link
Contributor

The docs seem to render ok. I removed extra text from @mkiffer original commit because it was identical to text from a journal article, which would be under copyright.

@andyfaff andyfaff merged commit e3cbfac into scipy:main Aug 26, 2023
5 checks passed
@j-bowhay j-bowhay added this to the 1.12.0 milestone Aug 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Documentation for scipy.optimize.differential_evolution is incomplete, reference link is broken
3 participants