lhallee commited on
Commit
925fd4a
·
verified ·
1 Parent(s): 77a9c3b

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 +52 -46
README.md CHANGED
@@ -8,28 +8,22 @@ tags:
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
- # Synthyra/ESMFold2-Fast
12
 
13
- This checkpoint contains the FastPLMs `ESMFold2` implementation.
14
 
15
- Accepted inputs are raw amino-acid sequences or typed molecular-complex
16
- specifications; low-level forward accepts prepared feature tensors.
17
- Supported Transformers entry points are `AutoConfig`, `AutoModel`,
18
- `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`.
19
 
20
- ## Capabilities
 
 
21
 
22
- | Feature | Status |
23
- | --- | --- |
24
- | Sequence classification | Supported: base weights with an untrained task head |
25
- | Token classification | Supported: base weights with an untrained task head |
26
- | PEFT fine-tuning | Supported pattern: preserve the separately trained `classifier` |
27
- | Embeddings | Special: ESMC state mixture to 256-wide residue embeddings |
28
- | Test-time training | Special: opt-in folding TTT on the ESMC backbone |
29
- | Attention variants | Supported: `eager`, `sdpa`, `flex_attention` |
30
- | Compliance | Declared: exact release evidence is required |
31
-
32
- 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.
33
 
34
  ## Install and platform requirements
35
 
@@ -43,9 +37,17 @@ python -m pip install -r \
43
  The FastPLMs implementation itself is embedded in the model repository.
44
  Transformers loads it through `trust_remote_code=True`.
45
 
46
- This model requires Python 3.11-3.14, PyTorch 2.13, and Transformers 5.13. The artifact requirements include the structure dependencies. The release contract requires a CUDA device. The current validated target is the exact NVIDIA GH200 on Linux aarch64. Linux x86-64, CPU-only, Windows, and macOS structure runs are not release evidence. The Hub quick start needs network access for
47
- the first download. For an air-gapped run, build the manifest-pinned local
48
- artifact first and use the offline example.
 
 
 
 
 
 
 
 
49
 
50
  ## Quick start
51
 
@@ -63,16 +65,16 @@ model = AutoModel.from_pretrained(
63
  For offline validation, replace `model_id` with the manifest-built
64
  `dist/hub/ESMFold2-Fast` path. Pass `local_files_only=True`.
65
 
66
- ## Attention and compliance
 
 
 
 
 
67
 
68
- The quick start selects `sdpa` explicitly. Declared variants are `eager`, `sdpa`, `flex_attention`. An unavailable
69
- requested backend raises. It does not silently change implementation.
70
  `output_attentions=True` can use the documented one-call eager fallback to
71
  materialize attention tensors. The configured backend does not change.
72
 
73
- This family declares the `compliance` tier. Release evidence identifies the
74
- checkpoint, backend, dtype, hardware, inputs, and reference revision.
75
-
76
  ## Downstream prediction
77
 
78
  The sequence and token prediction AutoClasses use the checkpoint backbone and
@@ -255,10 +257,11 @@ and
255
  Structure preparation requires `ccd.pkl` from
256
  `biohub/ESMFold2`. The manifest pins its repository, revision, size, content
257
  identity, and MIT terms. This is a trusted-deserialization boundary. FastPLMs
258
- accepts only the pinned snapshot link inside the repository blob directory and
259
- rejects user-supplied asset and `cache_dir` symlinks. The loader verifies a
260
- private temporary snapshot before deserialization. Offline execution requires
261
- the exact cached object and never downloads a replacement.
 
262
 
263
  ## Optional folding TTT
264
 
@@ -282,24 +285,28 @@ or show biological validity. Folding TTT is result-scoped. Its transient ESMC
282
  adapter modules are excluded from checkpoint state. It is not a generic
283
  `save_pretrained` adapter-persistence path.
284
 
285
- ## Runtime contract
286
 
287
- - Public input: Raw amino-acid sequences or typed molecular-complex specifications; low-level forward accepts prepared feature tensors
288
- - Advertised AutoClasses: `AutoConfig`, `AutoModel`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
289
- - AutoClass weight status: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
290
- - Attention implementations: `eager`, `sdpa`, `flex_attention`
291
- - Precision policies: `auto`, `fp32`, `bf16`, `fp8` (experimental)
292
  - BF16 execution: `fp32_parameters_autocast`
293
  - Generation contract: `not_applicable`
294
- - Artifact dependency set: `core + structure`
295
  - Weight publication allowed: `true`
296
  - Weight license status: `resolved`
297
  - Redistributable: `true`
298
  - Complete weight publication required: `false`
299
 
300
- ## Release record
 
 
 
 
301
 
302
- - FastPLMs weights: `Synthyra/ESMFold2-Fast`
303
  - Runtime revision: recorded separately in the built artifact and published commit
304
  - Runtime source identities: recorded in `source-record.json`
305
  - Official checkpoint: `biohub/ESMFold2-Fast`
@@ -309,14 +316,13 @@ adapter modules are excluded from checkpoint state. It is not a generic
309
  - Release tiers: `check`, `compliance`, `structure`, `feature`, `artifact`, `benchmark`
310
  - Unresolved required file identities: `0`
311
 
312
- The source record records exact file identities, conversion, source revisions,
313
- legal texts, schema, and attestations. A nonzero unresolved count blocks a release.
314
-
315
- ## Validation boundary
316
 
317
  Declared tiers compare configuration, tokenizer behavior, state, and
318
- representative inference with the pinned reference. Metadata does not show that
319
- a build passed, that a backend is faster, or that an output is biologically valid.
 
320
 
321
  ## License
322
 
 
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
+ # ESMFold2-Fast
12
 
13
+ ## Model overview
14
 
15
+ `Synthyra/ESMFold2-Fast` packages the `biohub/ESMFold2-Fast` checkpoint with
16
+ the FastPLMs runtime for Hugging Face Transformers. It accepts raw amino-acid
17
+ sequences or typed molecular-complex specifications; low-level forward accepts
18
+ prepared feature tensors.
19
 
20
+ The repository uses the standard Transformers loading interface with
21
+ `trust_remote_code=True`. See Technical details for each registered class and
22
+ whether its weights come from the checkpoint.
23
 
24
+ The sequence- and token-classification classes reuse the pretrained backbone,
25
+ but their task heads are newly initialized. Fine-tune those heads before
26
+ interpreting their logits as predictions.
 
 
 
 
 
 
 
 
27
 
28
  ## Install and platform requirements
29
 
 
37
  The FastPLMs implementation itself is embedded in the model repository.
38
  Transformers loads it through `trust_remote_code=True`.
39
 
40
+ This model requires Python 3.11-3.14, PyTorch 2.13, and Transformers 5.13.
41
+
42
+ The artifact requirements include the structure dependencies.
43
+
44
+ The release contract requires a CUDA device. The current validated target is
45
+ the exact NVIDIA GH200 on Linux aarch64. Linux x86-64, CPU-only, Windows, and
46
+ macOS structure runs are not release evidence.
47
+
48
+ The Hub quick start needs network access for the first download. For an
49
+ air-gapped run, build the manifest-pinned local artifact first and use the
50
+ offline example.
51
 
52
  ## Quick start
53
 
 
65
  For offline validation, replace `model_id` with the manifest-built
66
  `dist/hub/ESMFold2-Fast` path. Pass `local_files_only=True`.
67
 
68
+ ## Attention backends
69
+
70
+ The quick start uses `sdpa`.
71
+
72
+ Available backends are `eager`, `sdpa`, `flex_attention`. Requesting an
73
+ unavailable backend raises instead of silently changing implementation.
74
 
 
 
75
  `output_attentions=True` can use the documented one-call eager fallback to
76
  materialize attention tensors. The configured backend does not change.
77
 
 
 
 
78
  ## Downstream prediction
79
 
80
  The sequence and token prediction AutoClasses use the checkpoint backbone and
 
257
  Structure preparation requires `ccd.pkl` from
258
  `biohub/ESMFold2`. The manifest pins its repository, revision, size, content
259
  identity, and MIT terms. This is a trusted-deserialization boundary. FastPLMs
260
+ accepts only the pinned snapshot link inside the repository blob directory.
261
+ User-supplied asset and `cache_dir` symlinks are rejected. The loader verifies a
262
+ private temporary snapshot before deserialization, protecting against
263
+ path-replacement and in-place source-write races. Offline execution requires the
264
+ exact cached object and never downloads a replacement.
265
 
266
  ## Optional folding TTT
267
 
 
285
  adapter modules are excluded from checkpoint state. It is not a generic
286
  `save_pretrained` adapter-persistence path.
287
 
288
+ ## Technical details
289
 
290
+ - Inputs: Raw amino-acid sequences or typed molecular-complex specifications; low-level forward accepts prepared feature tensors
291
+ - Transformers classes: `AutoConfig`, `AutoModel`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
292
+ - Checkpoint weights: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
293
+ - Attention backends: `eager`, `sdpa`, `flex_attention`
294
+ - Precision: `auto`, `fp32`, `bf16`, `fp8` (experimental)
295
  - BF16 execution: `fp32_parameters_autocast`
296
  - Generation contract: `not_applicable`
297
+ - Dependencies: `core + structure`
298
  - Weight publication allowed: `true`
299
  - Weight license status: `resolved`
300
  - Redistributable: `true`
301
  - Complete weight publication required: `false`
302
 
303
+ ## Validation and provenance
304
+
305
+ FastPLMs pins the checkpoint, upstream source revisions, state transformation,
306
+ and required files in `models.toml`. Built artifacts record exact source
307
+ identities and conversion details in `source-record.json`.
308
 
309
+ - FastPLMs checkpoint: `Synthyra/ESMFold2-Fast`
310
  - Runtime revision: recorded separately in the built artifact and published commit
311
  - Runtime source identities: recorded in `source-record.json`
312
  - Official checkpoint: `biohub/ESMFold2-Fast`
 
316
  - Release tiers: `check`, `compliance`, `structure`, `feature`, `artifact`, `benchmark`
317
  - Unresolved required file identities: `0`
318
 
319
+ Release validation includes the `compliance` tier. Its evidence identifies the
320
+ checkpoint, backend, dtype, hardware, inputs, and reference revision.
 
 
321
 
322
  Declared tiers compare configuration, tokenizer behavior, state, and
323
+ representative inference with the pinned reference. A nonzero unresolved count
324
+ blocks release. Metadata alone does not show that a build passed, that a backend
325
+ is faster, or that an output is biologically valid.
326
 
327
  ## License
328