Package: lyzr-automata
![version](https://img.shields.io/badge/version-0.1.1-blue.svg) [![Discord](https://img.shields.io/badge/Discord-join%20now-blue.svg?style=flat&logo=Discord)](https://discord.gg/dXmgggHYUz) [![YouTube Video](https://img.shields.io/badge/YouTube-Video-red?logo=youtube)](https://youtu.be/6U42TgaR6RA?feature=shared)![Lyzr Automata Banner](https://github.com/LyzrCore/lyzr-automata/assets/136654928/2f05f718-5526-4178-a312-90059b945e23)# Lyzr Automata## 1. Introduction### A low-code multi-agent automation framework.Note : Framework was developed swiftly as an experiment, leading to initial imperfections. We're committed to enhancing its stability and structure in upcoming releases, ensuring a high-quality. We encourage contributions from everyone, aiming to advance the project further together.### [](https://github.com/LyzrCore/lyzr-automata#lyzr-automata---autonomous-multi-agent-framework-for-process-automation)Lyzr Automata - Autonomous Multi-Agent Framework for Process AutomationLyzr Automata is a sophisticated multi-agent automation framework designed to keep things simple, with a focus on workflow efficiency and effectiveness. It enables the creation of multiple agents that are coupled with specific tasks. The agents and tasks can run independently and complete the provided instructions, thus entering a stable state.![Lyzr Automata](https://github.com/LyzrCore/lyzr-automata/assets/136654928/a9f0ecf7-0722-4038-8e3a-f00ce43c882e)## 2. InstallationYou can install our package simply by runningpip install lyzr-automata## 3. Understanding fundamentalsTo make things very simple, we have split our framework into fundamental building blocks.1. Models2. Agents3. Tools4. Tasks5. Pipelines### 1. ModelsModels are the core unit of the framework, which helps you connect different LLM or other AI Models to workflows.Note: You can use our prebuilt model classes for **OpenAI and Perplexity** or extend our base **AIModel** class to provide support for your own models.1.1 *Let's look at an example to create a **OpenAI Model** with parameters*```pythonfrom lyzr_automata.ai_models.openai import OpenAIModelopen_ai_text_completion_model = OpenAIModel(api_key="YOUR_OPEN_AI_KEY",parameters={"model": "gpt-4-turbo-preview","temperature": 0.2,"max_tokens": 1500,},)```1.2 *Let's look at an example to create a **Perplexity Model** with parameters*```pythonfrom lyzr_automata.ai_models.perplexity import PerplexityModelperplexity_model_text = PerplexityModel(api_key="YOUR_KEY_HERE",parameters={"model": "pplx-70b-online",},)```### 2.  AgentsAgents are directed specialists which have a set role, persona and memory, they are used to set direction and expertise for LLM models to increase its effectiveness.2.1 *Let's look at an example to create a simple linkedin content creator agent.*```pythonfrom lyzr_automata import Agentlinkedin_content_creator_agent = Agent(role="linkedin content creator",prompt_persona="you are an expert linkedin content creator who holds a Phd in molecular biology and are good at creating engaging linkedin posts.")```### 3.  ToolsTools are used by Agents to complete tasks. In general sense tools help agents to connect with external software components like API's or other functions.*Note: You can use our pre-built tools or tools from other providers like **Llama Hub**. Optionally you can also use our base **Tool** class to create your own custom tool by providing the function, input and output Pydantic models.**3.1 Let's look at an example to use prebuilt linkedin post tool*```pythonfrom lyzr_automata.tools.prebuilt_tools import linkedin_image_text_post_toollinkedin_post_tool = linkedin_image_text_post_tool(owner="urn:li:person:<YOUR_ID_HERE>",token="YOUR_TOKEN_HERE",)```*3.2 Let's look at an example to use our tool class to create your own custom tool*##### 3.2 Step 1. Create a function```pythondef multiply_numbers(a, b):"""Multiply two numbers.Parameters:- a (int/float): The first number.- b (int/float): The second number.Returns:- int/float: The product of the two numbers."""return a * b```##### 3.2  Step 2. Create Pydantic input model```python#INPUTfrom pydantic import BaseModelclass MultiplyInput(BaseModel):a: float  # Assuming we want to allow floating point numbersb: float```##### 3.2 Step 3. Create Pydantic output model```python#OUPUTclass MultiplyOutput(BaseModel):result: float```#####  3.3 Step 4. Create a tool instance```pythonfrom lyzr_automata import Toolmultiplication_tool = Tool(name="Multiplication tool",desc="multiplies two numbers",function=multiply_numbers,function_input=MultiplyInput,function_output=MultiplyOutput,)```### 4.  TasksTasks are our smallest functioning unit/node that helps you define what do you want to get done by the agent. It combines agent & tools.*4.1 Let's look at an example, on how you can define a task*```pythonfrom  lyzr_automata  import  Tasklinkedin_content_writing_task = Task(name="linkedin content writing",agent=linkedin_content_writer_agent,output_type=OutputType.TEXT,input_type=InputType.TEXT,model=open_ai_model_text,instructions="Write a linkedin post on gene editing using CRISPR",log_output=True,enhance_prompt=False,)```*4.1 Let's look at an example, on how you can create a tool task*```pythonlinkedin_post_task  =  Task(name="upload post to linkedin",model=open_ai_model_text,tool=linkedin_post_tool,instructions="Post on Linkedin",)```### 5.  PipelinesPipelines help us run the tasks in a directed orderly fashion. Currently we support linear async pipeline, with plans to release async DAG pipelines in next versions.Let us look at a simple sync flow to create a pipeline for automated Linkedin post.*5.1 **Flow***```mermaidgraph LRA((T1. Write Content))  --> B((T2. Publish Content))```5.2 **Code**```pythonfrom  lyzr_automata.pipelines.linear_sync_pipeline  import  LinearSyncPipelineLinearSyncPipeline(name="Linkedin post automation pipeline",completion_message="post successfully posted ðŸŽ‰",tasks=[linkedin_content_writing_task,linkedin_post_task,],).run()```**Example Colabs**1. Linkedin Post Automation: https://colab.research.google.com/drive/1lVJrdjHVZjbwZSqwJEU_etHC4GM3ihD0?usp=sharing2. Blog Automation:https://colab.research.google.com/drive/1e1Qa2pRjbngvX683pXTFLyuqLK11g967?usp=sharing#scrollTo=TmBixqI_BULu### Join our community[![Discord](https://img.shields.io/badge/Discord-join%20now-blue.svg?style=flat&logo=Discord)](https://discord.gg/dXmgggHYUz)## ContactFor queries, reach us at contact@lyzr.ai