Updated Introduction (#16)

ljvmiranda921 · Jul 30, 2017 · e0db74f · e0db74f
1 parent a39f117
commit e0db74f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,7 +23,7 @@ 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 <https://pyswarms.readthedocs.io/en/latest/installation.html>`_ and the `use-case examples <https://pyswarms.readthedocs.io/en/latest/examples/usecases.html>`_ in this documentation.
+* If you don't know what Particle Swarm Optimization is, read up this short `Introduction <http://pyswarms.readthedocs.io/en/latest/intro.html>`_! Then, if you plan to use PySwarms in your project, check the `Installation guide <https://pyswarms.readthedocs.io/en/latest/installation.html>`_ and the `use-case examples <https://pyswarms.readthedocs.io/en/latest/examples/usecases.html>`_ 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 <https://pyswarms.readthedocs.io/en/latest/contributing.html>`_ page to see how to implement your optimizer using the current base classes in the library.
 

diff --git a/docs/intro.rst b/docs/intro.rst
@@ -29,8 +29,6 @@ at the same time maximize the group's reward. This is the basics of
 Particle Swarm Optimization (PSO). The group is called the *swarm*,
 you are a *particle*, and the treasure is the *global optimum* [CI2007]_.
 
-.. [CI2007] A. Engelbrecht, "An Introduction to Computational Intelligence," John Wiley & Sons, 2007.
-
 
 Particle Swarm Optimization (PSO)
 ---------------------------------
@@ -45,9 +43,6 @@ of the function, thus, objective functions need not to be differentiable.
 Moreover, the basic PSO is astonishingly simple. And adding variants to
 the original implementation can help it adapt to more complicated problems.
 
-.. [IJCNN1995] J. Kennedy and R.C. Eberhart, "Particle Swarm Optimization," Proceedings of the IEEE International Joint Conference on Neural Networks, 1995, pp. 1942-1948.
-.. [ICEC2008] Y. Shi and R.C. Eberhart, "A modified particle swarm optimizer," Proceedings of the IEEE International Conference on Evolutionary Computation, 1998, pp. 69-73.
-
 Why make PySwarms?
 ------------------
 
@@ -61,4 +56,11 @@ When I revisited my course project, I realized that PSO, given enough
 variations, can be used to solve a lot of problems: from simple optimization, 
 to robotics, and to job-shop scheduling. I then decided to build a
 research toolkit that can be extended by the community (us!) and be used
-by anyone.
+by anyone.
+
+References
+----------
+
+.. [CI2007] A. Engelbrecht, "An Introduction to Computational Intelligence," John Wiley & Sons, 2007.
+.. [IJCNN1995] J. Kennedy and R.C. Eberhart, "Particle Swarm Optimization," Proceedings of the IEEE International Joint Conference on Neural Networks, 1995, pp. 1942-1948.
+.. [ICEC2008] Y. Shi and R.C. Eberhart, "A modified particle swarm optimizer," Proceedings of the IEEE International Conference on Evolutionary Computation, 1998, pp. 69-73.