Welcome to maopy, the multi_agent_optimization module. The module contains several distributed optimization algorithms and distributed averaging (consensus) algorithms:
- Subgradient Push (optimization)
- Extra Push (optimization)
- Push DIGing (optimization)
- Push Sum Averaging (consensus)
- Asynchronous Subgradient Push (optimization)
Examples (demos) of each algorithm are provided in the main method at the bottom of each respective class. To run any of the demos, depending on your MPI distribution, execute one of the following command line instructions from the directory containing the maopy module,
mpirun -np $(num_processes) python -m maopy.$(algorithm_name)or
mpiexec -n $(num_processes) python -m maopy.$(algorithm_name)For example, to run the push-sum consensus demo in the push_sum_gossip_averaging file over a 5-agent network (with architecture specified in the demo), one would type
mpiexec -n 5 python -m maopy.push_sum_gossip_averagingNotice that we did not include the file suffix ('.py') in the command, since the path is already defined relative to the module.
To get started, install the message passing library mpi4py,
conda install -c anaconda mpi4pyNow just clone this repo and you're good to go!