Documentation cleanup, refactor

Signed-off-by: Rashid Kaleem <230885705+arekay-nv@users.noreply.github.com>

Author: arekay-nv

AGENTS.md

@@ -9,10 +9,7 @@ High-performance benchmarking tool for LLM inference endpoints targeting 50k+ QP
 ## Common Commands
 
 ```bash
-# Development setup
-python3.12 -m venv venv && source venv/bin/activate
-pip install -e ".[dev,test]"
-pre-commit install
+# Development setup — see docs/DEVELOPMENT.md for full instructions
 
 # Testing
 pytest                                        # All tests (excludes slow/performance)
@@ -137,10 +134,13 @@ src/inference_endpoint/
 │   └── utils.py               # Port range helpers
 ├── async_utils/
 │   ├── loop_manager.py        # LoopManager (uvloop + eager_task_factory)
+│   ├── runner.py              # run_async() — uvloop + eager_task_factory entry point for CLI commands
 │   ├── event_publisher.py     # Async event pub/sub
+│   ├── services/
+│   │   ├── event_logger/      # EventLoggerService: writes EventRecords to JSONL/SQLite
+│   │   └── metrics_aggregator/ # MetricsAggregatorService: real-time metrics (TTFT, TPOT, ISL, OSL)
 │   └── transport/             # ZMQ-based IPC transport layer
 │       ├── protocol.py        # Transport protocol definitions
-│       ├── record.py          # Transport records
 │       └── zmq/               # ZMQ implementation (context, pubsub, transport)
 ├── dataset_manager/
 │   ├── dataset.py             # Dataset base class, DatasetFormat enum
@@ -192,25 +192,9 @@ tests/
 
 ## Development Standards
 
-### Code Style
+### Code Style and Pre-commit Hooks
 
-- **Formatter/Linter**: `ruff` (line-length 88, target Python 3.12)
-- **Type checking**: `mypy` (via pre-commit)
-- **Formatting**: `ruff-format` (double quotes, space indent)
-- **License headers**: Required on all Python files (enforced by pre-commit hook `scripts/add_license_header.py`)
-- **Conventional commits**: `feat:`, `fix:`, `docs:`, `test:`, `chore:`
-
-### Pre-commit Hooks
-
-All of these run automatically on commit:
-
-- trailing-whitespace, end-of-file-fixer, check-yaml, check-merge-conflict, debug-statements
-- `ruff` (lint + autofix) and `ruff-format`
-- `mypy` type checking
-- `prettier` for YAML/JSON/Markdown
-- License header enforcement
-
-**Always run `pre-commit run --all-files` before committing.**
+See [Development Guide](docs/DEVELOPMENT.md) for formatting, linting, and pre-commit hook details.
 
 ### Data Types & Serialization
 
@@ -291,7 +275,7 @@ Update AGENTS.md as part of any PR that includes a **significant refactor**, mea
 - **Added or removed CLI commands/subcommands** — update CLI Modes and Common Commands
 - **Changed test infrastructure** (new fixtures, changed markers, new test directories) — update Testing section
 - **Added or removed key dependencies** — update Key Dependencies table
-- **Changed build/tooling** (new pre-commit hooks, changed ruff config, new CI steps) — update Code Style and Pre-commit Hooks
+- **Changed build/tooling** (new pre-commit hooks, changed ruff config, new CI steps) — update [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)
 - **Changed hot-path patterns** (new transport, changed serialization, new performance constraints) — update Performance Guidelines
 
 ### How to Update

CONTRIBUTING.md

@@ -7,3 +7,5 @@ Generally we encourage people to become MLCommons members if they wish to contri
 Regardless of whether you are a member, your organization (or you as an individual contributor) needs to sign the MLCommons Contributor License Agreement (CLA). Please submit your GitHub username to the [MLCommons Subscription form](https://mlcommons.org/community/subscribe/) to start that process.
 
 MLCommons project work is tracked with issue trackers and pull requests. Modify the project in your own fork and issue a pull request once you want other developers to take a look at what you have done and discuss the proposed changes. Ensure that cla-bot and other checks pass for your pull requests.
+
+For project-specific development standards (code style, test requirements, pre-commit hooks, commit format), see the [Development Guide](docs/DEVELOPMENT.md).

README.md

@@ -68,7 +68,7 @@ inference-endpoint benchmark offline \
 
 ```bash
 # Start local echo server
-python -m inference_endpoint.testing.echo_server --port 8765 &
+python3 -m inference_endpoint.testing.echo_server --port 8765 &
 
 # Test with dummy dataset (included in repo)
 inference-endpoint benchmark offline \
@@ -96,33 +96,51 @@ pytest -m "not performance and not run_explicitly"
 
 ## 📚 Documentation
 
+- [AGENTS.md](AGENTS.md) - Architecture, conventions, and AI agent guidelines
 - [CLI Quick Reference](docs/CLI_QUICK_REFERENCE.md) - Command-line interface guide
 - [Local Testing Guide](docs/LOCAL_TESTING.md) - Test with echo server
 - [Development Guide](docs/DEVELOPMENT.md) - How to contribute and develop
+- [Performance Architecture](docs/PERF_ARCHITECTURE.md) - Hot-path design and tuning
+- [Performance Tuning](docs/CLIENT_PERFORMANCE_TUNING.md) - CPU affinity and client tuning
 - [GitHub Setup Guide](docs/GITHUB_SETUP.md) - GitHub authentication and setup
 
+### Component Design Specs
+
+Each top-level component under `src/inference_endpoint/` has a corresponding spec:
+
+| Component         | Spec                                                             |
+| ----------------- | ---------------------------------------------------------------- |
+| Core types        | [docs/core/Design.md](docs/core/Design.md)                       |
+| Load generator    | [docs/load_generator/Design.md](docs/load_generator/Design.md)   |
+| Endpoint client   | [docs/endpoint_client/Design.md](docs/endpoint_client/Design.md) |
+| Metrics           | [docs/metrics/Design.md](docs/metrics/Design.md)                 |
+| Config            | [docs/config/Design.md](docs/config/Design.md)                   |
+| Async utils       | [docs/async_utils/Design.md](docs/async_utils/Design.md)         |
+| Dataset manager   | [docs/dataset_manager/Design.md](docs/dataset_manager/Design.md) |
+| Commands (CLI)    | [docs/commands/Design.md](docs/commands/Design.md)               |
+| OpenAI adapter    | [docs/openai/Design.md](docs/openai/Design.md)                   |
+| SGLang adapter    | [docs/sglang/Design.md](docs/sglang/Design.md)                   |
+| Evaluation        | [docs/evaluation/Design.md](docs/evaluation/Design.md)           |
+| Testing utilities | [docs/testing/Design.md](docs/testing/Design.md)                 |
+| Profiling         | [docs/profiling/Design.md](docs/profiling/Design.md)             |
+| Plugins           | [docs/plugins/Design.md](docs/plugins/Design.md)                 |
+| Utils             | [docs/utils/Design.md](docs/utils/Design.md)                     |
+
 ## 🎯 Architecture
 
 The system follows a modular, event-driven architecture:
 
 ```
-┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
-│   Dataset       │    │   Load          │    │   Endpoint      │
-│   Manager       │───▶│   Generator     │───▶│   Client        │
-└─────────────────┘    └─────────────────┘    └─────────────────┘
-         │                       │                       │
-         ▼                       ▼                       ▼
-┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
-│   Metrics       │    │   Configuration │    │   Endpoint      │
-│   Collector     │◄───│   Manager       │    │   (External)    │
-└─────────────────┘    └─────────────────┘    └─────────────────┘
+Dataset Manager ──► Load Generator ──► Endpoint Client ──► External Endpoint
+                          │
+                    Metrics Collector
+                  (EventRecorder + MetricsReporter)
 ```
 
-- **Load Generator**: Central orchestrator managing query lifecycle
-- **Dataset Manager**: Handles benchmark datasets and preprocessing
-- **Endpoint Client**: Abstract interface for endpoint communication
-- **Metrics Collector**: Performance measurement and analysis
-- **Configuration Manager**: System configuration (TBD)
+- **Dataset Manager**: Loads benchmark datasets and applies transform pipelines
+- **Load Generator**: Central orchestrator — controls timing (scheduler), issues queries, and emits sample events
+- **Endpoint Client**: Multi-process HTTP worker pool communicating over ZMQ IPC
+- **Metrics Collector**: Receives sample events from Load Generator; writes to SQLite (EventRecorder), aggregates after the run (MetricsReporter)
 
 ## Accuracy Evaluation
 
@@ -134,14 +152,13 @@ configuration. Currently, Inference Endpoints provides the following pre-defined
 - LiveCodeBench (default: lite, release_v6)
 
 However, LiveCodeBench will not work out-of-the-box and requires some additional setup. See the
-[LiveCodeBench](src/inference_endpoint/dataset_manager/predefined/livecodebench/README.md) documentation
-for details and explanations.
+[LiveCodeBench](src/inference_endpoint/evaluation/livecodebench/README.md) documentation for
+details and explanations.
 
 ## 🚧 Pending Features
 
 The following features are planned for future releases:
 
-- [ ] **Performance Tuning** - Advanced performance optimization features
 - [ ] **Submission Ruleset Integration** - Full MLPerf submission workflow support
 - [ ] **Documentation Generation and Hosting** - Sphinx-based API documentation with GitHub Pages
 
@@ -168,7 +185,8 @@ We are grateful to these communities for their contributions to LLM benchmarking
 
 ## 📄 License
 
-This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE.md) file for
+details.
 
 ## 🔗 Links
 

docs/CLI_QUICK_REFERENCE.md

@@ -1,13 +1,6 @@
 # CLI Quick Reference
 
-## Architecture
-
-The CLI is auto-generated from Pydantic models in `config/schema.py` using
-cyclopts. schema.py is the single source of truth for both YAML configs and CLI flags.
-
-- **All schema fields** available as CLI flags on each subcommand (dotted kebab-case)
-- **Shorthand aliases** declared via `cyclopts.Parameter(alias="--flag")` on schema fields
-- **`${VAR}` interpolation** in YAML files (with `${VAR:-default}` fallback)
+Command-line reference for all `inference-endpoint` subcommands, flags, load patterns, and usage examples.
 
 ## Commands
 
@@ -109,6 +102,8 @@ Flag names shown as `--full.dotted.path --alias`. Both forms work.
 - `--endpoint-config.api-key --api-key` - API authentication
 - `--endpoint-config.api-type --api-type` - API type: openai/sglang (default: openai)
 - `--report-dir` - Report output directory
+  Note: applies to CLI-driven `benchmark offline` / `benchmark online`; `benchmark from-config`
+  currently expects `report_dir` to be set in the YAML.
 - `--timeout` - Global timeout in seconds
 - `--enable-cpu-affinity / --no-cpu-affinity` - NUMA-aware CPU pinning (default: true)
 
@@ -242,10 +237,9 @@ inference-endpoint init submission
 
 # 2. Edit submission_template.yaml (set model, datasets, ruleset, endpoint)
 
-# 3. Run (YAML mode)
+# 3. Run (YAML mode - config-driven; CLI only allows --config, --timeout, and --mode; set report-dir in the YAML)
 inference-endpoint benchmark from-config \
-  --config submission_template.yaml \
-  --report-dir official_results
+  --config submission_template.yaml
 ```
 
 ### Validate First