Skip to content

solvi.experimental

The experimental package itself: STATUS (for each piece: what it is, since when, what it is missing to graduate, the script that measures it, the deadline), DEADLINE, and the helpers each piece uses to warn on import and to mark the decisions it takes part in. Importing this package warns about nothing; each piece warns when it is imported. See Experimental.

solvi.experimental — pieces that work and are tested but have not yet shown a measured gain (or a measured use) that the rest of solvi promises. Their API may change in any release, and each one either graduates or is removed by its deadline.

from solvi.experimental import STATUS
STATUS["lora"]       # {"since": "0.7", "missing": "...", "script": None, "deadline": "1.2"}

What marks them:

  • importing one warns once (solvi.ExperimentalWarning, a UserWarning: silence it with warnings.filterwarnings("ignore", category=solvi.ExperimentalWarning));
  • a decision made by a System that uses one records it: meta["experimental"] in the stored decision (the names, e.g. ["lora"]), and the system report counts them;
  • nothing stable imports them, and the top-level solvi package does not re-export them. Two command-line entries load one on request: solvi hook (hooks) and solvi serve --upstream (mcp).

Graduating needs a pre-registered bar, a script in benchmarks/ that measures it, the bar met and reviewed, no import of anything experimental, a conformance check and a docs move; the old path is then kept for one release. A piece that does not graduate by its deadline (two minor releases after 1.0), or that measures negative, is removed and the negative result published.

This package itself imports none of them: import solvi.experimental does not warn.

warn_on_import 

warn_on_import(module, why=None)

Called at the top of each experimental module: one ExperimentalWarning, located at the import that loaded it.

mark 

mark(system, name)

Say that system decides with the experimental piece name: its decisions record it (meta["experimental"]). → the system.