Skip to content

Commit

Permalink
Huge orchestration update
Browse files Browse the repository at this point in the history
  • Loading branch information
jlowin committed Sep 9, 2024
1 parent 4602181 commit b99677c
Show file tree
Hide file tree
Showing 18 changed files with 421 additions and 442 deletions.
File renamed without changes.
File renamed without changes.
45 changes: 0 additions & 45 deletions docs/guides/orchestration.mdx

This file was deleted.

11 changes: 3 additions & 8 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,19 +59,14 @@
"patterns/instructions",
"patterns/planning",
"patterns/dependencies",
"patterns/subtasks",
"patterns/collaboration",
"patterns/stopping-tasks-early"
"patterns/subtasks"
]
},
{
"group": "Guides",
"group": "Configuration",
"pages": [
"guides/tasks-and-agents",
"guides/llms",
"guides/default-agent",
"guides/agentic-loop",
"guides/orchestration"
"guides/default-agent"
]
},
{
Expand Down
71 changes: 0 additions & 71 deletions docs/patterns/collaboration.mdx

This file was deleted.

11 changes: 4 additions & 7 deletions docs/patterns/planning.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Use AI to generate new tasks.
icon: compass
---

The `plan()` function in ControlFlow extends the capabilities of AI workflows by allowing dynamic generation of tasks. This feature allows you to leverage AI for creating structured, goal-oriented task sequences programmatically.
The `plan` function in ControlFlow extends the capabilities of AI workflows by allowing dynamic generation of tasks. This feature allows you to leverage AI for creating structured, goal-oriented task sequences programmatically.

## Purpose of AI planning

Expand All @@ -15,9 +15,9 @@ While ControlFlow allows manual creation of tasks for AI workflows, there are sc
3. **Adaptive Workflows**: In processes that need to adjust based on changing conditions or new information.


## The `plan()` function
## The `plan` function

The `plan()` function takes a high-level objective and generates a structured sequence of tasks to achieve that goal. Here's a basic example:
The `plan` function takes a high-level objective and generates a structured sequence of tasks to achieve that goal. Here's a basic example:

```python
import controlflow as cf
Expand All @@ -31,11 +31,8 @@ tasks = cf.plan(
cf.run_tasks(tasks)
```

In this example, `plan()` will generate a list of 3 tasks that, when completed, should result in an analysis of customer feedback data. These tasks might include steps like "Load data", "Preprocess text", "Perform sentiment analysis", etc.
In this example, `plan` will generate a list of 3 tasks that, when completed, should result in an analysis of customer feedback data. These tasks might include steps like "Load data", "Preprocess text", "Perform sentiment analysis", etc.

## Advanced usage

The `plan` function can do more than just generate tasks that achieve an objective.

### Dependencies

Expand Down
Loading

0 comments on commit b99677c

Please sign in to comment.