Skip to content

Commit ad7c67c

Browse files
authored
Merge pull request #24 from KraHsu/docs/profiling-discoverability
Surface `prof` in the CLI overview and landing page
2 parents 0af18a5 + 7b00db0 commit ad7c67c

3 files changed

Lines changed: 3 additions & 1 deletion

File tree

‎docs/cli/overview.en.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ uv run genelab [GLOBAL OPTIONS] <subcommand> [ARGS]
1717
| `list tasks` | List registered tasks from the `TASKS` registry. |
1818
| `play` | Run a registered task in the configured Genesis backend; supports config overrides. |
1919
| `train` | Train a registered task when an RL runner exists; supports multi-GPU via `torchrun`. |
20+
| `prof open` | Launch TensorBoard against a `torch.profiler` trace directory. |
2021
| `project new` | Scaffold a new external extension package with all three registries wired up. |
2122

2223
## Global options

‎docs/cli/overview.zh.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ uv run genelab [全局选项] <子命令> [参数]
1717
| `list tasks` | 列出 `TASKS` 注册表里已注册的任务。 |
1818
| `play` | 在 Genesis 后端运行已注册任务,支持配置 override。 |
1919
| `train` | 任务带 RL runner 时启动训练,通过 `torchrun` 支持多 GPU。 |
20+
| `prof open` | 针对 `torch.profiler` 跟踪目录启动 TensorBoard。 |
2021
| `project new` | 生成一个新的下游扩展包骨架,三种注册表全部接通。 |
2122

2223
## 全局选项

‎src/genelab/cli/_render.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ def render_main_help() -> None:
7171
console.print(" [entry.name]Registry[/] list, info")
7272
console.print(" [entry.name]Runtime[/] play, train")
7373
console.print(" [entry.name]Project[/] project new")
74-
console.print(" [entry.name]Utilities[/] cache")
74+
console.print(" [entry.name]Utilities[/] cache, prof open")
7575
console.print()
7676
console.print(
7777
f"[entry.detail]Registered:[/] {robot_count} robots, {env_count} envs, {task_count} tasks"

0 commit comments

Comments
 (0)