Rename cuckoo search's --max-generations option to --iteration-number #24
Description
Description
The cuckoo search is the only algorithm whose amount of iterations is indicated by the --max-generations flag. All other algorithms use a flag --iteration-number to indicate that. Originally this naming was chosen to stick as close as possible to the paper's wording.
Pros
However, this causes that every algorithm must specify in its main.py its own option --iteration-number. Renaming the cuckoo search's option to --iteration-number enables us to move this option from an algorithm level to the top level of the CLI (swarm -i 15 wolves 12 instead of swarm wolves -i 15 12). In my opinion this is somewhat cleaner from a developer's point of view.
Cons
On the other hand, renaming the cuckoo search's option removes some of the algorithm's explanations and could make it less accessible to users. This is in contrast to swarmlib's overall goal: Making it easier to get into swarm optimization.
Summary
With this issue we want to discuss the trade-off of cleaner code vs. user accessibility.
Input and opinions from the community are heavily appreciated.