Skip to main content

Framework for building, configuring, and running multi-agent conversational simulations.

Project description

Scenario Labs

Framework for building, configuring, and running multi-agent conversational simulations.

Examples

You can also find past chat logs in the logs directory.

Getting Started

Set the enviromental variable XAPI_API_KEY to your xAI API key.

git clone https://github.com/christopherwoodall/scenario-labs Labs.git
cd scenario-labs
pip install -e ".[developer]"

scenario-labs

You can also run simulations in parallel with the following command:

for i in {1..9}; do scenario-labs & done; wait

Configuration

You can configure the simulation by editing the starbound_config.yaml file. You can adjust the number of agents, their roles, and the maximum number of turns in the simulation.

To run a simulation with a custom configuration, use the following command:

scenario-labs --config configs/prison_config.yaml

Prompt Considerations

The most important part of the prompt is the call and response formatting. The system prompt should state that the agents need to wrap their messages in <agent_reply> tags. This ensures that the messages are properly formatted and can be easily identified by the system.

The following is a good way of achieving this:

All messages must begin with your character's name followed by a colon. For example: 
"Lily Chen: I hope you're having a great day!"

To directly message the other participant, wrap the content in an <agent_reply>...</agent_reply> tag. 
Inside the tag, write the character name, a colon, then the message. For example: 
"<agent_reply>Lily Chen: Have you ever tried crypto investing?</agent_reply>"

The following agents are involved:
- "Lily Chen"
- "Michael"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scenario_labs-0.0.1-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file scenario_labs-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: scenario_labs-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for scenario_labs-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc7f8158192aa6d4cbd2a36d7c22167a36b8e89caf98c91003a9bd80405128f9
MD5 eb694989c7f0b09322ac0c4da866a910
BLAKE2b-256 27c8ee199fba6d00359d1bac3d6078acb2c3acf307392172192424bcc376fa7c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page