lhallee commited on
Commit
7bf56e5
·
verified ·
1 Parent(s): 46ea1b4

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/DPLM2-650M
12
 
13
- This checkpoint contains the FastPLMs `DPLM2` implementation.
14
 
15
- Accepted inputs are tokenized amino-acid and structure tracks with explicit
16
- modality boundaries.
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: `sdpa` |
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 CPU gate covers small offline tests. Published checkpoint throughput and parity require the documented device tier. 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,16 +61,16 @@ model = AutoModel.from_pretrained(
64
  For offline validation, replace `model_id` with the manifest-built
65
  `dist/hub/DPLM2-650M` path. Pass `local_files_only=True`.
66
 
67
- ## Attention and compliance
 
 
 
 
 
68
 
69
- The quick start selects `sdpa` explicitly. Declared variants are `sdpa`. An unavailable requested backend raises. It does
70
- not silently change implementation.
71
  `output_attentions=True` can use the documented one-call eager fallback to
72
  materialize attention tensors. The configured backend does not change.
73
 
74
- This family declares the `compliance` tier. Release evidence identifies the
75
- checkpoint, backend, dtype, hardware, inputs, and reference revision.
76
-
77
  ## Dataset embeddings
78
 
79
  The shared embedding mixin keeps input order and biological-position masking.
@@ -238,24 +235,28 @@ and [README](https://github.com/bytedance/dplm/blob/main/README.md#overview) doc
238
  weights. Complete publication requires all artifact, legal, parity, and
239
  atomic-publication checks.
240
 
241
- ## Runtime contract
242
 
243
- - Public input: Tokenized amino-acid and structure tracks with explicit modality boundaries
244
- - Advertised AutoClasses: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
245
- - AutoClass weight status: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
246
- - Attention implementations: `sdpa`
247
- - Precision policies: `default`
248
  - BF16 execution: `fp32_parameters_autocast`
249
  - Generation contract: `required`
250
- - Artifact dependency set: `core`
251
  - Weight publication allowed: `true`
252
  - Weight license status: `resolved`
253
  - Redistributable: `true`
254
  - Complete weight publication required: `false`
255
 
256
- ## Release record
 
 
 
 
257
 
258
- - FastPLMs weights: `Synthyra/DPLM2-650M`
259
  - Runtime revision: recorded separately in the built artifact and published commit
260
  - Runtime source identities: recorded in `source-record.json`
261
  - Canonical transformed state identity: recorded in `source-record.json`
@@ -268,14 +269,13 @@ atomic-publication checks.
268
  - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
269
  - Unresolved required file identities: `0`
270
 
271
- The source record records exact file identities, conversion, source revisions,
272
- legal texts, schema, and attestations. A nonzero unresolved count blocks a release.
273
-
274
- ## Validation boundary
275
 
276
  Declared tiers compare configuration, tokenizer behavior, state, and
277
- representative inference with the pinned reference. Metadata does not show that
278
- a build passed, that a backend is faster, or that an output is biologically valid.
 
279
 
280
  ## License
281
 
 
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
+ # DPLM2-650M
12
 
13
+ ## Model overview
14
 
15
+ `Synthyra/DPLM2-650M` packages the `airkingbd/dplm2_650m` checkpoint with the
16
+ FastPLMs runtime for Hugging Face Transformers. It accepts tokenized amino-acid
17
+ and structure tracks with explicit modality boundaries.
 
 
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 CPU gate covers small offline tests. Published checkpoint throughput and
42
+ parity require the documented device tier.
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/DPLM2-650M` path. Pass `local_files_only=True`.
63
 
64
+ ## Attention backends
65
+
66
+ The quick start uses `sdpa`.
67
+
68
+ Available backends are `sdpa`. Requesting an unavailable backend raises instead
69
+ of silently changing implementation.
70
 
 
 
71
  `output_attentions=True` can use the documented one-call eager fallback to
72
  materialize attention tensors. The configured backend does not change.
73
 
 
 
 
74
  ## Dataset embeddings
75
 
76
  The shared embedding mixin keeps input order and biological-position masking.
 
235
  weights. Complete publication requires all artifact, legal, parity, and
236
  atomic-publication checks.
237
 
238
+ ## Technical details
239
 
240
+ - Inputs: Tokenized amino-acid and structure tracks with explicit modality boundaries
241
+ - Transformers classes: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
242
+ - Checkpoint weights: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
243
+ - Attention backends: `sdpa`
244
+ - Precision: `default`
245
  - BF16 execution: `fp32_parameters_autocast`
246
  - Generation contract: `required`
247
+ - Dependencies: `core`
248
  - Weight publication allowed: `true`
249
  - Weight license status: `resolved`
250
  - Redistributable: `true`
251
  - Complete weight publication required: `false`
252
 
253
+ ## Validation and provenance
254
+
255
+ FastPLMs pins the checkpoint, upstream source revisions, state transformation,
256
+ and required files in `models.toml`. Built artifacts record exact source
257
+ identities and conversion details in `source-record.json`.
258
 
259
+ - FastPLMs checkpoint: `Synthyra/DPLM2-650M`
260
  - Runtime revision: recorded separately in the built artifact and published commit
261
  - Runtime source identities: recorded in `source-record.json`
262
  - Canonical transformed state identity: recorded in `source-record.json`
 
269
  - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
270
  - Unresolved required file identities: `0`
271
 
272
+ Release validation includes the `compliance` tier. Its evidence identifies the
273
+ checkpoint, backend, dtype, hardware, inputs, and reference revision.
 
 
274
 
275
  Declared tiers compare configuration, tokenizer behavior, state, and
276
+ representative inference with the pinned reference. A nonzero unresolved count
277
+ blocks release. Metadata alone does not show that a build passed, that a backend
278
+ is faster, or that an output is biologically valid.
279
 
280
  ## License
281