Skip to main content

A framework for managing and orchestrating AI agents

Project description

🌿 Agentarium

License: Apache 2.0 Python 3.10+ PyPI version

A powerful Python framework for managing and orchestrating AI agents with ease. Agentarium provides a flexible and intuitive way to create, manage, and coordinate interactions between multiple AI agents in various environments.

InstallationQuick StartFeaturesExamplesDocumentationContributing

🚀 Installation

pip install agentarium

🎯 Quick Start

from agentarium import Agent

# Create agents
agent1 = Agent(name="agent1")
agent2 = Agent(name="agent2")

agent1.talk_to(agent2, "Hello, how are you?")
agent2.talk_to(agent1, "I'm fine, thank you!")

agent1.act() # Same as agent.talk_to but it's the agent who decides what to do

✨ Features

  • 🤖 Advanced Agent Management: Create and orchestrate multiple AI agents with different roles and capabilities
  • 🔄 Robust Interaction Management: Coordinate complex interactions between agents
  • 💾 Checkpoint System: Save and restore agent states and interactions
  • 📊 Data Generation: Generate synthetic data through agent interactions
  • ⚡ Performance Optimized: Built for efficiency and scalability
  • 🌍 Flexible Environment Configuration: Define custom environments with YAML configuration files
  • 🛠️ Extensible Architecture: Easy to extend and customize for your specific needs

📚 Examples

Basic Chat Example

Create a simple chat interaction between agents:

# examples/basic_chat/demo.py
from agentarium import Agent

alice = Agent.create_agent()
bob = Agent.create_agent()

alice.talk_to(bob, "Hello Bob! I heard you're working on some interesting data science projects.")
bob.act()

Synthetic Data Generation

Generate synthetic data through agent interactions:

# examples/synthetic_data/demo.py
from agentarium import Agent
from agentarium.CheckpointManager import CheckpointManager

checkpoint = CheckpointManager("demo")

alice = Agent.create_agent()
bob = Agent.create_agent()

alice.talk_to(bob, "What a beautiful day!")
checkpoint.update(step="interaction_1")

checkpoint.save()

More examples can be found in the examples/ directory.

📖 Documentation

Environment Configuration

Configure your environment using YAML files:

llm:
  provider: "openai" # any provider supported by aisuite
  model: "gpt-4-mini" # any model supported by the provider

aisuite: # optional, credentials for aisuite
  openai:
    api_key: "sk-..."

Key Components

  • Agent: Base class for creating AI agents
  • CheckpointManager: Handles saving and loading of agent states

🤝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Commit your changes (git commit -m 'feat: add amazing feature')
  5. Push to the branch (git push origin feature/amazing-feature)
  6. Open a Pull Request

📄 License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

🙏 Acknowledgments

  • Thanks to all contributors who have helped shape Agentarium
  • Special thanks to the open-source community

Made with ❤️ by thytu

Project details


Download files

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

Source Distribution

agentarium-0.2.0.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

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

agentarium-0.2.0-py3-none-any.whl (19.8 kB view details)

Uploaded Python 3

File details

Details for the file agentarium-0.2.0.tar.gz.

File metadata

  • Download URL: agentarium-0.2.0.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.15

File hashes

Hashes for agentarium-0.2.0.tar.gz
Algorithm Hash digest
SHA256 907dbb5ce5bac9132a9cfb3df3548fbf4e7a478bb16ac2c68517d6e0dbbef0ee
MD5 821ad63e9cd3fa652949a46083a0ed3f
BLAKE2b-256 5a460c9760669b6d28e386e5a799c9f8577226a8d5ec316d2695c9c79fdebcdf

See more details on using hashes here.

File details

Details for the file agentarium-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: agentarium-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 19.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.15

File hashes

Hashes for agentarium-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b1692e24493acffd1e2b3ed4a6f5cba429788e97fa324b7241c7777b91d91a78
MD5 687c2186d8f214be3b1c87cc4e73c1a4
BLAKE2b-256 e201727d56960880d745fc6ef642c2ca5b09822db78ff55f5b2c327082ddd0e3

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