Files
Reithan-negative_rejection_…/scripts/negative_rejection_steering_script.py
Reithan 1be05ad7d2 v1.1.0: Unify NRS on a single v-space path (EPS/V/X0) + X0 support; defaults 2/4/0.5 (#44)
## Summary
Collapses the experimental three-mode EPS switch
(`current`/`identity`/`true_v`) into a single, mathematically-correct
v-prediction-space path used by **all** variance-preserving
parameterizations — EPS, v-pred, and x0.

The sampler hook delivers `cond`/`uncond` as `x - x0` for every VP
parameterization, so NRS recovers the true velocity `v = (cond -
A)/factor` (with `A = x·σ²/(σ²+1)`, `factor = σ/√(σ²+1)`), runs its
geometry in v-space, and inverts exactly on return. This replaces the
prior EPS-only affine that operated on the wrong input space.

## Version: 1.1.0
MINOR, not a patch: this adds **X0 (sample) prediction support** — a new
backward-compatible capability — and **changes the default parameters**
(2/5/0.75 → 2/4/0.5). The node interface is unchanged (`eps_mode` never
shipped in 1.0.0), so it is **not** breaking/MAJOR. `pyproject.toml` and
`NRS/nodes_NRS.py __version__` are bumped to `1.1.0` in this PR; the
registry publish is triggered by the merge/release process, not by this
branch.

## Changes
- **`NRS/nodes_NRS.py`**: two-branch conversion — FLOW/CONST operated
natively (identity); all VP types (EPS/V/X0, UNKNOWN→VP) share one
true-v-space transform. Implements X0 (removes the
`NotImplementedError`). Removes `eps_mode` from every method and the
`nrs()` call. New defaults **skew 2 / stretch 4 / squash 0.5**.
- **`scripts/negative_rejection_steering_script.py`** (Forge/A1111):
removes the `eps_mode` test radio, process args, XYZ axis, and
extra-param; reverts `patch()` to 4 args; defaults 2/4/0.5.
- **`tests/test_pred_type.py`**: rewritten for the unified path — FLOW
is the sole native branch; EPS/V/X0/UNKNOWN all run the algebra.
- **`README.md`**: rewrites the V-Space step (now covers EPS/v-pred/x0
identically; flow-matching stays native) and updates the default to
2/4/0.5.
- **`CHANGELOG.md`**: `[1.1.0]` entry.
- **`pyproject.toml` / `NRS/nodes_NRS.py`**: version bumped 1.0.0 →
1.1.0.

## Rationale
Empirical A/B on an EPS checkpoint showed the true-v path is weakly
dominant: equal in normal ranges, burn-resistant at the failure edge,
and unlocks an on-style high-detail regime via squash (squash becomes a
detail/steering knob because the offset `A` is unscaled).

## Validation
- 39 passed / 9 skipped locally (torch tests skip; CI runs them).
Branch-coverage gate passed on push.
- ⚠️ **v-pred and x0 in v-space are math-validated but not yet
image-validated** — recommend a spot-check on a v-pred checkpoint before
merge/release.
2026-09-03 05:30:03 -07:00

162 lines
4.5 KiB
Python

import logging
import sys
import traceback
from functools import partial
from typing import Any
import gradio as gr
from modules import script_callbacks, scripts
from NRS.nodes_NRS import NRS
class NRSScript(scripts.Script):
def __init__(self):
super().__init__()
self.enabled = False
self.skew = 2.00
self.stretch = 4.00
self.squash = 0.50
sorting_priority = 5
def title(self):
return "Negative Rejection Steering"
def show(self, is_img2img):
return scripts.AlwaysVisible
def ui(self, *args, **kwargs):
with gr.Accordion(open=False, label=self.title()):
enabled = gr.Checkbox(label="Enable NRS", value=self.enabled)
gr.HTML("<p><i>Adjust the settings for Negative Rejection Steering.</i></p>")
skew = gr.Slider(
label="NRS Skew Scale",
info="Adjusts the amount guidance is steered.",
minimum=-30.0,
maximum=30.0,
step=0.01,
value=self.skew,
)
stretch = gr.Slider(
label="NRS Stretch Scale",
info="Adjusts the amount guidance is amplified.",
minimum=-30.0,
maximum=30.0,
step=0.01,
value=self.stretch,
)
squash = gr.Slider(
label="NRS Squash Multiplier",
info="Adjusts the amount final guidance is normalized.",
minimum=0.0,
maximum=1.0,
step=0.01,
value=self.squash,
)
enabled.change(lambda x: self.update_enabled(x), inputs=[enabled])
return (enabled, skew, stretch, squash)
def update_enabled(self, value):
self.enabled = value
def process_before_every_sampling(self, p, *args, **kwargs):
if len(args) >= 4:
self.enabled, self.skew, self.stretch, self.squash = args[:4]
else:
logging.warning("Not enough arguments provided to process_before_every_sampling")
return
xyz = getattr(p, "_nrs_xyz", {})
if "enabled" in xyz:
self.enabled = xyz["enabled"] == "True"
if "skew" in xyz:
self.skew = xyz["skew"]
if "stretch" in xyz:
self.stretch = xyz["stretch"]
if "squash" in xyz:
self.squash = xyz["squash"]
# Always start with a fresh clone of the original unet
unet = p.sd_model.forge_objects.unet.clone()
if not self.enabled:
# Reset the unet to its original state
p.sd_model.forge_objects.unet = unet
return
unet = NRS().patch(unet, self.skew, self.stretch, self.squash)[0]
p.sd_model.forge_objects.unet = unet
p.extra_generation_params.update(
{
"NRS_enabled": True,
"NRS_skew": self.skew,
"NRS_stretch": self.stretch,
"NRS_squash": self.squash,
}
)
logging.debug(
f"NRS: Enabled: {self.enabled}, Skew: {self.skew}, Stretch: {self.stretch}, Squash: {self.squash}"
)
return
def set_value(p, x: Any, xs: Any, *, field: str):
if not hasattr(p, "_nrs_xyz"):
p._nrs_xyz = {}
p._nrs_xyz[field] = x
def make_axis_on_xyz_grid():
xyz_grid = None
for script in scripts.scripts_data:
if script.script_class.__module__ == "xyz_grid.py":
xyz_grid = script.module
break
if xyz_grid is None:
return
axis = [
xyz_grid.AxisOption(
"(NRS) Enabled", str, partial(set_value, field="enabled"), choices=lambda: ["True", "False"]
),
xyz_grid.AxisOption(
"(NRS) Skew",
float,
partial(set_value, field="skew"),
),
xyz_grid.AxisOption(
"(NRS) Stretch",
float,
partial(set_value, field="stretch"),
),
xyz_grid.AxisOption(
"(NRS) Squash",
float,
partial(set_value, field="squash"),
),
]
if not any(x.label.startswith("(NRS)") for x in xyz_grid.axis_options):
xyz_grid.axis_options.extend(axis)
def on_before_ui():
try:
make_axis_on_xyz_grid()
except Exception:
error = traceback.format_exc()
print(
f"[-] NRS Script: xyz_grid error:\n{error}",
file=sys.stderr,
)
script_callbacks.on_before_ui(on_before_ui)