Repository navigation
docs(mutation): document BitflipMutation parameter hierarchy and compound probability pitfall - #813
Open
CoferSamuel wants to merge 2 commits into
Open
CoferSamuel wants to merge 2 commits into
CoferSamuel wants to merge 2 commits into
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The documentation mishandles one-bit chromosomes, and the new test is nondeterministic.
2 open findings
What changed in this PR
Documents BitflipMutation probability semantics and adds a regression test for the default flip rate.
Changes:
- Explains chromosome- and gene-level probabilities.
- Warns against compounded mutation probabilities.
- Tests expected flips per chromosome.
| File | Description |
|---|---|
pymoo/operators/mutation/bitflip.py |
Adds detailed API documentation and examples. |
tests/operators/test_mutation.py |
Adds a statistical expectation test. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…cal test for CI determinism
This branch has not been deployed
This file contains hidden or 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
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
Currently,
BitflipMutationlacks a dedicated class docstring and simply inherits the baseMutationdocstring.Because$p_m$ universally denotes the per-bit flip probability $1/n$ ) frequently write:
Mutation.__init__definesprob(the chromosome-level probability) as the first positional parameter andprob_var(the locus-level probability) as the second, researchers accustomed to canonical genetic algorithm literature (where mutation rate