Improve generated model cards

Add-only FastPLMs files-only publication. Checkpoint weights and complete-artifact attestations are unchanged.

README.md

@@ -8,28 +8,21 @@ tags:
 
 <!-- Generated from src/fastplms/models.toml. Do not edit. -->
 
-# Synthyra/ESM2-8M
+# ESM2-8M
 
-This checkpoint contains the FastPLMs `ESM2` implementation.
+## Model overview
 
-Accepted inputs are amino-acid sequences tokenized to residue IDs.
-Supported Transformers entry points are `AutoConfig`, `AutoModel`,
-`AutoModelForMaskedLM`, `AutoModelForSequenceClassification`,
-`AutoModelForTokenClassification`.
+`Synthyra/ESM2-8M` packages the `facebook/esm2_t6_8M_UR50D` checkpoint with the
+FastPLMs runtime for Hugging Face Transformers. It accepts amino-acid sequences
+tokenized to residue IDs.
 
-## Capabilities
+The repository uses the standard Transformers loading interface with
+`trust_remote_code=True`. See Technical details for each registered class and
+whether its weights come from the checkpoint.
 
-| Feature | Status |
-| --- | --- |
-| Sequence classification | Supported: base weights with an untrained task head |
-| Token classification | Supported: base weights with an untrained task head |
-| PEFT fine-tuning | Supported pattern: preserve the separately trained `classifier` |
-| Embeddings | Supported: shared ordered embedding API |
-| Test-time training | Supported: low-rank masked-residue adaptation |
-| Attention variants | Supported: `eager`, `sdpa`, `flex_attention`, `flash_attention_2`, `flash_attention_3` |
-| Compliance | Declared: exact release evidence is required |
-
-A supported interface is not a pretrained downstream predictor. Classification heads start untrained. Compliance metadata does not show that a local build passed its release gate.
+The sequence- and token-classification classes reuse the pretrained backbone,
+but their task heads are newly initialized. Fine-tune those heads before
+interpreting their logits as predictions.
 
 ## Install and platform requirements
 
@@ -43,9 +36,14 @@ python -m pip install -r \
 The FastPLMs implementation itself is embedded in the model repository.
 Transformers loads it through `trust_remote_code=True`.
 
-This model requires Python 3.11-3.14, PyTorch 2.13, and Transformers 5.13. The artifact requirements include the FlashAttention loader dependency. FlashAttention also requires compatible CUDA hardware and BF16 execution. The Hub quick start needs network access for
-the first download. For an air-gapped run, build the manifest-pinned local
-artifact first and use the offline example.
+This model requires Python 3.11-3.14, PyTorch 2.13, and Transformers 5.13.
+
+The artifact requirements include the FlashAttention loader dependency.
+FlashAttention also requires compatible CUDA hardware and BF16 execution.
+
+The Hub quick start needs network access for the first download. For an
+air-gapped run, build the manifest-pinned local artifact first and use the
+offline example.
 
 ## Quick start
 
@@ -63,17 +61,17 @@ model = AutoModel.from_pretrained(
 For offline validation, replace `model_id` with the manifest-built
 `dist/hub/ESM2-8M` path. Pass `local_files_only=True`.
 
-## Attention and compliance
+## Attention backends
+
+The quick start uses `sdpa`.
+
+Available backends are `eager`, `sdpa`, `flex_attention`, `flash_attention_2`,
+`flash_attention_3`. Requesting an unavailable backend raises instead of
+silently changing implementation.
 
-The quick start selects `sdpa` explicitly. Declared variants are `eager`, `sdpa`, `flex_attention`, `flash_attention_2`,
-`flash_attention_3`. An unavailable requested backend raises. It does not
-silently change implementation.
 `output_attentions=True` can use the documented one-call eager fallback to
 materialize attention tensors. The configured backend does not change.
 
-This family declares the `compliance` tier. Release evidence identifies the
-checkpoint, backend, dtype, hardware, inputs, and reference revision.
-
 ## Tokenization and forward inference
 
 Load the tokenizer from the same artifact as the model. The attention mask
@@ -249,24 +247,28 @@ Plain `AutoModel` omits the optional ESM pooler because this masked-language-
 model checkpoint has no trained pooler weights. Pass `add_pooling_layer=True`
 only when you intend to initialize and train that head.
 
-## Runtime contract
+## Technical details
 
-- Public input: Amino-acid sequences tokenized to residue IDs
-- Advertised AutoClasses: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
-- AutoClass weight status: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
-- Attention implementations: `eager`, `sdpa`, `flex_attention`, `flash_attention_2`, `flash_attention_3`
-- Precision policies: `default`
+- Inputs: Amino-acid sequences tokenized to residue IDs
+- Transformers classes: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
+- Checkpoint weights: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
+- Attention backends: `eager`, `sdpa`, `flex_attention`, `flash_attention_2`, `flash_attention_3`
+- Precision: `default`
 - BF16 execution: `fp32_parameters_autocast`
 - Generation contract: `not_applicable`
-- Artifact dependency set: `core`
+- Dependencies: `core`
 - Weight publication allowed: `true`
 - Weight license status: `resolved`
 - Redistributable: `true`
 - Complete weight publication required: `false`
 
-## Release record
+## Validation and provenance
+
+FastPLMs pins the checkpoint, upstream source revisions, state transformation,
+and required files in `models.toml`. Built artifacts record exact source
+identities and conversion details in `source-record.json`.
 
-- FastPLMs weights: `Synthyra/ESM2-8M`
+- FastPLMs checkpoint: `Synthyra/ESM2-8M`
 - Runtime revision: recorded separately in the built artifact and published commit
 - Runtime source identities: recorded in `source-record.json`
 - Official checkpoint: `facebook/esm2_t6_8M_UR50D`
@@ -276,14 +278,13 @@ only when you intend to initialize and train that head.
 - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
 - Unresolved required file identities: `0`
 
-The source record records exact file identities, conversion, source revisions,
-legal texts, schema, and attestations. A nonzero unresolved count blocks a release.
-
-## Validation boundary
+Release validation includes the `compliance` tier. Its evidence identifies the
+checkpoint, backend, dtype, hardware, inputs, and reference revision.
 
 Declared tiers compare configuration, tokenizer behavior, state, and
-representative inference with the pinned reference. Metadata does not show that
-a build passed, that a backend is faster, or that an output is biologically valid.
+representative inference with the pinned reference. A nonzero unresolved count
+blocks release. Metadata alone does not show that a build passed, that a backend
+is faster, or that an output is biologically valid.
 
 ## License