Home

Awesome

<p align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="docs/images/praisonai-logo-large.png"> <source media="(prefers-color-scheme: light)" srcset="docs/images/praisonai-logo-black-large.png"> <img alt="PraisonAI Logo" src="docs/images/praisonai-logo-black-large.png"> </picture> </p> <p align="center"> <a href="https://github.com/MervinPraison/PraisonAI"><img src="https://static.pepy.tech/badge/PraisonAI" alt="Total Downloads"></a> <a href="https://github.com/MervinPraison/PraisonAI"><img src="https://img.shields.io/github/v/release/MervinPraison/PraisonAI" alt="Latest Stable Version"></a> <a href="https://github.com/MervinPraison/PraisonAI"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"></a> </p> <div align="center">

Praison AI

</div>

Praison AI, leveraging both AutoGen and CrewAI or any other agent framework, represents a low-code, centralised framework designed to simplify the creation and orchestration of multi-agent systems for various LLM applications, emphasizing ease of use, customization, and human-agent interaction.

<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="docs/images/architecture-dark.png"> <source media="(prefers-color-scheme: light)" srcset="docs/images/architecture-light.png"> <img alt="PraisonAI Architecture" src="docs/images/architecture-light.png"> </picture> </div>

Different User Interfaces:

InterfaceDescriptionURL
UIMulti Agents such as CrewAI or AutoGenhttps://docs.praison.ai/ui/ui
ChatChat with 100+ LLMs, single AI Agenthttps://docs.praison.ai/ui/chat
CodeChat with entire Codebase, single AI Agenthttps://docs.praison.ai/ui/code
Other FeaturesDescriptionDocs
TrainFine-tune LLMs using your custom datahttps://docs.praison.ai/train

Google Colab Multi Agents

CookbookOpen in Colab
BasicPraisonAI<a target="_blank" href="https://colab.research.google.com/github/MervinPraison/PraisonAI/blob/main/cookbooks/praisonai-googlecolab.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>
Include ToolsPraisonAI Tools<a target="_blank" href="https://colab.research.google.com/github/MervinPraison/PraisonAI/blob/main/cookbooks/praisonai-tools-googlecolab.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a>

Install

Installation
PraisonAIpip install praisonai
PraisonAI Codepip install "praisonai[code]"
PraisonAI Chatpip install "praisonai[chat]"
PraisonAI Trainpip install "praisonai[train]"

Key Features

TL;DR Multi Agents

pip install praisonai
export OPENAI_API_KEY="Enter your API key"
praisonai --init create a movie script about dog in moon
praisonai

Table of Contents

Installation Multi Agents

pip install praisonai

Initialise

export OPENAI_API_KEY="Enter your API key"

Generate your OPENAI API KEY from here: https://platform.openai.com/api-keys

Note: You can use other providers such as Ollama, Mistral ... etc. Details are provided at the bottom.

praisonai --init create a movie script about dog in moon

This will automatically create agents.yaml file in the current directory.

To initialise with a specific agent framework (Optional):

praisonai --framework autogen --init create movie script about cat in mars

Run

praisonai

or

python -m praisonai

Specify the agent framework (Optional):

praisonai --framework autogen

Full Automatic Mode

praisonai --auto create a movie script about Dog in Moon

User Interface

PraisonAI User Interfaces:

InterfaceDescriptionURL
UIMulti Agents such as CrewAI or AutoGenhttps://docs.praisonai.com/ui/ui
ChatChat with 100+ LLMs, single AI Agenthttps://docs.praisonai.com/ui/chat
CodeChat with entire Codebase, single AI Agenthttps://docs.praisonai.com/ui/code
pip install -U "praisonai[ui]"
export OPENAI_API_KEY="Enter your API key"
chainlit create-secret
export CHAINLIT_AUTH_SECRET=xxxxxxxx
praisonai ui

or

python -m praisonai ui

Praison AI Chat

pip install "praisonai[chat]"
export OPENAI_API_KEY="Enter your API key"
praisonai chat

Praison AI Code

pip install "praisonai[code]"
export OPENAI_API_KEY="Enter your API key"
praisonai code

Create Custom Tools

Agents Playbook

Simple Playbook Example

framework: crewai
topic: Artificial Intelligence
roles:
  screenwriter:
    backstory: "Skilled in crafting scripts with engaging dialogue about {topic}."
    goal: Create scripts from concepts.
    role: Screenwriter
    tasks:
      scriptwriting_task:
        description: "Develop scripts with compelling characters and dialogue about {topic}."
        expected_output: "Complete script ready for production."

Use 100+ Models

Include praisonai package in your project

Option 1: Using RAW YAML

from praisonai import PraisonAI

# Example agent_yaml content
agent_yaml = """
framework: "crewai"
topic: "Space Exploration"

roles:
  astronomer:
    role: "Space Researcher"
    goal: "Discover new insights about {topic}"
    backstory: "You are a curious and dedicated astronomer with a passion for unraveling the mysteries of the cosmos."
    tasks:
      investigate_exoplanets:
        description: "Research and compile information about exoplanets discovered in the last decade."
        expected_output: "A summarized report on exoplanet discoveries, including their size, potential habitability, and distance from Earth."
"""

# Create a PraisonAI instance with the agent_yaml content
praisonai = PraisonAI(agent_yaml=agent_yaml)

# Run PraisonAI
result = praisonai.run()

# Print the result
print(result)

Option 2: Using separate agents.yaml file

Note: Please create agents.yaml file before hand.

from praisonai import PraisonAI

def basic(): # Basic Mode
    praisonai = PraisonAI(agent_file="agents.yaml")
    praisonai.run()

if __name__ == "__main__":
    basic()

Commands to Install Dependencies:

  1. Install all dependencies, including dev dependencies:

    poetry install
    
  2. Install only documentation dependencies:

    poetry install --with docs
    
  3. Install only test dependencies:

    poetry install --with test
    
  4. Install only dev dependencies:

    poetry install --with dev
    

This configuration ensures that your development dependencies are correctly categorized and installed as needed.

Contributing

Star History

Star History Chart

License

Praison AI is an open-sourced software licensed under the MIT license.