docs: unified structure — LICENSE, README, CONTRIBUTING, bot/

CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing to xPyD-acc
+
+## Development Setup
+
+```bash
+git clone https://github.com/xPyD-hub/xPyD-acc
+cd xPyD-acc
+pip install -e ".[dev]"
+```
+
+## Running Tests
+
+```bash
+pytest tests/ -q
+```
+
+## Code Style
+
+- Python 3.10+
+- Ruff for linting: `ruff check xpyd_acc tests`
+- All PRs must pass CI (lint + tests on 3.10/3.11/3.12 + integration trigger)
+
+## PR Process
+
+1. Create a branch from `main`
+2. Make changes, add tests
+3. Push and open PR
+4. CI runs: unit tests + integration tests (via trigger)
+5. Review and merge
+
+## Bot Development
+
+See [bot/](bot/) for automated development policies and iteration records.

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.

README.md

@@ -1,25 +1,16 @@
 # xPyD-acc
 
-Accuracy diagnostic tool for PD (Prefill/Decode) disaggregated LLM inference.
+PD disaggregation accuracy diagnostic tool.
 
-When PD disaggregation introduces accuracy issues, xPyD-acc helps you pinpoint
-exactly where the problem is: Prefill, KV transfer, or Decode.
+When PD disaggregated inference produces wrong output, xPyD-acc pinpoints where the problem is: Prefill, KV transfer, or Decode.
 
-## The Problem
+## Key Features
 
-In PD disaggregated deployment, the inference pipeline is split across nodes.
-Any of these stages can introduce accuracy drift:
-- **Prefill** — TP parallelism, numerical precision (FP16/BF16), attention implementation
-- **KV Transfer** — serialization/deserialization, quantization, memory alignment
-- **Decode** — context length handling, position encoding, KV cache interpretation
-
-## Approach
-
-Step-by-step isolation:
-1. Establish baseline (aggregated mode output)
-2. Isolate and test each stage independently
-3. Compare outputs at each boundary
-4. Report exactly where divergence starts
+- **Logprobs comparison** — token-by-token divergence detection between endpoints
+- **KV cache analysis** — numerical accuracy checks (max abs diff, cosine similarity)
+- **Automated diagnostics** — full pipeline: baseline → isolate → compare → report
+- **Interactive REPL** — exploratory comparison with live parameter tuning
+- **Batch & offline modes** — multi-dataset runs and file-based comparison
 
 ## Install
 
@@ -42,19 +33,23 @@ xpyd-acc compare-logprobs \
   --endpoint-a http://aggregated:8000 \
   --endpoint-b http://prefill:8001 \
   --prompt "Hello world"
-
-# Check KV cache numerical accuracy
-xpyd-acc check-kv \
-  --kv-dump-a baseline_kv.npz \
-  --kv-dump-b transfer_kv.npz
 ```
 
-## Documentation
+## Part of xPyD
+
+| Component | Description |
+|-----------|-------------|
+| [xPyD-proxy](https://github.com/xPyD-hub/xPyD-proxy) | PD-aware reverse proxy |
+| [xPyD-sim](https://github.com/xPyD-hub/xPyD-sim) | PD disaggregation simulator |
+| [xPyD-bench](https://github.com/xPyD-hub/xPyD-bench) | Benchmarking tool |
+| **xPyD-acc** | Accuracy diagnostics (this repo) |
+| [xPyD-plan](https://github.com/xPyD-hub/xPyD-plan) | Project planning |
+
+## Resources
 
-- **[User Guide](docs/guide.md)** — installation, subcommand reference, step-by-step diagnostic flow, and results interpretation
-- **[Current Iteration](docs/iterations/current.md)** — M72 milestone status, features, known limitations, and roadmap
-- **[Diagnostic Script](scripts/run_diagnose.sh)** — one-shot `bash scripts/run_diagnose.sh <aggregated_url> <pd_url>`
+- [User Guide](docs/guide.md)
+- [Contributing](CONTRIBUTING.md)
 
 ## License
 
-TBD
+[Apache 2.0](LICENSE)

bot/AUTHOR_POLICY.md

@@ -0,0 +1,53 @@
+<!-- CRITICAL: DO NOT SUMMARIZE OR COMPRESS THIS FILE -->
+<!-- This file contains precise rules that must be read in full. -->
+
+# Author Policy — xPyD-acc
+
+Rules for the bot that writes code and submits PRs.
+
+## Identity
+
+| Role | GitHub Account |
+|------|---------------|
+| Author | `hlin99` |
+
+## Before Coding
+
+1. Pull latest main: `git pull origin main`
+2. Create feature branch: `git checkout -b <type>/<short-description>`
+3. Read [DESIGN_PRINCIPLES.md](DESIGN_PRINCIPLES.md) for architecture constraints.
+
+## Code Quality
+
+1. Run lint: `ruff check xpyd_acc tests`
+2. Run tests: `pytest tests/ -q`
+3. Rebase before push: `git pull --rebase origin main`
+
+## PR Submission
+
+1. **One PR per task.** Don't bundle unrelated changes.
+2. **Descriptive title.** Format: `type: short description` (e.g., `feat: add KV cache comparison`).
+3. **PR body must include:** what changed, why, test coverage, breaking changes.
+4. **All CI must pass** before requesting review.
+
+## Responding to Review
+
+1. Fix all blockers before re-requesting review.
+2. Reply to every comment — "Fixed in <commit>" or explain disagreement with evidence.
+3. Push new commits (don't force push over reviewer comments).
+4. **Never force push.** If the branch is too messy, close the PR and open a new one.
+
+## Documentation Updates
+
+Every PR must update relevant documentation:
+
+| Change Type | Update |
+|---|---|
+| New feature / CLI argument | `docs/guide.md` — add usage section |
+| Design decision | `bot/DESIGN_PRINCIPLES.md` — append if needed |
+| Quick Start affected | `README.md` — update (keep it one screen max, link to guide.md) |
+| PR completed | `bot/iterations/current.md` — append summary |
+
+`docs/guide.md` is the source of truth for how to use the tool.
+
+When current iteration is complete, rename `bot/iterations/current.md` to `YYYY-MM-DD-<topic>.md` and create a fresh `current.md`.

bot/BOT_POLICY.md

@@ -0,0 +1,23 @@
+<!-- CRITICAL: DO NOT SUMMARIZE OR COMPRESS THIS FILE -->
+<!-- This file contains precise rules that must be read in full. -->
+
+# Bot Policy — xPyD-acc
+
+## Language
+- **English only** — all code, docs, issues, PRs, comments on GitHub must be in English. No Chinese characters.
+
+## Code Rules
+- All changes go through PR. Never push directly to main.
+- Every PR must have tests. No untested code.
+- CI must be 100% green before merge. No skips allowed.
+- No test may be skipped. If a test can't run, fix it or remove it.
+- Rebase to latest main before pushing.
+
+## Testing
+- Unit tests in `tests/` — pure acc logic, no external dependencies.
+- Integration tests in [xPyD-integration](https://github.com/xPyD-hub/xPyD-integration) — cross-component tests.
+
+## Architecture
+- acc is a diagnostic tool for PD accuracy issues. No server components.
+- All inference backend interaction goes through xPyD-integration tests.
+- Follow step-by-step isolation approach (see [DESIGN_PRINCIPLES.md](DESIGN_PRINCIPLES.md)).

docs/DESIGN_PRINCIPLES.md → bot/DESIGN_PRINCIPLES.md

@@ -1,3 +1,6 @@
+<!-- CRITICAL: DO NOT SUMMARIZE OR COMPRESS THIS FILE -->
+<!-- This file contains precise rules that must be read in full. -->
+
 # xPyD-acc Design Principles
 
 ## Core Positioning
@@ -18,7 +21,6 @@ Help users answer: "My PD disaggregated output is wrong. Is it Prefill, KV trans
 - Clear human-readable report
 
 ## Rules
-- Committer must be hlin99 <tony.lin@intel.com>
 - All code, docs, issues, PRs in English
 - Commit messages: conventional commits format
-- Code in src/xpyd_acc/, tests in tests/
+- Code in `src/xpyd_acc/`, tests in `tests/`