phijax 0.1.0b1__tar.gz

phijax-0.1.0b1/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 [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.

phijax-0.1.0b1/PKG-INFO

@@ -0,0 +1,219 @@
+Metadata-Version: 2.4
+Name: phijax
+Version: 0.1.0b1
+Summary: A configuration-first JAX framework for training physics-informed neural networks.
+Keywords: jax,physics-informed-neural-networks,pinn,scientific-machine-learning
+Author: Hang Jung Ling
+Author-email: Hang Jung Ling <hangjung.ling@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Dist: colorlog>=6.10,<7
+Requires-Dist: flax==0.12.9
+Requires-Dist: hydra-core==1.3.5
+Requires-Dist: h5py>=3.16,<4
+Requires-Dist: jax==0.11.1
+Requires-Dist: mat73>=0.65,<1
+Requires-Dist: numpy>=2.4,<3
+Requires-Dist: omegaconf==2.3.1
+Requires-Dist: optax==0.2.8
+Requires-Dist: orbax-checkpoint==0.12.4
+Requires-Dist: rich>=15,<16
+Requires-Dist: rootutils>=1.0.7,<2
+Requires-Dist: scipy>=1.17,<2
+Requires-Dist: jax[cuda12]==0.11.1 ; extra == 'cuda12'
+Requires-Dist: jax[cuda13]==0.11.1 ; extra == 'cuda13'
+Requires-Dist: tensorboard>=2.20,<3 ; extra == 'tensorboard'
+Requires-Dist: wandb>=0.29,<0.30 ; extra == 'wandb'
+Requires-Python: >=3.12
+Project-URL: Changelog, https://github.com/HangJung97/PhiJAX/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://hangjung97.github.io/PhiJAX
+Project-URL: Issues, https://github.com/HangJung97/PhiJAX/issues
+Project-URL: Repository, https://github.com/HangJung97/PhiJAX
+Provides-Extra: cuda12
+Provides-Extra: cuda13
+Provides-Extra: tensorboard
+Provides-Extra: wandb
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# PhiJAX
+
+[![Code Quality](https://github.com/HangJung97/PhiJAX/actions/workflows/code-quality-main.yaml/badge.svg)](https://github.com/HangJung97/PhiJAX/actions/workflows/code-quality-main.yaml)
+[![Tests](https://github.com/HangJung97/PhiJAX/actions/workflows/tests.yaml/badge.svg)](https://github.com/HangJung97/PhiJAX/actions/workflows/tests.yaml)
+[![Documentation](https://github.com/HangJung97/PhiJAX/actions/workflows/docs.yaml/badge.svg)](https://github.com/HangJung97/PhiJAX/actions/workflows/docs.yaml)
+[![Codecov](https://codecov.io/gh/HangJung97/PhiJAX/graph/badge.svg)](https://codecov.io/gh/HangJung97/PhiJAX)
+<br>
+[![Python](https://img.shields.io/pypi/pyversions/phijax?logo=python&logoColor=white&color=blue)](https://pypi.org/project/phijax/)
+[![PyPI](https://img.shields.io/pypi/v/phijax)](https://pypi.org/project/phijax/)
+<br>
+[![License](https://img.shields.io/github/license/HangJung97/PhiJAX?color=blue)](LICENSE)
+
+</div>
+
+PhiJAX is a typed [JAX](https://docs.jax.dev/) framework for physics-informed neural networks (PINNs). It provides the
+core tools for training PINNs: functional state, explicit-key sampling, reusable equations and objectives, adaptive
+loss balancing, callbacks, logging, checkpointing, and prediction artifacts. Its `Trainer` and `PhiModule` lifecycles
+are inspired by Lightning.
+
+For a configuration-first project layout, start from
+[`phijax-hydra-template`](https://github.com/HangJung97/phijax-hydra-template) and customize its entrypoints, Hydra
+configs, and application DataModules.
+
+> **Beta API:** PhiJAX `0.1.0b1` defines the first supported public API. Minor changes may still occur before `1.0`.
+> Checkpoints can be restored by compatible PhiJAX releases from the same major and minor version.
+
+[Quickstart](https://hangjung97.github.io/PhiJAX/getting-started/quickstart/) |
+[Guides](https://hangjung97.github.io/PhiJAX/guides/datasets/) |
+[API reference](https://hangjung97.github.io/PhiJAX/api/) |
+[Changelog](CHANGELOG.md) |
+[Contributing](CONTRIBUTING.md)
+
+## Why PhiJAX?
+
+JAX provides automatic differentiation, vectorization, compilation, and accelerator support. PhiJAX adds the
+structure needed to build reproducible, maintainable PINN experiments:
+
+- selective coordinate derivatives and reusable PDE, boundary, and data-fidelity equations;
+- named objective terms with static, gradient-norm, and exact-NTK loss balancing;
+- standard MLP, Modified MLP, and adaptive-residual PirateNet architectures with a custom NNX adapter;
+- explicit model, optimizer, balancer, and PRNG state for reproducible compiled updates;
+- familiar, Lightning-inspired lifecycles for trainers, modules, DataModules, callbacks, loggers, and checkpoints; and
+- scientific data preparation on the CPU, automatic batch placement by the Trainer, and prediction files with a
+  stable, versioned format.
+
+PhiJAX reduces boilerplate for training, prediction, logging, and checkpointing without hiding JAX transformations or
+functional state. Hydra support is optional, and the core Trainer API does not depend on a configuration framework.
+
+## Installation
+
+PhiJAX requires Python 3.12 or newer. Python 3.12, 3.13, and 3.14 are covered by CI.
+
+```bash
+pip install phijax
+```
+
+The default installation includes CPU-capable JAX. Select one mutually exclusive GPU extra when the matching NVIDIA
+runtime is available:
+
+```bash
+pip install "phijax[cuda12]"
+# or
+pip install "phijax[cuda13]"
+```
+
+Optional experiment loggers are installed separately:
+
+```bash
+pip install "phijax[tensorboard]"
+pip install "phijax[wandb]"
+```
+
+Extras can be combined when an environment needs GPU support and both logging integrations:
+
+```bash
+pip install "phijax[cuda13,wandb,tensorboard]"
+```
+
+Replace `cuda13` with `cuda12` for a CUDA 12 environment; do not install both CUDA extras together.
+
+See the [installation guide](https://hangjung97.github.io/PhiJAX/getting-started/installation/) for environment
+verification and development setup.
+
+## Quickstart
+
+The first runnable example solves a one-dimensional heat equation with initial, boundary, and PDE losses. It uses no
+external data and runs on CPU after JAX completes its initial compilation:
+
+```bash
+git clone https://github.com/HangJung97/PhiJAX.git
+cd PhiJAX
+uv sync
+JAX_PLATFORMS=cpu uv run --no-sync python examples/quickstart.py
+```
+
+`JAX_PLATFORMS=cpu` keeps the whole process strictly CPU-only. This is stronger than selecting
+`Trainer(accelerator="cpu")`, which controls PhiJAX placement without changing JAX's process-wide default backend.
+
+Read the [annotated quickstart](https://hangjung97.github.io/PhiJAX/getting-started/quickstart/) for the equation,
+complete source, and an explanation of each runtime object.
+
+## Core workflow
+
+PhiJAX keeps each part of a PINN workflow explicit:
+
+```text
+DataModule -> named batches ---------------------------> Trainer
+                                                               |
+InitializedModel -> PhiModule -> named objective losses -------+-> TrainingPlan -> compiled update
+                                                               |
+LossBalancer -> weights and diagnostics -----------------------+
+```
+
+The Trainer prepares data sources, moves batches to devices, runs hooks, restores checkpoints, and cleans up resources.
+`TrainState` holds the model, optimizer, balancer, PRNG, and step values. `TrainingPlan` defines the pure compiled
+update.
+
+Application DataModules implement `setup()`, `train_batch_source()`, and optionally `predict_batch_source()`.
+Prediction is skipped cleanly when a DataModule has no prediction source.
+
+`Trainer` manages setup and cleanup automatically across fitting and prediction.
+
+## Core APIs
+
+- `Trainer`, `TrainingPlan`, and `TrainState` separate runtime orchestration from compiled state.
+- `BasePhiModule` and `PhiModule` provide overridable fit and prediction hooks without owning optimizers or balancers.
+- `PhiDataModule` owns host data and explicit-key batch sources. The Trainer owns device placement.
+- `InitializedModel` lets any JAX model factory return an apply callable, functional state, and optional summary.
+- `LossBalancer` supports arbitrary JAX-compatible state and exposes diagnostics without a prescribed state layout.
+- Derivative, equation, objective, callback, logger, evaluation, and artifact APIs can be reused across projects.
+- Hydra instantiation helpers and OmegaConf resolvers are available under `phijax.integrations` without coupling the
+  Trainer to Hydra.
+
+Only names documented in package `__all__` declarations are supported public imports.
+
+## Checkpoints and prediction artifacts
+
+PhiJAX saves complete training state in versioned checkpoints and produces portable prediction artifacts for
+downstream evaluation. Restoration raises an error when a checkpoint version is incompatible.
+
+## Development
+
+Install all development dependencies, then enable the repository hooks:
+
+```bash
+uv sync --group all
+uv run --no-sync pre-commit install
+```
+
+Run the local validation suite before submitting a change:
+
+```bash
+JAX_PLATFORMS=cpu uv run --no-sync pytest
+uv run --no-sync ruff check .
+uv run --no-sync ruff format --check .
+uv run --no-sync pyright
+uv run --no-sync mkdocs build --strict
+uv run --no-sync pre-commit run --all-files
+```
+
+See the [documentation](https://hangjung97.github.io/PhiJAX/) for the complete API and extension guides.
+
+## Contributing
+
+Contributions are welcome. Read the
+[contribution guide](https://github.com/HangJung97/PhiJAX/blob/main/CONTRIBUTING.md) for the development workflow,
+testing expectations, documentation requirements, and pull-request checklist.
+
+## License
+
+PhiJAX is distributed under the [Apache License 2.0](LICENSE).

phijax-0.1.0b1/README.md

@@ -0,0 +1,173 @@
+<div align="center">
+
+# PhiJAX
+
+[![Code Quality](https://github.com/HangJung97/PhiJAX/actions/workflows/code-quality-main.yaml/badge.svg)](https://github.com/HangJung97/PhiJAX/actions/workflows/code-quality-main.yaml)
+[![Tests](https://github.com/HangJung97/PhiJAX/actions/workflows/tests.yaml/badge.svg)](https://github.com/HangJung97/PhiJAX/actions/workflows/tests.yaml)
+[![Documentation](https://github.com/HangJung97/PhiJAX/actions/workflows/docs.yaml/badge.svg)](https://github.com/HangJung97/PhiJAX/actions/workflows/docs.yaml)
+[![Codecov](https://codecov.io/gh/HangJung97/PhiJAX/graph/badge.svg)](https://codecov.io/gh/HangJung97/PhiJAX)
+<br>
+[![Python](https://img.shields.io/pypi/pyversions/phijax?logo=python&logoColor=white&color=blue)](https://pypi.org/project/phijax/)
+[![PyPI](https://img.shields.io/pypi/v/phijax)](https://pypi.org/project/phijax/)
+<br>
+[![License](https://img.shields.io/github/license/HangJung97/PhiJAX?color=blue)](LICENSE)
+
+</div>
+
+PhiJAX is a typed [JAX](https://docs.jax.dev/) framework for physics-informed neural networks (PINNs). It provides the
+core tools for training PINNs: functional state, explicit-key sampling, reusable equations and objectives, adaptive
+loss balancing, callbacks, logging, checkpointing, and prediction artifacts. Its `Trainer` and `PhiModule` lifecycles
+are inspired by Lightning.
+
+For a configuration-first project layout, start from
+[`phijax-hydra-template`](https://github.com/HangJung97/phijax-hydra-template) and customize its entrypoints, Hydra
+configs, and application DataModules.
+
+> **Beta API:** PhiJAX `0.1.0b1` defines the first supported public API. Minor changes may still occur before `1.0`.
+> Checkpoints can be restored by compatible PhiJAX releases from the same major and minor version.
+
+[Quickstart](https://hangjung97.github.io/PhiJAX/getting-started/quickstart/) |
+[Guides](https://hangjung97.github.io/PhiJAX/guides/datasets/) |
+[API reference](https://hangjung97.github.io/PhiJAX/api/) |
+[Changelog](CHANGELOG.md) |
+[Contributing](CONTRIBUTING.md)
+
+## Why PhiJAX?
+
+JAX provides automatic differentiation, vectorization, compilation, and accelerator support. PhiJAX adds the
+structure needed to build reproducible, maintainable PINN experiments:
+
+- selective coordinate derivatives and reusable PDE, boundary, and data-fidelity equations;
+- named objective terms with static, gradient-norm, and exact-NTK loss balancing;
+- standard MLP, Modified MLP, and adaptive-residual PirateNet architectures with a custom NNX adapter;
+- explicit model, optimizer, balancer, and PRNG state for reproducible compiled updates;
+- familiar, Lightning-inspired lifecycles for trainers, modules, DataModules, callbacks, loggers, and checkpoints; and
+- scientific data preparation on the CPU, automatic batch placement by the Trainer, and prediction files with a
+  stable, versioned format.
+
+PhiJAX reduces boilerplate for training, prediction, logging, and checkpointing without hiding JAX transformations or
+functional state. Hydra support is optional, and the core Trainer API does not depend on a configuration framework.
+
+## Installation
+
+PhiJAX requires Python 3.12 or newer. Python 3.12, 3.13, and 3.14 are covered by CI.
+
+```bash
+pip install phijax
+```
+
+The default installation includes CPU-capable JAX. Select one mutually exclusive GPU extra when the matching NVIDIA
+runtime is available:
+
+```bash
+pip install "phijax[cuda12]"
+# or
+pip install "phijax[cuda13]"
+```
+
+Optional experiment loggers are installed separately:
+
+```bash
+pip install "phijax[tensorboard]"
+pip install "phijax[wandb]"
+```
+
+Extras can be combined when an environment needs GPU support and both logging integrations:
+
+```bash
+pip install "phijax[cuda13,wandb,tensorboard]"
+```
+
+Replace `cuda13` with `cuda12` for a CUDA 12 environment; do not install both CUDA extras together.
+
+See the [installation guide](https://hangjung97.github.io/PhiJAX/getting-started/installation/) for environment
+verification and development setup.
+
+## Quickstart
+
+The first runnable example solves a one-dimensional heat equation with initial, boundary, and PDE losses. It uses no
+external data and runs on CPU after JAX completes its initial compilation:
+
+```bash
+git clone https://github.com/HangJung97/PhiJAX.git
+cd PhiJAX
+uv sync
+JAX_PLATFORMS=cpu uv run --no-sync python examples/quickstart.py
+```
+
+`JAX_PLATFORMS=cpu` keeps the whole process strictly CPU-only. This is stronger than selecting
+`Trainer(accelerator="cpu")`, which controls PhiJAX placement without changing JAX's process-wide default backend.
+
+Read the [annotated quickstart](https://hangjung97.github.io/PhiJAX/getting-started/quickstart/) for the equation,
+complete source, and an explanation of each runtime object.
+
+## Core workflow
+
+PhiJAX keeps each part of a PINN workflow explicit:
+
+```text
+DataModule -> named batches ---------------------------> Trainer
+                                                               |
+InitializedModel -> PhiModule -> named objective losses -------+-> TrainingPlan -> compiled update
+                                                               |
+LossBalancer -> weights and diagnostics -----------------------+
+```
+
+The Trainer prepares data sources, moves batches to devices, runs hooks, restores checkpoints, and cleans up resources.
+`TrainState` holds the model, optimizer, balancer, PRNG, and step values. `TrainingPlan` defines the pure compiled
+update.
+
+Application DataModules implement `setup()`, `train_batch_source()`, and optionally `predict_batch_source()`.
+Prediction is skipped cleanly when a DataModule has no prediction source.
+
+`Trainer` manages setup and cleanup automatically across fitting and prediction.
+
+## Core APIs
+
+- `Trainer`, `TrainingPlan`, and `TrainState` separate runtime orchestration from compiled state.
+- `BasePhiModule` and `PhiModule` provide overridable fit and prediction hooks without owning optimizers or balancers.
+- `PhiDataModule` owns host data and explicit-key batch sources. The Trainer owns device placement.
+- `InitializedModel` lets any JAX model factory return an apply callable, functional state, and optional summary.
+- `LossBalancer` supports arbitrary JAX-compatible state and exposes diagnostics without a prescribed state layout.
+- Derivative, equation, objective, callback, logger, evaluation, and artifact APIs can be reused across projects.
+- Hydra instantiation helpers and OmegaConf resolvers are available under `phijax.integrations` without coupling the
+  Trainer to Hydra.
+
+Only names documented in package `__all__` declarations are supported public imports.
+
+## Checkpoints and prediction artifacts
+
+PhiJAX saves complete training state in versioned checkpoints and produces portable prediction artifacts for
+downstream evaluation. Restoration raises an error when a checkpoint version is incompatible.
+
+## Development
+
+Install all development dependencies, then enable the repository hooks:
+
+```bash
+uv sync --group all
+uv run --no-sync pre-commit install
+```
+
+Run the local validation suite before submitting a change:
+
+```bash
+JAX_PLATFORMS=cpu uv run --no-sync pytest
+uv run --no-sync ruff check .
+uv run --no-sync ruff format --check .
+uv run --no-sync pyright
+uv run --no-sync mkdocs build --strict
+uv run --no-sync pre-commit run --all-files
+```
+
+See the [documentation](https://hangjung97.github.io/PhiJAX/) for the complete API and extension guides.
+
+## Contributing
+
+Contributions are welcome. Read the
+[contribution guide](https://github.com/HangJung97/PhiJAX/blob/main/CONTRIBUTING.md) for the development workflow,
+testing expectations, documentation requirements, and pull-request checklist.
+
+## License
+
+PhiJAX is distributed under the [Apache License 2.0](LICENSE).