Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 3.37 KB

index.rst

File metadata and controls

91 lines (66 loc) · 3.37 KB

PySwarms Logo

Welcome to PySwarms's documentation!

PyPI Version Build Status Documentation Status License Citation

PySwarms is an extensible research toolkit for particle swarm optimization (PSO) in Python.

It is intended for swarm intelligence researchers, practitioners, and students who prefer a high-level declarative interface for implementing PSO in their problems. PySwarms enables basic optimization with PSO and interaction with swarm optimizations. Check out more features below!

Launching pad

  • If you don't know what Particle Swarm Optimization is, read up this short Introduction! Then, if you plan to use PySwarms in your project, check the Installation guide and use-case examples.
  • 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!).
.. toctree::
   :maxdepth: 2
   :caption: General

   intro
   features
   installation
   authors
   history

.. toctree::
   :maxdepth: 2
   :caption: Examples

   tutorials
   usecases

.. toctree::
   :maxdepth: 2
   :caption: Developer's Guide

   contributing
   dev.api
   dev.loop
   dev.optimizer

.. toctree::
   :caption: API Documentation

   api/_pyswarms.backend
   api/_pyswarms.base.classes
   api/_pyswarms.optimizers
   api/_pyswarms.utils

Indices and tables