Skip to content

Commit 0e40788

Browse files
committed
docs: add Causal Tree Engine to README
- Add CTE to Highlights section - Add CTE Flags subsection with all 9 config parameters - Update architecture diagram to include CTE - Add CTE entry to documentation table - Update test count to 3,500+
1 parent de442d9 commit 0e40788

1 file changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,36 @@ Forked from [ZeroClaw](https://github.com/zeroclaw-labs/zeroclaw) and extended w
88

99
- **9 LLM providers** — Anthropic, OpenAI, Google Gemini, GitHub Copilot, Ollama, AWS Bedrock, GLM, OpenAI Codex, and OpenAI-compatible endpoints
1010
- **LLM Router** — heuristic routing (capability + Elo + cost + latency), KNN semantic routing (cold-start guard + 100ms timeout fallback), and Automix low-confidence auto-upgrade
11+
- **Causal Tree Engine** — speculative multi-branch prediction with rehearsal, scoring, and circuit breaker; opt-in via `causal_tree.enabled` (disabled by default)
1112
- **19 messaging channels** — Signal, WhatsApp, Telegram, Discord, Slack, Matrix, and more
1213
- **43+ built-in tools** — shell, browser, MCP, memory, scheduling, remote nodes
1314
- **Xin (心) task engine** — autonomous heartbeat scheduler with 3 execution modes (Rust/LLM/Shell), 5 built-in system tasks, SQLite persistence
1415
- **Web Console** — browser-based management interface (`console/`)
1516
- **Remote Nodes** — control macOS/Linux/Pi devices via `prx-node` agent
1617
- **Self-Evolution** — autonomous prompt/memory/strategy improvement with xin-managed scheduling
1718
- **Subagent Governance** — concurrency limits, depth control, config inheritance
18-
- **3,400+ tests** — comprehensive test coverage across all modules
19+
- **3,500+ tests** — comprehensive test coverage across all modules
1920

2021
### LLM Router Flags
2122

2223
- `router.enabled` — enable heuristic model routing
2324
- `router.knn_enabled` — enable semantic KNN scoring (with timeout-safe fallback)
2425
- `router.automix.enabled` — enable cheap-first, low-confidence upgrade to premium model
2526

27+
### Causal Tree Engine Flags
28+
29+
> **Disabled by default.** Set `causal_tree.enabled = true` to activate.
30+
31+
- `causal_tree.enabled` — master switch for the CTE pipeline (default: `false`)
32+
- `causal_tree.policy.max_branches` — maximum candidate branches to expand (default: `3`)
33+
- `causal_tree.policy.commit_threshold` — minimum score to commit a branch (default: `0.62`)
34+
- `causal_tree.policy.extra_latency_budget_ms` — max additional latency budget in ms (default: `300`)
35+
- `causal_tree.policy.rehearsal_timeout_ms` — per-rehearsal timeout in ms (default: `5000`)
36+
- `causal_tree.policy.circuit_breaker_threshold` — consecutive failures before tripping (default: `5`)
37+
- `causal_tree.w_confidence` — scoring weight for confidence dimension (default: `0.50`)
38+
- `causal_tree.w_cost` — scoring weight for cost penalty (default: `0.25`)
39+
- `causal_tree.w_latency` — scoring weight for latency penalty (default: `0.25`)
40+
2641
## Quick Start
2742

2843
```bash
@@ -58,7 +73,7 @@ Or download pre-built binaries from [Releases](https://github.com/openprx/prx/re
5873
▼ ▼ ▼
5974
┌─────────────────────────────────────────────────────┐
6075
│ openprx daemon │
61-
│ Agent Loop · Gateway · Cron · Xin · Memory · Evo │
76+
│ Agent Loop · Gateway · CTE · Xin · Memory · Evo
6277
└──────────────────────┬──────────────────────────────┘
6378
6479
Providers (9 LLMs)
@@ -77,6 +92,7 @@ Or download pre-built binaries from [Releases](https://github.com/openprx/prx/re
7792
| [Evolution](docs/evolution.md) | Self-improvement pipeline |
7893
| [Configuration](docs/configuration.md) | Config reference, workspace files, security |
7994
| [Router](docs/router.md) | LLM Router config, flow, safety boundaries |
95+
| [Causal Tree Engine](docs/causal-tree.md) | CTE pipeline, branch prediction, rehearsal, scoring |
8096
| [WASM Plugins](docs/plugin-developer-guide.md) | Plugin developer guide (Rust/Python/JS/Go) |
8197
| [Host Function Reference](docs/host-function-reference.md) | WASM plugin host API reference |
8298

0 commit comments

Comments
 (0)