From ae86cab49d5613567186bd750803ba050bd08514 Mon Sep 17 00:00:00 2001 From: ljvmiranda921 Date: Sun, 30 Jul 2017 17:23:08 +0900 Subject: [PATCH] Fixed documentation --- docs/features.rst | 6 ++---- docs/index.rst | 11 +++-------- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/docs/features.rst b/docs/features.rst index 1db5c2c1..338f56f1 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -13,11 +13,9 @@ Continuous These optimizers are used on problems involving a continuous space (bounded or unbounded), and is optimized given a single objective function. -* :mod:`pyswarms.single.gb` - global-best Particle Swarm Optimization algorithm with a star-topology. Every -particle compares itself with the best-performing particle in the swarm. +* :mod:`pyswarms.single.gb` - global-best Particle Swarm Optimization algorithm with a star-topology. Every particle compares itself with the best-performing particle in the swarm. -* :mod:`pyswarms.single.lb` - local-best Particle Swarm Optimization algorithm with a ring-topology. Every -particle compares itself only with its nearest-neighbours as computed by a distance metric. +* :mod:`pyswarms.single.lb` - local-best Particle Swarm Optimization algorithm with a ring-topology. Every particle compares itself only with its nearest-neighbours as computed by a distance metric. Utilities diff --git a/docs/index.rst b/docs/index.rst index dcd491db..89bce351 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,16 +23,11 @@ PySwarms is a simple, Python-based, Particle Swarm Optimization (PSO) library. Launching pad ------------- -* If you want to use PySwarms in your project, check the `Installation guide `_ -and the `use-case examples `_ in this documentation. +* If you want to use PySwarms in your project, check the `Installation guide `_ and the `use-case examples `_ in this documentation. -* If you are a researcher in the field of swarm intelligence, and would like to include your technique in our list of optimizers, check our -`contributing `_ page to see how to implement your optimizer using the current base -classes in the library. +* If you are a researcher in the field of swarm intelligence, and would like to include your technique in our list of optimizers, check our `contributing `_ page to see how to implement your optimizer using the current base classes in the library. -* If you are an open-source contributor, and would like to help PySwarms grow, be sure to check our `Issues `_ page in Github, and see the open -issues with the tag `help-wanted `_. Moreover, we accommodate contributions from first-time contributors! Just check our -`first-timers-only `_ tag for open issues (Don't worry! We're happy to help you make your first PR!). +* If you are an open-source contributor, and would like to help PySwarms grow, be sure to check our `Issues `_ page in Github, and see the open issues with the tag `help-wanted `_. Moreover, we accommodate contributions from first-time contributors! Just check our `first-timers-only `_ tag for open issues (Don't worry! We're happy to help you make your first PR!). .. toctree::