Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jlowin committed May 16, 2024
1 parent 6e855fb commit ae390e7
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,43 @@ This targeted approach results in AI systems that are easier to build, maintain,

- **Agent**: An AI agent that can be assigned tasks. Agents are powered by specialized AI models that excel at specific tasks, such as text generation or decision making based on unstructured data.

## Key Features

- **Targeted AI Integration**: Engage specialized AI agents only for the tasks they're best suited for, while keeping the majority of your application logic in the realm of traditional software.
## Get Started

- **Seamless Data Flow**: The `Task` class facilitates smooth data transfer between AI agents and your application, making it easy to incorporate AI-generated results into your workflow.
ControlFlow is under active development.

- **Flexible Agent Orchestration**: Coordinate multiple AI agents to work together on complex tasks, leveraging their individual strengths.
```bash
git clone https://github.com/jlowin/controlflow.git
cd controlflow
pip install .
```

- **Human Interaction**: AI agents can interact with humans to gather input or provide information when needed, enabling powerful human-in-the-loop workflows.
## Development

- **Intuitive APIs**: Clean, readable decorators and APIs for defining tasks and agents, built on top of the powerful Prefect and Marvin engines.
To install for development:

## Get Started
```bash
git clone https://github.com/jlowin/controlflow.git
cd controlflow
pip install -e ".[dev]"
```

ControlFlow is under active development.
To run tests:

```bash
git clone https://github.com/jlowin/controlflow.git
cd controlflow
pip install .
pytest -vv
```

The ControlFlow documentation is built with [Mintlify](https://mintlify.com/). To build the documentation, first install `mintlify`:
```bash
npm i -g mintlify
```
Then run the local build:
```bash
cd controlflow/docs
mintlify dev
```
## Example

```python
Expand Down

0 comments on commit ae390e7

Please sign in to comment.