transformers-mic 0.1.0__tar.gz

transformers_mic-0.1.0/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+All notable changes to `transformers-mic` will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project uses
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-11-02
+
+First release on PyPI. `tmic` is alpha: generated contracts still need code review, and the cloud baseline and
+publication paths are for maintainers of the `huggingface-mic` organization.
+
+### Added
+
+- `tmic run`: one command from a real checkpoint to a validated MIC. It drafts or reuses a contract, builds the
+  slim fixture, records and reviews baselines, checks every declared variant and, for maintainers, publishes the
+  model and updates the fleet. `--local-only` measures on your machine and uploads nothing. Human mode asks in the
+  terminal; `--mode agent` speaks a JSON question/answer protocol. Runs resume from `.mic/automation.json`.
+- Step-by-step commands: `create`, `update`, `build`, `record`, `review`, `check`, `status`, `replay`,
+  `publish`, `export`, `pin`, `retire` and `batch`.
+- Contract drafting through Hugging Face Inference Providers (default `deepseek-ai/DeepSeek-V4.1-Flash-1017` on
+  Together), billed to the `huggingface` organization unless `--bill-to` says otherwise. Drafts that enable
+  `trust_remote_code`, import names Transformers does not export, or train on `no_grad` outputs are rejected.
+  Bounded contract repair proposes a fix for a failing draft and applies it only after approval.
+- The fixture builder: shrinks the real config while keeping every layer kind the checkpoint builds, copies
+  processor files byte for byte, keeps the checkpoint's tensor names and file format, keeps sources of 20M
+  parameters or fewer whole, and refuses test checkpoints as sources. Weights are random when they pass the
+  input-sensitivity gate and overfit on the contract's batch otherwise.
+- `tmic shrink`: a page comparing the fixture's layer stacks, parameters and config with its checkpoint.
+- Baselines per platform (`cpu-arm64`, `cpu-x86_64`, `cpu-x86_64-bf16`, CUDA) and variant. `review --approve`
+  accepts only new and unchanged values; changed values need a person.
+- The fleet as CSV tables in the `huggingface-mic/transformers-fleet` dataset, converted to and from the JSON
+  lock the runners read. Transformers pins a dataset commit in `tests/contracts.lock`.
+- Cloud baseline collections on CPU and CUDA runners (`tmic baselines`), through the dashboard or directly
+  through GitHub Actions.
+- `tmic auth` for the Transformers CI dashboard.

transformers_mic-0.1.0/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2018- The Hugging Face team. All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

transformers_mic-0.1.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include setup.py
+include example/*.py
+recursive-include example/schemas *.json
+recursive-include example/hub integration.json usage.md README.md build.json *.flac *.js package.json package-lock.json
+include example/hub/WhisperSpeech-integration/audio/*.json
+include example/transformers/tests/contracts/fleet.lock
+recursive-include example/transformers/tests/contracts/expectations *.json
+include experiments/sweep.py experiments/layer_patterns.py
+include docs/cli.md
+prune example/hub/SmolLM-integration/integrations/transformers.js/node_modules
+global-exclude *.candidate.json *.pyc
+include CHANGELOG.md

transformers_mic-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: transformers-mic
+Version: 0.1.0
+Summary: Build and validate model integration contracts and slim fixtures for Transformers
+Author-email: The Hugging Face Team <transformers@huggingface.co>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/huggingface/transformers-mic
+Project-URL: Repository, https://github.com/huggingface/transformers-mic
+Project-URL: Changelog, https://github.com/huggingface/transformers-mic/blob/main/CHANGELOG.md
+Keywords: transformers,huggingface,testing,ci,model-integration
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: huggingface-hub>=1.32
+Requires-Dist: jsonschema>=4.23
+Requires-Dist: filelock>=3
+Provides-Extra: runtime
+Requires-Dist: transformers>=5; extra == "runtime"
+Requires-Dist: torch>=2.11; extra == "runtime"
+Requires-Dist: numpy; extra == "runtime"
+Requires-Dist: pillow; extra == "runtime"
+Requires-Dist: soundfile; extra == "runtime"
+Requires-Dist: librosa; extra == "runtime"
+Requires-Dist: scipy; extra == "runtime"
+Requires-Dist: safetensors; extra == "runtime"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: sentencepiece; extra == "dev"
+Dynamic: license-file
+
+# transformers-mic
+
+![logo](https://raw.githubusercontent.com/huggingface/transformers-mic/main/docs/mic-logo.png)
+
+A **Model Integration Contract (MIC)** is a proposed standard: next to a Hub
+model, an executable check that it works in a framework, run by that
+framework's CI. Each MIC has three parts:
+
+- a **fixture**: a shrunk model built from the real checkpoint's config, with its
+  tokenizer and processor files copied unchanged
+- a **usage path**: runnable Markdown that does what users do, such as generating
+  text or running a training step
+- **baselines**: the outputs that usage produced, reviewed by a human
+
+Fixtures run on framework PRs (CPU, seconds); real checkpoints run after merge,
+nightly and before release. **A slim pass is a fast regression signal, not a pass
+for the real model.**
+
+This repository holds the `tmic` CLI, the fixture builder and the runner. MICs are
+published in [`huggingface-mic`](https://huggingface.co/huggingface-mic) and pinned
+by the [fleet dataset](https://huggingface.co/datasets/huggingface-mic/transformers-fleet);
+coverage is in the [coverage space](https://huggingface.co/spaces/huggingface-mic/mic-coverage).
+In Transformers, the contracts job runs on PRs and reports failures without
+blocking ([status](docs/evidence.md#transformers-ci-proof)).
+
+![A proposed link lets agents discover a model's MIC on the Hub. Transformers checks slim fixtures on PRs and real checkpoints in run-slow or nightly jobs; Transformers.js has its own contract entry point and baseline, with CI triggers still to define.](https://raw.githubusercontent.com/huggingface/transformers-mic/main/docs/assets/mic-overview.svg)
+
+## Try it locally
+
+```sh
+pip install "transformers-mic[runtime] @ git+https://github.com/huggingface/transformers-mic.git" \
+  "hf-doc-builder @ git+https://github.com/huggingface/doc-builder.git"
+hf auth login
+tmic run org/model --local-only --fixtures-only --no-history --bill-to ''
+```
+
+This drafts a contract for `org/model`, builds its fixture and records baselines
+on your machine, asks you to review each step, and uploads nothing. See
+[Try it locally](docs/cli.md#try-it-locally) for the flags. `tmic run --mode agent`
+gives agents a JSON protocol for the same questions.
+
+Cloud baselines and publication are for maintainers: [CLI guide](docs/cli.md),
+[cloud baselines](docs/cloud-baselines.md) (dashboard activation is still pending).
+
+## Documents
+
+Start with:
+
+- [CLI guide](docs/cli.md): `tmic`, from a checkpoint to a published MIC.
+- [The standard](docs/standard.md): why MICs, the repository layout, manifest, checks and pins.
+- [Small fixtures](docs/fixtures.md): the shrink recipe and the weight experiments.
+- [Evidence](docs/evidence.md): replays, backfills, stability and cost.
+- [Pilot](docs/pilot.md): the proposed adoption pilot and the results so far.
+
+Details: [full example](example/README.md), [technical design](docs/design.md),
+[Hub layout](docs/hub-organization.md), [slim models in Transformers CI](docs/slim-models-in-transformers-ci.md),
+[Transformers CI proof](docs/transformers-ci-proof.md), [improving contracts](docs/improving-contracts.md),
+[smoke vs assertions](docs/smoke-vs-assertions.md), [problems and open questions](docs/problems-and-opened-questions.md),
+[cloud baselines](docs/cloud-baselines.md), [end-to-end tests](docs/end-to-end-tests.md),
+[agent walkthroughs](docs/agent-walkthrough/README.md), [maintainer slides](docs/slides/index.html),
+[changelog](CHANGELOG.md), [releasing](docs/release.md).

transformers_mic-0.1.0/README.md

@@ -0,0 +1,61 @@
+# transformers-mic
+
+![logo](https://raw.githubusercontent.com/huggingface/transformers-mic/main/docs/mic-logo.png)
+
+A **Model Integration Contract (MIC)** is a proposed standard: next to a Hub
+model, an executable check that it works in a framework, run by that
+framework's CI. Each MIC has three parts:
+
+- a **fixture**: a shrunk model built from the real checkpoint's config, with its
+  tokenizer and processor files copied unchanged
+- a **usage path**: runnable Markdown that does what users do, such as generating
+  text or running a training step
+- **baselines**: the outputs that usage produced, reviewed by a human
+
+Fixtures run on framework PRs (CPU, seconds); real checkpoints run after merge,
+nightly and before release. **A slim pass is a fast regression signal, not a pass
+for the real model.**
+
+This repository holds the `tmic` CLI, the fixture builder and the runner. MICs are
+published in [`huggingface-mic`](https://huggingface.co/huggingface-mic) and pinned
+by the [fleet dataset](https://huggingface.co/datasets/huggingface-mic/transformers-fleet);
+coverage is in the [coverage space](https://huggingface.co/spaces/huggingface-mic/mic-coverage).
+In Transformers, the contracts job runs on PRs and reports failures without
+blocking ([status](docs/evidence.md#transformers-ci-proof)).
+
+![A proposed link lets agents discover a model's MIC on the Hub. Transformers checks slim fixtures on PRs and real checkpoints in run-slow or nightly jobs; Transformers.js has its own contract entry point and baseline, with CI triggers still to define.](https://raw.githubusercontent.com/huggingface/transformers-mic/main/docs/assets/mic-overview.svg)
+
+## Try it locally
+
+```sh
+pip install "transformers-mic[runtime] @ git+https://github.com/huggingface/transformers-mic.git" \
+  "hf-doc-builder @ git+https://github.com/huggingface/doc-builder.git"
+hf auth login
+tmic run org/model --local-only --fixtures-only --no-history --bill-to ''
+```
+
+This drafts a contract for `org/model`, builds its fixture and records baselines
+on your machine, asks you to review each step, and uploads nothing. See
+[Try it locally](docs/cli.md#try-it-locally) for the flags. `tmic run --mode agent`
+gives agents a JSON protocol for the same questions.
+
+Cloud baselines and publication are for maintainers: [CLI guide](docs/cli.md),
+[cloud baselines](docs/cloud-baselines.md) (dashboard activation is still pending).
+
+## Documents
+
+Start with:
+
+- [CLI guide](docs/cli.md): `tmic`, from a checkpoint to a published MIC.
+- [The standard](docs/standard.md): why MICs, the repository layout, manifest, checks and pins.
+- [Small fixtures](docs/fixtures.md): the shrink recipe and the weight experiments.
+- [Evidence](docs/evidence.md): replays, backfills, stability and cost.
+- [Pilot](docs/pilot.md): the proposed adoption pilot and the results so far.
+
+Details: [full example](example/README.md), [technical design](docs/design.md),
+[Hub layout](docs/hub-organization.md), [slim models in Transformers CI](docs/slim-models-in-transformers-ci.md),
+[Transformers CI proof](docs/transformers-ci-proof.md), [improving contracts](docs/improving-contracts.md),
+[smoke vs assertions](docs/smoke-vs-assertions.md), [problems and open questions](docs/problems-and-opened-questions.md),
+[cloud baselines](docs/cloud-baselines.md), [end-to-end tests](docs/end-to-end-tests.md),
+[agent walkthroughs](docs/agent-walkthrough/README.md), [maintainer slides](docs/slides/index.html),
+[changelog](CHANGELOG.md), [releasing](docs/release.md).