lhallee commited on
Commit
605dff9
·
verified ·
1 Parent(s): 59af8db

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/ANKH_large
12
 
13
- This checkpoint contains the FastPLMs `ANKH` implementation.
14
 
15
- Accepted inputs are amino-acid sequences tokenized for encoder or sequence-to-
16
- sequence use.
17
- Supported Transformers entry points are `AutoConfig`, `AutoModel`,
18
- `AutoModelForMaskedLM`, `AutoModelForSeq2SeqLM`,
19
- `AutoModelForSequenceClassification`, `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 | Special: encoder or explicitly prepared decoder states |
29
- | Test-time training | Supported: low-rank masked-residue adaptation |
30
- | Attention variants | Supported: `eager`, `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/ANKH_large` path. Pass `local_files_only=True`.
66
 
67
- ## Attention and compliance
 
 
 
 
 
68
 
69
- The quick start selects `sdpa` explicitly. Declared variants are `eager`, `sdpa`. An unavailable requested backend raises.
70
- It does 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
  ## Tokenization and forward inference
78
 
79
  `Synthyra/ANKH_large` contains the complete encoder-decoder checkpoint.
@@ -268,24 +265,28 @@ ANKH parity covers the official encoder and sequence-to-sequence heads.
268
  AutoModelForMaskedLM exposes the separately named FastPLMs synthesized
269
  masked-LM extension and is not an official ANKH head.
270
 
271
- ## Runtime contract
272
 
273
- - Public input: Amino-acid sequences tokenized for encoder or sequence-to-sequence use
274
- - Advertised AutoClasses: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSeq2SeqLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
275
- - AutoClass weight status: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `FastPLMs extension`, `AutoModelForSeq2SeqLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
276
- - Attention implementations: `eager`, `sdpa`
277
- - Precision policies: `default`
278
  - BF16 execution: `static_parameters`
279
  - Generation contract: `required`
280
- - Artifact dependency set: `core`
281
  - Weight publication allowed: `true`
282
  - Weight license status: `resolved`
283
  - Redistributable: `true`
284
  - Complete weight publication required: `false`
285
 
286
- ## Release record
 
 
 
 
287
 
288
- - FastPLMs weights: `Synthyra/ANKH_large`
289
  - Runtime revision: recorded separately in the built artifact and published commit
290
  - Runtime source identities: recorded in `source-record.json`
291
  - Canonical transformed state identity: recorded in `source-record.json`
@@ -297,14 +298,13 @@ masked-LM extension and is not an official ANKH head.
297
  - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
298
  - Unresolved required file identities: `0`
299
 
300
- The source record records exact file identities, conversion, source revisions,
301
- legal texts, schema, and attestations. A nonzero unresolved count blocks a release.
302
-
303
- ## Validation boundary
304
 
305
  Declared tiers compare configuration, tokenizer behavior, state, and
306
- representative inference with the pinned reference. Metadata does not show that
307
- a build passed, that a backend is faster, or that an output is biologically valid.
 
308
 
309
  ## License
310
 
 
8
 
9
  <!-- Generated from src/fastplms/models.toml. Do not edit. -->
10
 
11
+ # ANKH-Large
12
 
13
+ ## Model overview
14
 
15
+ `Synthyra/ANKH_large` packages the `ElnaggarLab/ankh-large` checkpoint with the
16
+ FastPLMs runtime for Hugging Face Transformers. It accepts amino-acid sequences
17
+ tokenized for encoder or sequence-to-sequence use.
 
 
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/ANKH_large` path. Pass `local_files_only=True`.
63
 
64
+ ## Attention backends
65
+
66
+ The quick start uses `sdpa`.
67
+
68
+ Available backends are `eager`, `sdpa`. Requesting an unavailable backend
69
+ raises instead 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
  ## Tokenization and forward inference
75
 
76
  `Synthyra/ANKH_large` contains the complete encoder-decoder checkpoint.
 
265
  AutoModelForMaskedLM exposes the separately named FastPLMs synthesized
266
  masked-LM extension and is not an official ANKH head.
267
 
268
+ ## Technical details
269
 
270
+ - Inputs: Amino-acid sequences tokenized for encoder or sequence-to-sequence use
271
+ - Transformers classes: `AutoConfig`, `AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSeq2SeqLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`
272
+ - Checkpoint weights: `AutoConfig` = `FastPLMs extension`, `AutoModel` = `pretrained`, `AutoModelForMaskedLM` = `FastPLMs extension`, `AutoModelForSeq2SeqLM` = `pretrained`, `AutoModelForSequenceClassification` = `base weights + untrained task head`, `AutoModelForTokenClassification` = `base weights + untrained task head`
273
+ - Attention backends: `eager`, `sdpa`
274
+ - Precision: `default`
275
  - BF16 execution: `static_parameters`
276
  - Generation contract: `required`
277
+ - Dependencies: `core`
278
  - Weight publication allowed: `true`
279
  - Weight license status: `resolved`
280
  - Redistributable: `true`
281
  - Complete weight publication required: `false`
282
 
283
+ ## Validation and provenance
284
+
285
+ FastPLMs pins the checkpoint, upstream source revisions, state transformation,
286
+ and required files in `models.toml`. Built artifacts record exact source
287
+ identities and conversion details in `source-record.json`.
288
 
289
+ - FastPLMs checkpoint: `Synthyra/ANKH_large`
290
  - Runtime revision: recorded separately in the built artifact and published commit
291
  - Runtime source identities: recorded in `source-record.json`
292
  - Canonical transformed state identity: recorded in `source-record.json`
 
298
  - Release tiers: `check`, `compliance`, `feature`, `artifact`, `benchmark`
299
  - Unresolved required file identities: `0`
300
 
301
+ Release validation includes the `compliance` tier. Its evidence identifies the
302
+ checkpoint, backend, dtype, hardware, inputs, and reference revision.
 
 
303
 
304
  Declared tiers compare configuration, tokenizer behavior, state, and
305
+ representative inference with the pinned reference. A nonzero unresolved count
306
+ blocks release. Metadata alone does not show that a build passed, that a backend
307
+ is faster, or that an output is biologically valid.
308
 
309
  ## License
310