agentx-harness 1.0.7__py3-none-any.whl

agentx_cli.py

@@ -0,0 +1,58 @@
+# SPDX-FileCopyrightText: Copyright (c) 2026 SemiAnalysis. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+"""AgentX command-line branding and defaults over the upstream AIPerf CLI."""
+
+from __future__ import annotations
+
+import sys
+from collections.abc import Sequence
+from importlib.metadata import PackageNotFoundError, version
+
+from cyclopts import App
+
+from aiperf.cli import app as aiperf_app
+
+
+def _version() -> str:
+    """Read the AgentX distribution version independently of upstream AIPerf."""
+    try:
+        return version("agentx-harness")
+    except PackageNotFoundError:
+        return "unknown"
+
+
+app = App(
+    name="agentx",
+    version=_version,
+    help=(
+        "AgentX Harness - agentic inference benchmarking, powered by AIPerf.\n\n"
+        "The profile command defaults to --scenario agentx when using CLI flags. "
+        "An explicit --scenario takes precedence. With --config/-f, the YAML "
+        "configuration supplies the scenario."
+    ),
+)
+app.update(aiperf_app)
+# Copied root commands are bound to AIPerf; bind these to the branded app.
+app.help_flags = ("--help", "-h")
+app.version_flags = ("--version",)
+del app["--install-completion"]
+app.register_install_completion_command()
+
+
+def main(argv: Sequence[str] | None = None) -> None:
+    """Run the upstream commands with AgentX defaults for flag-based profiles."""
+    tokens = list(sys.argv[1:] if argv is None else argv)
+    if tokens and tokens[0] == "profile":
+        options = tokens[1 : tokens.index("--") if "--" in tokens else len(tokens)]
+        has_scenario_or_config = any(
+            token in {"--scenario", "--config", "-f"}
+            or token.startswith(("--scenario=", "--config=", "-f"))
+            for token in options
+        )
+        if not has_scenario_or_config:
+            tokens[1:1] = ["--scenario", "agentx"]
+    app(tokens)
+
+
+if __name__ == "__main__":
+    main()

agentx_harness-1.0.7.dist-info/METADATA

@@ -0,0 +1,402 @@
+Metadata-Version: 2.5
+Name: agentx-harness
+Version: 1.0.7
+Summary: SemiAnalysis AgentX inference benchmark harness, built on AIPerf
+Project-URL: Homepage, https://github.com/SemiAnalysisAI/agentx-harness
+Project-URL: Source, https://github.com/SemiAnalysisAI/agentx-harness
+Project-URL: Issues, https://github.com/SemiAnalysisAI/agentx-harness/issues
+Author-email: "NVIDIA Inc." <sw-dl-dynamo@nvidia.com>
+License: Apache-2.0
+License-File: ATTRIBUTIONS.md
+License-File: LICENSE
+Requires-Python: <3.14,>=3.11
+Requires-Dist: aiofiles~=24.1.0
+Requires-Dist: aiohttp~=3.13.3
+Requires-Dist: crick~=0.0.8
+Requires-Dist: cyclopts<5,>=4
+Requires-Dist: dash-bootstrap-components~=2.0.0
+Requires-Dist: dash~=3.1.0
+Requires-Dist: datasets>=3.0,>=4.7.0; platform_system != 'Windows' or platform_machine != 'ARM64'
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: ffmpeg-python~=0.2.0
+Requires-Dist: filelock>=3.13
+Requires-Dist: huggingface-hub<2.0,>=0.34.0
+Requires-Dist: jinja2~=3.1.5
+Requires-Dist: jmespath~=1.0.1
+Requires-Dist: kaleido~=1.2.0
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: msgspec<1.0.0,>=0.19.0
+Requires-Dist: numpy<3,>=1.26.4
+Requires-Dist: nvidia-ml-py
+Requires-Dist: optuna>=3.6
+Requires-Dist: orjson~=3.11.7
+Requires-Dist: pandas~=2.3.3
+Requires-Dist: pillow~=12.2.0
+Requires-Dist: plotly~=6.4.0
+Requires-Dist: prometheus-client~=0.23.1
+Requires-Dist: protobuf>=4
+Requires-Dist: psutil~=7.0.0
+Requires-Dist: pyarrow>=18.0.0; platform_system != 'Windows' or platform_machine != 'ARM64'
+Requires-Dist: pydantic-settings<3.0.0,>=2.10.0
+Requires-Dist: pydantic<3.0.0,>=2.10.0
+Requires-Dist: pyzmq~=26.4.0
+Requires-Dist: rich~=14.1.0
+Requires-Dist: ruamel-yaml~=0.18.12
+Requires-Dist: scipy>=1.13.0
+Requires-Dist: seaborn~=0.13.2
+Requires-Dist: sentencepiece>=0.2.0
+Requires-Dist: setproctitle~=1.3.6
+Requires-Dist: soundfile~=0.13.1
+Requires-Dist: starlette-compress>=1.0.1
+Requires-Dist: textual~=5.3.0
+Requires-Dist: tiktoken<1,>=0.7.0
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: transformers>=4.56.0
+Requires-Dist: uvicorn[standard]<1,>=0.34
+Requires-Dist: uvloop>=0.22.1; platform_system != 'Windows'
+Requires-Dist: zstandard>=0.25.0
+Provides-Extra: accuracy
+Requires-Dist: deepeval<5.0.0,>=2.9.0; extra == 'accuracy'
+Requires-Dist: latex2sympy2-extended>=1.0.6; extra == 'accuracy'
+Requires-Dist: lighteval>=0.13.0; extra == 'accuracy'
+Requires-Dist: sympy>=1.14.0; extra == 'accuracy'
+Provides-Extra: botorch
+Requires-Dist: botorch>=0.10; extra == 'botorch'
+Requires-Dist: gpytorch>=1.11; extra == 'botorch'
+Requires-Dist: optuna-integration>=3.6; extra == 'botorch'
+Requires-Dist: torch>=2.0; extra == 'botorch'
+Provides-Extra: dev
+Requires-Dist: black>=25.1.0; extra == 'dev'
+Requires-Dist: httpx>=0.27.0; extra == 'dev'
+Requires-Dist: hypothesis<6.156,>=6.0.0; (platform_system == 'Windows' and platform_machine == 'ARM64') and extra == 'dev'
+Requires-Dist: hypothesis>=6.0.0; (platform_system != 'Windows' or platform_machine != 'ARM64') and extra == 'dev'
+Requires-Dist: jsonschema>=4.0.0; extra == 'dev'
+Requires-Dist: looptime>=0.5; extra == 'dev'
+Requires-Dist: mlflow<4.0.0,>=3.10.0; extra == 'dev'
+Requires-Dist: opentelemetry-exporter-otlp-proto-http<2.0.0,>=1.24.0; extra == 'dev'
+Requires-Dist: opentelemetry-sdk<2.0.0,>=1.24.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-rerunfailures>=15.0; extra == 'dev'
+Requires-Dist: pytest-timeout>=2.0.0; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.8.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff<0.15.0,>=0.14.0; extra == 'dev'
+Requires-Dist: trustme>=1.0.0; (platform_system != 'Windows' or platform_machine != 'ARM64') and extra == 'dev'
+Requires-Dist: wandb<1.0.0,>=0.19.0; extra == 'dev'
+Provides-Extra: mlflow
+Requires-Dist: mlflow<4.0.0,>=3.10.0; extra == 'mlflow'
+Provides-Extra: optuna
+Requires-Dist: botorch>=0.10; extra == 'optuna'
+Requires-Dist: gpytorch>=1.11; extra == 'optuna'
+Requires-Dist: optuna-integration>=3.6; extra == 'optuna'
+Requires-Dist: torch>=2.0; extra == 'optuna'
+Provides-Extra: otel
+Requires-Dist: opentelemetry-exporter-otlp-proto-http<2.0.0,>=1.24.0; extra == 'otel'
+Requires-Dist: opentelemetry-sdk<2.0.0,>=1.24.0; extra == 'otel'
+Provides-Extra: test
+Requires-Dist: httpx>=0.27.0; extra == 'test'
+Requires-Dist: hypothesis<6.156,>=6.0.0; (platform_system == 'Windows' and platform_machine == 'ARM64') and extra == 'test'
+Requires-Dist: hypothesis>=6.0.0; (platform_system != 'Windows' or platform_machine != 'ARM64') and extra == 'test'
+Requires-Dist: jsonschema>=4.0.0; extra == 'test'
+Requires-Dist: looptime>=0.5; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-rerunfailures>=15.0; extra == 'test'
+Requires-Dist: pytest-timeout>=2.0.0; extra == 'test'
+Requires-Dist: pytest-xdist>=3.8.0; extra == 'test'
+Requires-Dist: pytest>=7.0.0; extra == 'test'
+Requires-Dist: trustme>=1.0.0; (platform_system != 'Windows' or platform_machine != 'ARM64') and extra == 'test'
+Provides-Extra: wandb
+Requires-Dist: wandb<1.0.0,>=0.19.0; extra == 'wandb'
+Description-Content-Type: text/markdown
+
+
+<!--
+SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+SPDX-License-Identifier: Apache-2.0
+-->
+
+
+# AgentX Harness
+
+## Realistic 1mil Long Context, Multi Turn Agentic Workload Trace Replayer, collected from over $3mil USD of Traces
+
+https://inferencex.semianalysis.com/datasets
+
+## Install and run AgentX
+
+Requires Python 3.11–3.13. Install the version matching the GitHub release:
+
+```bash
+pip install agentx-harness==1.0.7
+
+agentx profile \
+  --url "$SERVER_URL" --endpoint /v1/chat/completions \
+  --model "$SERVED_MODEL_NAME" --tokenizer "$TOKENIZER" \
+  --tokenizer-trust-remote-code \
+  --concurrency "$CONC" \
+  --public-dataset "$DATASET" \
+  --output-artifact-dir "$OUTPUT_DIR"
+```
+
+`agentx profile` selects the AgentX scenario automatically. Explicit flags
+override its defaults; `--config`/`-f` uses the scenario and settings in the
+YAML file. See the [AgentX guide](docs/tutorials/agentx-mvp.md) for dataset
+choices and benchmark settings. The underlying `aiperf` command remains
+available for compatibility.
+
+Install in a dedicated virtual environment: this distribution includes the
+fork's `aiperf` Python package and should not be installed alongside the
+upstream `aiperf` distribution. On Linux ARM64, the `crick` dependency requires
+a C compiler to build.
+
+The package name is `agentx-harness`; the command is `agentx`. Releases tagged
+`agentx-vX.Y.Z` publish version `X.Y.Z` automatically to PyPI.
+
+## Original README.md Below
+
+# AIPerf
+
+[![PyPI version](https://img.shields.io/pypi/v/AIPerf)](https://pypi.org/project/aiperf/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Codecov](https://codecov.io/gh/ai-dynamo/aiperf/graph/badge.svg)](https://codecov.io/gh/ai-dynamo/aiperf)
+[![Discord](https://dcbadge.limes.pink/api/server/D92uqZRjCZ?style=flat)](https://discord.gg/D92uqZRjCZ)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ai-dynamo/aiperf)
+
+AIPerf is a comprehensive benchmarking tool that measures the performance of generative AI models served by your preferred inference solution. It provides detailed metrics using a command line display as well as extensive benchmark performance reports.
+
+<img width="1724" height="670" alt="AIPerf UI Dashboard" src="https://github.com/user-attachments/assets/7eb40867-b1c1-4ebe-bd57-7619f2154bba" />
+
+## Quick Start
+
+This quick start guide leverages [Ollama](https://ollama.com/) via
+ [Docker Desktop](https://www.docker.com/products/docker-desktop/).
+
+### Setting up a Local Server
+
+In order to set up an Ollama server, run `granite4:350m` using the following commands:
+
+```bash
+docker run -d \
+  --name ollama \
+  -p 11434:11434 \
+  -v ollama-data:/root/.ollama \
+  ollama/ollama:latest
+docker exec -it ollama ollama pull granite4:350m
+```
+
+### Basic Usage
+
+Create a virtual environment and install AIPerf:
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install aiperf
+```
+
+> [!NOTE]
+> On Linux **aarch64** (`arm64`), one of AIPerf's dependencies (`crick`)
+> ships only an sdist and needs a C compiler at install time. Install
+> the system build toolchain before `pip install aiperf` —
+> `sudo apt install build-essential` (Debian/Ubuntu),
+> `sudo yum groupinstall "Development Tools"` (RHEL/CentOS), or
+> equivalent. Linux x86_64, macOS, and Windows install from pre-built
+> wheels and need no toolchain.
+
+Optional integrations:
+- `pip install "aiperf[mlflow]"` enables MLflow uploads and live telemetry streaming
+- `pip install "aiperf[otel]"` enables OpenTelemetry metric streaming
+- `pip install "aiperf[wandb]"` enables Weights & Biases result uploads
+- `pip install "aiperf[mlflow,otel,wandb]"` installs all telemetry extras
+
+To run a simple benchmark against your Ollama server:
+
+```bash
+aiperf profile \
+  --model "granite4:350m" \
+  --streaming \
+  --endpoint-type chat \
+  --tokenizer ibm-granite/granite-4.0-micro \
+  --url http://localhost:11434 \
+  --request-count 10
+```
+
+
+### Example with Custom Configuration
+
+```bash
+aiperf profile \
+  --model "granite4:350m" \
+  --streaming \
+  --endpoint-type chat \
+  --tokenizer ibm-granite/granite-4.0-micro \
+  --url http://localhost:11434 \
+  --concurrency 5 \
+  --request-count 10
+```
+
+Example output:
+
+
+**NOTE:** The example performance is reflective of a CPU-only run and does not represent an official benchmark.
+
+```bash
+                                               NVIDIA AIPerf | LLM Metrics
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓
+┃                               Metric ┃       avg ┃      min ┃       max ┃       p99 ┃       p90 ┃       p50 ┃      std ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩
+│             Time to First Token (ms) │  7,463.28 │ 7,125.81 │  9,484.24 │  9,295.48 │  7,596.62 │  7,240.23 │   677.23 │
+│            Time to Second Token (ms) │     68.73 │    32.01 │    102.86 │    102.55 │     99.80 │     67.37 │    24.95 │
+│      Time to First Output Token (ms) │  7,463.28 │ 7,125.81 │  9,484.24 │  9,295.48 │  7,596.62 │  7,240.23 │   677.23 │
+│                 Request Latency (ms) │ 13,829.40 │ 9,029.36 │ 27,905.46 │ 27,237.77 │ 21,228.48 │ 11,338.31 │ 5,614.32 │
+│             Inter Token Latency (ms) │     65.31 │    53.06 │     81.31 │     81.24 │     80.64 │     63.79 │     9.09 │
+│     Output Token Throughput Per User │     15.60 │    12.30 │     18.85 │     18.77 │     18.08 │     15.68 │     2.05 │
+│                    (tokens/sec/user) │           │          │           │           │           │           │          │
+│      Output Sequence Length (tokens) │     95.20 │    29.00 │    295.00 │    283.12 │    176.20 │     63.00 │    77.08 │
+│       Input Sequence Length (tokens) │    550.00 │   550.00 │    550.00 │    550.00 │    550.00 │    550.00 │     0.00 │
+│ Output Token Throughput (tokens/sec) │      6.85 │      N/A │       N/A │       N/A │       N/A │       N/A │      N/A │
+│    Request Throughput (requests/sec) │      0.07 │      N/A │       N/A │       N/A │       N/A │       N/A │      N/A │
+│             Request Count (requests) │     10.00 │      N/A │       N/A │       N/A │       N/A │       N/A │      N/A │
+└──────────────────────────────────────┴───────────┴──────────┴───────────┴───────────┴───────────┴───────────┴──────────┘
+
+CLI Command: aiperf profile --model 'granite4:350m' --streaming --endpoint-type 'chat' --tokenizer 'ibm-granite/granite-4.0-micro' --url 'http://localhost:11434'
+Benchmark Duration: 138.89 sec
+CSV Export: /home/user/aiperf/artifacts/granite4:350m-openai-chat-concurrency1/profile_export_aiperf.csv
+JSON Export: /home/user/Code/aiperf/artifacts/granite4:350m-openai-chat-concurrency1/profile_export_aiperf.json
+Log File: /home/user/Code/aiperf/artifacts/granite4:350m-openai-chat-concurrency1/logs/aiperf.log
+```
+
+## Features
+
+- Scalable multiprocess architecture with 10 services communicating via ZMQ
+- 3 UI modes: `dashboard` (real-time TUI), `simple` (progress bars), `none` (headless)
+- Multiple benchmarking modes: concurrency, request-rate, [request-rate with max concurrency](docs/tutorials/request-rate-concurrency.md), [trace replay](docs/benchmark-modes/trace-replay.md)
+- Extensible plugin system for endpoints, datasets, transports, and metrics
+- [Public dataset support](docs/benchmark-datasets.md) including ShareGPT and custom formats
+
+## Supported APIs
+
+- OpenAI chat completions, completions, embeddings, audio, images
+- NIM embeddings, rankings
+
+## Tutorials and Feature Guides
+
+### Getting Started
+- [Basic Tutorial](docs/tutorial.md) - Profile Qwen3-0.6B with vLLM
+- [Comprehensive Benchmarking Guide](docs/comprehensive-llm-benchmarking.md) - 5 real-world use cases
+- [Interactive Chat Sanity Checks](docs/tutorials/interactive-chat.md) - Talk to an endpoint with `aiperf chat` and see per-turn TTFT/TPS/ITL
+- [YAML Configuration Files](docs/tutorials/yaml-config.md) - Drive AIPerf from a config file instead of CLI flags
+- [Sampling Distributions in YAML Configs](docs/tutorials/yaml-distributions.md) - Fixed, Normal, Log-normal, Multimodal, and Empirical shapes for ISL/OSL/turns/etc.
+- [User Interface](docs/tutorials/ui-types.md) - Dashboard, simple, or headless
+- [Hugging Face TGI](docs/tutorials/huggingface-tgi.md) - Profile Hugging Face TGI models
+- [OpenAI Text Endpoints](docs/tutorials/openai-text-endpoints.md) - Profile OpenAI-compatible text APIs
+
+### Load Control and Timing
+- [Request Rate with Max Concurrency](docs/tutorials/request-rate-concurrency.md) - Dual request control
+- [Arrival Patterns](docs/tutorials/arrival-patterns.md) - Constant, Poisson, gamma traffic
+- [Prefill Concurrency](docs/tutorials/prefill-concurrency.md) - Memory-safe long-context benchmarking
+- [Adaptive Scale](docs/tutorials/adaptive-scale.md) - Single-run SLA boundary discovery and sustain
+- [Gradual Ramping](docs/tutorials/ramping.md) - Smooth ramp-up of concurrency and request rate
+- [Warmup Phase](docs/tutorials/warmup.md) - Eliminate cold-start effects
+- [User-Centric Timing](docs/tutorials/user-centric-timing.md) - Per-user rate limiting for KV cache benchmarking
+- [Request Cancellation](docs/tutorials/request-cancellation.md) - Timeout and resilience testing
+- [Multi-URL Load Balancing](docs/tutorials/multi-url-load-balancing.md) - Distribute across servers
+
+### Workloads and Data
+- [Trace Benchmarking](docs/benchmark-modes/trace-replay.md) - Deterministic workload replay
+- [Bailian Traces](docs/tutorials/bailian-trace.md) - Bailian production trace replay
+- [Baseten Traces](docs/tutorials/baseten-trace.md) - Baseten Parquet production trace replay
+- [BurstGPT Traces](docs/tutorials/burst-gpt-trace.md) - BurstGPT real-world bursty traffic trace replay
+- [SageMaker Data Capture](docs/tutorials/sagemaker-data-capture.md) - Replay production traffic from SageMaker endpoints
+- [Custom Prompt Benchmarking](docs/tutorials/custom-prompt-benchmarking.md) - Send exact prompts as-is
+- [Custom Dataset](docs/tutorials/custom-dataset.md) - Custom dataset formats
+- [Inline Datasets](docs/tutorials/inline-datasets.md) - Embed records directly in the YAML config (single_turn, multi_turn, multi-pool random_pool, traces)
+- [ShareGPT Dataset](docs/tutorials/sharegpt.md) - Profile with ShareGPT dataset
+- [AIMO Dataset](docs/tutorials/aimo.md) - Profile with AIMO math reasoning datasets (NuminaMath-TIR, NuminaMath-CoT, NuminaMath-1.5, AIME)
+- [MMStar Dataset](docs/tutorials/mmstar.md) - Profile vision language models with MMStar visual QA benchmark
+- [MMVU Dataset](docs/tutorials/mmvu.md) - Profile video language models with MMVU expert-level video understanding benchmark
+- [VisionArena Dataset](docs/tutorials/vision-arena.md) - Profile with real-world vision conversations from Chatbot Arena
+- [LLaVA-OneVision Dataset](docs/tutorials/llava-onevision.md) - Profile with diverse multimodal instruction-following data
+- [SPEED-Bench Dataset](docs/tutorials/speed-bench.md) - Profile speculative decoding with SPEED-Bench
+- [Per-Request Spec-Decode Metrics](docs/tutorials/spec-decode-metrics.md) - Inline per-request acceptance length, draft rate, and pooled histogram from a normal profile run
+- [InstructCoder Dataset](docs/tutorials/instruct-coder.md) - Profile with InstructCoder code generation dataset
+- [SpecBench Dataset](docs/tutorials/spec-bench.md) - Profile with SpecBench speculative decoding dataset
+- [Blazedit Dataset](docs/tutorials/blazedit.md) - Profile with Blazedit code editing dataset
+- [ASR Datasets](docs/tutorials/asr.md) - Profile ASR models with LibriSpeech, VoxPopuli, GigaSpeech, AMI, and SPGISpeech
+- [Synthetic Dataset Generation](docs/tutorials/synthetic-dataset.md) - Generate synthetic datasets
+- [Agentic Code Generator](docs/tutorials/agentic-code-generator.md) - Generate multi-turn coding-agent traces for KV cache benchmarking
+- [Weka Traces](docs/tutorials/weka-trace.md) - Replay real agentic coding sessions with KV-cache-aware Weka traces
+- [AgentX scenarios](docs/tutorials/agentx-mvp.md) - InferenceX defaults (`--scenario agentx`) and the original MVP benchmark (`--scenario inferencex-agentx-mvp`)
+- [Fixed Schedule](docs/tutorials/fixed-schedule.md) - Precise timestamp-based execution
+- [Time-based Benchmarking](docs/tutorials/time-based-benchmarking.md) - Duration-based testing
+- [Sequence Distributions](docs/tutorials/sequence-distributions.md) - Mixed ISL/OSL pairings
+- [Prefix Synthesis](docs/tutorials/prefix-synthesis.md) - Prefix data synthesis for KV cache testing
+- [Reproducibility](docs/reproducibility.md) - Deterministic datasets with `--random-seed`
+- [Template Endpoint](docs/tutorials/template-endpoint.md) - Custom Jinja2 request templates
+- [Multi-Turn Conversations](docs/tutorials/multi-turn.md) - Multi-turn conversation benchmarking
+- [Raw Payload Replay](docs/tutorials/raw-payload-replay.md) - Verbatim JSONL payload replay (single file or directory)
+- [Inputs JSON Replay](docs/tutorials/inputs-json-replay.md) - Verbatim multi-turn replay of AIPerf inputs.json artifacts
+- [Local Tokenizer](docs/tutorials/local-tokenizer.md) - Use local tokenizers without HuggingFace
+
+### Endpoint Types
+- [Embeddings](docs/tutorials/embeddings.md) - Profile embedding models
+- [Rankings](docs/tutorials/rankings.md) - Profile ranking models
+- [OpenAI Responses API](docs/tutorials/openai-responses.md) - Profile OpenAI Responses API endpoints
+- [Audio](docs/tutorials/audio.md) - Profile audio language models
+- [NIM Image Retrieval](docs/tutorials/nim-image-retrieval.md) - Profile NIM image retrieval models
+- [Vision](docs/tutorials/vision.md) - Profile vision language models
+- [Image Generation](docs/tutorials/image-generation.md) - Benchmark any OpenAI-compatible image generation API
+- [SGLang Image Edit](docs/tutorials/sglang-image-edit.md) - Benchmark OpenAI-compatible image-to-image (image edit) endpoints
+- [SGLang Video Generation](docs/tutorials/sglang-video-generation.md) - Video generation benchmarking
+- [Synthetic Video](docs/tutorials/synthetic-video.md) - Synthetic video generation
+
+### Analysis and Monitoring
+- [Timeslice Metrics](docs/tutorials/timeslices.md) - Per-timeslice performance analysis
+- [Goodput](docs/tutorials/goodput.md) - SLO-based throughput measurement
+- [Parameter Sweeps](docs/tutorials/sweeps.md) - YAML reference for grid/zip/scenarios sweeps + multi-run, with picker for choosing a sweep mode
+- [Adaptive Search](docs/tutorials/adaptive-search.md) - Bayesian-optimization walkthrough (single-objective + multi-objective Pareto)
+- [Adaptive Scale](docs/tutorials/adaptive-scale.md) - Single-run SLA boundary discovery and sustain
+- [Search Recipes](docs/sweeping/search-recipes.md) - Named recipe catalog including `pareto-sweep`, `max-throughput-ttft-sla`, `max-concurrency-under-sla`
+- [HTTP Trace Metrics](docs/tutorials/http-trace-metrics.md) - DNS, TCP/TLS, TTFB timing
+- [Multi-Run Confidence](docs/tutorials/multi-run-confidence.md) - Confidence intervals across repeated runs
+- [Profile Exports](docs/tutorials/working-with-profile-exports.md) - Post-processing with Pydantic models
+- [Visualization and Plotting](docs/tutorials/plot.md) - PNG charts and multi-run comparison
+- [Auto-Plot After Profile](docs/tutorials/auto-plot.md) - Run `aiperf plot` automatically after `aiperf profile`
+- [GPU Telemetry](docs/tutorials/gpu-telemetry.md) - DCGM metrics collection
+- [OTel + MLflow Live Telemetry](docs/tutorials/otel-mlflow.md) - Stream metrics to OTel and MLflow in real time
+- [Weights & Biases Export](docs/tutorials/wandb.md) - Upload results tables and artifacts to wandb
+- [Server Metrics](docs/server-metrics/server-metrics.md) - Prometheus-compatible metrics
+
+## Documentation
+
+| Document | Purpose |
+|----------|---------|
+| [Architecture](docs/architecture.md) | Three-plane architecture, core components, credit system, data flow |
+| [CLI Options](docs/cli-options.md) | Complete command and option reference |
+| [Metrics Reference](docs/metrics-reference.md) | All metric definitions, formulas, and requirements |
+| [Environment Variables](docs/environment-variables.md) | All `AIPERF_*` configuration variables |
+| [Plugin System](docs/plugins/plugin-system.md) | Plugin architecture, 25+ categories, creation guide |
+| [Creating Plugins](docs/plugins/creating-your-first-plugin.md) | Step-by-step plugin tutorial |
+| [Accuracy Benchmarks](docs/accuracy/accuracy-benchmarking.md) | Accuracy evaluation against MMLU, AIME, and other benchmarks |
+| [Benchmark Modes](docs/benchmark-modes/trace-replay.md) | Trace replay and timing modes |
+| [Server Metrics](docs/server-metrics/server-metrics.md) | Prometheus-compatible server metrics collection |
+| [Tokenizer Auto-Detection](docs/reference/tokenizer-auto-detection.md) | Pre-flight tokenizer detection |
+| [Conversation Context Mode](docs/reference/conversation-context-mode.md) | How conversation history accumulates in multi-turn |
+| [Dataset Synthesis API](docs/api/synthesis.md) | Synthesis module API reference |
+| [Code Patterns](docs/dev/patterns.md) | Code examples for services, models, messages, plugins |
+| [Migrating from Genai-Perf](docs/migrating.md) | Migration guide and feature comparison |
+| [Design Proposals](https://github.com/ai-dynamo/enhancements) | Enhancement proposals and discussions |
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup, coding conventions, and contribution guidelines.
+
+## Known Issues
+
+- Output sequence length constraints (`--output-tokens-mean`) cannot be guaranteed unless you pass `ignore_eos` and/or `min_tokens` via `--extra-inputs` to an inference server that supports them.
+- Very high concurrency settings (typically >15,000) may lead to port exhaustion on some systems. Adjust system limits or reduce concurrency if connection failures occur.
+- Startup errors caused by invalid configuration settings can cause AIPerf to hang indefinitely. Terminate the process and check configuration settings.
+- Copying selected text may not work reliably in the dashboard UI. Use the `c` key to copy all logs.