Risk Map#
This map helps maintainers decide how much review and testing a PR needs. It is intentionally practical: files are high risk when a small change can alter scientific results, compatibility, or many downstream workflows.
High Risk#
Changes here should normally include regression tests and maintainer review.
Area | Files | Review focus |
|---|---|---|
AtomicDataDict contract |
| key names, key meaning, tensor shape, downstream callers |
Orbital indexing |
| basis ordering, orbital block indices, mixed-basis behavior |
Hamiltonian expansion |
| SK/E3 transforms, signs, ordering, dtype/device, overlap |
Model assembly |
| model type detection, checkpoint loading, config interpretation |
Config schema |
| defaults, backward compatibility, docs/examples alignment |
Training behavior |
| task detection, validation behavior, reference datasets |
Loss behavior |
| numerical targets, masks, reductions, task-specific semantics |
Medium Risk#
Changes here may need focused tests depending on scope.
Area | Files | Review focus |
|---|---|---|
Embedding and prediction |
| tensor shape, irreps, batch behavior, model compatibility |
Dataset backends |
| format compatibility, missing fields, cutoff behavior |
CLI entrypoints |
| args, defaults, config loading, user-facing behavior |
Postprocess and export |
| exported formats, unit conventions, compatibility |
Plugins |
| checkpointing, logging, training lifecycle |
Lower Risk#
These changes still need review, but usually do not require broad regression testing.
Area | Files | Review focus |
|---|---|---|
Documentation |
| stale commands, stale paths, config consistency |
Issue templates |
| clarity and triage usefulness |
Packaging metadata |
| dependency compatibility, install behavior |
Escalation Rules#
Treat a PR as high risk if it:
changes a high-risk file;
changes public CLI/config behavior;
changes tensor shapes, dtype, device movement, batching, or key names;
changes checkpoint or dataset compatibility;
changes numerical behavior in Hamiltonian, overlap, eigenvalue, loss, or export paths;
touches both data representation and model behavior in the same PR.