diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e13563c..2508bb0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,64 +1,26 @@ -# Contributing to MicroPDProxy +# Contributing to xPyD-proxy -Thank you for your interest in contributing! This guide covers the workflow and -standards we follow. - -## Branch Strategy - -1. Fork or create a **feature branch** from `main`: - ```bash - git checkout -b feature/my-change main - ``` -2. Make your changes, commit with clear messages. -3. Open a **Pull Request** against `main`. -4. All PRs require at least one approving review before merge. - -## Code Style - -We use [Ruff](https://docs.astral.sh/ruff/) for linting and formatting, and -[isort](https://pycqa.github.io/isort/) for import sorting. +## Development Setup ```bash -# Check -ruff check . -isort --check-only . - -# Auto-fix -ruff check --fix . -isort . +git clone https://github.com/xPyD-hub/xPyD-proxy +cd xPyD-proxy +pip install -e ".[dev]" ``` -## Testing +## Running Tests -- All CI checks **must pass** before a PR can be merged. -- Run the test suite locally: - ```bash - pip install -r requirements.txt - python -m pytest tests/ -v - ``` -- If you add a new feature, add corresponding tests. - -## Review Process - -1. Open a PR with a clear description of **what** and **why**. -2. At least one maintainer must approve. -3. CI must be fully green. -4. After approval, the PR will be merged (squash or merge commit). - -## Changes to `core/` +```bash +pytest tests/unit/ -q +``` -The `core/` directory contains the validated proxy implementation. Changes here -are held to a **higher standard**: +## Code Style -- Must not break existing topology matrix tests - (`tests/test_proxy_matrix.py`). -- Must include test coverage for new behavior. -- Require review from a core maintainer. -- Performance-sensitive changes should include benchmark results. +- Python 3.10+ +- Ruff: `ruff check .` +- Pre-commit: `pre-commit run --all-files` +- All PRs must pass CI (lint + tests + integration trigger) -## Reporting Issues +## Bot Development -Open a GitHub issue with: -- Steps to reproduce -- Expected vs. actual behavior -- Environment details (Python version, OS, GPU setup if relevant) +See [bot/](bot/) for automated development policies. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index da4d8ca..364b555 100644 --- a/README.md +++ b/README.md @@ -1,281 +1,52 @@ -# xPyD Proxy +# xPyD-proxy -A lightweight Prefill-Decode (PD) proxy for disaggregated LLM serving. +**Lightweight Prefill-Decode disaggregated proxy for LLM serving.** -## Architecture +xPyD-proxy routes inference requests between prefill and decode nodes, enabling PD-disaggregated LLM serving with load balancing, health monitoring, and fault tolerance. -xPyD Proxy supports two operating modes: +## Key Features -### Prefill-Decode (P/D) Disaggregated Mode +- **PD disaggregation** — separate prefill and decode nodes for optimal resource utilization +- **Multiple scheduling policies** — round-robin, consistent hash, cache-aware, power-of-two +- **Resilience** — circuit breaker, health monitoring, automatic failover +- **Multi-model routing** — serve multiple models through a single proxy +- **OpenAI-compatible API** — drop-in replacement for vLLM/OpenAI endpoints +- **YAML configuration** — declarative topology and settings -Requests are routed through two phases with KV cache transfer: - -1. **Prefill** — KV cache preparation on prefill nodes (`max_tokens=1`) -2. **Decode** — autoregressive token generation on decode nodes (receives KV cache from prefill) - -### Dual-Role Mode - -A single instance handles both prefill and decode in one pass — no KV transfer needed. This simplifies deployment when disaggregation is not required or for smaller-scale setups. - -The proxy handles scheduling (load-balanced, round-robin, consistent hash, power-of-two, cache-aware), health monitoring, circuit breaking, and dynamic instance management. Multi-model routing allows serving multiple models through a single proxy with per-model scheduler configuration. - -See [`docs/architecture.md`](docs/architecture.md) for details. - -## Installation - -```bash -pip install . - -# Verify -xpyd --version -``` - -## Quick Start - -```bash -# Generate a config template -xpyd proxy --init-config - -# Edit xpyd.yaml with your model and node addresses, then: -xpyd proxy -c xpyd.yaml -``` - -## Configuration - -All configuration is done via YAML. Three config formats are supported. - -### Format 1: Legacy (Single Model) - -Simple prefill/decode address lists for a single model: - -```yaml -model: /path/to/model -prefill: - - "10.0.0.3:8100" -decode: - - "10.0.0.1:8200" - - "10.0.0.2:8200" -port: 8000 -scheduling: loadbalanced -``` - -Topology-style config is also supported in Format 1: - -```yaml -model: /path/to/model -port: 8868 - -prefill: - nodes: - - "10.0.0.1:8100" - tp_size: 8 - dp_size: 1 - world_size_per_node: 8 - -decode: - nodes: - - "10.0.0.2:8200" - - "10.0.0.3:8200" - tp_size: 1 - dp_size: 16 - world_size_per_node: 8 -``` - -### Format 2: Instances (Multi-Model, Per-Instance Role) - -Explicit per-instance configuration with role and model assignment. Supports `dual` role: - -```yaml -instances: - - address: "10.0.0.1:8000" - role: prefill - model: llama-3 - - address: "10.0.0.2:8000" - role: decode - model: llama-3 - - address: "10.0.0.3:8000" - role: dual - model: qwen-2 -port: 8000 -scheduling: loadbalanced -``` - -### Format 3: Models Shorthand (Multi-Model, Per-Model Scheduler) - -Compact format with per-model scheduler override and `dual` shorthand: - -```yaml -models: - - name: llama-3 - prefill: - - "10.0.0.1:8000" - decode: - - "10.0.0.2:8000" - scheduler: round_robin - - name: qwen-2 - dual: - - "10.0.0.3:8000" - - "10.0.0.4:8000" - scheduler: loadbalanced -port: 8000 -``` - -> **Note:** `instances` and `models` cannot be combined. Legacy `prefill`/`decode` lists cannot be used with `instances` or `models`. - -See [`examples/proxy.yaml`](examples/proxy.yaml) for a fully-commented example. - -### CLI Reference - -``` -xpyd proxy [OPTIONS] - -Options: - --config, -c PATH Path to YAML config (default: ./xpyd.yaml or XPYD_CONFIG env) - --init-config [PATH] Generate a config template and exit - --validate-config PATH Validate a config file and exit - --port PORT Override port from config - --log-level LEVEL Override log level: debug|info|warning|error - --version, -V Show version and exit -``` - -``` -xpyd fix-config CONFIG_PATH [OPTIONS] - -Auto-fix common config mistakes (typos, missing ports, whitespace). - -Arguments: - CONFIG_PATH Path to YAML config file to fix - -Options: - --write Write fixes back to file (creates timestamped .bak backup). - Note: does not preserve YAML comments or formatting. - --interactive Prompt for confirmation on ambiguous suggestions -``` - -### Config resolution order - -1. `--config` / `-c` CLI argument -2. `XPYD_CONFIG` environment variable -3. `./xpyd.yaml` in the current directory - -### YAML Config - -```yaml -# Required -model: /path/to/model -decode: - - "10.0.0.1:8200" - - "10.0.0.2:8200" - -# Optional -prefill: - - "10.0.0.3:8100" -port: 8000 -log_level: warning -scheduling: loadbalanced # roundrobin | loadbalanced | consistent_hash | power_of_two | cache_aware -generator_on_p_node: false -``` - -See [`examples/proxy.yaml`](examples/proxy.yaml) for a fully-commented example. - -### YAML Fields Reference - -| Field | Type | Default | Description | -|---|---|---|---| -| `model` | string | — | Model name / path (required in Format 1) | -| `port` | int | 8000 | Proxy listen port | -| `log_level` | string | warning | Log level: debug, info, warning, error | -| `prefill` | list or topology | [] | Prefill node config (Format 1) | -| `decode` | list or topology | — | Decode node config (Format 1, required) | -| `instances` | list | — | Per-instance config (Format 2): `{address, role, model}` | -| `models` | list | — | Per-model shorthand (Format 3): `{name, prefill, decode, dual, scheduler}` | -| `scheduling` | string | loadbalanced | Global scheduling policy | -| `scheduling_config` | dict | {} | Policy-specific options | -| `generator_on_p_node` | bool | false | Generate first token on prefill node | -| `admin_api_key` | string | — | Admin API key (env `ADMIN_API_KEY` overrides) | -| `openai_api_key` | string | — | OpenAI API key (env `OPENAI_API_KEY` overrides) | -| `startup.wait_timeout_seconds` | int | 600 | Max wait for nodes at startup | -| `startup.probe_interval_seconds` | int | 10 | Health probe interval | - -**Valid `role` values:** `prefill`, `decode`, `dual` - -**Valid `scheduling` values:** `loadbalanced`, `roundrobin` (alias: `round_robin`), `load_balanced`, `consistent_hash`, `power_of_two`, `cache_aware` - -### API - -The proxy exposes an OpenAI-compatible API: - -- **`POST /v1/chat/completions`** — Chat completions (streaming and non-streaming) -- **`POST /v1/completions`** — Text completions (streaming and non-streaming) -- **`GET /v1/models`** — List all registered models in OpenAI-compatible format - -### Startup Node Discovery - -The proxy returns **503** on business endpoints until the minimum instance requirement is met: at least **1 prefill + 1 decode** node, or **1 dual** node per model must respond healthy. Health/status/metrics endpoints are always available. - -## Docker +## Install ```bash -# Full local topology (prefill + decode + proxy) -docker compose up --build - -# Proxy only, connecting to existing GPU nodes -docker build -t xpyd . -docker run -p 8868:8868 -v ./config.yaml:/app/xpyd.yaml xpyd +pip install xpyd-proxy ``` -See [`docs/deployment.md`](docs/deployment.md) for production deployment. - -## Benchmark +Or as part of the full xPyD toolkit: ```bash -python -m vllm bench serve \ - --base-url http://localhost:8868 \ - --model DeepSeek-R1 \ - --dataset-name sonnet \ - --sonnet-input-len 1024 \ - --sonnet-output-len 128 \ - --num-prompts 100 \ - --request-rate 10 +pip install xpyd ``` -## Development +## Quick Start ```bash -# Install in dev mode -pip install -e ".[dev]" +# Start with YAML config +xpyd proxy --config proxy.yaml -# Run tests -python -m pytest tests/unit/ tests/integration/ -v - -# Lint -pre-commit run --all-files +# Or with CLI args +xpyd proxy --model my-model \ + --prefill 127.0.0.1:8001 \ + --decode 127.0.0.1:8002 ``` -### Environment Variables - -| Variable | Description | -|---|---| -| `XPYD_CONFIG` | Default config file path | -| `ADMIN_API_KEY` | Admin API key (overrides YAML) | -| `OPENAI_API_KEY` | Bearer token for backend nodes (overrides YAML) | -| `PREFILL_DELAY_PER_TOKEN` | Simulated prefill latency for dummy nodes (default: 0.001s) | -| `DECODE_DELAY_PER_TOKEN` | Simulated decode latency for dummy nodes (default: 0.01s) | +## Part of xPyD -## Documentation +| Component | Description | +|-----------|-------------| +| **xpyd-proxy** | PD-disaggregated proxy | +| [xpyd-sim](https://github.com/xPyD-hub/xPyD-sim) | OpenAI-compatible inference simulator | +| [xpyd-bench](https://github.com/xPyD-hub/xPyD-bench) | Benchmarking & planning tool | -| Document | Description | -|---|---| -| [Architecture](docs/architecture.md) | System architecture overview | -| [API Reference](docs/api_reference.md) | HTTP API endpoints | -| [Configuration](docs/configuration.md) | YAML config reference | -| [CLI](docs/cli.md) | xpyd command-line tool | -| [Scheduling](docs/scheduling.md) | Load balancing strategies | -| [Resilience](docs/resilience.md) | Health checks, circuit breakers, retry | -| [Metrics](docs/metrics.md) | Prometheus metrics endpoint | -| [Deployment](docs/deployment.md) | Deployment and Docker guide | -| [Contributing](CONTRIBUTING.md) | Contribution guidelines | +📖 **[Full Guide →](docs/guide.md)** | 💡 **[Examples →](examples/)** | 🏗️ **[Contributing →](CONTRIBUTING.md)** ## License -Apache-2.0 +Apache 2.0 — see [LICENSE](LICENSE)