Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Reviewers should **block on boundary violations** before nitpicking style: wrong

### TorchProbe overhead (do not regress)

Changing overhead **formulas**, **`_close_step_wall` hook order**, or **deferred drain defaults** requires reading **`docs/src/design/overhead-invariants.zh.md`** and updating the tests listed there.
Changing overhead **formulas**, **`_close_step_wall` hook order**, or **deferred drain defaults** requires reading **`docs/src/design/overhead.zh.md#change-invariants`** and updating the tests listed there.

| Invariant | Do not |
|-----------|--------|
Expand Down
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ install:
# Live preview server
serve:
@echo "Starting live preview server..."
@echo "Open http://127.0.0.1:8000 in your browser"
mkdocs serve --dev-addr 0.0.0.0:8000
@echo "Open http://127.0.0.1:8001 in your browser"
$(PYTHON) -m mkdocs serve --dev-addr 127.0.0.1:8001

# Build static site
build:
Expand Down
2 changes: 1 addition & 1 deletion docs/archive/REVIEW_COMPARISON.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Python 侧最精巧的实现(1,554 行),三个关键设计:
#### 1.3.3 文档质量 — 评分:5.0/5.0

- `modularity.md` 以表格追踪架构边界和技术债务,达到工程级别
- `overhead-invariants.zh.md` 精确定义了开销不变性公式和测试要求
- `overhead.zh.md#change-invariants` 精确定义了开销不变性公式和测试要求
- `AGENTS.md` 为 AI 协作设计的编码规范
- 13 个 skill 各有 `SKILL.md` 人类文档
- API.md / CHANGELOG.md 维护良好
Expand Down
45 changes: 18 additions & 27 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,25 +92,19 @@ plugins:
Live Debugging: 现场调试
Troubleshooting: 常见问题
Architecture: 架构
Platform: 平台核心
Foundations: 基础架构
Collectors & Profiling: 采集与 Profiling
Distributed: 分布式
Distributed Query & Analysis: 分布式查询与分析
Modularity & Boundaries: 模块化与边界
Activation & Runtime Control: 启用、注入与运行时控制
Data Layer: 数据层
Extensibility: 扩展机制
CLI Command Tree: CLI 命令树
Profiling: 性能分析
Torch Profiler SQL: Torch Profiler SQL(Kineto 虚拟表)
Profiling & Tracing: 性能分析与 Tracing
Overhead: 开销测量
NCCL Profiler: NCCL Profiler
Debugging Engine: 调试引擎
Training Phases: 训练阶段
Overview: 概览
Torchrun Cluster Heartbeat: torchrun 集群心跳
Distributed Membership: 分布式成员与控制面
Federated Query Engine: 联邦查询引擎
Hierarchical Fan-out: 分层集群查询
Cluster with Pulsing: 基于 Pulsing 的集群
System Architecture (legacy): 系统架构(旧版)
Distributed Profiler: 分布式 Profiler 查询与可视化
Examples: 示例
Training Debugging: 训练调试
Memory Leak: 内存泄漏
Expand All @@ -122,6 +116,8 @@ plugins:
Skill Format: Skill 格式规范
Versions: 版本兼容性
Contributing: 贡献指南
Contributing Guide: 贡献指南
Documentation Style: 文档写作规范
Development Setup: 开发环境
Welcome Contributors: 欢迎参与开发
Welcome: 欢迎参与
Expand Down Expand Up @@ -152,26 +148,19 @@ nav:
- Troubleshooting: guide/troubleshooting.md
- Architecture:
- design/index.md
- Platform:
- Foundations:
- Modularity & Boundaries: design/modularity.md
- Activation & Runtime Control: design/activation-injection.md
- Data Layer: design/data-layer.md
- Extensibility: design/extensibility.md
- CLI Command Tree: design/cli.md
- Collectors & Profiling:
- Profiling: design/profiling.md
- Torch Profiler SQL: design/torch-profiler-sql.md
- Overhead: design/overhead.md
- Overhead invariants: design/overhead-invariants.md
- Profiling & Tracing: design/profiling.md
- NCCL Profiler: design/nccl-profiler.md
- Debugging Engine: design/debugging.md
- Training Phases: design/training-phase.md
- Distributed:
- Overview: design/distributed.md
- Torchrun Cluster Heartbeat: design/torchrun-cluster.md
- Overhead: design/overhead.md
- Distributed Query & Analysis:
- Distributed Membership: design/distributed.md
- Federated Query Engine: design/federation.md
- Hierarchical Fan-out: design/hierarchical-fanout.md
- Cluster with Pulsing: design/cluster-pulsing.md
- System Architecture (legacy): design/architecture.md
- Distributed Profiler: design/distributed-profiler.md
- Examples:
- examples/index.md
- Training Debugging: examples/training-debugging.md
Expand All @@ -185,7 +174,9 @@ nav:
- Environment Variables: reference/env-vars.md
- Skill Format: reference/skill-format.md
- Versions: versions.md
- Contributing: contributing.md
- Contributing:
- Contributing Guide: contributing.md
- Documentation Style: writing.md

extra:
generator: false
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ configure_backends(["memtable", "logger"]) # terminal + memtable
configure_backends(["memtable", "my_sink"])
```

### @table (dataclass plugins)
### @table (dataclass plugins) {#table-dataclass-plugins}

```python
from dataclasses import dataclass
Expand Down
2 changes: 1 addition & 1 deletion docs/src/api-reference.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ configure_backends(["memtable", "logger"]) # 终端 + memtable
configure_backends(["memtable", "my_sink"])
```

### @table(dataclass 插件)
### @table(dataclass 插件) {#table-dataclass-plugins}

```python
from dataclasses import dataclass
Expand Down
56 changes: 56 additions & 0 deletions docs/src/assets/architecture/probing-activation-paths.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 55 additions & 0 deletions docs/src/assets/architecture/probing-cli-control-surface.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading