lhallee commited on
Commit
a497a44
·
verified ·
1 Parent(s): 2fab7b6

Improve generated model cards

Browse files

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

Files changed (1) hide show
  1. README.md +43 -43
README.md CHANGED
@@ -8,29 +8,21 @@ tags:
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
- # Synthyra/DPLM-150M
12
 
13
- This checkpoint contains the FastPLMs `DPLM` implementation.
14
 
15
- Accepted inputs are amino-acid sequences tokenized to masked or partially
16
- masked residue IDs.
17
- Supported Transformers entry points are `AutoConfig`, `AutoModel`,
18
- `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`,
19
- `AutoModelForTokenClassification`.
20
 
21
- ## Capabilities
 
 
22
 
23
- | Feature | Status |
24
- | --- | --- |
25
- | Sequence classification | Supported: base weights with an untrained task head |
26
- | Token classification | Supported: base weights with an untrained task head |
27
- | PEFT fine-tuning | Supported pattern: preserve the separately trained `classifier` |
28
- | Embeddings | Supported: shared ordered embedding API |
29
- | Test-time training | Supported: low-rank masked-residue adaptation |
30
- | Attention variants | Supported: `eager`, `sdpa`, `flex_attention`, `flash_attention_3` |
31
- | Compliance | Declared: exact release evidence is required |
32
-
33
- 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.
34
 
35
  ## Install and platform requirements
36
 
@@ -44,9 +36,14 @@ python -m pip install -r \
44
  The FastPLMs implementation itself is embedded in the model repository.
45
  Transformers loads it through `trust_remote_code=True`.
46
 
47
- 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
48
- the first download. For an air-gapped run, build the manifest-pinned local
49
- artifact first and use the offline example.
 
 
 
 
 
50
 
51
  ## Quick start
52
 
@@ -64,17 +61,17 @@ model = AutoModel.from_pretrained(
64
  For offline validation, replace `model_id` with the manifest-built
65
  `dist/hub/DPLM-150M` path. Pass `local_files_only=True`.
66
 
67
- ## Attention and compliance
68
 
69
- The quick start selects `sdpa` explicitly. Declared variants are `eager`, `sdpa`, `flex_attention`, `flash_attention_3`.
70
- An unavailable requested backend raises. It does not silently change
 
 
71
  implementation.
 
72
  `output_attentions=True` can use the documented one-call eager fallback to
73
  materialize attention tensors. The configured backend does not change.
74
 
75
- This family declares the `compliance` tier. Release evidence identifies the
76
- checkpoint, backend, dtype, hardware, inputs, and reference revision.
77
-
78
  ## Tokenization and forward inference
79
 
80
  Load the tokenizer from the same artifact as the model. The attention mask
@@ -257,24 +254,28 @@ repository release to pretrained DPLM1 and DPLM2 weights. FastPLMs artifacts
257
  record `weights_license_status="resolved"` and `redistributable=true`. Complete
258
  publication requires all artifact, legal, parity, and atomic-publication checks.
259
 
260
- ## Runtime contract
261
 
262
- - Public input: Amino-acid sequences tokenized to masked or partially masked residue IDs
263
- - Advertised AutoClasses: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
264
- - AutoClass weight status: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
265
- - Attention implementations: `eager`, `sdpa`, `flex_attention`, `flash_attention_3`
266
- - Precision policies: `default`
267
  - BF16 execution: `fp32_parameters_autocast`
268
  - Generation contract: `required`
269
- - Artifact dependency set: `core`
270
  - Weight publication allowed: `true`
271
  - Weight license status: `resolved`
272
  - Redistributable: `true`
273
  - Complete weight publication required: `false`
274
 
275
- ## Release record
 
 
 
 
276
 
277
- - FastPLMs weights: `Synthyra/DPLM-150M`
278
  - Runtime revision: recorded separately in the built artifact and published commit
279
  - Runtime source identities: recorded in `source-record.json`
280
  - Official checkpoint: `airkingbd/dplm_150m`
@@ -284,14 +285,13 @@ publication requires all artifact, legal, parity, and atomic-publication checks.
284
  - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
285
  - Unresolved required file identities: `0`
286
 
287
- The source record records exact file identities, conversion, source revisions,
288
- legal texts, schema, and attestations. A nonzero unresolved count blocks a release.
289
-
290
- ## Validation boundary
291
 
292
  Declared tiers compare configuration, tokenizer behavior, state, and
293
- representative inference with the pinned reference. Metadata does not show that
294
- a build passed, that a backend is faster, or that an output is biologically valid.
 
295
 
296
  ## License
297
 
 
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
+ # DPLM-150M
12
 
13
+ ## Model overview
14
 
15
+ `Synthyra/DPLM-150M` packages the `airkingbd/dplm_150m` checkpoint with the
16
+ FastPLMs runtime for Hugging Face Transformers. It accepts amino-acid sequences
17
+ tokenized to masked or partially masked residue IDs.
 
 
18
 
19
+ The repository uses the standard Transformers loading interface with
20
+ `trust_remote_code=True`. See Technical details for each registered class and
21
+ whether its weights come from the checkpoint.
22
 
23
+ The sequence- and token-classification classes reuse the pretrained backbone,
24
+ but their task heads are newly initialized. Fine-tune those heads before
25
+ interpreting their logits as predictions.
 
 
 
 
 
 
 
 
26
 
27
  ## Install and platform requirements
28
 
 
36
  The FastPLMs implementation itself is embedded in the model repository.
37
  Transformers loads it through `trust_remote_code=True`.
38
 
39
+ This model requires Python 3.11-3.14, PyTorch 2.13, and Transformers 5.13.
40
+
41
+ The artifact requirements include the FlashAttention loader dependency.
42
+ FlashAttention also requires compatible CUDA hardware and BF16 execution.
43
+
44
+ The Hub quick start needs network access for the first download. For an
45
+ air-gapped run, build the manifest-pinned local artifact first and use the
46
+ offline example.
47
 
48
  ## Quick start
49
 
 
61
  For offline validation, replace `model_id` with the manifest-built
62
  `dist/hub/DPLM-150M` path. Pass `local_files_only=True`.
63
 
64
+ ## Attention backends
65
 
66
+ The quick start uses `sdpa`.
67
+
68
+ Available backends are `eager`, `sdpa`, `flex_attention`, `flash_attention_3`.
69
+ Requesting an unavailable backend raises instead of silently changing
70
  implementation.
71
+
72
  `output_attentions=True` can use the documented one-call eager fallback to
73
  materialize attention tensors. The configured backend does not change.
74
 
 
 
 
75
  ## Tokenization and forward inference
76
 
77
  Load the tokenizer from the same artifact as the model. The attention mask
 
254
  record `weights_license_status="resolved"` and `redistributable=true`. Complete
255
  publication requires all artifact, legal, parity, and atomic-publication checks.
256
 
257
+ ## Technical details
258
 
259
+ - Inputs: Amino-acid sequences tokenized to masked or partially masked residue IDs
260
+ - Transformers classes: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
261
+ - Checkpoint weights: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
262
+ - Attention backends: `eager`, `sdpa`, `flex_attention`, `flash_attention_3`
263
+ - Precision: `default`
264
  - BF16 execution: `fp32_parameters_autocast`
265
  - Generation contract: `required`
266
+ - Dependencies: `core`
267
  - Weight publication allowed: `true`
268
  - Weight license status: `resolved`
269
  - Redistributable: `true`
270
  - Complete weight publication required: `false`
271
 
272
+ ## Validation and provenance
273
+
274
+ FastPLMs pins the checkpoint, upstream source revisions, state transformation,
275
+ and required files in `models.toml`. Built artifacts record exact source
276
+ identities and conversion details in `source-record.json`.
277
 
278
+ - FastPLMs checkpoint: `Synthyra/DPLM-150M`
279
  - Runtime revision: recorded separately in the built artifact and published commit
280
  - Runtime source identities: recorded in `source-record.json`
281
  - Official checkpoint: `airkingbd/dplm_150m`
 
285
  - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
286
  - Unresolved required file identities: `0`
287
 
288
+ Release validation includes the `compliance` tier. Its evidence identifies the
289
+ checkpoint, backend, dtype, hardware, inputs, and reference revision.
 
 
290
 
291
  Declared tiers compare configuration, tokenizer behavior, state, and
292
+ representative inference with the pinned reference. A nonzero unresolved count
293
+ blocks release. Metadata alone does not show that a build passed, that a backend
294
+ is faster, or that an output is biologically valid.
295
 
296
  ## License
297