Various documentation updates #157
Conversation
Created a RST file for the Inverse Kinematics tutorial and fixed some typos in the text.
|
The LaTex script does not work properly as in the other RST-files, too. It may have something to do with this. |
Added a citation to the Pyramid topology to a paper that proposes the Delaunay triangulation as a method to obtain neighbors. http://pubs.cs.uct.ac.za/archive/00000477/01/ParticleSwarm.pdf
Changed the subject line of the docstrings to a commanding style, similar to PEP257. Fixed some typos.
Simplified some docstrings with the http://www.hemingwayapp.com/ . The minimal Readability level in important places is now "Grade 9".
whzup
changed the title
pyswarms/backend/topology/pyramid.py
Outdated
| This uses the Delaunay method from :code:`scipy` to triangulate N-dimensional space | ||
| with simplices consisting of swarm particles [SIS2008] | ||
| This topology uses the Delaunay method from :code:`scipy`. This method is used to triangulate | ||
| N-dimensional space into simplices. The vertecies of the simplicies consist of swarm particles. [SIS2008] |
Fixed a typo in the Pyramid class
Reference: #129 Added a new topology with random neighbors. Added documentation and a test file for it and reworked the documentation of the GeneralOptimizer class to incorporate all available topologies. Simplified the fixture function for the GeneralOptimizer class. Cited the relevant paper for the algorithm implemented. Updated the documentation of the Random class. Especially the __compute_neighbor() method. Added the comments inside the method to the docstring and deleted irrelevant comments. Changed the nested for-loops to one loop with the itertools library. Added a new test for the return value of the __compute_neighbor() method, which checks the shape and the symmetry. Added a new test for the return value of the __compute_neighbors() method, which compares the returned matrix with a preset comparison matrix using a seed. Signed-off-by: Lester James V. Miranda <[email protected]> Committed-by: @whzup
Moved the basic optimization with arguments jupyter notebook into the basic optimization jupyter notebook. Added the RST file as well.
Added notes on large boundaries and overflow errors. See also: #152
|
Since we have a lot of conflicting files, I suggest that we merge this at the very end 🙈. |
|
Yup, don’t worry! |
|
And now we're down to this haha! Let me try this next week, might need a lot of work. The pyup bot also made a lot of PRs and some of them are failing (I wonder why, afaik it's because of a broken dependency in pyyaml), I'll merge all of them into development then to master then we'll draft the release notes by august 👍 As long as the "Resolve conflicts" button remains clickable, then that means our merge conflicts remain manageable haha |
| .. note:: | ||
| Please keep in mind that Python has a biggest float number. | ||
| So using large boundaries in combination with exponentiation or | ||
| multiplication can lead to an :code:`OverflowError`. |
|
I tried resolving some merge conflicts and it passed our CI. Would you mind double-checking on your end, @whzup ? If this is all good, we can merge now and make a PR for the development branch (and v.0.3.0 preparation). I'll be squashing all commits here into one (all about documentation etc.) |
|
Looking good to me 👍 Wasn't sure about the topology parametrization in the GeneralOptimizer tests because the dynamic variants are not tested. But TBH, they have the same velocity methods as the static versions so we would just run the same test twice 😄 I think we can merge it 💯 |
Created an RST file for the Inverse Kinematics tutorial and fixed some typos in the text.
Added citation in the Pyramid class.
Changed the subject line of doc strings to a commanding style.
Simplified the doc strings using the http://www.hemingwayapp.com/.
See also: #154