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

BUG: Documentation for scipy.optimize.differential_evolution is incomplete, reference link is broken #17398

Closed
Dominik1123 opened this issue Nov 11, 2022 · 6 comments · Fixed by #17495
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution
Milestone

Comments

@Dominik1123
Copy link

Describe your issue.

The different possible choices for scipy.optimize.differential_evolution, parameter strategy, are not explained in the documentation. Currently, it lists 12 different values:

    strategy : str, optional
        The differential evolution strategy to use. Should be one of:
            - 'best1bin'
            - 'best1exp'
            - 'rand1exp'
            - 'randtobest1exp'
            - 'currenttobest1exp'
            - 'best2exp'
            - 'rand2exp'
            - 'randtobest1bin'
            - 'currenttobest1bin'
            - 'best2bin'
            - 'rand2bin'
            - 'rand1bin'
        The default is 'best1bin'.

Only one of them, the default, is explained in the doc string section Notes. There is reference [2] but the provided link is broken. Also reference [1] does not seem to contain details on what the different strategies mean.
Since this is a critical parameter of the function, it would be good if it is documented properly, so that users can make an informed choice.

Reproducing Code Example

This is a docs issue.

Error message

This is a docs issue.

SciPy/NumPy/Python version information

v1.9.3

@Dominik1123 Dominik1123 added the defect A clear bug or issue that prevents SciPy from being installed or used as expected label Nov 11, 2022
@j-bowhay j-bowhay added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution labels Nov 11, 2022
@andyfaff
Copy link
Contributor

Seems like ref 2 is stale. https://www.osti.gov/servlets/purl/1163659 also explains what the strategies represent. They give references within that article as well.
Can also reference that paper as "Qiang, JI. (2014). A Unified Differential Evolution Algorithm for Global Optimization. Lawrence Berkeley National Laboratory. Retrieved from https://escholarship.org/uc/item/41b84414"

@Femme-js
Copy link
Contributor

@tupui If this doc enhancement seems important, Can I pick this up?

@mdhaber
Copy link
Contributor

mdhaber commented Nov 13, 2022

@Femme-js a PR would be welcome.

@mkiffer
Copy link
Contributor

mkiffer commented Nov 25, 2022

I will try to work on this too.

@meaviral17
Copy link

Hi. This project is interesting. I will try to work on this too

@mkiffer
Copy link
Contributor

mkiffer commented Feb 17, 2023

Can you access the changes I have made? I just wasn’t able to format them correctly and haven’t had a chance to fix them :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants