mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-08 07:38:29 +00:00
Adding initial README
This commit is contained in:
97
README.md
97
README.md
@@ -1,58 +1,73 @@
|
||||
# CrewAI
|
||||
|
||||
## Installing Dependencies
|
||||
```bash
|
||||
poetry lock
|
||||
poetry install
|
||||
🤖 Cutting-edge framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
|
||||
|
||||
## Why CrewAI?
|
||||
|
||||
The power of AI collaboration has too much to offer.
|
||||
CrewAI is designed to bridge to enable AI agents to assume roles, share goals, and operate in a cohesive unit - much like a well-oiled crew. Whether you're building a smart assistant platform, an automated customer service ensemble, or a multi-agent research team, CrewAI provides the backbone for sophisticated multi-agent interactions.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To get started with CrewAI, follow these simple steps:
|
||||
|
||||
1. **Installation**:
|
||||
|
||||
```shell
|
||||
pip install crewai
|
||||
```
|
||||
|
||||
## Virtual Env
|
||||
```bash
|
||||
poetry shell
|
||||
2. **Setting Up Your Crew**:
|
||||
|
||||
```python
|
||||
from crewai import Agent, Task, Crew, Process
|
||||
|
||||
# Define your agents with roles and goals
|
||||
researcher = Agent(role='Researcher', goal='Discover new insights')
|
||||
writer = Agent(role='Writer', goal='Create engaging content')
|
||||
|
||||
# Create tasks for your agents
|
||||
task1 = Task(description='Investigate the latest AI trends', agent=researcher)
|
||||
task2 = Task(description='Write a blog post on AI advancements', agent=writer)
|
||||
|
||||
# Instantiate your crew with a sequential process
|
||||
crew = Crew(
|
||||
agents=[researcher, writer],
|
||||
tasks=[task1, task2],
|
||||
process=Process.sequential
|
||||
)
|
||||
|
||||
# Get your crew to work!
|
||||
crew.kickoff()
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
```bash
|
||||
poetry run pytest
|
||||
```
|
||||
## Key Features
|
||||
|
||||
## Packaging
|
||||
```bash
|
||||
poetry build
|
||||
```
|
||||
- **Role-Based Agent Design**: Customize agents with specific roles, goals, and tools.
|
||||
- **Autonomous Inter-Agent Delegation**: Agents can autonomously delegate tasks and inquire amongst themselves, enhancing problem-solving efficiency.
|
||||
- **Flexible Task Management**: Define tasks with customizable tools and assign them to agents dynamically.
|
||||
- **Processes Driven**: Currently only supports `sequential` task execution but more complex processes like consensual and hierarchical being worked on.
|
||||
|
||||
### Installing Locally
|
||||
```bash
|
||||
pip install dist/*.tar.gz
|
||||
```
|
||||

|
||||
|
||||
RolaPLaying
|
||||
|
||||
# CrewAI
|
||||
## How CrewAI Compares
|
||||
|
||||
## Why?
|
||||
- **Autogen**: While Autogen excels in creating conversational agents capable of working together, it lacks an inherent concept of process. In Autogen, orchestrating agents' interactions requires additional programming, which can become complex and cumbersome as the scale of tasks grows.
|
||||
|
||||
## How?
|
||||
- **ChatDev**: ChatDev introduced the idea of processes into the realm of AI agents, but its implementation is quite rigid. Customizations in ChatDev are limited and not geared towards production environments, which can hinder scalability and flexibility in real-world applications.
|
||||
|
||||
## What is it?
|
||||
Convention?
|
||||
**CrewAI's Advantage**: CrewAI is built with production in mind. It offers the flexibility of Autogen's conversational agents and the structured process approach of ChatDev, but without the rigidity. CrewAI's processes are designed to be dynamic and adaptable, fitting seamlessly into both development and production workflows.
|
||||
|
||||
Convention of Roles
|
||||
Convention over Tools
|
||||
Convention over interactions (In what ways agents interact, how flexible, conversation patterns, where these happen [in a room, in isolation])
|
||||
Convention over degree of guidance
|
||||
## Contribution
|
||||
|
||||
You must be able to bring any tools <- Convention over tools
|
||||
CrewAI is open-source and we welcome contributions. If you're looking to contribute, please:
|
||||
|
||||
How does it compare to autogen?
|
||||
- Fork the repository.
|
||||
- Create a new branch for your feature.
|
||||
- Add your feature or improvement.
|
||||
- Send a pull request.
|
||||
- We appreciate your input!
|
||||
|
||||
Autogen is good to create conversational agents, these agents can then work
|
||||
together autonomously, but there is no concepts of process, a process would need
|
||||
to be programatically added.
|
||||
|
||||
ChatDev brings the idea of processes to the AI Agents but it's stiff and it's
|
||||
customizations are not meant to be deployed at production settings
|
||||
|
||||
CrewAI is a python library that provide modules to build crews of AI Agents tha
|
||||
|
||||
What is the interface to interact with CrewAI?
|
||||
## License
|
||||
CrewAI is released under the MIT License
|
||||
BIN
crewAI-mindmap.png
Normal file
BIN
crewAI-mindmap.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 431 KiB |
Reference in New Issue
Block a user