Skip to content

Commit b6e1882

Browse files
committed
Consolidate documentation: merge RESUME_MODE.md into README.md
- Integrate detailed Resume Mode documentation into README.md - Remove RESUME_MODE.md (content merged) - Remove README_zh-TW.md (keep only English README.md) - All resume mode information now in single README.md
1 parent ec36fc1 commit b6e1882

9 files changed

+3212
-575
lines changed

docs/pages/mindmaps/neetcode_ontology_agent_evolved_en.html

Lines changed: 694 additions & 1 deletion
Large diffs are not rendered by default.

docs/pages/mindmaps/neetcode_ontology_agent_evolved_zh-TW.html

Lines changed: 352 additions & 1 deletion
Large diffs are not rendered by default.

tools/ai-markmap-agent/README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,80 @@ output:
421421

422422
**Reset mode** prompts for confirmation. Old versions are deleted only after the pipeline completes successfully (safe: if pipeline fails, old versions are preserved).
423423

424+
### Resume Mode
425+
426+
Resume mode allows you to continue execution from a previous pipeline run, supporting:
427+
- Reusing completed stage outputs (saves tokens and time)
428+
- Re-running from a specific stage (debug-friendly)
429+
- Not overwriting original run data (generates new regen run)
430+
431+
#### Resume vs Reset
432+
433+
**Important distinction:**
434+
- **`--resume`**: Reuses debug outputs from previous runs to save API calls. This is about **pipeline execution** (whether to run new API calls or reuse existing results).
435+
- **`versioning.mode: reset`**: Deletes old version directories and starts fresh. This is about **version management** (how to organize final output versions).
436+
437+
These two features are **independent**:
438+
- You can use `--resume` even when `versioning.mode: reset` is set
439+
- Resume mode reuses debug outputs regardless of versioning mode
440+
- Versioning reset only affects final output directories, not debug outputs
441+
- When resuming, versioning reset prompts are skipped (reset applies to final output only)
442+
443+
#### Usage
444+
445+
**Method 1: Interactive Resume Mode**
446+
447+
```bash
448+
python main.py --resume
449+
```
450+
451+
After startup, it will:
452+
1. Scan all previous runs under `outputs/debug/`
453+
2. Display them sorted by time (newest first)
454+
3. Let you select the run to resume
455+
4. Ask whether to reuse each stage's output one by one
456+
457+
**Method 2: Start from a Specific Stage**
458+
459+
```bash
460+
python main.py --resume --from-stage writer
461+
```
462+
463+
This will automatically:
464+
- Select the latest run
465+
- Reuse outputs from `expert_review`, `full_discussion`, `consensus`
466+
- Re-run from the `writer` stage
467+
468+
**Supported stages:**
469+
- `expert_review`
470+
- `full_discussion`
471+
- `consensus`
472+
- `writer`
473+
- `translate`
474+
- `post_process`
475+
476+
#### Run Naming Rules
477+
478+
- **Original run**: `run_YYYYMMDD_HHMMSS/`
479+
- **Resume from original run**: `run_YYYYMMDD_HHMMSS_regen_1/`
480+
- **Resume again**: `run_YYYYMMDD_HHMMSS_regen_2/`
481+
482+
**Important**: Original run data is never overwritten, all new outputs are in regen directories.
483+
484+
#### State Loading
485+
486+
The system automatically loads:
487+
- ✅ **Consensus data**: Loaded from JSON file (if reusing consensus stage)
488+
- ✅ **Writer output**: Loaded from writer output file (if reusing writer stage)
489+
- ⚠️ **Expert responses**: Currently only marked as reused, incomplete recovery (needs improvement)
490+
491+
#### Notes
492+
493+
1. **Ensure debug_output.enabled = true**: Resume mode depends on debug output
494+
2. **API Keys**: Still need to provide API keys (even when reusing stages)
495+
3. **Configuration consistency**: Resume uses current config, which may differ from original run
496+
4. **Partial state recovery**: Currently only partial state recovery is supported, some stages may need to be re-run
497+
424498
---
425499

426500
## Module Responsibilities

0 commit comments

Comments
 (0)