GPTSwarm

<p align="left"> <a href=""><img src="swarm/utils/assets/logo.png" alt="GPTSwarm" width="430px"></a> </p>

🐝 GPTSwarm is a graph-based framework for LLM-based agents, providing two high-level features:

• It lets you build LLM-based agents from graphs.
• It enables the customized and automatic self-organization of agent swarms with self-improvement capabilities.

About GPTSwarm

<img src="assets/gpt_swarm.png" alt="Framework" width="799">

At a granular level, GPTSwarm is a library that includes the following components:

| Module | Description | | ---- | --- | | swarm.environment | Domain-specific operations, agents, tools, and tasks | | swarm.graph | Graph-related functions for creating and executing agent graphs and swarm composite graphs | | swarm.llm | Interface for selecting LLM backends and calculating their operational costs | | swarm.memory | Index-based memory | | swarm.optimizer | Optimization algorithms designed to enhance agent performance and overall swarm efficiency |

Visualizations of the graphs

<img src="assets/swarm_vis.png" alt="Edge optimization" width="800">

News

• 😎 [10/12] Respect 🐝 OpenAI's Swarm, but 🐝 GPTSwarm is the better option if consider the 🐝Swarm Intelligence🐝.

• 🔥 [08/07] Mingchen attended an invited seminar with Shanghai AI Lab.

• 🔥 [07/25] Louis and Francesco gave the oral presentation in ICML 2024.

• 🔥 [07/17] Mingchen introduced GPTSwarm to Meta.

• 🔥 [07/05] Mingchen gave an invited talk to WAIC.

• 🔥 [06/21] Mingchen gave an invited talk to IA-CAS.

• 🔥 [06/20] Dmitrii gave an invited talk to Sberbank.

• 🔥 [06/03] SDAIA invited GPTSwarm team (Wenyi, Francesco, Dmitrii) for a 5 hour seminar.

• 🔥 [06/02] GPTSwarm has been selected as Oral Presentation (top 1.5%, 144 in 9,473) by ICML2024! Congratulation!

• 🔥 [05/01] GPTSwarm has been accepted by ICML2024.

• 🔥 [04/18] Mingchen gave the invited talk to ByteDance.

• 🔥 [03/20] Mingchen gave the invited talk to HUAWEI.

• 🔥 [03/13] MITTR China Exclusive Interview with Mingchen.

• 🔥 [03/01] GPTSwarm can be installed via pip now: pip install gptswarm

• 🔥 [02/27] Our academic paper: Language Agents as Optimizable Graphs is released.

Edge optimization example

Here is the edge optimization process that updates edge probabilities toward improvement of the benchmark score. Notice that within an agent, the edges are fixed, whereas the inter-agent connections are getting optimized towards either edge pruning (value 0, blue) or creation (value 1, red).

<img src="assets/edge_opt.gif" alt="Edge optimization" width="300">

Quickstart

Clone the repo

git clone https://github.com/metauto-ai/GPTSwarm.git
cd GPTSwarm/

Install packages

conda create -n swarm python=3.10
conda activate swarm
pip install poetry
poetry install

You should add API keys in .env.template and change its name to .env

OPENAI_API_KEY="" # for OpenAI LLM backend
BING_API_KEY="" # for Bing Web Search
GOOGLE_API_KEY="" # for Google Web Search
SEARCHAPI_API_KEY="" # for SearchAPI  Web Search

Selecting the Search Engine

The system will automatically select the appropriate search engine based on the following priority:

• Bing API: If BING_API_KEY is provided
• Search API: If SEARCHAPI_API_KEY is provided
• Google API: If GOOGLE_API_KEY is provided

Getting started with GPTSwarm is easy. Quickly run a predefined swarm

from swarm.graph.swarm import Swarm

swarm = Swarm(["IO", "IO", "IO"], "gaia")
task = "What is the capital of Jordan?"
inputs = {"task": task}
answer = await swarm.arun(inputs)

or make use of tools, such as the file analyzer

from swarm.graph.swarm import Swarm
swarm = Swarm(["IO", "TOT"], "gaia")
task = "Tell me more about this image and summarize it in 3 sentences."
files = ["./datasets/demos/js.png"]
inputs = {"task": task, "files": files}
danswer = swarm.run(inputs)

Check out the minimal Swarm example in Colab here: .

See how to create a custom Agent and run a Swarm with it here: .

Here is a Youtube video on how to run the demo notebooks:

<img src="assets/youtube_preview.png" width="75%">

🔥🔥🔥 See our experiments for more advanced use of our framework.

Class diagram

<img src="assets/class_diagram.png" alt="Edge optimization" width="700">

Example of the Swarm

<img src="assets/swarm_v3.png" alt="Edge optimization" width="500">

Running with a local LLM

We support local LM inference via LM Studio. Download their desktop app for Mac or Windows, choose a model from the Huggingface repository and start the server. Use model_name='lmstudio' in GPTSwarm code to run with the local LLM.

<img src="assets/lm_studio.png" alt="Edge optimization" width="800">

Contributors

<a href="https://github.com/metauto-ai/gptswarm/graphs/contributors"> <img src="https://contrib.rocks/image?repo=metauto-ai/gptswarm&max=200" /> </a>

• Mingchen Zhuge (PhD Student@KAUST; Project Initiator)
• Wenyi Wang (PhD Student @ KAUST; Initial Participant)
• Dmitrii Khizbullin (Research Engineer Lead @ KAUST; Project Engineer Lead)
• Louis Kirsch (PhD Student @ IDSIA)
• Francesco Faccio (PostDoc@IDSIA; Visiting Researcher@KAUST)
• Jürgen Schmidhuber (Director @ KAUST AI Initiative; Scientific Director @ IDSIA)
• William FH (Engineering @ LangChain)
• Lukas Vierling (BS Student @ RWTH & HKUST)
• Sandro Hanea (Senior SDE @ Microsoft)

Please read our developer document if you are interested in contributing.

Citation

Please cite our paper if you find the library useful or interesting.

@inproceedings{zhugegptswarm,
  title={GPTSwarm: Language Agents as Optimizable Graphs},
  author={Zhuge, Mingchen and Wang, Wenyi and Kirsch, Louis and Faccio, Francesco and Khizbullin, Dmitrii and Schmidhuber, J{\"u}rgen},
  booktitle={Forty-first International Conference on Machine Learning}
}