ohagi 1.0.0__tar.gz

ohagi-1.0.0/AUTHORS

@@ -0,0 +1,4 @@
+SOULS-TAMU contributors
+
+Upstream research authors include Rahul Golder,
+Bimol Nath Roy, and M. M. Faruque Hasan. See CITATION.bib and NOTICE.

ohagi-1.0.0/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Changelog
+
+Notable changes to OHAGI are recorded here. This history starts with the
+initial public version; internal development steps are not separate releases.
+The initial release is still in preparation, so no release date is assigned.
+
+## 1.0.0 — Unreleased
+
+- Promote the shared-stack implementation to `main`; preserve the previous main in `v0.1.0`.
+- Align main-branch installation links, badges and citation metadata.
+
+### Added
+
+- Added stateful update-rejection, early-stopping, compiled-epoch, metadata-validation
+  and extension-registry regression tests.
+
+- API, numerical, frontend integration, dependency review, documentation,
+  quality regression and informational performance workflows.
+
+- Expanded numerical, training, artifact and optional-adapter regression tests,
+  with an inclusive 90% combined statement-and-branch coverage gate.
+
+- Cross-platform CPU CI for Linux, Windows and Apple Silicon macOS, with
+  baseline/current JAX, runtime configuration artifacts and ARM64 coverage.
+
+- GitHub Actions CI for numerical tests, package checks and Ruff, with measured
+  branch coverage reporting and scheduled Python CodeQL analysis.
+
+- A shared JAX learning engine for the KKTHN, DAEHN and NLPOPTNet frontends,
+  with framework-specific problem definitions supplied by those packages.
+- Projected neural models using PURIN's projection algorithms and kernels.
+- Functional JAX backbones and optional Flax backbone adapters.
+- Shared training, optimizer and batching utilities, with optional Optax
+  integration and Orbax training checkpoints.
+- A shared JAX model bundle for export and loading through `metadata.json`,
+  supporting repeated single-instance inference.
+- Python package metadata, an executable quick start, model artifact
+  documentation and contribution guidance.
+- Apache-2.0 licensing and machine-readable software citation metadata.
+
+### Fixed
+
+- Preserve training-state buffers when discarding a donated Flax warmup update.

ohagi-1.0.0/CITATION.bib

@@ -0,0 +1,8 @@
+@misc{ohagi,
+  author       = {{SOULS-TAMU contributors}},
+  title        = {{OHAGI}: A shared {JAX} engine for hard-constrained neural networks},
+  howpublished = {Computer software},
+  version      = {1.0.0},
+  url          = {https://github.com/SOULS-TAMU/Ohagi},
+  note         = {Version 1.0.0, initial release in preparation. Licensed under Apache-2.0}
+}

ohagi-1.0.0/CITATION.cff

@@ -0,0 +1,10 @@
+cff-version: 1.2.0
+message: "If you use OHAGI, please cite this software. A BibTeX entry is available in CITATION.bib."
+type: software
+title: "OHAGI: A shared JAX engine for hard-constrained neural networks"
+authors:
+  - name: "SOULS-TAMU contributors"
+version: "1.0.0"
+url: "https://github.com/SOULS-TAMU/Ohagi"
+repository-code: "https://github.com/SOULS-TAMU/Ohagi"
+license: Apache-2.0

ohagi-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# Contributing to OHAGI
+
+Thank you for helping improve OHAGI. Bug reports, documentation fixes,
+examples and numerical improvements are welcome. This guide accompanies
+the first public version of the project.
+
+## Before you start
+
+For a small fix, open a focused pull request. For a new public API, dependency
+or change to numerical behavior, open an issue first so the design can be
+discussed before implementation.
+
+Bug reports should include a minimal reproducer, the expected and observed
+behavior, package versions, device, precision settings and random seed.
+Include the traceback when an exception occurs. Remove private data and
+credentials from examples and logs.
+
+## Development setup
+
+Use Python 3.10 or newer in an isolated environment. With sibling OHAGI and
+PURIN source checkouts, run the following from their parent directory:
+
+```sh
+python -m pip install -e ./purin -e "./ohagi[dev]"
+```
+
+Install optional features only when needed:
+
+```sh
+python -m pip install -e "./ohagi[flax,orbax,optax,plotting]"
+```
+
+For frontend integration work, also install the relevant KKTHN, DAEHN or
+NLPOPTNet checkout in editable mode. Follow the
+[JAX installation instructions](https://docs.jax.dev/en/latest/installation.html)
+for your device. See the [README](README.md) for a runnable quick start.
+
+## Keep responsibilities clear
+
+OHAGI owns the shared learning engine: backbone adapters, training, model
+export and metadata-driven inference. PURIN owns projection algorithms and
+numerical kernels. KKTHN, DAEHN and NLPOPTNet own their problem definitions
+and framework-specific policies.
+
+Keep these dependencies directed toward the shared libraries. Do not add
+frontend imports to OHAGI or copy projection solvers into it. Reuse the
+shared engine instead of introducing a separate training or inference path.
+
+## Code and documentation
+
+Use descriptive names, small functions and Google-style docstrings for
+public APIs. Document array shapes, coordinate conventions, residual signs
+and gradient behavior where they affect callers. Explain mathematical
+choices and invariants in comments; avoid restating the code.
+
+Run these checks from the OHAGI directory:
+
+```sh
+python -m ruff format --check src
+python -m ruff check --select F,E9 src
+```
+
+Use `python -m ruff format src` to apply formatting. Keep unrelated formatting
+changes out of a pull request, and leave benchmark scripts unchanged unless
+the proposed change specifically concerns them.
+
+## Validate your change
+
+Include a focused regression test or a reproducible validation script with
+the pull request. Record the commands, environment and results so another
+contributor can repeat the checks. Run the README quick start for changes
+that affect installation or the public workflow.
+
+Match validation to the affected behavior:
+
+| Change | Required comparison |
+| --- | --- |
+| Numerical or projection interfaces | Outputs, parameter gradients and constraint residuals against the previous implementation. |
+| Training or checkpoint handling | Training histories and parameters, including resumed versus uninterrupted training. |
+| Export or inference | Export, reload through `metadata.json` in a fresh process, and repeated single-instance predictions. |
+| Public interfaces | Signatures, aliases and the relevant unchanged frontend benchmark scripts. |
+| Restructuring or documentation | Confirm executable behavior is unchanged; check examples and links. |
+
+Use identical inputs, seeds, JAX versions, devices and precision settings for
+numerical comparisons. Report tolerances explicitly and investigate any
+difference. Separate intentional numerical changes from restructuring.
+For inference timing, warm up compilation and synchronize device execution.
+
+The [model artifact guide](docs/artifacts.md) describes inference bundles
+and training checkpoints. Preserve their documented contracts.
+
+## Packaging checks
+
+From the OHAGI directory, build and validate distributions:
+
+```sh
+python -m pip install build twine
+python -m build
+python -m twine check dist/*
+```
+
+Install the built wheel in a separate environment with PURIN available and
+exercise the affected public workflow. Do not commit environments, caches,
+build output, generated results or checkpoints.
+
+## Pull request checklist
+
+- Explain the problem and the resulting behavior.
+- Keep the change focused and identify any compatibility implications.
+- Include reproducible validation results and numerical tolerances.
+- Update documentation and the appropriate unreleased changelog entry.
+- Preserve benchmark APIs and metadata-driven inference unless an API change
+  has been explicitly agreed.
+
+Contributions are provided under the project's [Apache-2.0 license](LICENSE).
+Preserve relevant attribution in [AUTHORS](AUTHORS) and [NOTICE](NOTICE).
+Keep [CITATION.bib](CITATION.bib) and [CITATION.cff](CITATION.cff) consistent.
+The CFF metadata supports GitHub's citation panel; BibTeX remains available directly.
+
+## Automated checks
+
+CI runs the full numerical suite on CPU across these configurations:
+
+| Platform | Python | JAX configuration |
+| --- | --- | --- |
+| Linux x86-64, Windows x86-64, macOS Apple Silicon | 3.10–3.14 | Newest compatible dependencies for each interpreter. |
+| Linux x86-64, Windows x86-64, macOS Apple Silicon | 3.12 | JAX/JAXlib 0.6.2 baseline. |
+| Linux ARM64 | 3.13 | Newest compatible dependencies. |
+
+The configuration tests additionally exercise float32/float64, eager/JIT
+execution and batch sizes one and four for the equality projection and
+functional backbone interfaces. Full solver regression tests use float64.
+Ruff runs on Linux; wheel and source-distribution builds and installation
+checks run on Linux, Windows and macOS. Each core test job uploads its OS,
+architecture, Python, package versions and JAX devices as a diagnostic artifact.
+The test suite is in `tests/`. CPU results do not establish GPU/TPU support.
+
+Flax, Optax and Orbax have separate integration jobs on all three OSes.
+Another job exports float32/float64 inference bundles on Linux and reloads
+the same artifacts on Linux, Windows and macOS using the exporter's JAX
+version. It exercises repeated single-instance inference from `metadata.json`.
+
+Install the test dependencies with `python -m pip install ".[test]"`, then run:
+
+```sh
+python -m pip install ".[test,flax,orbax,optax,plotting]"
+python -m pytest -q --cov=ohagi --cov-branch --cov-report=term-missing --cov-report=xml --cov-report=json
+```
+
+Coverage measures the entire package, including unexecuted modules. The badge
+combines statement and branch coverage from the Linux x86-64 / Python 3.12 / current-JAX full test run, including the optional adapters.
+Reports are retained as workflow artifacts; the badge and measured totals are
+published to `codex/coverage` after successful trusted pushes to `main`.
+Pull requests run checks with read-only repository access and do not publish
+coverage. No third-party coverage account or additional secret is required.
+
+CodeQL runs extended Python security analysis on pushes, pull requests and a
+weekly schedule. Its badge reports workflow execution status; inspect code
+scanning alerts separately. GitHub Actions dependencies are pinned to commits
+and monitored by Dependabot.
+
+The combined statement-and-branch coverage floor is 90%. All source modules,
+including optional adapters and unexecuted files, remain in the denominator.
+Do not omit modules to improve the score.
+
+## Compatibility and quality regression checks
+
+Additional workflows protect public APIs, numerical results and frontend
+integration, validate documentation and dependency changes, and publish code
+quality and performance reports. See the [validation policies](.github/validation/README.md)
+for thresholds, existing baselines and reproduction instructions. Timing changes
+are informational; correctness and quality regressions fail their checks.

ohagi-1.0.0/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 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 2026 MM Faruque Hasan, Bimol Nath Roy and Rahul Golder
+
+   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.

ohagi-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include AUTHORS CHANGELOG.md CITATION.bib CITATION.cff CONTRIBUTING.md NOTICE
+
+recursive-include docs *.rst *.md *.py *.css *.html *.json *.txt *.png
+recursive-include assets *.png *.svg

ohagi-1.0.0/NOTICE

@@ -0,0 +1,12 @@
+OHAGI
+
+Copyright (c) 2025 SOULS-TAMU
+
+Part of the HardNet stack maintained from SOULS-TAMU implementations.
+KKT-HardNet, DAEHN, and NLPOpt-Net contributions retain their
+upstream authorship and applicable license terms.
+Original repositories: https://github.com/SOULS-TAMU/kkt-hardnet
+and https://github.com/SOULS-TAMU/nlpoptnet.
+
+The current project is licensed under the Apache License, Version 2.0.
+See LICENSE for the full terms.