lhallee commited on
Commit
92bb240
·
verified ·
1 Parent(s): 8c83e97

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