paraug 0.1.1__tar.gz

paraug-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: publish to PyPI
+
+# Triggered when a git tag matching `v*` is pushed. Builds a wheel + sdist
+# from pyproject.toml and uploads to PyPI via OIDC trusted publisher (no API
+# token stored as a secret).
+#
+# Prerequisites on PyPI side:
+#   1. PyPI account exists for the project owner.
+#   2. PyPI "Trusted Publisher" configured for this repo:
+#         - Owner:        alieuidsh
+#         - Repository:   paraug
+#         - Workflow:     publish.yml
+#         - Environment:  pypi
+#      (Set via https://pypi.org/manage/account/publishing/ — for the first
+#      release the project entry doesn't exist yet, so use the "pending"
+#      publisher form to pre-authorise the first upload.)
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/paraug/
+    permissions:
+      id-token: write   # OIDC token for PyPI trusted-publisher auth
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build sdist + wheel
+        run: python -m build
+      - name: Inspect dist/
+        run: ls -lh dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        # No `password:` — OIDC via trusted publisher.

paraug-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: tests
+
+# NOTE on CUDA parity coverage:
+# GitHub's free runners are CPU-only, so the 13 `test_parity_*_cpu_vs_cuda`
+# tests in `tests/test_parity.py` skip on CI. The 1e-6 elementwise and 2e-4
+# grid_sample tolerances advertised in README are verified locally on
+# developer GPUs (NVIDIA 5060 Ti / 4080 confirmed at v0.1.0 — see
+# CHANGELOG). To enable CI-side CUDA verification, add a self-hosted GPU
+# runner and remove the `runs-on: ubuntu-latest` constraint on a new job.
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    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 -e ".[dev]"
+      - name: Audit spec-key consistency
+        run: python scripts/audit_spec_keys.py
+      - name: Note — CUDA parity tests skip on free runners
+        run: |
+          echo "::warning::CUDA-only tests in tests/test_parity.py (13 cases) will SKIP on this CPU-only runner."
+          echo "::warning::The 1e-6 / 2e-4 CPU↔CUDA tolerance claim is verified locally; see README parity-comparison section."
+      - name: Run tests (CPU only — parity tests skip CUDA on free runners)
+        run: pytest tests/ -v --tb=short -ra
+
+  example-smoke:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install
+        run: pip install -e .
+      - name: Run examples
+        run: |
+          python examples/01_quickstart.py
+          python examples/02_mask_aware.py
+          echo "::warning::example 03_cpu_gpu_parity will SKIP its CUDA assertions on this CPU-only runner."
+          python examples/03_cpu_gpu_parity.py

paraug-0.1.1/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.egg-info/
+.eggs/
+build/
+dist/
+*.egg
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Virtual env
+.venv/
+venv/
+env/
+.python-version
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+.DS_Store
+
+# Coverage
+.coverage
+htmlcov/
+coverage.xml
+
+# Build artifacts
+*.so
+
+# Local outputs
+outputs/
+scratch/

paraug-0.1.1/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+All notable changes to paraug are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2026-05-15
+
+### Added
+
+- README hero banner (`docs/banner.png`) and project logo (`docs/logo.png`).
+- Traditional Chinese translation: `README_zh-TW.md` with a language switcher
+  in the main README.
+- `.github/workflows/publish.yml` — OIDC trusted-publisher workflow that
+  builds an sdist + wheel and uploads to PyPI when a `v*` git tag is pushed.
+
+### Changed
+
+- Installation instructions now point to `pip install git+https://...` as the
+  primary path until the PyPI release is live, instead of the previous
+  unconditional `pip install paraug` (which would have failed).
+
+## [0.1.0] - 2026-05-15
+
+Initial public release.
+
+### Added
+
+- `AugPipeline(config)` — single entry point accepting a dict of geometric
+  and photometric primitive specs. Returns `(image_aug, mask_aug)` with
+  deterministic per-item RNG.
+- **7 geometric primitives**: `affine`, `perspective`, `random_crop_pad`,
+  `elastic_transform`, `optical_distortion`, `random_shadow`, `tps`.
+- **24 photometric primitives**: gamma, gaussian_noise, gaussian_blur,
+  motion_blur, salt_pepper_noise, color_jitter, hue_shift, random_grayscale,
+  lighting, jpeg_approx, sharpness, clahe, local_contrast, vignette,
+  specular_highlight, specular_streaks, cutout, salt_patches,
+  paper_texture_overlay, watermark, random_text_overlay, background_compose,
+  stains, creases.
+- **CPU/GPU bit-exact parity**: per-primitive RNG is sampled on CPU
+  regardless of tensor device, so the same seed produces identical output
+  across CPU and CUDA back-ends within 1e-6 elementwise / 2e-4
+  grid_sample-class tolerance.
+- `set_deterministic(state=True, warn_only=True)` global toggle wrapping
+  `torch.use_deterministic_algorithms` and cuDNN flags.
+- `per_item_seed(seed_base, epoch, step, item_i, primitive)` and
+  `cpu_generator(seed)` exposed for callers that need to mirror the RNG
+  outside the pipeline.
+- `scripts/audit_spec_keys.py` — AST-based check that every test fixture and
+  example dict uses spec keys that match the primitive's
+  `spec.get("KEY", default)` reads. Runs in CI; exits non-zero on mismatch.

paraug-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 Support. 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 support.
+
+   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 2026 alieuidsh
+
+   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.

paraug-0.1.1/NOTICE

@@ -0,0 +1,4 @@
+paraug
+Copyright 2026 alieuidsh
+
+This product includes software developed under the Apache License 2.0.

paraug-0.1.1/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: paraug
+Version: 0.1.1
+Summary: Parity Augmentation — bit-exact CPU/GPU parity for image augmentation
+Project-URL: Homepage, https://github.com/alieuidsh/paraug
+Project-URL: Repository, https://github.com/alieuidsh/paraug
+Project-URL: Issues, https://github.com/alieuidsh/paraug/issues
+Project-URL: Changelog, https://github.com/alieuidsh/paraug/blob/main/CHANGELOG.md
+Author-email: alieuidsh <alieuidsh@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: augmentation,computer-vision,cpu-gpu-parity,deep-learning,deterministic,image,pytorch
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.9
+Requires-Dist: numpy>=1.24
+Requires-Dist: torch>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Provides-Extra: opencv
+Requires-Dist: opencv-python>=4.5; extra == 'opencv'
+Description-Content-Type: text/markdown
+
+# paraug
+
+![paraug banner — CPU and GPU augmentation pipelines converging to a single bit-exact output](docs/banner.png)
+
+> **Bit-exact CPU/GPU parity for image augmentation.**
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Python 3.9-3.12](https://img.shields.io/badge/python-3.9--3.12-blue.svg)]()
+
+**Languages**: English | [繁體中文](README_zh-TW.md)
+
+`paraug` is a PyTorch-native augmentation library that guarantees **the same
+seed produces the same output on CPU and CUDA**. Per-primitive RNG is sampled
+on CPU regardless of tensor device, so a training run that randomly switches
+between CPU and GPU stages — or a unit test that swaps backends — stays
+deterministic.
+
+## Why parity matters
+
+Most augmentation libraries (albumentations, kornia, torchvision) use device-
+local RNG. Same seed, different output across CPU/CUDA. This bites in three
+places:
+
+1. **Reproducibility**: paper-to-code lineage breaks when a reviewer can't
+   match published numbers.
+2. **Debugging**: CPU-side unit tests don't catch GPU-only bugs and vice
+   versa.
+3. **Distributed training**: workers on heterogeneous hardware drift apart.
+
+paraug fixes this by isolating RNG to CPU (`torch.Generator(device="cpu")`)
+and routing only the deterministic torch ops through device. Tolerance:
+
+- **Elementwise ops** (gamma, noise, color jitter, …): atol 1e-6
+- **`grid_sample`-class ops** (affine, perspective, tps, …): atol 2e-4
+  (bilinear ulp drift across ATen vs cuDNN)
+
+## Installation
+
+```bash
+pip install git+https://github.com/alieuidsh/paraug.git
+```
+
+> PyPI release (`pip install paraug`) coming once the v0.1.x publish workflow
+> is wired up — see issue tracker for status.
+
+## Quickstart
+
+```python
+import torch
+from paraug import AugPipeline
+
+aug = AugPipeline({
+    "geometric": {
+        "affine": {"p": 1.0, "rot_deg": 15.0, "scale_range": (0.9, 1.1)},
+        "tps":    {"p": 0.5, "max_disp": 12.0, "n_ctrl": 5},
+    },
+    "photometric": {
+        "gamma":         {"p": 0.5},
+        "color_jitter":  {"p": 0.5},
+        "gaussian_blur": {"p": 0.3},
+    },
+})
+
+img  = torch.rand(2, 3, 256, 256)         # (B, C, H, W)
+mask = torch.ones(2, 1, 256, 256)         # optional
+
+img_out, mask_out = aug(img, mask=mask, seed_base=42, epoch=0, step=0)
+```
+
+The same call on GPU is bit-exact within tolerance:
+
+```python
+img_gpu  = img.cuda()
+mask_gpu = mask.cuda()
+img_cuda, mask_cuda = aug(img_gpu, mask=mask_gpu, seed_base=42, epoch=0, step=0)
+assert (img_out - img_cuda.cpu()).abs().max() < 2e-4
+```
+
+## Primitives
+
+### Geometric (7)
+
+| Name | Description |
+|---|---|
+| `affine` | Rotation + scale + translation via `F.affine_grid` |
+| `perspective` | 4-point homography from corner jitter |
+| `random_crop_pad` | Scale-then-pad crop, area-preserving |
+| `elastic_transform` | Bilinear-upsampled random displacement field |
+| `optical_distortion` | Radial barrel / pincushion (k·r²) |
+| `random_shadow` | Soft-blurred triangle multiplicative shadow |
+| `tps` | Thin-plate-spline-like warp from low-res control grid |
+
+### Photometric (24)
+
+Intensity / color: `gamma`, `color_jitter`, `hue_shift`, `random_grayscale`,
+`lighting`, `clahe`, `local_contrast`, `sharpness`.
+
+Noise: `gaussian_noise`, `salt_pepper_noise`, `salt_patches`.
+
+Blur / artifacts: `gaussian_blur`, `motion_blur`, `jpeg_approx`.
+
+Lighting: `vignette`, `specular_highlight`, `specular_streaks`.
+
+Content overlays: `cutout`, `paper_texture_overlay`, `watermark`,
+`random_text_overlay`, `background_compose`, `stains`, `creases`.
+
+## Parity comparison
+
+| Library | Bit-exact CPU↔GPU | Per-item RNG | GPU native | Mask-aware | Batch-native | # Geometric¹ | # Photometric¹ | License |
+|---|---|---|---|---|---|---|---|---|
+| **paraug** | **✓** (1e-6 / 2e-4)² | ✓ | ✓ (torch) | ✓ | ✓ | 7 | 24 | Apache 2.0 |
+| albumentations | ✗ (numpy-only) | ✓ | ✗ | ✓ | partial | ~20 | ~50+ | MIT |
+| kornia | ✗ (device-local RNG) | ✓ | ✓ (torch) | ✓ | ✓ | ~10 | ~45 | Apache 2.0 |
+| torchvision.v2 | ✗ (device-local RNG) | ✓ | ✓ (torch) | partial | ✓ | ~18 | ~12 | BSD-3 |
+| imgaug | ✗ (numpy-only) | ✓ | ✗ | ✓ | partial | ~20 | ~40 | MIT |
+| augly | ✗ (PIL-only) | ✓ | ✗ | ✗ | ✗ | ~5 | ~20 | MIT |
+
+<sub>¹ External counts are approximate as of 2026-05 (sampled from each project's
+`__init__.py` / docs index). Versions move fast — consult each project's
+authoritative API reference for current numbers. paraug counts are
+code-exact (`len(GEOMETRIC_PRIMITIVES)` / `len(PHOTOMETRIC_PRIMITIVES)`).</sub>
+
+<sub>² Tolerance verified by `tests/test_parity.py` on NVIDIA 5060 Ti + 4080
+at v0.1.0; exact bounds: 1e-6 for the 6 elementwise photometric ops listed
+in `PHOTO_ELEMENTWISE` (gamma / gaussian_noise / color_jitter / vignette /
+cutout / hue_shift), 2e-4 for grid_sample-class (geometric) and conv-class
+(blur) ops. **GitHub free CI runners are CPU-only**, so the 13 CUDA parity
+tests skip on CI — community verification on additional GPU SKUs is
+welcome (open a PR with the result, or run `pytest tests/test_parity.py -k
+cpu_vs_cuda` locally and post the output).</sub>
+
+### When to use paraug
+
+- Cross-device reproducibility (paper-grade ablation where CPU↔GPU drift breaks a baseline)
+- Distributed training on heterogeneous hardware
+- Unit-test-friendly augmentation pipelines (CPU-side RNG means a test on a free CI runner reproduces a developer's GPU result)
+
+### When **NOT** to use paraug
+
+- You need 50+ primitive options out of the box → try `albumentations` or `imgaug`
+- You need PIL-style per-image API → try `augly`
+- You need built-in compositional ops like `OneOf` / `SomeOf` → try `albumentations`
+
+## Examples
+
+See `examples/`:
+
+- `01_quickstart.py` — minimal load → augment → save
+- `02_mask_aware.py` — image + segmentation mask warped together
+- `03_cpu_gpu_parity.py` — same seed on CPU and CUDA, assert
+  `max_abs_diff < 2e-4`
+
+## Citation
+
+```bibtex
+@software{paraug2026,
+  author = {alieuidsh},
+  title  = {paraug: Bit-exact CPU/GPU parity for image augmentation},
+  year   = {2026},
+  url    = {https://github.com/alieuidsh/paraug},
+}
+```
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).