diff --git a/docs/api/_pyswarms.utils.rst b/docs/api/_pyswarms.utils.rst index 0bd75a0c..a7e81225 100644 --- a/docs/api/_pyswarms.utils.rst +++ b/docs/api/_pyswarms.utils.rst @@ -1,11 +1,13 @@ Utilities ========= -This includes various utilities to help in optimization. In the future, -parameter search and plotting techniques will be incoroporated in this -module. +This includes various utilities to help in optimization. Some utilities +include benchmark objective functions, hyperparameter search, and plotting +functionalities. .. toctree:: pyswarms.utils.functions pyswarms.utils.search + pyswarms.utils.plotters + pyswarms.utils.environments diff --git a/docs/api/pyswarms.utils.environments.rst b/docs/api/pyswarms.utils.environments.rst new file mode 100644 index 00000000..907e20b4 --- /dev/null +++ b/docs/api/pyswarms.utils.environments.rst @@ -0,0 +1,17 @@ +pyswarms.utils.environments package +==================================== + +.. automodule:: pyswarms.utils.environments + +.. deprecated:: 0.2.1 + This module will be deprecated in the next release. Please use + :mod:`pyswarms.utils.plotters` instead. + +pyswarms.utils.environments.plot_environment module +---------------------------------------------------- + +.. automodule:: pyswarms.utils.environments.plot_environment + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ \ No newline at end of file diff --git a/docs/api/pyswarms.utils.plotters.rst b/docs/api/pyswarms.utils.plotters.rst new file mode 100644 index 00000000..a95795d3 --- /dev/null +++ b/docs/api/pyswarms.utils.plotters.rst @@ -0,0 +1,20 @@ +pyswarms.utils.plotters package +================================ + +.. automodule:: pyswarms.utils.plotters + +pyswarms.utils.plotters.plotters module +---------------------------------------- + +.. automodule:: pyswarms.utils.plotters.plotters + :members: + :undoc-members: + :show-inheritance: + +pyswarms.utils.plotters.formatters module +------------------------------------------ + +.. automodule:: pyswarms.utils.plotters.formatters + :members: + :undoc-members: + :show-inheritance: \ No newline at end of file diff --git a/pyswarms/utils/environments/plot_environment.py b/pyswarms/utils/environments/plot_environment.py index 9606d91d..23024530 100644 --- a/pyswarms/utils/environments/plot_environment.py +++ b/pyswarms/utils/environments/plot_environment.py @@ -3,6 +3,10 @@ r""" Plot environment for Optimizer Analysis +.. deprecated:: 0.2.1 + This module will be deprecated in the next release. Please use + :mod:`pyswarms.utils.plotters` instead. + The class PlotEnvironment is built on top of :code:`matplotlib` in order to render quick and easy plots for your optimizer. It can plot the best cost for each iteration, and show animations of the particles in 2-D and