README.md

---
license: apache-2.0
---

# Flowchart Generation Model

## Overview

This model generates Mermaid diagrams from a sequence of steps provided in the input. It processes the input text and automatically outputs a flowchart that visually represents the steps. The model strictly follows a defined template and does not require any additional prompt engineering.

## How It Works

The model takes a set of sequential instructions as input and produces a flowchart diagram in Mermaid format.

## Video Performance On A Mac M1 8GB:
https://x.com/troydoesai/status/1833671273765020158

### Input Format

The input is a sequence of steps written as plain text:

```text
Step 1: Do something.
Step 2: Do the next thing.
Step 3: Complete the task.
```

### Output Format

The output is a Mermaid diagram:

```mermaid
graph TD;
   Step1 --> Step2;
   Step2 --> Step3;
   ...
```

### Example

**Input:**

```text
Fill the coffee maker with water.
Add coffee grounds to the filter.
Turn on the coffee maker.
Wait for brewing to finish.
Pour the coffee.
Optional: Add sugar or milk.
Enjoy your coffee.
```

**Output:**

```mermaid
graph TD;
   A[Fill Coffee Maker] --> B[Add Water];
   B --> C[Add Coffee Grounds];
   C --> D[Turn On Coffee Maker];
   D --> E[Wait for Brewing];
   E --> F[Pour Coffee];
   F --> G{Add Sugar & Milk?};
   G--Yes-->H[Mix In];
   H-->I[Enjoy Coffee];
   G--No-->I;
```

## Features

- Transforms plain text instructions into Mermaid flowcharts. (It might work with code, stories, or anything that has a flow)
- Follows a consistent input-output template.
- Simple and direct without requiring additional prompt adjustments.

## Use Cases

- Visualizing step-by-step processes.
- Converting written instructions into clear, easy-to-read diagrams.
- Ideal for documentation, workflows, and tutorials.

### How To Use With Ollama

- Please Use Provided `Ollama`: `Modelfile`
```
ollama create AgentFlow
``` 
```
ollama run AgentFlow
```