Skip to content

Commit 4600ffe

Browse files
authored
Rewrite README tone and structure (#14)
1 parent 652a725 commit 4600ffe

2 files changed

Lines changed: 123 additions & 467 deletions

File tree

README.md

Lines changed: 62 additions & 231 deletions
Original file line numberDiff line numberDiff line change
@@ -4,283 +4,114 @@
44

55
# PhD-Zero
66

7-
### An Operating System for the Autonomous AI Scientist
8-
9-
<p align="center">
10-
<a href="./README_zh.md">简体中文</a> •
11-
<a href="./README.md">English</a> •
12-
<a href="#-what-is-phd-zero">What is PhD-Zero?</a> •
13-
<a href="#-why-it-exists">Why it exists</a> •
14-
<a href="#-core-skill-stack">Skill Stack</a> •
15-
<a href="#-how-it-works">How it works</a> •
16-
<a href="#-quick-start">Quick Start</a> •
17-
<a href="#-roadmap">Roadmap</a> •
18-
<a href="#-contributing">Contributing</a> •
19-
<a href="#-acknowledgements">Acknowledgements</a> •
20-
<a href="#-cite">Cite</a>
7+
<p>An operating system for research-oriented coding agents.</p>
8+
9+
<p>
10+
<a href="./README_zh.md">简体中文</a> ·
11+
<a href="./docs/index.html">Website</a> ·
12+
<a href="#quick-start">Quick Start</a> ·
13+
<a href="#core-skills">Core Skills</a> ·
14+
<a href="#contributing">Contributing</a>
2115
</p>
2216

23-
**Turn research workflows into reusable agent skills.**
24-
**From literature search to experiment execution, memory, and paper writing.**
25-
26-
*Built for Codex, Claude Code, and the future autonomous AI researcher.*
27-
2817
</div>
2918

30-
---
31-
32-
## 👁️ What is PhD-Zero?
33-
34-
**PhD-Zero** is an open-source **AI R&D operating layer** for coding agents.
35-
36-
Instead of treating research as a single prompt, PhD-Zero breaks it into structured, reusable skills:
37-
- plan the work,
38-
- search for evidence,
39-
- execute experiments,
40-
- manage memory,
41-
- request human review when needed,
42-
- and turn results into research artifacts.
43-
44-
The goal is simple:
45-
46-
- **Near term:** build an **intern-level AI researcher** that can reliably handle scoped R&D tasks.
47-
- **Long term:** build an **autonomous AI scientist** that can navigate the full algorithm-development lifecycle.
48-
49-
In short, **PhD-Zero is the systems layer between raw model capability and real research execution.**
50-
51-
---
52-
53-
## 🔥 Why it exists
54-
55-
Today, strong models can already code, read papers, and debug scripts.
56-
57-
What they still lack is **research discipline**.
58-
59-
Real AI R&D is not just “generate an answer.” It requires:
60-
- staged execution,
61-
- evidence-backed reasoning,
62-
- memory across steps,
63-
- controlled experimentation,
64-
- and human checkpoints for expensive or risky decisions.
65-
66-
PhD-Zero exists to provide that missing structure.
67-
68-
It helps agents move:
69-
- **from vague ideas to executable plans**
70-
- **from one-shot prompting to reusable workflows**
71-
- **from hallucinated confidence to evidence-backed outputs**
72-
- **from isolated tasks to compounding research memory**
73-
74-
---
75-
76-
## 🛠️ Core skill stack
77-
78-
PhD-Zero decomposes AI research into modular skills that agents can discover and invoke.
79-
80-
| Skill | Role in the system | Human analogy |
81-
| --- | --- | --- |
82-
| `run-governor` | Controls stages, execution discipline, and run safety | PI / project lead |
83-
| `research-workflow` | Default orchestration loop for non-trivial research tasks | Research manager |
84-
| `research-plan` | Turns open-ended goals into concrete plans, ablations, and study designs | Senior researcher |
85-
| `deep-research` | Collects external evidence, compares literature, and synthesizes findings | Literature reviewer |
86-
| `experiment-execution` | Runs code, debugs failures, and executes experiments | Research engineer |
87-
| `memory-manager` | Maintains working state and promotes reusable memory | Working + long-term memory |
88-
| `project-context` | Persists project-specific runtime context and conventions | Lab notebook |
89-
| `human-checkpoint` | Escalates risky, expensive, or high-impact decisions | Advisor / reviewer |
90-
| `paper-writing` | Drafts and revises research artifacts and paper text | Scientific writer |
91-
92-
> **Research is not one capability. It is a coordinated system of capabilities.**
93-
94-
---
95-
96-
## ⚙️ How it works
97-
98-
PhD-Zero is designed as a **shared skill layer** for different coding agents.
99-
100-
### For Codex / GitHub Copilot-style agents
101-
Repository-level behavior is defined through `AGENTS.md`.
102-
103-
### For Claude Code
104-
Skills are exposed through `.claude/skills/`.
105-
106-
### Source of truth
107-
The canonical skill definitions live in:
108-
109-
```text
110-
.agents/skills/
111-
```
112-
113-
This lets one repository drive multiple agent runtimes with the same research workflow logic.
114-
115-
---
116-
117-
## 📂 Repository structure
118-
119-
```text
120-
.
121-
├── AGENTS.md # Global operating rules for the workspace
122-
├── REPO_CONVENTIONS.md # Artifact, logging, and repo hygiene rules
123-
├── .agents/
124-
│ └── skills/ # Canonical skill definitions
125-
├── .claude/
126-
│ └── skills/ # Claude Code discovery layer
127-
├── .github/
128-
│ └── workflows/ # Repo automation
129-
└── README.md
130-
```
131-
132-
---
133-
134-
## ✨ What makes this different?
135-
136-
Most “AI researcher” repos are one of these:
137-
138-
* a benchmark,
139-
* a paper list,
140-
* a single-agent demo,
141-
* or a prompt pack.
142-
143-
PhD-Zero is different because it focuses on **operationalizing research**.
144-
145-
It is not just trying to make an agent sound smart.
146-
It is trying to make an agent **work like a research system**.
147-
148-
That means:
19+
PhD-Zero is a repository of reusable skills for AI research work. The point is not to make an agent sound smart for one turn. The point is to give it a workflow it can actually follow: plan the task, gather evidence, run experiments, keep context, ask for human review when needed, and write results down in a form another person can inspect.
14920

150-
* explicit execution stages,
151-
* controlled memory usage,
152-
* evidence-first decisions,
153-
* reusable skills instead of ad hoc prompts,
154-
* and compatibility with multiple coding-agent environments.
21+
The same skill library is exposed to different runtimes. Codex-style agents read workspace rules from `AGENTS.md`. Claude Code sees a mirrored discovery layer under `.claude/skills/`. The actual source of truth lives in `.agents/skills/`.
15522

156-
---
23+
## Quick start
15724

158-
## 🚀 Quick start
159-
160-
### 1. Clone the repository
25+
If you just want to see whether the repo is wired correctly, do this:
16126

16227
```bash
16328
git clone https://github.com/TenureAI/PhD-Zero.git
16429
cd PhD-Zero
165-
```
16630

167-
### 2. Inspect the skill library
168-
169-
```bash
17031
find .agents/skills -mindepth 1 -maxdepth 1 -type d
17132
find .claude/skills -mindepth 1 -maxdepth 1 -type l
17233
```
17334

174-
### 3. Connect your agent runtime
175-
176-
* **Codex / Copilot-style agents** read workspace rules from `AGENTS.md`
177-
* **Claude Code** discovers the same capabilities through `.claude/skills/`
178-
179-
If both commands in step 2 list the same skill names, the shared skill layer is wired correctly.
180-
181-
### 4. Start with a real research task
182-
183-
Examples:
35+
Those two commands should list the same skill names. If they do, the shared skill layer is in place.
18436

185-
* reproduce a paper result
186-
* investigate why a training run failed
187-
* design an ablation plan
188-
* compare methods for a new project direction
189-
* draft a research report from experiment evidence
37+
From there:
19038

191-
---
39+
1. Read `AGENTS.md` to understand the workspace rules used by Codex-style agents.
40+
2. Inspect `.agents/skills/` if you want the canonical skill implementations.
41+
3. Inspect `.claude/skills/` if you want to verify the Claude Code mirror.
19242

193-
## 🧭 Roadmap
43+
If you prefer a landing page over the raw repository view, there is also a static site under [docs/index.html](./docs/index.html).
19444

195-
PhD-Zero is the first layer of a larger vision.
45+
## What is in this repository?
19646

197-
### Phase 1 — AI Research Intern
47+
The repository is intentionally small. It does not try to be a benchmark suite, a framework, and a demo app all at once. It is mostly a skill library plus the rules that tell agents how to use it.
19848

199-
* scoped literature investigation
200-
* experiment planning
201-
* code execution and debugging
202-
* report drafting
203-
204-
### Phase 2 — AI Research Collaborator
205-
206-
* reusable memory across projects
207-
* stronger project context persistence
208-
* better experiment iteration loops
209-
* improved human-in-the-loop checkpoints
210-
211-
### Phase 3 — Autonomous AI Scientist
212-
213-
* independent hypothesis generation
214-
* self-directed experimentation
215-
* long-horizon project execution
216-
* end-to-end algorithm development
217-
218-
---
219-
220-
## 🤝 Contributing
221-
222-
We are building this in the open.
49+
```text
50+
.
51+
├── AGENTS.md
52+
├── REPO_CONVENTIONS.md
53+
├── .agents/skills/ # canonical skill definitions
54+
├── .claude/skills/ # Claude Code mirror layer
55+
├── .github/workflows/ # repository validation
56+
├── assets/ # shared visual assets
57+
└── docs/ # static landing page
58+
```
22359

224-
You can contribute by:
60+
The CI in this repo checks that the skill directories under `.agents/skills` and `.claude/skills` stay in sync, and that every tracked skill has a readable `SKILL.md`.
22561

226-
1. adding new agent skills,
227-
2. improving existing workflows,
228-
3. contributing better evaluation tasks for AI R&D,
229-
4. or using PhD-Zero in real research loops and sharing what breaks.
62+
## Core skills
23063

231-
If you care about the future of **AI doing AI research**, this repo is for you.
64+
The current skill set covers the basic loop of a research-oriented agent:
23265

233-
---
66+
| Skill | What it is for |
67+
| --- | --- |
68+
| `run-governor` | Stage control, run discipline, and execution policy |
69+
| `research-workflow` | The default loop for non-trivial research tasks |
70+
| `research-plan` | Turning an open-ended goal into a concrete plan |
71+
| `deep-research` | External search, literature comparison, and synthesis |
72+
| `experiment-execution` | Running code, debugging, and experiment execution |
73+
| `memory-manager` | Working state and reusable memory |
74+
| `project-context` | Project-specific runtime context and conventions |
75+
| `human-checkpoint` | Human review for risky or expensive decisions |
76+
| `paper-writing` | Drafting and revising research artifacts |
23477

235-
## 🙏 Acknowledgements
78+
That list will probably grow, but the idea is stable: break research into pieces that can be reused instead of trying to solve everything with one giant prompt.
23679

237-
PhD-Zero builds on the broader agent, tooling, and writing-assistance ecosystem.
80+
## Who this is for
23881

239-
We especially want to acknowledge:
82+
PhD-Zero is for people who are already using coding agents in research or engineering-adjacent work and want more discipline around the process. If you care about literature review, experiment planning, reproducibility, or keeping an agent from improvising its way through a long task, this repo is meant to be useful. If you just want a flashy demo, it is probably not the right project.
24083

241-
- the contributors behind reusable coding-agent environments and workflow conventions
242-
- the open-source communities building skill systems for Codex, Claude Code, and adjacent agent runtimes
243-
- [blader/humanizer](https://github.com/blader/humanizer/tree/main), for practical text humanization patterns
244-
- [op7418/Humanizer-zh](https://github.com/op7418/Humanizer-zh), for Chinese-focused humanization references
84+
## Contributing
24585

246-
These projects are not dependencies of PhD-Zero, but they helped shape how we think about reusable agent behaviors and writing support.
86+
Contributions are welcome, especially in three areas:
24787

248-
---
88+
1. new skills that fit the repository's scope
89+
2. tighter workflows for the existing skills
90+
3. validation and examples from real usage
24991

250-
## 💡 Philosophy
92+
Before opening a PR, check `REPO_CONVENTIONS.md`. This repo keeps reusable skill content in version control and keeps task-specific logs or run artifacts out.
25193

252-
PhD-Zero is based on one belief:
94+
## Acknowledgements
25395

254-
> **AI research should become programmable.**
96+
PhD-Zero is shaped by the broader ecosystem around coding agents, research tooling, and writing support. In particular, the repository draws useful ideas from projects that treat workflows as first-class artifacts rather than one-off prompts.
25597

256-
Not just smarter outputs.
257-
Not just better prompts.
258-
But reusable, inspectable, evolving research workflows.
98+
We also want to acknowledge:
25999

260-
That is the first step toward the autonomous AI scientist.
100+
- [blader/humanizer](https://github.com/blader/humanizer/tree/main)
101+
- [op7418/Humanizer-zh](https://github.com/op7418/Humanizer-zh)
261102

262-
---
103+
These are not runtime dependencies here, but they were useful references when thinking about writing quality and reusable editing guidance.
263104

264-
## 📚 Cite
105+
## Cite
265106

266-
If PhD-Zero is useful in your workflow or research, please cite:
107+
If PhD-Zero is useful in your workflow or research, you can cite it as:
267108

268109
```bibtex
269110
@misc{phd_zero_github,
270111
author = {TenureAI Contributors},
271-
title = {PhD-Zero: An Operating System for the Autonomous AI Scientist},
112+
title = {PhD-Zero: An Operating System for Research-Oriented Coding Agents},
272113
year = {2026},
273114
howpublished = {\url{https://github.com/TenureAI/PhD-Zero}},
274115
note = {GitHub repository}
275116
}
276117
```
277-
278-
---
279-
280-
<div align="center">
281-
282-
### Built by <a href="https://github.com/TenureAI">TenureAI</a>
283-
284-
**Automating the grind. Scaling research.**
285-
286-
</div>

0 commit comments

Comments
 (0)