You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -75,7 +75,7 @@ A contribution that touches a component must conform to its interface contract.
75
75
76
76
For every contribution:
77
77
78
-
1.**Mirror the source layout in `tests/`.** Cover output shape, sign conventions, mixin requirements, and known input/output pairs. See [`TESTING.md`](TESTING.md) for tolerances and per-component checklists.
78
+
1.**Add tests** following the conventions and per-component checklists in [`TESTING.md`](TESTING.md); match the layout of the existing tests under [`tests/`](tests/). Cover output shape, sign conventions, mixin requirements, and known input/output pairs. Note that the end-to-end suite runs tiny CPU models with few steps, so tests assert shapes and finiteness — not loss decrease or trigger content, which are flaky at that scale.
79
79
2.**Regenerate the compatibility matrix** if you touched a model, optimizer, mixin, or loss `require_*` flag: `python docs/scripts/generate_compat_matrix.py`. Commit the regenerated [`docs/guides/compatibility_matrix.md`](docs/guides/compatibility_matrix.md).
80
80
3.**Update the relevant README row** — recipes need an entry in [`tropt/recipe_hub/README.md`](tropt/recipe_hub/README.md) (key, description, target model, required access, paper, file).
81
81
4.**Smoke-test end-to-end** on a small model (e.g. `google/gemma-3-270m-it`) before submitting.
Copy file name to clipboardExpand all lines: DESIGN.md
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -287,8 +287,6 @@ The repository exposes two interfaces for managing recipes:
287
287
288
288
<!-- * **Config Runner [`runner/main.py`].** A flexible runner that constructs a recipe from a YAML configuration file. The runner uses [Hydra](https://hydra.cc/) to manage configurations, allowing users to specify the model, loss, optimizer, and their parameters in a structured way without writing new code. -->
0 commit comments