poros-train 0.1.0__tar.gz

poros_train-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2026 Caistro Labs
+
+   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.

poros_train-0.1.0/PKG-INFO

@@ -0,0 +1,225 @@
+Metadata-Version: 2.4
+Name: poros-train
+Version: 0.1.0
+Summary: Blockwise residency for frozen-base QLoRA. Fine-tune 32B on 16GB, bitwise-identical.
+Author-email: Jeffrey Tigres <contact@caistrolabs.com>
+Maintainer-email: Caistro Labs <contact@caistrolabs.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Caistro-Labs/poros
+Project-URL: Repository, https://github.com/Caistro-Labs/poros
+Project-URL: Issues, https://github.com/Caistro-Labs/poros/issues
+Project-URL: Documentation, https://github.com/Caistro-Labs/poros#readme
+Keywords: qlora,lora,fine-tuning,transformers,gpu-memory
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.12
+Requires-Dist: rich>=13.7
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: ml
+Requires-Dist: torch>=2.10; extra == "ml"
+Requires-Dist: transformers<6,>=5.5; extra == "ml"
+Requires-Dist: datasets>=2.16; extra == "ml"
+Requires-Dist: peft>=0.13; extra == "ml"
+Requires-Dist: accelerate>=0.34; extra == "ml"
+Requires-Dist: bitsandbytes>=0.43; extra == "ml"
+Requires-Dist: huggingface-hub>=0.25; extra == "ml"
+Requires-Dist: safetensors>=0.4; extra == "ml"
+Provides-Extra: bench
+Requires-Dist: matplotlib>=3.8; extra == "bench"
+Requires-Dist: jinja2>=3.1; extra == "bench"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: jinja2>=3.1; extra == "dev"
+Requires-Dist: matplotlib>=3.8; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/poros-banner-dark.png" alt="Poros — bit-exact fine-tuning on consumer GPUs" width="100%">
+
+<a href="https://pypi.org/project/poros-train/"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-pypi.png" height="28" alt="pypi v0.1.0"></a>&nbsp;<a href="https://github.com/Caistro-Labs/poros/blob/main/pyproject.toml"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-python.png" height="28" alt="python 3.11+"></a>&nbsp;<a href="https://github.com/Caistro-Labs/poros/blob/main/LICENSE"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-license.png" height="28" alt="license apache-2.0"></a>&nbsp;<a href="https://github.com/Caistro-Labs/poros/tree/main/docs/validation"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-parity.png" height="28" alt="parity 0.00e+00"></a>
+
+<br>
+
+<a href="#install"><kbd>&nbsp;Install&nbsp;</kbd></a>&nbsp;
+<a href="#quickstart"><kbd>&nbsp;Quickstart&nbsp;</kbd></a>&nbsp;
+<a href="#benchmarks"><kbd>&nbsp;Benchmarks&nbsp;</kbd></a>&nbsp;
+<a href="#supported-models"><kbd>&nbsp;Models&nbsp;</kbd></a>&nbsp;
+<a href="#how-it-works"><kbd>&nbsp;How&nbsp;it&nbsp;works&nbsp;</kbd></a>&nbsp;
+<a href="https://github.com/Caistro-Labs/poros/blob/main/docs/index.md"><kbd>&nbsp;Docs&nbsp;</kbd></a>&nbsp;
+<a href="https://github.com/Caistro-Labs/poros/blob/main/paper/poros.pdf"><kbd>&nbsp;Paper&nbsp;</kbd></a>
+
+</div>
+
+---
+
+Poros streams the frozen base of a QLoRA fine-tune through the GPU one block at a time, so only the adapters and a single block are ever resident. The adapter it produces is bit-for-bit identical to a fully resident run, verified with `torch.equal` (not `allclose`): all four surfaces — loss, adapter weights, gradient norms, and optimizer state — are gated directly at 7B and 32B; at 72B, loss and weights are gated directly and the other two are inferred from the bit-identical weight trajectory.
+
+- **32B trains in 11.61 GB** peak VRAM (44.88 GB resident) — inside a 16 GB budget
+- **72B trains end-to-end on a single RTX 5090** — 18.13 GB training peak on the 5090 (18.87 GB canonical; 81.57 GB resident)
+- **Parity is 0.00e+00, not "close"** — gated over 200-step and 1000-step runs, with dropout, gradient accumulation, and `torch.compile`
+- **One line** on top of your existing PEFT script
+
+## Install
+
+```bash
+pip install poros-train            # CLI + config, no GPU needed
+pip install "poros-train[ml]"      # + torch, transformers, peft, bitsandbytes
+pip install "poros-train[ml,bench]"  # + benchmark harness
+```
+
+Python 3.11+, PyTorch 2.10+, Transformers 5.5+, Linux with CUDA. The base install runs `poros --help`, `poros check`, and `poros doctor` on CPU-only machines.
+
+## Quickstart
+
+Already have a Hugging Face + PEFT script? Add one line and keep your loop:
+
+```python
+import poros
+
+model = poros.prepare(model)   # your loop, your config, untouched
+trainer.train()
+```
+
+```text
+Poros prepared model
+        model  Qwen/Qwen2.5-7B
+   model_type  qwen2
+ architecture  certified
+      adapter  lora (certified)
+    precision  NF4
+        stack  certified
+   block_size  4
+    guarantee  official bitwise path (NF4, deterministic)
+```
+
+`prepare()` never touches your training setup — learning rate, LoRA config, optimizer, and data stay exactly as you wrote them. It detects the architecture, wraps the model in place, and reports which guarantee applies. Paths not gated at 0.00e+00 are labeled `experimental` or `target`. Reverse it any time with `poros.unprepare(model)`.
+
+No script yet? `PorosTrainer` is the five-line path:
+
+```python
+from poros import PorosTrainer
+
+trainer = PorosTrainer.from_pretrained(
+    "Qwen/Qwen2.5-32B", quantization="nf4", lora_rank=16, lora_alpha=32,
+)
+trainer.train("OpenAssistant/oasst1", steps=200, seq_len=512)
+trainer.save("./poros-qwen32b-lora")
+```
+
+The saved adapter is a standard PEFT adapter — load it with `PeftModel.from_pretrained`, or merge for vLLM/TGI with `poros export ./poros-qwen32b-lora -o ./merged`. See [examples/inference.py](https://github.com/Caistro-Labs/poros/blob/main/examples/inference.py).
+
+If a block doesn't fit your card, `PorosOOMError` suggests a smaller `block_size` to try. Details: [docs/quickstart.md](https://github.com/Caistro-Labs/poros/blob/main/docs/quickstart.md) · [docs/api.md](https://github.com/Caistro-Labs/poros/blob/main/docs/api.md).
+
+## Benchmarks
+
+Consumer cards, measured. Every row has a raw artifact in [docs/validation/](https://github.com/Caistro-Labs/poros/tree/main/docs/validation); the datacenter matrices (A100, B300, RTX PRO 6000) live in [docs/official-a100-results.md](https://github.com/Caistro-Labs/poros/blob/main/docs/official-a100-results.md) and [docs/official-b300-results.md](https://github.com/Caistro-Labs/poros/blob/main/docs/official-b300-results.md).
+
+**RTX 3090 (24 GB)** — Qwen2.5 QLoRA, all methods on identical data, seeds, and deterministic kernels (rank-16 LoRA, NF4, seq_len 512, 200 steps):
+
+| Scale | Method | Peak VRAM | s/step |
+|---|---|---|---|
+| 7B | PEFT QLoRA | 16.37 GB | 0.51 |
+| 7B | Accelerate CPU-offload | 9.71 GB | 0.73 |
+| 7B | Unsloth QLoRA | 8.66 GB | 0.53 |
+| 7B | **Poros** | **6.90 GB** | 0.87 |
+| 32B | PEFT QLoRA | OOM | — |
+| 32B | Accelerate CPU-offload | OOM | — |
+| 32B | Unsloth QLoRA¹ | 22.29 GB | 2.07 |
+| 32B | **Poros** | **11.61 GB** | 3.21 |
+
+¹ Unsloth at 32B fits only with its own `use_gradient_checkpointing="unsloth"` mode; without it, it OOMs at ~23 GB. Final losses match to ≤4×10⁻⁴ across methods (kernel dispatch); Poros is bit-identical to its resident reference on the primary platform.
+
+**RTX 5090 (32 GB)** — official validation runs (PyTorch 2.11.0+cu128):
+
+| Run | Steps | Peak VRAM | Result |
+|---|---|---|---|
+| Qwen2.5-32B, synthetic | 50 | **11.02 GB** | loss tracks the A100 trajectory to ~2×10⁻⁴ |
+| Qwen2.5-32B, real data (oasst1) | 100 | **11.02 GB** | padding-masked CE, same 11.02 GB envelope |
+| Qwen2.5-72B, end-to-end | 10 | **18.13 GB** train · 30.57 GB process peak | streamed load + training on one card; loss matches the PRO 6000 run to ~1×10⁻⁵ |
+
+The 72B process peak is the startup self-check probe, not the loader — the streamed loader's own ceiling is 1.63 GB at 72B. The 5090 runs use the instrumented single-pass validation protocol, so step-time comparisons belong in the 3090 table above.
+
+The cost, on consumer hardware: 0.87 vs 0.51 s/step at 7B on the 3090 (about 1.7×). At 32B and 72B there is no resident consumer baseline to be slower than — it OOMs. If your model fits comfortably resident, run it resident.
+
+The streamed NF4 loader (default) keeps host RAM at 12.1 / 34.7 / 48.2 GB RSS for 7B / 32B / 72B (standard path: 15.3 / 62.0 / 136.5 GB).
+
+Reproduce any row with the shipped configs, e.g. `poros bench run configs/bench/official_a100_qwen25_32b.yaml`. Consumer guidance: [docs/consumer-gpus.md](https://github.com/Caistro-Labs/poros/blob/main/docs/consumer-gpus.md).
+
+## Supported models
+
+Every validated family is gated at exactly 0.00e+00 on real hardware — byte-identical load plus bitwise training parity. The four surfaces (loss, adapter weights, gradient norms, optimizer state) are gated directly at 7B and 32B; at 72B, loss and weights are gated directly and the other two are inferred from the bit-identical weights.
+
+| Family | `model_type` | Coverage |
+|---|---|---|
+| Qwen2.5 | `qwen2` | 0.5B–72B, incl. DeepSeek-R1-Distill-Qwen |
+| Qwen3 | `qwen3` | 32B |
+| Qwen3.5 / Qwen3.6 dense | `qwen3_5` | 0.8B–27B |
+| Gemma 3 | `gemma3` | 27B |
+| Gemma 4 | `gemma4` | 31B |
+
+Check any model without downloading it:
+
+```bash
+poros check Qwen/Qwen3.5-27B   # resolves model_type + status, no torch needed
+```
+
+Unvalidated architectures fail loudly instead of training with an unverified guarantee. MoE models with fused expert layers (Qwen3-MoE, GLM-4.5+, gpt-oss) are not NF4-quantizable and are out of scope. Roadmap and the registry mechanism: [docs/architecture-support.md](https://github.com/Caistro-Labs/poros/blob/main/docs/architecture-support.md).
+
+## How it works
+
+A frozen base receives no gradients — it sits in VRAM only because the forward pass reads it. Poros bounds residency to one block plus prefetch in both directions: the forward streams blocks through a small GPU window, the backward reloads each block and recomputes its forward before differentiating adapters and block inputs.
+
+Exactness comes from RNG capture. Recomputing a block would normally redraw its dropout masks and silently change the gradients; Poros snapshots CPU and CUDA RNG state before each block's forward and restores it inside `torch.random.fork_rng` during recomputation, so the backward runs on the identical graph. Nothing about the learning problem changes — same kernels, same optimizer, same data order.
+
+The formal statement and full audit matrix are in the [paper](https://github.com/Caistro-Labs/poros/blob/main/paper/poros.pdf). Configurations that would break parity silently (block-major gradient accumulation with dropout) raise instead of degrading.
+
+## Limitations
+
+- **Slower than resident training** — 1.6–4.3× per step, hardware-dependent. That is the trade.
+- **Single GPU** in v0.1; multi-GPU is v0.2 work.
+- **Dense architectures only** — fused-expert MoE is not NF4-quantizable.
+- **LoRA-family adapters on a frozen base** — full fine-tuning is out of scope.
+- **Host RAM** holds the streamed base: provision to the measured RSS peaks above.
+- The 72B end-to-end process peak is ~30.5 GB today (a 32 GB card) — the training step itself needs 18.87 GB.
+
+The complete list: [docs/limitations.md](https://github.com/Caistro-Labs/poros/blob/main/docs/limitations.md).
+
+## Docs
+
+| | |
+|---|---|
+| [Quickstart](https://github.com/Caistro-Labs/poros/blob/main/docs/quickstart.md) | `prepare()`, `PorosTrainer`, exporting adapters |
+| [API](https://github.com/Caistro-Labs/poros/blob/main/docs/api.md) | every public surface, typed |
+| [Architecture support](https://github.com/Caistro-Labs/poros/blob/main/docs/architecture-support.md) | validated registry, `poros check`, adding families |
+| [Consumer GPUs](https://github.com/Caistro-Labs/poros/blob/main/docs/consumer-gpus.md) | 3090/4090/5090 guidance |
+| [Parity modes](https://github.com/Caistro-Labs/poros/blob/main/docs/parity-modes.md) | what 0.00e+00 covers, mode sweep |
+| [Benchmarks](https://github.com/Caistro-Labs/poros/blob/main/docs/bench.md) | running the harness, HTML reports |
+| [Validation artifacts](https://github.com/Caistro-Labs/poros/tree/main/docs/validation) | raw gate JSONL for every claim |
+
+## Citation
+
+```bibtex
+@article{tigres2026poros,
+  title   = {Poros: Bit-Exact Large-Model Fine-Tuning on Consumer GPUs},
+  author  = {Tigres, Jeffrey},
+  journal = {arXiv preprint arXiv:ARXIV_ID},
+  year    = {2026}
+}
+```
+
+## License
+
+[Apache-2.0](https://github.com/Caistro-Labs/poros/blob/main/LICENSE). Built by [Caistro Labs](https://caistrolabs.com).

poros_train-0.1.0/README.md

@@ -0,0 +1,178 @@
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/poros-banner-dark.png" alt="Poros — bit-exact fine-tuning on consumer GPUs" width="100%">
+
+<a href="https://pypi.org/project/poros-train/"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-pypi.png" height="28" alt="pypi v0.1.0"></a>&nbsp;<a href="https://github.com/Caistro-Labs/poros/blob/main/pyproject.toml"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-python.png" height="28" alt="python 3.11+"></a>&nbsp;<a href="https://github.com/Caistro-Labs/poros/blob/main/LICENSE"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-license.png" height="28" alt="license apache-2.0"></a>&nbsp;<a href="https://github.com/Caistro-Labs/poros/tree/main/docs/validation"><img src="https://raw.githubusercontent.com/Caistro-Labs/poros/main/docs/assets/badge-parity.png" height="28" alt="parity 0.00e+00"></a>
+
+<br>
+
+<a href="#install"><kbd>&nbsp;Install&nbsp;</kbd></a>&nbsp;
+<a href="#quickstart"><kbd>&nbsp;Quickstart&nbsp;</kbd></a>&nbsp;
+<a href="#benchmarks"><kbd>&nbsp;Benchmarks&nbsp;</kbd></a>&nbsp;
+<a href="#supported-models"><kbd>&nbsp;Models&nbsp;</kbd></a>&nbsp;
+<a href="#how-it-works"><kbd>&nbsp;How&nbsp;it&nbsp;works&nbsp;</kbd></a>&nbsp;
+<a href="https://github.com/Caistro-Labs/poros/blob/main/docs/index.md"><kbd>&nbsp;Docs&nbsp;</kbd></a>&nbsp;
+<a href="https://github.com/Caistro-Labs/poros/blob/main/paper/poros.pdf"><kbd>&nbsp;Paper&nbsp;</kbd></a>
+
+</div>
+
+---
+
+Poros streams the frozen base of a QLoRA fine-tune through the GPU one block at a time, so only the adapters and a single block are ever resident. The adapter it produces is bit-for-bit identical to a fully resident run, verified with `torch.equal` (not `allclose`): all four surfaces — loss, adapter weights, gradient norms, and optimizer state — are gated directly at 7B and 32B; at 72B, loss and weights are gated directly and the other two are inferred from the bit-identical weight trajectory.
+
+- **32B trains in 11.61 GB** peak VRAM (44.88 GB resident) — inside a 16 GB budget
+- **72B trains end-to-end on a single RTX 5090** — 18.13 GB training peak on the 5090 (18.87 GB canonical; 81.57 GB resident)
+- **Parity is 0.00e+00, not "close"** — gated over 200-step and 1000-step runs, with dropout, gradient accumulation, and `torch.compile`
+- **One line** on top of your existing PEFT script
+
+## Install
+
+```bash
+pip install poros-train            # CLI + config, no GPU needed
+pip install "poros-train[ml]"      # + torch, transformers, peft, bitsandbytes
+pip install "poros-train[ml,bench]"  # + benchmark harness
+```
+
+Python 3.11+, PyTorch 2.10+, Transformers 5.5+, Linux with CUDA. The base install runs `poros --help`, `poros check`, and `poros doctor` on CPU-only machines.
+
+## Quickstart
+
+Already have a Hugging Face + PEFT script? Add one line and keep your loop:
+
+```python
+import poros
+
+model = poros.prepare(model)   # your loop, your config, untouched
+trainer.train()
+```
+
+```text
+Poros prepared model
+        model  Qwen/Qwen2.5-7B
+   model_type  qwen2
+ architecture  certified
+      adapter  lora (certified)
+    precision  NF4
+        stack  certified
+   block_size  4
+    guarantee  official bitwise path (NF4, deterministic)
+```
+
+`prepare()` never touches your training setup — learning rate, LoRA config, optimizer, and data stay exactly as you wrote them. It detects the architecture, wraps the model in place, and reports which guarantee applies. Paths not gated at 0.00e+00 are labeled `experimental` or `target`. Reverse it any time with `poros.unprepare(model)`.
+
+No script yet? `PorosTrainer` is the five-line path:
+
+```python
+from poros import PorosTrainer
+
+trainer = PorosTrainer.from_pretrained(
+    "Qwen/Qwen2.5-32B", quantization="nf4", lora_rank=16, lora_alpha=32,
+)
+trainer.train("OpenAssistant/oasst1", steps=200, seq_len=512)
+trainer.save("./poros-qwen32b-lora")
+```
+
+The saved adapter is a standard PEFT adapter — load it with `PeftModel.from_pretrained`, or merge for vLLM/TGI with `poros export ./poros-qwen32b-lora -o ./merged`. See [examples/inference.py](https://github.com/Caistro-Labs/poros/blob/main/examples/inference.py).
+
+If a block doesn't fit your card, `PorosOOMError` suggests a smaller `block_size` to try. Details: [docs/quickstart.md](https://github.com/Caistro-Labs/poros/blob/main/docs/quickstart.md) · [docs/api.md](https://github.com/Caistro-Labs/poros/blob/main/docs/api.md).
+
+## Benchmarks
+
+Consumer cards, measured. Every row has a raw artifact in [docs/validation/](https://github.com/Caistro-Labs/poros/tree/main/docs/validation); the datacenter matrices (A100, B300, RTX PRO 6000) live in [docs/official-a100-results.md](https://github.com/Caistro-Labs/poros/blob/main/docs/official-a100-results.md) and [docs/official-b300-results.md](https://github.com/Caistro-Labs/poros/blob/main/docs/official-b300-results.md).
+
+**RTX 3090 (24 GB)** — Qwen2.5 QLoRA, all methods on identical data, seeds, and deterministic kernels (rank-16 LoRA, NF4, seq_len 512, 200 steps):
+
+| Scale | Method | Peak VRAM | s/step |
+|---|---|---|---|
+| 7B | PEFT QLoRA | 16.37 GB | 0.51 |
+| 7B | Accelerate CPU-offload | 9.71 GB | 0.73 |
+| 7B | Unsloth QLoRA | 8.66 GB | 0.53 |
+| 7B | **Poros** | **6.90 GB** | 0.87 |
+| 32B | PEFT QLoRA | OOM | — |
+| 32B | Accelerate CPU-offload | OOM | — |
+| 32B | Unsloth QLoRA¹ | 22.29 GB | 2.07 |
+| 32B | **Poros** | **11.61 GB** | 3.21 |
+
+¹ Unsloth at 32B fits only with its own `use_gradient_checkpointing="unsloth"` mode; without it, it OOMs at ~23 GB. Final losses match to ≤4×10⁻⁴ across methods (kernel dispatch); Poros is bit-identical to its resident reference on the primary platform.
+
+**RTX 5090 (32 GB)** — official validation runs (PyTorch 2.11.0+cu128):
+
+| Run | Steps | Peak VRAM | Result |
+|---|---|---|---|
+| Qwen2.5-32B, synthetic | 50 | **11.02 GB** | loss tracks the A100 trajectory to ~2×10⁻⁴ |
+| Qwen2.5-32B, real data (oasst1) | 100 | **11.02 GB** | padding-masked CE, same 11.02 GB envelope |
+| Qwen2.5-72B, end-to-end | 10 | **18.13 GB** train · 30.57 GB process peak | streamed load + training on one card; loss matches the PRO 6000 run to ~1×10⁻⁵ |
+
+The 72B process peak is the startup self-check probe, not the loader — the streamed loader's own ceiling is 1.63 GB at 72B. The 5090 runs use the instrumented single-pass validation protocol, so step-time comparisons belong in the 3090 table above.
+
+The cost, on consumer hardware: 0.87 vs 0.51 s/step at 7B on the 3090 (about 1.7×). At 32B and 72B there is no resident consumer baseline to be slower than — it OOMs. If your model fits comfortably resident, run it resident.
+
+The streamed NF4 loader (default) keeps host RAM at 12.1 / 34.7 / 48.2 GB RSS for 7B / 32B / 72B (standard path: 15.3 / 62.0 / 136.5 GB).
+
+Reproduce any row with the shipped configs, e.g. `poros bench run configs/bench/official_a100_qwen25_32b.yaml`. Consumer guidance: [docs/consumer-gpus.md](https://github.com/Caistro-Labs/poros/blob/main/docs/consumer-gpus.md).
+
+## Supported models
+
+Every validated family is gated at exactly 0.00e+00 on real hardware — byte-identical load plus bitwise training parity. The four surfaces (loss, adapter weights, gradient norms, optimizer state) are gated directly at 7B and 32B; at 72B, loss and weights are gated directly and the other two are inferred from the bit-identical weights.
+
+| Family | `model_type` | Coverage |
+|---|---|---|
+| Qwen2.5 | `qwen2` | 0.5B–72B, incl. DeepSeek-R1-Distill-Qwen |
+| Qwen3 | `qwen3` | 32B |
+| Qwen3.5 / Qwen3.6 dense | `qwen3_5` | 0.8B–27B |
+| Gemma 3 | `gemma3` | 27B |
+| Gemma 4 | `gemma4` | 31B |
+
+Check any model without downloading it:
+
+```bash
+poros check Qwen/Qwen3.5-27B   # resolves model_type + status, no torch needed
+```
+
+Unvalidated architectures fail loudly instead of training with an unverified guarantee. MoE models with fused expert layers (Qwen3-MoE, GLM-4.5+, gpt-oss) are not NF4-quantizable and are out of scope. Roadmap and the registry mechanism: [docs/architecture-support.md](https://github.com/Caistro-Labs/poros/blob/main/docs/architecture-support.md).
+
+## How it works
+
+A frozen base receives no gradients — it sits in VRAM only because the forward pass reads it. Poros bounds residency to one block plus prefetch in both directions: the forward streams blocks through a small GPU window, the backward reloads each block and recomputes its forward before differentiating adapters and block inputs.
+
+Exactness comes from RNG capture. Recomputing a block would normally redraw its dropout masks and silently change the gradients; Poros snapshots CPU and CUDA RNG state before each block's forward and restores it inside `torch.random.fork_rng` during recomputation, so the backward runs on the identical graph. Nothing about the learning problem changes — same kernels, same optimizer, same data order.
+
+The formal statement and full audit matrix are in the [paper](https://github.com/Caistro-Labs/poros/blob/main/paper/poros.pdf). Configurations that would break parity silently (block-major gradient accumulation with dropout) raise instead of degrading.
+
+## Limitations
+
+- **Slower than resident training** — 1.6–4.3× per step, hardware-dependent. That is the trade.
+- **Single GPU** in v0.1; multi-GPU is v0.2 work.
+- **Dense architectures only** — fused-expert MoE is not NF4-quantizable.
+- **LoRA-family adapters on a frozen base** — full fine-tuning is out of scope.
+- **Host RAM** holds the streamed base: provision to the measured RSS peaks above.
+- The 72B end-to-end process peak is ~30.5 GB today (a 32 GB card) — the training step itself needs 18.87 GB.
+
+The complete list: [docs/limitations.md](https://github.com/Caistro-Labs/poros/blob/main/docs/limitations.md).
+
+## Docs
+
+| | |
+|---|---|
+| [Quickstart](https://github.com/Caistro-Labs/poros/blob/main/docs/quickstart.md) | `prepare()`, `PorosTrainer`, exporting adapters |
+| [API](https://github.com/Caistro-Labs/poros/blob/main/docs/api.md) | every public surface, typed |
+| [Architecture support](https://github.com/Caistro-Labs/poros/blob/main/docs/architecture-support.md) | validated registry, `poros check`, adding families |
+| [Consumer GPUs](https://github.com/Caistro-Labs/poros/blob/main/docs/consumer-gpus.md) | 3090/4090/5090 guidance |
+| [Parity modes](https://github.com/Caistro-Labs/poros/blob/main/docs/parity-modes.md) | what 0.00e+00 covers, mode sweep |
+| [Benchmarks](https://github.com/Caistro-Labs/poros/blob/main/docs/bench.md) | running the harness, HTML reports |
+| [Validation artifacts](https://github.com/Caistro-Labs/poros/tree/main/docs/validation) | raw gate JSONL for every claim |
+
+## Citation
+
+```bibtex
+@article{tigres2026poros,
+  title   = {Poros: Bit-Exact Large-Model Fine-Tuning on Consumer GPUs},
+  author  = {Tigres, Jeffrey},
+  journal = {arXiv preprint arXiv:ARXIV_ID},
+  year    = {2026}
+}
+```
+
+## License
+
+[Apache-2.0](https://github.com/Caistro-Labs/poros/blob/main/LICENSE). Built by [Caistro Labs](https://caistrolabs.com).