transformers-fleet / README.md
tarekziade's picture
tarekziade HF Staff
Card: the JSON locks only exist in revisions from before the tables
91cbf1d verified
|
Raw History Blame Contribute Delete
2.8 kB
---
license: apache-2.0
tags:
- mic
- transformers
- ci
configs:
- config_name: contracts
default: true
data_files:
- split: control
path: control/contracts.csv
- split: prototypes
path: prototypes/contracts.csv
- config_name: environment
data_files:
- split: control
path: control/environment.csv
- split: prototypes
path: prototypes/environment.csv
- config_name: known_failures
data_files:
- split: control
path: control/known_failures.csv
- split: prototypes
path: prototypes/known_failures.csv
---
# Transformers MIC fleet
This dataset defines the Model Integration Contracts run by Transformers CI.
There are two fleets, each a folder of CSV tables:
- `control/`: the control fleet, run with the default variant.
- `prototypes/`: the prototype fleet, run with the bfloat16 variant.
| Table | One row per | Columns |
| --- | --- | --- |
| `contracts.csv` | contract and slim model | `contract`, `target`, `mic_repo`, `revision`, `contract_sha256`, `fixture_sha256`, `checkpoints` |
| `environment.csv` | package | `package`, `version` |
| `known_failures.csv` | tracked framework bug | `contract`, `target`, `issue`, `match`, `skip_outputs` |
Each row pins a `huggingface-mic/<model>-mic` model snapshot containing the slim
weights, executable usage and reviewed Transformers expectations. The row with a
`contract_sha256` carries the contract and its checkpoints (`model@revision`,
separated by `; `); a second slim model of the same contract leaves both empty.
An empty `target` uses the repository name. Contract and fixture hashes verify the
pinned content. Known failures are scoped to one contract target.
The runner lives in [transformers-ci](https://github.com/huggingface/transformers-ci).
Transformers pins the dataset commit SHA in `tests/contracts.lock`; CI uses
that revision for both fleets. `tmic export --execute` updates this dataset and
`tmic pin --transformers-checkout PATH --revision SHA` adopts a revision; tmic
converts the tables to and from the JSON lock the runners read. Results and
traces record that revision for reproduction. Model repository revisions remain
immutable even when this dataset is updated.
Revisions from before the tables hold the same fleets as JSON (`fleet-lock.json`,
`prototype-fleet.lock`); tmic and the runner still read those for old pins.
```bash
run-model-contracts --fixtures-only --fleet control
run-model-contracts --fixtures-only --fleet prototypes --variant bfloat16
# Reproduce a job with its recorded dataset commit:
run-model-contracts --fixtures-only --fleet prototypes --variant bfloat16 --fleet-revision <dataset-commit>
```
Update the fleet after measuring and reviewing changed expectations. CI checks
against expectations; it does not record or approve new baselines.