search

anyoptimization / pymoo

NSGA2, NSGA3, R-NSGA3, MOEAD, Genetic Algorithms (GA), Differential Evolution (DE), CMAES, PSO
https://pymoo.org
Apache License 2.0
2.23k stars 381 forks source link

Added documentation for two core modules #584

Closed rzshrote closed 5 months ago

rzshrote commented 5 months ago

Hi Julian & the PyMOO community,

I have added module, class, and function type hints and documentation for two of the core modules in PyMOO. Hopefully this is helpful for the package, its developers, and its users.

Additionally, I have added some minor features to the two modules. They include:

  1. Inclusion of an __all__ variable to specify what objects are to be imported from a wildcard statement: from pymoo.core.<module> import *
  2. Addition of a deprecation warning when calling Individual.feasible.
blankjul commented 5 months ago

Thanks for the effort improving the code documentation!