lhallee commited on
Commit
4021ca5
·
verified ·
1 Parent(s): 4a217a9

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 +46 -42
README.md CHANGED
@@ -8,28 +8,21 @@ tags:
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
- # Synthyra/FastESMFold
12
 
13
- This checkpoint contains the FastPLMs `ESMFold` implementation.
14
 
15
- Accepted inputs are raw amino-acid sequences through folding helpers, or
16
- prepared residue 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 | Unavailable for this structure-only checkpoint |
28
- | Test-time training | Unavailable: the checkpoint has no trained MLM head |
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 +36,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 +64,16 @@ model = AutoModel.from_pretrained(
63
  For offline validation, replace `model_id` with the manifest-built
64
  `dist/hub/FastESMFold` 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
@@ -169,24 +170,28 @@ FastPLMs does not expose ProteinTTT for ESMFold. The pinned folding checkpoint
169
  has no trained masked-language-model head for this objective. `ttt()` and TTT
170
  folding requests raise.
171
 
172
- ## Runtime contract
173
 
174
- - Public input: Raw amino-acid sequences through folding helpers, or prepared residue tensors
175
- - Advertised AutoClasses: `AutoConfig`, `AutoModel`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
176
- - AutoClass weight status: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
177
- - Attention implementations: `eager`, `sdpa`, `flex_attention`
178
- - Precision policies: `default`
179
  - BF16 execution: `fp32_parameters_autocast`
180
  - Generation contract: `not_applicable`
181
- - Artifact dependency set: `core + structure`
182
  - Weight publication allowed: `true`
183
  - Weight license status: `resolved`
184
  - Redistributable: `true`
185
  - Complete weight publication required: `false`
186
 
187
- ## Release record
 
 
 
 
188
 
189
- - FastPLMs weights: `Synthyra/FastESMFold`
190
  - Runtime revision: recorded separately in the built artifact and published commit
191
  - Runtime source identities: recorded in `source-record.json`
192
  - Official checkpoint: `facebook/esmfold_v1`
@@ -196,14 +201,13 @@ folding requests raise.
196
  - Release tiers: `check`, `compliance`, `structure`, `feature`, `artifact`, `benchmark`
197
  - Unresolved required file identities: `0`
198
 
199
- The source record records exact file identities, conversion, source revisions,
200
- legal texts, schema, and attestations. A nonzero unresolved count blocks a release.
201
-
202
- ## Validation boundary
203
 
204
  Declared tiers compare configuration, tokenizer behavior, state, and
205
- representative inference with the pinned reference. Metadata does not show that
206
- a build passed, that a backend is faster, or that an output is biologically valid.
 
207
 
208
  ## License
209
 
 
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
+ # FastESMFold
12
 
13
+ ## Model overview
14
 
15
+ `Synthyra/FastESMFold` packages the `facebook/esmfold_v1` checkpoint with the
16
+ FastPLMs runtime for Hugging Face Transformers. It accepts raw amino-acid
17
+ sequences through folding helpers, or prepared residue tensors.
 
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 structure dependencies.
42
+
43
+ The release contract requires a CUDA device. The current validated target is
44
+ the exact NVIDIA GH200 on Linux aarch64. Linux x86-64, CPU-only, Windows, and
45
+ macOS structure runs are not release evidence.
46
+
47
+ The Hub quick start needs network access for the first download. For an
48
+ air-gapped run, build the manifest-pinned local artifact first and use the
49
+ offline example.
50
 
51
  ## Quick start
52
 
 
64
  For offline validation, replace `model_id` with the manifest-built
65
  `dist/hub/FastESMFold` path. Pass `local_files_only=True`.
66
 
67
+ ## Attention backends
68
+
69
+ The quick start uses `sdpa`.
70
+
71
+ Available backends are `eager`, `sdpa`, `flex_attention`. Requesting an
72
+ unavailable backend raises instead of silently changing implementation.
73
 
 
 
74
  `output_attentions=True` can use the documented one-call eager fallback to
75
  materialize attention tensors. The configured backend does not change.
76
 
 
 
 
77
  ## Downstream prediction
78
 
79
  The sequence and token prediction AutoClasses use the checkpoint backbone and
 
170
  has no trained masked-language-model head for this objective. `ttt()` and TTT
171
  folding requests raise.
172
 
173
+ ## Technical details
174
 
175
+ - Inputs: Raw amino-acid sequences through folding helpers, or prepared residue tensors
176
+ - Transformers classes: `AutoConfig`, `AutoModel`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
177
+ - Checkpoint weights: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
178
+ - Attention backends: `eager`, `sdpa`, `flex_attention`
179
+ - Precision: `default`
180
  - BF16 execution: `fp32_parameters_autocast`
181
  - Generation contract: `not_applicable`
182
+ - Dependencies: `core + structure`
183
  - Weight publication allowed: `true`
184
  - Weight license status: `resolved`
185
  - Redistributable: `true`
186
  - Complete weight publication required: `false`
187
 
188
+ ## Validation and provenance
189
+
190
+ FastPLMs pins the checkpoint, upstream source revisions, state transformation,
191
+ and required files in `models.toml`. Built artifacts record exact source
192
+ identities and conversion details in `source-record.json`.
193
 
194
+ - FastPLMs checkpoint: `Synthyra/FastESMFold`
195
  - Runtime revision: recorded separately in the built artifact and published commit
196
  - Runtime source identities: recorded in `source-record.json`
197
  - Official checkpoint: `facebook/esmfold_v1`
 
201
  - Release tiers: `check`, `compliance`, `structure`, `feature`, `artifact`, `benchmark`
202
  - Unresolved required file identities: `0`
203
 
204
+ Release validation includes the `compliance` tier. Its evidence identifies the
205
+ checkpoint, backend, dtype, hardware, inputs, and reference revision.
 
 
206
 
207
  Declared tiers compare configuration, tokenizer behavior, state, and
208
+ representative inference with the pinned reference. A nonzero unresolved count
209
+ blocks release. Metadata alone does not show that a build passed, that a backend
210
+ is faster, or that an output is biologically valid.
211
 
212
  ## License
213