diff --git a/HISTORY.rst b/HISTORY.rst index 8ddcf4a9..3fb7cfad 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -6,7 +6,7 @@ History ------------------ * First release on PyPI. -* Includes primary optimization techniques such as global-best PSO and local-best PSO - `#1`_, `#3`_ +* **NEW:** Includes primary optimization techniques such as global-best PSO and local-best PSO - `#1`_, `#3`_ .. _#1: https://github.com/ljvmiranda921/pyswarms/issues/1 .. _#3: https://github.com/ljvmiranda921/pyswarmsissues/3 @@ -14,8 +14,8 @@ History 0.1.1 (2017-07-25) ~~~~~~~~~~~~~~~~~~ -* Patch on LocalBestPSO implementation. It seems that it's not returning the best value of the neighbors, this fixes the problem . -* **New feature:** Test functions for single-objective problems - `#6`_, `#10`_, `#14`_. Contributed by `@Carl-K `_. Thank you! +* **FIX:** Patch on LocalBestPSO implementation. It seems that it's not returning the best value of the neighbors, this fixes the problem . +* **NEW:** Test functions for single-objective problems - `#6`_, `#10`_, `#14`_. Contributed by `@Carl-K `_. Thank you! .. _#6: https://github.com/ljvmiranda921/pyswarms/issues/6 .. _#10: https://github.com/ljvmiranda921/pyswarms/pull/10 @@ -24,9 +24,9 @@ History 0.1.2 (2017-08-02) ~~~~~~~~~~~~~~~~~~ -* **New feature:** Binary Particle Swarm Optimization - `#7`_, `#17`_ -* Patch on Ackley function return error - `#22`_ -* Improved documentation and unit tests - `#16`_ +* **NEW:** Binary Particle Swarm Optimization - `#7`_, `#17`_ +* **FIX:** Fix on Ackley function return error - `#22`_ +* **IMPROVED:** Documentation and unit tests - `#16`_ .. _#7: https://github.com/ljvmiranda921/pyswarms/issues/7 .. _#16: https://github.com/ljvmiranda921/pyswarms/issues/16 @@ -37,12 +37,12 @@ History 0.1.4 (2017-08-03) ~~~~~~~~~~~~~~~~~~ -* Added a patch to fix :code:`pip` installation +* **FIX:** Added a patch to fix :code:`pip` installation 0.1.5 (2017-08-11) ~~~~~~~~~~~~~~~~~~ -* **New feature:** easy graphics environment. This new plotting environment makes it easier to plot the costs and swarm movement in 2-d or 3-d planes - `#30`_, `#31`_ +* **NEW:** easy graphics environment. This new plotting environment makes it easier to plot the costs and swarm movement in 2-d or 3-d planes - `#30`_, `#31`_ .. _#30: https://github.com/ljvmiranda921/pyswarms/issues/30 .. _#31: https://github.com/ljvmiranda921/pyswarms/pull/31 @@ -50,9 +50,9 @@ History 0.1.6 (2017-09-24) ~~~~~~~~~~~~~~~~~~ -* **New feature:** Native GridSearch and RandomSearch implementations for finding the best hyperparameters in controlling swarm behaviour - `#4`_, `#20`_, `#25`_. Contributed by `@SioKCronin `_. Thanks a lot! -* Added tests for hyperparameter search techniques - `#27`_, `#28`_, `#40`_. Contributed by `@jazcap53 `_. Thank you so much! -* Updated structure of Base classes for higher extensibility +* **NEW:** Native GridSearch and RandomSearch implementations for finding the best hyperparameters in controlling swarm behaviour - `#4`_, `#20`_, `#25`_. Contributed by `@SioKCronin `_. Thanks a lot! +* **NEW:** Added tests for hyperparameter search techniques - `#27`_, `#28`_, `#40`_. Contributed by `@jazcap53 `_. Thank you so much! +* **IMPROVED:** Updated structure of Base classes for higher extensibility .. _#4: https://github.com/ljvmiranda921/pyswarms/issues/4 .. _#20: https://github.com/ljvmiranda921/pyswarms/pull/20 @@ -64,8 +64,8 @@ History 0.1.7 (2017-09-25) ~~~~~~~~~~~~~~~~~~ -* Fixed patch on :code:`local_best.py` and :code:`binary.py` - `#33`_, `#34`_. Thanks for the awesome fix, `@CPapadim `_! -* Git now ignores IPython notebook checkpoints +* **FIX:** Fixed patch on :code:`local_best.py` and :code:`binary.py` - `#33`_, `#34`_. Thanks for the awesome fix, `@CPapadim `_! +* **NEW:** Git now ignores IPython notebook checkpoints .. _#33: https://github.com/ljvmiranda921/pyswarms/issues/33 .. _#34: https://github.com/ljvmiranda921/pyswarms/pull/34 @@ -73,7 +73,7 @@ History 0.1.8 (2018-01-11) ~~~~~~~~~~~~~~~~~~ -* PySwarms is now published on the Journal of Open Source Software (JOSS)! You can check the review here_. In addition, you can also find our paper in this link_. Thanks a lot to `@kyleniemeyer `_ and `@stsievert `_ for the thoughtful reviews and comments. +* **NEW:** PySwarms is now published on the Journal of Open Source Software (JOSS)! You can check the review here_. In addition, you can also find our paper in this link_. Thanks a lot to `@kyleniemeyer `_ and `@stsievert `_ for the thoughtful reviews and comments. .. _here: https://github.com/openjournals/joss-reviews/issues/433 .. _link: http://joss.theoj.org/papers/235299884212b9223bce909631e3938b @@ -81,9 +81,9 @@ History 0.1.9 (2018-04-20) ~~~~~~~~~~~~~~~~~~ -* You can now set the initial position wherever you want - `#93`_ -* Quick-fix for the Rosenbrock function - `#98`_ -* Tolerance can now be set to break during iteration - `#100`_ +* **NEW:** You can now set the initial position wherever you want - `#93`_ +* **FIX:** Quick-fix for the Rosenbrock function - `#98`_ +* **NEW:** Tolerance can now be set to break during iteration - `#100`_ Thanks for all the wonderful Pull Requests, `@mamadyonline `_! @@ -95,9 +95,9 @@ Thanks for all the wonderful Pull Requests, `@mamadyonline `_! +* **FIX:** Fix sigmoid function in BinaryPSO - `#145`_. Thanks a lot `@ThomasCES `_! .. _#145: https://github.com/ljvmiranda921/pyswarms/pull/145 0.3.0 (2018-08-10) ------------------ -* New topologies: Pyramid, Random, and Von Neumann. More ways for your particles to interact! - `#176`_, `#177`_, `#155`_, `#142`_. Thanks a lot `@whzup `_! -* New GeneralOptimizer algorithm that allows you to switch-out topologies for your optimization needs - `#151`_. Thanks a lot `@whzup `_! -* All topologies now have a static attribute. Neigbors can now be set initially or computed dynamically - `#164`_. Thanks a lot `@whzup `_! -* New single-objective functions - `#168`_. Awesome work, `@jayspeidell `_! -* New tutorial on Inverse Kinematics using Particle Swarm Optimization - `#141`_. Thanks a lot `@whzup `_! -* New plotters module for visualization. The environment module is now deprecated - `#135`_ -* Keyword arguments can now be passed in the :code:`optimize()` method for your custom objective functions - `#144`_. Great job, `@bradahoward `_ +* **NEW:** New topologies: Pyramid, Random, and Von Neumann. More ways for your particles to interact! - `#176`_, `#177`_, `#155`_, `#142`_. Thanks a lot `@whzup `_! +* **NEW:** New GeneralOptimizer algorithm that allows you to switch-out topologies for your optimization needs - `#151`_. Thanks a lot `@whzup `_! +* **NEW:** All topologies now have a static attribute. Neigbors can now be set initially or computed dynamically - `#164`_. Thanks a lot `@whzup `_! +* **NEW:** New single-objective functions - `#168`_. Awesome work, `@jayspeidell `_! +* **NEW:** New tutorial on Inverse Kinematics using Particle Swarm Optimization - `#141`_. Thanks a lot `@whzup `_! +* **NEW:** New plotters module for visualization. The environment module is now deprecated - `#135`_ +* **IMPROVED:** Keyword arguments can now be passed in the :code:`optimize()` method for your custom objective functions - `#144`_. Great job, `@bradahoward `_ .. _#135: https://github.com/ljvmiranda921/pyswarms/pull/135 .. _#141: https://github.com/ljvmiranda921/pyswarms/pull/141 @@ -138,12 +138,35 @@ Thanks for all the wonderful Pull Requests, `@mamadyonline `_! -* Add configuration file for pyup.io - `#210`_ -* Fix incomplete documentation in ReadTheDocs - `#208`_ -* Update dependencies via pyup - `#204`_ +* **NEW:** New collaboration tool using Vagrantfiles - `#193`_. Thanks a lot `@jdbohrman `_! +* **NEW:** Add configuration file for pyup.io - `#210`_ +* **FIX:** Fix incomplete documentation in ReadTheDocs - `#208`_ +* **IMPROVED:** Update dependencies via pyup - `#204`_ .. _#193: https://github.com/ljvmiranda921/pyswarms/pull/193 .. _#204: https://github.com/ljvmiranda921/pyswarms/pull/204 .. _#208: https://github.com/ljvmiranda921/pyswarms/pull/208 -.. _#210: https://github.com/ljvmiranda921/pyswarms/pull/210 \ No newline at end of file +.. _#210: https://github.com/ljvmiranda921/pyswarms/pull/210 + +0.4.0 (2019-01-29) +------------------ + +* **NEW:** The console output is now generated by the :code:`Reporter` module - `#227`_ +* **NEW:** A :code:`@cost` decorator which automatically scales to the whole swarm - `#226`_ +* **FIX:** A bug in the topologies where the best position in some topologies was not calculated using the nearest neighbours - `#253`_ +* **FIX:** Swarm init positions - `#249`_ Thanks `@dfhljf`_! +* **IMPROVED:** Better naming for the benchmark functions - `#222`_ Thanks `@nik1082`_! +* **IMPROVED:** Error handling in the :code:`Optimizers` - `#232`_ +* **IMPROVED:** New management method for dependencies - `#263`_ +* **DEPRECATED:** The `environments` module is now deprecated - `#217`_ + +.. _#217: https://github.com/ljvmiranda921/pyswarms/pull/217 +.. _#222: https://github.com/ljvmiranda921/pyswarms/pull/222 +.. _#226: https://github.com/ljvmiranda921/pyswarms/pull/226 +.. _#227: https://github.com/ljvmiranda921/pyswarms/pull/227 +.. _#232: https://github.com/ljvmiranda921/pyswarms/pull/232 +.. _#249: https://github.com/ljvmiranda921/pyswarms/pull/249 +.. _#253: https://github.com/ljvmiranda921/pyswarms/pull/253 +.. _#263: https://github.com/ljvmiranda921/pyswarms/pull/263 +.. _@nik1082: https://github.com/nik1082 +.. _@dfhljf: https://github.com/dfhljf