Fix doc typos in binary discrete optimizer module (pyswarms.discrete.binary) #409
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
Since 'm' wasn't defined anywhere, I assumed the inertia 'w' was actually meant here, similar to the formula for the real-valued algorithm
Archer6621
changed the title
…inaryPSO init The 'w' key was missing in the `options` dictionary, but was described below in the list (and is used in the code as well).
ljvmiranda921
approved these changes
Jun 16, 2020
There was a problem hiding this comment.
Oh wow thanks for catching this @Archer6621 ! Approved. Let me merge by tomorrow! 👍
|
@all-contributors please add @Archer6621 for documentation! |
|
I've put up a pull request to add @Archer6621! 🎉 |
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.
Description
Since
mwasn't defined anywhere, I assumed the inertiawwas actually meant here, similar to the formula for the real-valued algorithm. In addition to that, thewkey was also missing in documentation for the options dict keyword argument in the initialization ofBinaryPSO, fixed that as well.Related Issue
I guess #389 ?
Motivation and Context
This change improves the clarity of the documentation.
How Has This Been Tested?
Not applicable.
Screenshots (if appropriate):
Not applicable.
Types of changes
Checklist: