polgrad 0.1.0__tar.gz

polgrad-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install torch --index-url https://download.pytorch.org/whl/cpu
+          pip install -e '.[dev]'
+      - name: ruff check
+        run: ruff check src tests examples tools
+      - name: ruff format
+        run: ruff format --check src tests examples tools
+      - name: mypy
+        run: mypy
+
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.10", "3.13"]
+    runs-on: ${{ matrix.os }}
+    env:
+      HYPOTHESIS_PROFILE: ci
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install torch --index-url https://download.pytorch.org/whl/cpu
+          pip install -e '.[dev]'
+        if: runner.os == 'Linux'
+      - name: Install (macOS)
+        run: |
+          python -m pip install --upgrade pip
+          pip install torch
+          pip install -e '.[dev]'
+        if: runner.os == 'macOS'
+      - name: pytest
+        run: pytest -n auto
+
+  examples:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install torch --index-url https://download.pytorch.org/whl/cpu
+          pip install -e .
+      - name: Run examples
+        run: |
+          for f in examples/*.py; do python "$f"; done

polgrad-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade build
+          python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

polgrad-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.pytest_cache/
+.hypothesis/
+.mypy_cache/
+.ruff_cache/
+.DS_Store

polgrad-0.1.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+Framework-behavior findings (conformance deviations, upstream changes detected against
+vendored snapshots) are recorded here alongside library changes, versioned by the pin
+they were observed at.
+
+## 0.1.0 — 2026-07-16
+
+Initial release.
+
+- Loss algebra: `PG_CLIP` (PPO, incl. dual-clip), `PG`, `REINFORCE`, `CISPO` surrogates ×
+  token / sequence (GSPO) / sequence-token (GSPO-token) ratios × four aggregation modes,
+  with truncated importance-sampling correction for rollout↔trainer mismatch.
+- KL estimators k1/k2/k3 (+ `abs` for conformance) with in-reward and as-loss placements
+  and machine-checked pathwise gradients.
+- Advantage estimators: GRPO group normalization, Dr.GRPO, RLOO, REINFORCE++, GAE.
+- Algorithm registry: ppo, grpo, dr_grpo, dapo, gspo, gspo_token, cispo, rloo,
+  reinforce_pp, grpo_tis — every constant traced to its paper or released code.
+- Diagnostics: importance-ratio ESS (+ sliding window), rollout↔trainer logprob mismatch,
+  clip-fraction quadrant decomposition with exact zero-gradient masks, entropy trend with
+  permutation-calibrated changepoint, length-bias probe with HC3 robust errors.
+- Verification harness as public API: fp64 gradcheck runners, finite-difference checks of
+  analytic formulas, softmax-bandit closed forms, hand-derived golden cases.
+- Conformance: vendored verl / OpenRLHF loss functions with pinned provenance, recorded
+  fixtures, deviation registry.

polgrad-0.1.0/CITATION.cff

@@ -0,0 +1,10 @@
+cff-version: 1.2.0
+message: "If you use polgrad in your research, please cite it as below."
+title: "polgrad: reference semantics, conformance testing, and pathology diagnostics for LLM policy-gradient post-training"
+authors:
+  - family-names: Punjwani
+    given-names: Saif
+repository-code: "https://github.com/SaifPunjwani/polgrad"
+license: Apache-2.0
+version: 0.1.0
+date-released: 2026-07-17

polgrad-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing
+
+polgrad is a reference-semantics library: the tests and derivation pages are the product
+as much as the code. Contributions are held to that bar.
+
+## Setup
+
+```sh
+python -m venv .venv && source .venv/bin/activate
+pip install torch            # or the CPU index: pip install torch --index-url https://download.pytorch.org/whl/cpu
+pip install -e '.[dev]'
+```
+
+## Checks
+
+Everything that CI runs, locally:
+
+```sh
+pytest -n auto               # HYPOTHESIS_PROFILE=ci for the full example count
+ruff check src tests examples tools
+ruff format --check src tests examples tools
+mypy
+```
+
+All four must pass. There are no known-flaky tests; if a seeded test fails
+intermittently, that is a bug worth reporting on its own.
+
+## What a change needs
+
+- **A new loss variant or estimator** needs, in one PR: the config entry, a derivation
+  page in `docs/derivations/` showing the per-token objective and its gradient with the
+  algebra written out, fp64 `gradcheck` coverage, at least one hand-derived golden case
+  with the arithmetic shown, and property tests for whatever equivalences or invariances
+  the derivation claims. A variant whose defaults cannot be traced to a paper or its
+  released code documents that ambiguity in its `notes` rather than inventing values.
+- **A new diagnostic** needs a documented null distribution and a Monte Carlo test
+  calibrating it. Thresholds without error rates are not accepted.
+- **A conformance claim** (an entry in `conformance/deviations.py`) needs a test that
+  demonstrates it against vendored code, and neutral wording: deviations are described
+  relative to a paper equation, never as defects of the framework.
+- **Vendored code updates** must be real fetches at a pinned commit with the header's
+  SHA256 updated; see the header format in `src/polgrad/conformance/_vendor/`.
+
+## Conventions
+
+Shapes, masking, sign conventions, and dtype rules are specified in
+`docs/conventions.md` and enforced by tests; read it before writing code. Style is
+whatever `ruff` and `mypy --strict` accept, plus: no stop-gradient without a comment
+stating its semantic reason, and docstrings reference the derivation page and the test
+that enforces each claim.

polgrad-0.1.0/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.

polgrad-0.1.0/NOTICE

@@ -0,0 +1,42 @@
+polgrad
+Copyright 2026 Saif Punjwani
+
+Licensed under the Apache License, Version 2.0.
+
+This product vendors code from the following Apache-2.0 licensed projects for
+conformance testing, under src/polgrad/conformance/_vendor/. Each vendored
+file's header records the pinned upstream commit, source paths, upstream file
+SHA256s, the definitions kept, and every edit made (import/decorator stripping
+only; kept bodies are byte-identical to upstream).
+
+1. verl
+   https://github.com/volcengine/verl
+   (redirects to https://github.com/verl-project/verl after the project rename)
+   Copyright 2024 Bytedance Ltd. and/or its affiliates
+   Copyright 2022 The HuggingFace Team. All rights reserved.
+   Licensed under the Apache License, Version 2.0.
+   Vendored file: src/polgrad/conformance/_vendor/verl_core_algos.py
+   Sources: verl/trainer/ppo/core_algos.py and verl/utils/torch_functional.py
+   at commit 74a718a492092312f1004fe25369975137388849.
+   SHA256 of the vendored file as committed:
+   54332baf8da9e821bdb3cd5738d7c74018f25d0df51e4d91e193b82db29bbe3a
+
+2. OpenRLHF
+   https://github.com/OpenRLHF/OpenRLHF
+   Licensed under the Apache License, Version 2.0 (the upstream LICENSE keeps
+   the unmodified Apache-2.0 template copyright line and the source files carry
+   no per-file license header; copyright rests with the OpenRLHF contributors).
+   Vendored file: src/polgrad/conformance/_vendor/openrlhf_loss.py
+   Sources: openrlhf/models/loss.py and openrlhf/models/utils.py
+   at commit bc71bb19464aca306b33080b2d2bb45d154e2f49.
+   SHA256 of the vendored file as committed:
+   caad2b3b7cd6f0d873b71f765d0ad94e7d5da4e19b9a8e0186ed105b9c6ba9f0
+
+This product also contains a labeled reimplementation (not vendored code) of
+the TRL GRPO loss in src/polgrad/conformance/harness.py whose clipped-surrogate
+arithmetic is reproduced verbatim from trl/trainer/grpo_trainer.py
+(https://github.com/huggingface/trl) at commit
+95809b942eb5d11d0b06d749510d88be99230b73 (upstream file SHA256
+52d9a6c1e298df35d0da4a6fa17874d750ee627f6ac15393c8860d74d1ba4917).
+Copyright 2020-2026 The HuggingFace Team. All rights reserved.
+Licensed under the Apache License, Version 2.0.