
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
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
SwarmOptimizer.__init__()
SwarmOptimizer.n_particles
SwarmOptimizer.dimensions
SwarmOptimizer.options
SwarmOptimizer.bounds
SwarmOptimizer.velocity_clamp
SwarmOptimizer.center
SwarmOptimizer.ftol
SwarmOptimizer.ftol_iter
SwarmOptimizer._abc_impl
SwarmOptimizer._populate_history()
SwarmOptimizer.optimize()
SwarmOptimizer.reset()
DiscreteSwarmOptimizer
DiscreteSwarmOptimizer.__init__()
DiscreteSwarmOptimizer.n_particles
DiscreteSwarmOptimizer.dimensions
DiscreteSwarmOptimizer.binary
DiscreteSwarmOptimizer.options
DiscreteSwarmOptimizer.velocity_clamp
DiscreteSwarmOptimizer.ftol
DiscreteSwarmOptimizer.ftol_iter
DiscreteSwarmOptimizer.options
DiscreteSwarmOptimizer._abc_impl
DiscreteSwarmOptimizer._populate_history()
DiscreteSwarmOptimizer.optimize()
DiscreteSwarmOptimizer.reset()
- pyswarms.base module
- pyswarms.base package
- Optimizers
- pyswarms.single package
- pyswarms.single.global_best module
GlobalBestPSO
GlobalBestPSO.__init__()
GlobalBestPSO.n_particles
GlobalBestPSO.dimensions
GlobalBestPSO.options
GlobalBestPSO.bounds
GlobalBestPSO.oh_strategy
GlobalBestPSO.bh_strategy
GlobalBestPSO.velocity_clamp
GlobalBestPSO.vh_strategy
GlobalBestPSO.center
GlobalBestPSO.ftol
GlobalBestPSO.ftol_iter
GlobalBestPSO.init_pos
GlobalBestPSO.optimize()
- pyswarms.single.local_best module
LocalBestPSO
LocalBestPSO.__init__()
LocalBestPSO.n_particles
LocalBestPSO.dimensions
LocalBestPSO.bounds
LocalBestPSO.oh_strategy
LocalBestPSO.bh_strategy
LocalBestPSO.velocity_clamp
LocalBestPSO.vh_strategy
LocalBestPSO.center
LocalBestPSO.ftol
LocalBestPSO.ftol_iter
LocalBestPSO.options
LocalBestPSO.init_pos
LocalBestPSO.static
LocalBestPSO._abc_impl
LocalBestPSO.optimize()
- 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.single.global_best module
- 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