feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81) - #110

Merged
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81
Jul 30, 2026
Merged

feat(sensitivity): carry the equilibration's dx/dθ into a parameter scan (#81)#110
wshlavacek merged 1 commit into
mainfrom
feat/carry-sens-through-scan-81

Conversation

@wshlavacek

Copy link
Copy Markdown
Collaborator

Closes#81.

The gap

A pre-equilibrate → scored dose scan could not be gradient-fit: parameter_scan /
bifurcate refused every sensitivity-configured Simulator. As the issue says, the
refusal is right — each point's initial condition is the equilibrated snapshot x_ss(θ),
so re-seeding it as if it were the model's seed ICs discards the dx/dθ accumulated
during the equilibration. The gap was that there was no correct option instead.

Answering the issue's two questions:

  1. Does carry_sensitivities already give the right semantics across the boundary?
    Yes — for a sequential two-phase run. What was missing is that every primitive which
    restores a state dropped the derivative on the way: set_state() /
    restore_concentrations() clear the pending seed, and save_concentrations() cleared it
    and the "carried-over" flag.
  2. Does a scan need a per-point clone that inherits both x and dx/dp? Not a clone —
    it needs the restore path to carry the derivative with the state. Then the existing
    per-point loop just passes carry_sensitivities=True.

What changed

  • Model.save_concentrations() redefines the IC baseline to the current state; the state
    did not change, so neither did its dx/dθ — the new baseline inherits it, and
    reset() restores both. A baseline saved with nothing carried is θ-independent literal
    ICs, i.e. the pre-No way to carry forward sensitivities through a pre-equilibration into a scored parameter scan (blocks gradient fitting of pre-equilibrated dose-response) #81 fresh start, so reset() on an ordinary model (and the
    every-action-reset backends) is unchanged.
  • save_concentrations(label=…) / restore_concentrations(label) capture and restore a
    named snapshot's dx/dθ the same way.
  • Simulator.parameter_scan / bifurcate restore the reset target's state and its
    dx/dθ per point, integrate each point with carry_sensitivities=True, and leave the
    model — state, scanned parameter, carried derivative, dirty flag — exactly as found. A
    continuation scan (reset_conc=False) chains each point's dx/dθ from the previous
    point, so the whole sweep is one differentiable protocol.
  • NetworkModel gained the write half of the seed accessor,
    set_pending_sensitivity_seed(seed, param_names) — the primitive that lets any protocol
    restore a state together with its θ-derivative (PyBNF drives its own per-point loop, so
    it can use this directly without parameter_scan) — plus
    has_baseline_sensitivity_seed and a writable ic_state_dirty for the restore.
sim=bngsim.Simulator(model, method="ode", sensitivity_params=["kf", "kr", "kdeg"])
sim.run(t_span=(0, 1e6), n_points=2, steady_state=True) # equilibrate ONCEpoints=sim.parameter_scan("L_0", par_min=1e-3, par_max=1e2, n_scan_pts=12,
log_scale=True, t_span=(0, 600), n_points=61,
steady_state=True)
grads= [p.output_sensitivities("observable:pReceptor") forpinpoints]

Measurements

Oracle is a closed form, not a finite difference: preequil_prod_deg.net is
dA/dt = k_prod − (k_deg + dose)·A equilibrated at dose = 0, so every point's
dA/dθ is exact. Four doses off one equilibration:

dosecarried (this PR)re-seeded per point, t=0re-seeded, t=3 (k_prod / k_deg)
0.51.2e-10100%9.5% / 15.3%
1.01.7e-10100%3.3% / 8.4%
2.02.3e-10100%0.3% / 1.3%
4.01.2e-09100%0.0% / 0.0%

The trajectories are identical to 1e-7 in every row — the seed is the only difference. The
same scan scored at each point's own steady state matches dA_ss/dθ = (1/λ, −k_prod/λ²)
to 1e-12. Note the shape of the wrong column: re-seeding is 100% off at t=0 and its
error decays with dose, so it is worst at the low-dose end of a dose-response — the
informative part of the fit — and looks fine at saturating dose.

On the issue's own model family (IGF1R_model_v1, 589 species / 4198 reactions,
equilibrated at a basal ligand dose so 1107 of 1178 carried seed entries are live, then
scanned over three doses applying each with on_point + set_concentration):
d(pY980)/d{kp, kdp} matches central FD of the measured observable over the full
protocol at 1e-8 … 1e-9, stable across h/p = 1e-3, 1e-4, 1e-5 (signal, not FD
noise), and the whole scan runs off ONE equilibration in 2.0 s. The scan is also
bit-identical to the hand-rolled equivalent (restore snapshot → install seed →
run(carry_sensitivities=True)) on every point.

A silent defect this also closes

No scan required: equilibrate → save_concentrations() → run(sensitivities) used to drop
the carry and clear the carried-over flag, so it re-seeded a θ-dependent initial
condition as a fresh start and returned wrong derivatives with no warning (100% off at
t=0 on the model above; reset() after the save had the same hole). That is exactly the
BNG action ordering simulate({steady_state=>1}) → saveConcentrations() → parameter_scan, so a fix that only worked from the live state would not have unblocked
the protocol shape in the issue.

Refusals kept (never a silently re-seeded gradient)

SituationWhy it cannot be answered
the reset target carries no matching dx/dθnothing to seed from (no equilibration on this Simulator with these params, or a plain run / set_concentration() / set_state() dropped it)
the scanned parameter is a sensitivity_params entryeach point overwrites it, so the derivative carried into the point was taken at a different value of the same symbol
sensitivity_ic across the boundarythe point starts from a snapshot, not the model's ICs, so ∂y/∂y_k(0) has no meaning
an on_point hook moves a differentiated parametersame composition problem as scanning one

An on_point hook may apply the usual coupled setConcentration dose override:
assigning species k a literal value makes ∂x_k(0)/∂θ = 0 for that species (what a
literal assignment means, and what set_concentration already documents) while the rest
keep the carried derivative. The one case bngsim cannot infer is an override computed
from
a differentiated parameter — such a hook installs the correct rows itself with
set_pending_sensitivity_seed after its concentration writes, and a seed still pending
when the hook returns is used verbatim.

Tests / verification

  • python/tests/test_preequilibration_sensitivity.py — new TestScanCarryOver (closed-form
    per point, per-point t=0 seed, observable output sensitivities, scored steady-state
    dose-response, the BNG save_concentrations ordering, reset_to named snapshot,
    continuation == a chain of sequential carry runs, on_point literal-dose zero row and the
    install-your-own-seed escape hatch, "left as we found it", and the five refusals), plus
    baseline-inheritance and seed-write round-trip/validation cases.
  • python/tests/test_parameter_scan.py — the old blanket-refusal test split into the two
    refusals that remain.
  • python/tests/test_model_clone.py — the Impl clone contract for the pending and
    baseline seeds (new fields ⇒ new cases, per the contract comment).
  • Full suite: 2950 passed, 67 skipped (python/tests, in-tree); C++ ctest5/5;
    pre-commit (ruff, ruff-format, clang-format, mypy) clean.
  • No codegen / RHS / Jacobian code is touched, so no corpus sweep applies: outside a
    sensitivity workflow the only behavior change is that a plain scan now rewinds the
    carried-over flag it used to leave set.

…can (#81)
A dose-response experiment that pre-equilibrates and then scans could not be
fit by a gradient method: parameter_scan / bifurcate refused every
sensitivity-configured Simulator. The refusal was right — each point starts
from the equilibrated snapshot, so re-seeding it as if it were the model's seed
ICs discards the dx/dθ accumulated during the equilibration — but there was no
correct option to offer instead.
carry_sensitivities=True already had the right semantics for a sequential
two-phase run; what was missing is that every primitive which *restores* a
state dropped the derivative. Each is fixed where the state lives:
* save_concentrations() redefines the IC baseline to the current state, whose
dx/dθ did not change — so the new baseline inherits it and reset() restores
both. A baseline saved with nothing carried is θ-independent literal ICs,
i.e. the pre-#81 fresh start, so reset() on an ordinary model is unchanged.
* save_concentrations(label=…) / restore_concentrations(label) capture and
restore a named snapshot's dx/dθ the same way.
* parameter_scan / bifurcate restore the reset target's state AND its dx/dθ
per point, run each point with carry_sensitivities=True, and leave the model
exactly as found. A continuation scan chains each point's dx/dθ from the
previous point instead.
NetworkModel gained the write half of the seed accessor
(set_pending_sensitivity_seed) — the primitive that lets a protocol restore a
state together with its θ-derivative — plus has_baseline_sensitivity_seed.
Measured against a closed form (preequil_prod_deg.net, four doses off one
equilibration): carried max rel err 1.2e-10 … 1.2e-9, versus a per-point fresh
re-seed that is 100% wrong at t=0 and still 9.5%/15.3% at t=3 on the lowest
dose (identical trajectories — the seed is the only difference). The scored
steady-state variant matches dA_ss/dθ to 1e-12. On IGF1R_model_v1 (589 species
/ 4198 reactions, 1107 of 1178 carried seed entries live) d(pY980)/d{kp,kdp}
matches central FD over the full protocol at 1e-8 … 1e-9, stable across three
step sizes, with the whole three-dose scan running off one equilibration.
Also closes a silent version of the same defect that needed no scan:
equilibrate → save_concentrations() → run(sensitivities) used to drop the carry
*and* clear the carried-over flag, so it re-seeded a θ-dependent IC as a fresh
start and returned wrong derivatives with no warning — which is exactly the BNG
simulate(steady_state) → saveConcentrations() → parameter_scan ordering.
Refusals (never a silently re-seeded gradient): no matching carried dx/dθ, a
scanned parameter that is itself differentiated, sensitivity_ic across the
boundary, or an on_point hook that moves a differentiated parameter. An
on_point literal setConcentration dose zeroes that species' seed row; a hook
needing a θ-dependent override installs the rows itself and they are used
verbatim.
@wshlavacek
wshlavacek merged commit 9edda80 into mainJul 30, 2026
7 checks passed
@wshlavacek
wshlavacek deleted the feat/carry-sens-through-scan-81 branch July 30, 2026 02:30
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

1 participant

@wshlavacek