RepoOpenBMB (MiniCPM)OpenBMB (MiniCPM)published May 6, 2023seen 5d

OpenBMB/AgentVerse

JavaScript

Open original ↗

Captured source

source ↗
GH
GitHub/github.com/OpenBMB/AgentVerse
OpenBMB/AgentVerse repository metadata
Source ↗
published May 6, 2023seen 5dcaptured 9hhttp 200method plain

OpenBMB/AgentVerse

Description: 🤖 AgentVerse 🪐 is designed to facilitate the deployment of multiple LLM-based agents in various applications, which primarily provides two frameworks: task-solving and simulation

Language: JavaScript

License: Apache-2.0

Stars: 5052

Forks: 514

Open issues: 35

Created: 2023-05-06T01:43:19Z

Pushed: 2024-09-09T05:47:44Z

Default branch: main

Fork: no

Archived: no

README: 🤖 AgentVerse 🪐

【Paper】

【English | Chinese】

AgentVerse is designed to facilitate the deployment of multiple LLM-based agents in various applications. AgentVerse primarily provides two frameworks: task-solving and simulation.

Applications: software development system, consulting system, etc.

  • Simulation: This framework allows users to set up custom environments to observe behaviors among, or interact with, multiple agents. ⚠️⚠️⚠️ We're refactoring the code. If you require a stable version that exclusively supports simulation framework, you can use `release-0.1` branch. Applications: game, social behavior research of LLM-based agents, etc.

---

📰 What's New

  • [2024/1/17] We're super excited to announce that our paper got accepted at ICLR 2024. More updates will be coming soon!
  • [2023/10/17] We're super excited to share our open-source AI community hugging face: `AgentVerse`. You are able to try out the two simulation applications, NLP Classroom and Prisoner's Dilemma,with your code of the openai API key and the openai organization. Have fun!
  • [2023/10/5] Re-factor our codebase to enable the deployment of both simulation and task-solving framework! We have placed the code for Minecraft example in the paper at the `minecraft` branch. Our tool-using example will soon be updated to the main branch. Stay tuned!

in detail of AgentVerse.

  • [2023/6/5] We are thrilled to present an array of [demos](#-simple-demo-video), including [NLP Classroom](#nlp-classroom), [Prisoner Dilemma](#prisoner-dilemma), [Software Design](#software-design), [Database Administrator](#database-administrator-dba), and a simple [H5 Pokemon Game](#pokemon) that enables the interaction with the characters in Pokemon! Try out these demos and have fun!
  • [2023/5/1] 🚀 AgentVerse is officially launched!

🗓 Coming Soon

  • [x] Code release of our paper
  • [x] Add support for local LLM (LLaMA, Vicunna, etc.)
  • [ ] Add documentation
  • [ ] Support more sophisticated memory for conversation history

Contents

  • [📰 What's New](#-whats-new)
  • [🗓 Coming Soon](#-coming-soon)
  • [Contents](#contents)
  • [🚀 Getting Started](#-getting-started)
  • [Installation](#installation)
  • [Environment Variables](#environment-variables)
  • [Simulation](#simulation)
  • [Framework Required Modules](#framework-required-modules)
  • [CLI Example](#cli-example)
  • [GUI Example](#gui-example)
  • [Task-Solving](#task-solving)
  • [Framework Required Modules](#framework-required-modules-1)
  • [CLI Example](#cli-example-1)
  • [Local Model Support](#local-model-support)
  • [vLLM Support](#vllm-support)
  • [FSChat Support](#fschat-support)
  • [1. Install the Additional Dependencies](#1-install-the-additional-dependencies)
  • [2. Launch the Local Server](#2-launch-the-local-server)
  • [3. Modify the Config File](#3-modify-the-config-file)
  • [AgentVerse Showcases](#agentverse-showcases)
  • [Simulation Showcases](#simulation-showcases)
  • [Task-Solving Showcases](#task-solving-showcases)
  • [🌟 Join Us!](#-join-us)
  • [Leaders](#leaders)
  • [Contributors](#contributors)
  • [How Can You Contribute?](#how-can-you-contribute)
  • [Social Media and Community](#social-media-and-community)
  • [Star History](#star-history)
  • [Citation](#citation)
  • [Contact](#contact)

🚀 Getting Started

Installation

Manually Install (Recommended!)

Make sure you have Python >= 3.9

git clone https://github.com/OpenBMB/AgentVerse.git --depth 1
cd AgentVerse
pip install -e .

If you want to use AgentVerse with local models such as LLaMA, you need to additionally install some other dependencies:

pip install -r requirements_local.txt

Install with pip

Or you can install through pip

pip install -U agentverse

Environment Variables

You need to export your OpenAI API key as follows：

# Export your OpenAI API key
export OPENAI_API_KEY="your_api_key_here"

If you want use Azure OpenAI services, please export your Azure OpenAI key and OpenAI API base as follows：

export AZURE_OPENAI_API_KEY="your_api_key_here"
export AZURE_OPENAI_API_BASE="your_api_base_here"

Simulation

Framework Required Modules

- agentverse
- agents
- simulation_agent
- environments
- simulation_env

CLI Example

You can create a multi-agent environments provided by us. Using the classroom scenario as an example. In this scenario, there are nine agents, one playing the role of a professor and the other eight as students.

agentverse-simulation --task simulation/nlp_classroom_9players

GUI Example

We also provide a local website demo for this environment. You can launch it with

agentverse-simulation-gui --task simulation/nlp_classroom_9players

After successfully launching the local server, you can visit http://127.0.0.1:7860/ to view the classroom environment.

If you want to run the simulation cases with tools (e.g., simulation/nlp_classroom_3players_withtool), you need to install BMTools as follows:

git clone git+https://github.com/OpenBMB/BMTools.git
cd BMTools
pip install -r requirements.txt
python setup.py develop

This is…

Excerpt shown — open the source for the full document.