derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
76 lines
3.4 KiB
Markdown
76 lines
3.4 KiB
Markdown
# PerfXpert documentation
|
|
|
|
Top-level index for everything under `docs/`. The repo-level
|
|
[README.md](../README.md) is the user-facing entry point; this index is
|
|
the map for everything that follows.
|
|
|
|
## Start here
|
|
|
|
| You want to… | Read |
|
|
|--------------|------|
|
|
| Install + run your first analysis | [guides/getting-started.md](guides/getting-started.md) |
|
|
| Understand the agentic pipeline | [guides/agentic-mode.md](guides/agentic-mode.md) |
|
|
| Embed PerfXpert in your own tool | [guides/python-api.md](guides/python-api.md) |
|
|
| Drive PerfXpert from a backend (opencode / claude / codex / gemini) | [guides/backends.md](guides/backends.md) |
|
|
|
|
## By area
|
|
|
|
| Area | Index |
|
|
|------|-------|
|
|
| User guides (install, formats, providers, MCP) | [guides/README.md](guides/README.md) |
|
|
| Architecture (agent hierarchy, gate cascade, backend adapter) | [architecture/README.md](architecture/README.md) |
|
|
| Integration (MCP server, REST shim) | [integration/README.md](integration/README.md) |
|
|
| Contributing (extension surfaces, governance, audit gate) | [contributing/README.md](contributing/README.md) |
|
|
| RFCs (architectural change proposals) | [rfcs/README.md](rfcs/README.md) |
|
|
| Benchmarks (proven optimizations baselines) | [benchmarks/](benchmarks/) |
|
|
| Archive (pre-agentic migration notes) | [archive/](archive/) |
|
|
|
|
## File quick-reference
|
|
|
|
```
|
|
docs/
|
|
├── README.md ← you are here
|
|
├── architecture.md ← top-level system overview
|
|
├── architecture/
|
|
│ ├── README.md ← architecture sub-index
|
|
│ ├── agent-hierarchy.md ← Root → Analysis → Recommendation → specialists
|
|
│ ├── gate-cascade.md ← correctness gate + revert path
|
|
│ └── backend-adapter.md ← per-backend installer / verifier surface
|
|
├── guides/
|
|
│ ├── README.md ← guides sub-index
|
|
│ ├── getting-started.md ← install, run, formats, providers, troubleshooting
|
|
│ ├── agentic-mode.md ← how the agent brain works at runtime
|
|
│ ├── python-api.md ← `perfxpert.api.*` — 1:1 mirror of the agent MCP tools
|
|
│ ├── backends.md ← perfxpert-code dispatch matrix
|
|
│ └── assets/gifs/ ← checked-in guide demo recordings
|
|
├── integration/
|
|
│ ├── README.md
|
|
│ └── mcp-server.md ← the MCP wire surface (56 tools)
|
|
├── contributing/
|
|
│ ├── README.md ← per-surface extension guides
|
|
│ ├── tools.md, knowledge.md, providers.md, agents.md, mcp_tools.md,
|
|
│ │ output_formats.md, schemas.md, fixtures.md, gpu_arch.md,
|
|
│ │ external-tools.md, proven_optimizations.md
|
|
│ ├── governance.md
|
|
│ ├── audit_gate_runbook.md
|
|
│ └── walkthrough_new_bottleneck_class.md
|
|
├── rfcs/
|
|
│ ├── README.md
|
|
│ ├── TEMPLATE.md
|
|
│ └── 0000-example-rfc.md
|
|
├── benchmarks/
|
|
│ └── mi300x_baseline.md
|
|
└── archive/
|
|
└── migration-to-agentic.md
|
|
```
|
|
|
|
## Conventions
|
|
|
|
- Every Python / bash code block intended as illustrative (not executable
|
|
in CI) is prefixed with `# SKIP-SAMPLE — <reason>` so
|
|
`scripts/test-samples.py --strict` skips it.
|
|
- All cross-doc links are relative paths within this tree; external links
|
|
are flagged out-of-scope by `scripts/link-checker.py`.
|
|
- The user-facing brand is **PerfXpert**. `rocinsight` / `ROCINSIGHT` are
|
|
retired and should not appear in any new doc.
|