Welcome to PySwarms’s documentation!
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!
Free software: MIT license
Github repository: https://github.com/ljvmiranda921/pyswarms
Python versions: 3.5, 3.6, and 3.7
Chat with us: https://gitter.im/pyswarms/Issues
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!).
General
Examples
Developer's Guide
API Documentation
- Backend
- pyswarms.backend package
- pyswarms.handlers package
- pyswarms.topology package
- pyswarms.swarms package
- Base Classes
- pyswarms.base package
- pyswarms.base module
SwarmOptimizer
DiscreteSwarmOptimizer
- pyswarms.base module
- pyswarms.base package
- Optimizers
- pyswarms.single package
- pyswarms.single.global_best module
- pyswarms.single.local_best module
- pyswarms.single.general_optimizer module
GeneralOptimizerPSO
GeneralOptimizerPSO.__init__()
GeneralOptimizerPSO.n_particles
GeneralOptimizerPSO.dimensions
GeneralOptimizerPSO.options
GeneralOptimizerPSO.topology
GeneralOptimizerPSO.bounds
GeneralOptimizerPSO.oh_strategy
GeneralOptimizerPSO.bh_strategy
GeneralOptimizerPSO.velocity_clamp
GeneralOptimizerPSO.vh_strategy
GeneralOptimizerPSO.center
GeneralOptimizerPSO.ftol
GeneralOptimizerPSO.ftol_iter
GeneralOptimizerPSO.init_pos
GeneralOptimizerPSO._abc_impl
GeneralOptimizerPSO.optimize()
- pyswarms.discrete package
- pyswarms.single package
- Utilities
- pyswarms.utils.decorators package
- pyswarms.utils.functions package
- pyswarms.utils.plotters package
- pyswarms.utils.reporter package
- pyswarms.utils.search package