Skip to content

Commit c00db1b

Browse files
Protocol-zero-0Protocol Zero (v1.1 agent)claude
authored
docs: README hero — ▶ Try in 10 minutes + ASCII workflow (closes #33) (#34)
The first thing a stranger sees on the repo should be something they can *run*. Insert a small hero block above "Motivation" / "动机": 1. ▶ Try in 10 minutes — 4-line shell snippet that drives `examples/quickstart/` to a real `evolution/accepted` commit in ~1 second, $0, no API key. Links to the quickstart README and to examples/oss_fix_demo/ for the LLM-driven version. 2. How the loop works — a compact ASCII diagram showing Observe → Plan → Execute → Evaluate → accept/reject → ledger. Sits where a reader naturally lands after the call-to-action. Both README.md and README.zh.md updated in parity. No prose rewritten; the existing investor-narrative Motivation / SWE-bench worked-example sections are intact below. Co-authored-by: Protocol Zero (v1.1 agent) <agent@protocol-zero-0.dev> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
1 parent d93b136 commit c00db1b

2 files changed

Lines changed: 70 additions & 0 deletions

File tree

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,41 @@
3333

3434
---
3535

36+
> ### ▶ Try in 10 minutes
37+
>
38+
> ```bash
39+
> pip install -e . && pip install ruff
40+
> bash examples/quickstart/setup.sh
41+
> evolution-kernel \
42+
> --config examples/quickstart/evolution.yml \
43+
> --repo /tmp/ek-quickstart-target \
44+
> --ledger /tmp/ek-quickstart-ledger \
45+
> --loop
46+
> ```
47+
>
48+
> Closes the full loop in **~1 second**, **\$0**, **no API key**. See [examples/quickstart/](examples/quickstart/) for what just happened. For the LLM-driven version on a real OSS target, see [examples/oss_fix_demo/](examples/oss_fix_demo/).
49+
50+
### How the loop works
51+
52+
```
53+
┌─ Observe ─┐ ┌─ Plan ─┐ ┌─ Execute ─┐ ┌─ Evaluate ─┐
54+
│ metrics │ → │ LLM │ → │ worktree │ → │ re-run │
55+
│ ruff/test │ │ + hist │ │ + agent │ │ metric │
56+
└─────┬─────┘ └────────┘ └─────┬─────┘ └──────┬─────┘
57+
│ │ │
58+
│ ┌─────────────────┴──────────────────┘
59+
│ ▼
60+
│ ✅ accept → real git commit on evolution/accepted
61+
│ ❌ reject → worktree discarded, experiment branch kept for audit
62+
│ │
63+
└────────────┴────► ledger: goal · obs · plan · diff · eval · decision · reflection
64+
(every step replayable, every change rollback-able)
65+
```
66+
67+
Each pass writes a complete forensic record to `runs/<id>/`. Nothing the kernel decides is held in memory; everything is reconstructable from the ledger alone.
68+
69+
---
70+
3671
## Motivation
3772

3873
Frontier-class agent behavior is the joint product of *the model* and *the harness that runs it* — prompt structure, tool loop, sampling and best-of-N, verifier, retry policy. Today that harness is hand-tuned by senior engineers at every serious AI lab, and the resulting code is usually the actual ceiling against which the base model is judged.

README.zh.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,41 @@
3131

3232
---
3333

34+
> ### ▶ 10 分钟跑通
35+
>
36+
> ```bash
37+
> pip install -e . && pip install ruff
38+
> bash examples/quickstart/setup.sh
39+
> evolution-kernel \
40+
> --config examples/quickstart/evolution.yml \
41+
> --repo /tmp/ek-quickstart-target \
42+
> --ledger /tmp/ek-quickstart-ledger \
43+
> --loop
44+
> ```
45+
>
46+
> 整个闭环 **~1 秒** 跑完,**\$0****无需 API key**。详见 [examples/quickstart/](examples/quickstart/)。需要 LLM 驱动的真实 OSS 修复案例,见 [examples/oss_fix_demo/](examples/oss_fix_demo/)。
47+
48+
### 闭环工作流
49+
50+
```
51+
┌─ Observe ─┐ ┌─ Plan ─┐ ┌─ Execute ─┐ ┌─ Evaluate ─┐
52+
│ 指标 │ → │ LLM + │ → │ worktree │ → │ 重跑指标 │
53+
│ ruff/test │ │ 历史 │ │ + agent │ │ │
54+
└─────┬─────┘ └────────┘ └─────┬─────┘ └──────┬─────┘
55+
│ │ │
56+
│ ┌─────────────────┴──────────────────┘
57+
│ ▼
58+
│ ✅ accept → evolution/accepted 上的真实 git commit
59+
│ ❌ reject → worktree 销毁,实验分支保留供审计
60+
│ │
61+
└────────────┴────► ledger: goal · obs · plan · diff · eval · decision · reflection
62+
(每一步可重放,每个变更可回滚)
63+
```
64+
65+
每一轮都把完整的取证记录写进 `runs/<id>/`。内核不在内存里保留任何决策状态,所有信息都能从 ledger 重建。
66+
67+
---
68+
3469
## 动机
3570

3671
旗舰级 agent 能力是 *模型**运行它的 harness* 的联合产出——prompt 结构、工具循环、采样和 best-of-N、验证器、重试策略。今天这套 harness 在每家严肃的 AI 实验室都靠资深工程师手调,最终结果通常就是评判基座模型时实际的能力上限。

0 commit comments

Comments
 (0)