portallib 0.1.0__tar.gz

portallib-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+node_modules/
+out/
+__pycache__/
+*.pyc
+*.zip
+.DS_Store
+.venv/
+uv.lock
+.env
+.env.*
+!.env.example
+dist/
+*.pt
+*.pth
+*.safetensors

portallib-0.1.0/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to `portallib` are documented here.
+
+## 0.1.0 - 2026-07-15
+
+Initial public release of `portallib` on PyPI.
+
+- Canonical shared task-latent/core architecture with one exact-path alignment per base.
+- Joint multi-source core training, frozen-core target refitting, and normalized evaluation APIs.
+- Deterministic balanced task rounds, EMA loss normalization, per-base latent-gradient
+  balancing, learning-rate warmup, checkpointing, and best-validation-epoch selection.
+- Local and Hugging Face dataset loading, canonical JSON serialization, and explicit Hub upload.
+- Standard `save_pretrained`, `from_pretrained`, and `push_to_hub` behavior through
+  `ModelHubMixin`.
+- Exact PEFT model materialization and reloadable task-specific PEFT adapter export.
+- Published Qwen3-1.7B and Qwen3-4B source artifacts containing the jointly trained shared core and
+  task latents with their respective base alignments.
+- Published 1,000-example-per-task Qwen3-8B and Gemma 3 4B refit artifacts.
+- Pinned source training, target refitting, and evaluation recipes.
+- CPU correctness contracts plus Docker and Modal execution guidance.

portallib-0.1.0/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use PorTAL, please cite this software."
+title: "PorTAL: Portable Task Adapters for LLMs"
+type: software
+authors:
+  - family-names: Geist
+    given-names: Benjamin
+repository-code: "https://github.com/ramp-public/portallib"
+url: "https://x.com/RampLabs/status/2072381992285647280"
+version: 0.1.0
+license: Apache-2.0

portallib-0.1.0/COMPUTE.md

@@ -0,0 +1,78 @@
+# Running PorTAL on GPU compute
+
+PorTAL training and evaluation are single-process PyTorch workloads. The library is installed from
+PyPI; the repository supplies the editable recipe files and compute launchers. Select
+`train_example.py`, `refit_example.py`, or `evaluate_example.py`, edit its recipe block, and run it.
+Every compute platform follows the same pattern:
+
+```bash
+python examples/train_example.py
+```
+
+The compute platform provisions the GPU, preserves the Hugging Face cache and `artifacts/`
+directory, and supplies any required Hugging Face token. The release source and both 1,000-example
+refit settings are documented in [`REPRODUCING.md`](REPRODUCING.md).
+
+## Hardware and execution model
+
+Source training loads both source models in one process. Refitting loads one trained PorTAL artifact
+and one raw target base; evaluation loads one artifact and its matching raw base. Use one high-memory
+NVIDIA GPU; an H200-class GPU is recommended for the complete two-source recipe. A smaller model or
+CPU can be used for development and contract tests.
+
+The examples use one CUDA device and do not use multi-process or multi-node execution.
+
+## Local Docker
+
+The included [`Dockerfile`](Dockerfile) builds a CUDA training image containing the exact checked-out
+package code and edited recipe. This source-based image is useful for validating a release commit;
+ordinary library installation should use PyPI.
+The default base image can be overridden with `--build-arg PYTORCH_IMAGE=...` when the host requires
+a different PyTorch/CUDA combination.
+
+```bash
+docker build -t portallib-training .
+mkdir -p artifacts hf-cache
+docker run --rm --gpus all \
+  -e HF_TOKEN \
+  -v "$PWD/artifacts:/workspace/portallib/artifacts" \
+  -v "$PWD/hf-cache:/cache/huggingface" \
+  portallib-training
+```
+
+The image defaults to `train_example.py`. Override its command for another stage:
+
+```bash
+docker run --rm --gpus all \
+  -e HF_TOKEN \
+  -v "$PWD/artifacts:/workspace/portallib/artifacts" \
+  -v "$PWD/hf-cache:/cache/huggingface" \
+  portallib-training python examples/refit_example.py
+```
+
+Choose a base image whose CUDA build supports the assigned GPU. This matters particularly for new
+GPU architectures.
+
+## Modal
+
+[`examples/launchers/modal_launcher.py`](examples/launchers/modal_launcher.py) is one optional
+compute wrapper. It builds the repository's Docker image, mounts persistent storage at the recipe's
+`artifacts/` directory, and runs the file selected by its `EXAMPLE` constant.
+
+```bash
+python -m pip install modal
+modal setup
+modal secret create HF_TOKEN HF_TOKEN=your_token
+modal run examples/launchers/modal_launcher.py
+```
+
+Download a completed output directory with:
+
+```bash
+modal volume get portallib-artifacts portal-qwen-sources ./portal-qwen-sources
+```
+
+Use the selected example's `OUTPUT_DIR` name when downloading refit results.
+
+Edit the launcher's `gpu` value if H200 is unavailable in the selected Modal workspace. The named
+volumes are created automatically and preserve outputs and downloaded models across jobs.

portallib-0.1.0/Dockerfile

@@ -0,0 +1,17 @@
+ARG PYTORCH_IMAGE=pytorch/pytorch:2.7.1-cuda12.8-cudnn9-runtime
+FROM ${PYTORCH_IMAGE}
+
+WORKDIR /workspace/portallib
+
+ENV HF_HOME=/cache/huggingface \
+    PIP_DISABLE_PIP_VERSION_CHECK=1 \
+    PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1
+
+COPY pyproject.toml README.md LICENSE ./
+COPY src ./src
+COPY examples ./examples
+
+RUN python -m pip install --no-cache-dir '.[training]'
+
+CMD ["python", "examples/train_example.py"]

portallib-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

portallib-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: portallib
+Version: 0.1.0
+Summary: Generate portable task-specific LoRA adapters across language models
+Project-URL: Homepage, https://github.com/ramp-public/portallib
+Project-URL: Repository, https://github.com/ramp-public/portallib
+Project-URL: Documentation, https://github.com/ramp-public/portallib#readme
+Project-URL: Issues, https://github.com/ramp-public/portallib/issues
+Project-URL: Announcement, https://x.com/RampLabs/status/2072381992285647280
+Project-URL: Download, https://pypi.org/project/portallib/
+Author-email: Benjamin Geist <benjamin.geist@ramp.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: adapters,llm,lora,machine-learning,peft
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.11
+Requires-Dist: huggingface-hub<2,>=0.30
+Requires-Dist: peft<1,>=0.15
+Requires-Dist: safetensors<1,>=0.4
+Requires-Dist: torch>=2.2
+Provides-Extra: training
+Requires-Dist: datasets<5,>=3; extra == 'training'
+Requires-Dist: transformers<6,>=4.52; extra == 'training'
+Description-Content-Type: text/markdown
+
+# PorTAL: Portable Task Adapters for LLMs
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ramp-public/portallib/main/docs/assets/portal_header_dark_v2.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ramp-public/portallib/main/docs/assets/portal_header_light_v3.png">
+    <img src="https://raw.githubusercontent.com/ramp-public/portallib/main/docs/assets/portal_header_light_v3.png" width="560" alt="PorTAL wordmark passing through two portals">
+  </picture>
+</p>
+
+> Alpha research release [announced by Ramp Labs](https://x.com/RampLabs/status/2072381992285647280).
+> APIs and artifact schemas may evolve before the first stable release.
+
+PorTAL learns a base-agnostic task latent and a light per-base decoder that generates ordinary
+per-layer LoRA weights. A task can be trained once, adapted to supported frozen base models, and
+exported as a standard Hugging Face PEFT adapter.
+
+`portallib` is an alpha Python library for loading, training, saving, publishing, and exporting
+PorTAL artifacts with standard PyTorch and Hugging Face interfaces.
+
+The included pinned recipes reproduce the PorTAL source-training, target-refitting, and evaluation
+method described by Ramp Labs. Reported results should be generated from the released artifacts and
+their recorded evaluation configuration rather than treated as fixed package guarantees.
+
+![PorTAL source training and target-base refitting phases](https://raw.githubusercontent.com/ramp-public/portallib/main/docs/assets/portal_phases.gif)
+
+During source training, PorTAL jointly learns the task-latent table, one shared canonical core, and
+one alignment for each source base. To port the learned tasks, it freezes the latent table and core
+and refits only a fresh alignment for the target base. The resulting task adapter is exportable as
+an ordinary PEFT LoRA adapter.
+
+## Install
+
+Install the inference library from PyPI:
+
+```bash
+pip install portallib
+```
+
+Install the optional Hugging Face model and dataset dependencies for training:
+
+```bash
+pip install 'portallib[training]'
+```
+
+Python 3.11 and 3.12 are supported. Install a CUDA-compatible PyTorch build for GPU training before
+installing the training extra when your platform requires a specific CUDA wheel.
+
+## Load and export
+
+Load a native PorTAL artifact, select a trained task, and obtain a normal PEFT model:
+
+```python
+from transformers import AutoModelForCausalLM
+from portallib import PortalModel
+
+base = AutoModelForCausalLM.from_pretrained(
+    "Qwen/Qwen3-4B",
+    revision="1cfa9a7208912126459214e8b04321603b3df60c",
+)
+portal = PortalModel.from_pretrained(
+    "RampPublic/portal-qwen3-4b",
+    revision="v0.1.0",
+    base_model=base,
+)
+model = portal.get_peft_model("rte")
+model.save_pretrained("./portal-rte-qwen3-4b")
+```
+
+A task can also be exported without loading the base LLM:
+
+```python
+portal.export_peft("rte", "./portal-rte-qwen3-4b")
+```
+
+The exported directory is an ordinary PEFT adapter and reloads with
+`PeftModel.from_pretrained`.
+
+## Published artifacts
+
+| Artifact | Role |
+|---|---|
+| [`RampPublic/portal-qwen3-1.7b`](https://huggingface.co/RampPublic/portal-qwen3-1.7b) | Jointly trained shared weights plus the 1.7B alignment |
+| [`RampPublic/portal-qwen3-4b`](https://huggingface.co/RampPublic/portal-qwen3-4b) | Jointly trained shared weights plus the 4B alignment |
+| [`RampPublic/portal-qwen3-8b`](https://huggingface.co/RampPublic/portal-qwen3-8b) | 1,000-example-per-task refit |
+| [`RampPublic/portal-gemma-3-4b`](https://huggingface.co/RampPublic/portal-gemma-3-4b) | 1,000-example-per-task cross-family refit |
+
+The recipes load the `v0.1.0` artifact revisions. Each repository contains one base-specific native
+PorTAL artifact; task-specific standard PEFT adapters can be generated from it as needed.
+
+## Examples
+
+[`examples/train_example.py`](https://github.com/ramp-public/portallib/blob/main/examples/train_example.py) is thin orchestration around the public
+canonical trainer APIs. It freezes each base model, jointly learns shared task latents and a canonical
+core with one thin alignment per source base, evaluates epoch zero and every training epoch, restores
+the best held-out epoch, and writes one native artifact per source base. Its only model downloads are
+the raw Hugging Face bases selected for source training.
+
+The complete pinned recipe is a short, editable block near the top of the file. It selects the
+dataset, exact model revisions, output directory, source bases, and `PortalTrainingConfig`:
+
+```bash
+python examples/train_example.py
+```
+
+[`examples/refit_example.py`](https://github.com/ramp-public/portallib/blob/main/examples/refit_example.py) loads either source artifact as a carrier
+for the task vectors and canonical core learned jointly from Qwen3-1.7B and Qwen3-4B. It downloads
+only the new raw target base, freezes the shared components, and trains a fresh target alignment:
+
+```bash
+python examples/refit_example.py
+```
+
+The checked-in recipe reads the shared weights from `RampPublic/portal-qwen3-4b`; this does not make
+the refit 4B-only—the 1.7B and 4B source artifacts contain identical jointly trained task latents and
+canonical core weights. The default target is Qwen3-8B with at most 1,000 training examples per task.
+The adjacent Gemma 3 recipe uses the same shared components and its exact text-decoder layer path.
+
+[`examples/evaluate_example.py`](https://github.com/ramp-public/portallib/blob/main/examples/evaluate_example.py) loads a trained PorTAL artifact and
+its matching raw base, then reports the base floor, adapted per-task metrics, macro metrics, and
+accuracy lift:
+
+```bash
+python examples/evaluate_example.py
+```
+
+The checked-in evaluation recipe uses `RampPublic/portal-qwen3-8b`; change the artifact and matching
+base recipe together to evaluate one of the other published source or refit artifacts.
+
+The examples are repository assets rather than installed console commands. Clone the repository to
+run them, then install the released training package:
+
+```bash
+git clone https://github.com/ramp-public/portallib
+cd portallib
+pip install 'portallib[training]==0.1.0'
+python examples/train_example.py
+```
+
+[`REPRODUCING.md`](https://github.com/ramp-public/portallib/blob/main/REPRODUCING.md) records pinned dataset and model revisions, the complete training
+configuration, checkpoint selection, and source/Qwen/Gemma recipes.
+
+[`COMPUTE.md`](https://github.com/ramp-public/portallib/blob/main/COMPUTE.md) shows how to run any example locally with Docker or remotely through
+Modal. The compute wrapper provisions the runtime and persistent storage; the training and evaluation
+behavior comes from the installed `portallib` release and selected recipe.
+
+## Model compatibility
+
+PorTAL supports Qwen3 and cross-family refitting to Gemma 3. Qwen3 exposes decoder layers at
+`model.layers`; Gemma 3 exposes its text decoder at
+`model.language_model.layers`. The default projection paths cover the usual query, key, value,
+attention-output, and gated-MLP linear modules used by those families.
+
+Other causal language-model families are expected to work when they expose uniform linear
+projections across decoder layers. Pass their exact layer and projection paths through `PortalBase`;
+PorTAL validates every configured path and dimension before training. Automatic architecture
+adapters and models with non-uniform per-layer projection dimensions are not yet part of the
+supported v0.1 compatibility surface. Contributions that add exact, tested architecture mappings
+are welcome.
+
+For another model family, set its exact `BaseRecipe.layer_path`; paths are explicit rather than
+inferred from module-name patterns, so an incompatible model fails before training.
+
+The checked-in `modules=("q", "v")` setting generates LoRA for query/value projections. Set it to
+`("q", "k", "v", "o", "gate", "up", "down")` to include the attention output and MLP
+projections. In both cases, the base model parameters remain frozen.
+
+## Artifact format
+
+Native artifacts use the standard Hugging Face layout:
+
+- `config.json` contains the schema version, base model and revision, task names, LoRA settings,
+  exact layer/module paths, and projection dimensions.
+- `model.safetensors` contains `task_latents`, the canonical `core`, and one base-specific
+  `alignment`, with `portallib` format metadata.
+- `README.md` is the generated model card.
+
+`PortalModel` inherits `ModelHubMixin`, so `save_pretrained`, `from_pretrained`, and `push_to_hub`
+follow standard Hugging Face Hub behavior:
+
+```python
+portal.push_to_hub("your-namespace/portal-qwen3-4b", private=True)
+```
+
+Configured layers and projections are resolved deterministically. Missing modules, incompatible
+dimensions, unknown schema versions, and inconsistent target declarations fail explicitly.
+
+## Public API
+
+- `PortalConfig` validates artifacts and builds exact configurations from supported base models.
+- `PortalCoreTrainer` jointly trains shared latents/core and one alignment per source base using
+  balanced per-task updates, EMA loss normalization, and per-base latent-gradient balancing.
+- `PortalAdapterRefitter` freezes a source artifact's latents/core and trains only a target alignment.
+- `PortalTrainingConfig.from_portal_config` preserves an artifact's architecture while selecting a
+  new optimization recipe for refitting.
+- `PortalEvaluator` batches candidate continuations while reporting character-normalized
+  multiple-choice accuracy and token-mean gold NLL.
+- `EvaluationResult.to_dict` returns the canonical JSON-ready evaluation representation.
+- `PortalDecoder` combines a canonical core and one base-specific alignment to generate LoRA factors.
+- `PortalModel` loads, saves, publishes, materializes, and exports trained artifacts.
+- `ChoiceDataset` loads and saves the normalized local/Hub task schema and supports explicit Hub upload.
+- `collate_gold_batch` provides the causal-LM batch format used by the training APIs.
+
+## Development
+
+```bash
+uv run ruff check src tests examples scripts
+uv run pytest -q
+uv run python -m build
+```
+
+PorTAL is licensed under Apache-2.0.
+
+## Citation
+
+If you use PorTAL, cite the software metadata in
+[`CITATION.cff`](https://github.com/ramp-public/portallib/blob/main/CITATION.cff).