Update dev-pyswarms documentation #124
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ljvmiranda921
force-pushed
the
add-dev-docs
branch
from
498b009 to
38bfe37
Compare
added 2 commits
June 10, 2018 13:23
In this commit, we'll use the Markdown file going forward. Turns out the PyPI is now more accommodating of .md files so we'll follow them from now on. In the same vein, we also updated the references found in the setup.py and MANIFEST.in of our module. In py34, there are some problems when we're not referencing properly in MANIFEST.in, and I wonder why. Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
In this commit, we do a documentation cleanup for the previous documentation. Specifically, we updated the following: - Better grammar on some sentences/paragraphs. - Clearer docstring in some old methods - Add PlotEnvironment docs (wonder why it's not been added before) - Overall cleaner code and organization Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
ljvmiranda921
force-pushed
the
add-dev-docs
branch
from
38bfe37 to
297cab7
Compare
added 7 commits
June 10, 2018 20:04
This commit adds a documentation for the backend module. I also updated some docstrings for clearer explanations Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
In this commit, we add an assets directory to contain all images for our documentation. The images were generated using the TiKz package in LaTeX. Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
Add some explanation about the PySwarms API and on how to use the backend module. Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
This commit updates the default parameters in create_swarm (options, by default, is now an empty dict), and in the update_velocity of the ring and star topologies (clamp, by default, is now None) Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
This commit should update all Jupyter notebook examples to the dev version. Hopefully everything is okay after this. This also adds a new notebook for demonstrating the custom optimization loop. Signed-off-by: Lester James V. Miranda <ljvmiranda@gmail.com>
ljvmiranda921
force-pushed
the
add-dev-docs
branch
from
8396272 to
6402be4
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.