Test set x deprecation by Jocho-Smith · Pull Request #1946 · sbi-dev/sbi

Jocho-Smith · 2026-07-22T11:30:14Z

This PR continue #1945 it was about making bind independent of set_x. This one prepares deprecation of set_x by 'flipping its role with bind'. By that I mean the following: in #1943 I used set_x inside bind, to build a stateless version of set_x. In #1945 I made them independent and here I will write set_x in a way that it uses bind internally. This way deleting set_x will be trivially safe.

- Add bind() method to BasePotential (abstract) and CustomPotentialWrapper - Add bind() to LikelihoodBasedPotential, PosteriorBasedPotential, RatioBasedPotential - Add bind() to VectorFieldBasedPotential with full parameter support - Add bind() to EnsemblePotential in ensemble_posterior.py - Add bind() to ConditionedPotential in conditional_density_utils.py - Fix _base_recursor to use local variable _active_holder to avoid Python scoping issues with the _active parameter - Update posteriors to use bind() instead of set_x() for immutability - Fix PytorchReturnTypeWrapper, MultipleIndependent, OneDimPriorWrapper init order and add __deepcopy__ methods for proper deepcopy support - Update error messages to reference bind() instead of set_x() - Add bind() to test FakePotential and TractablePotential classes

- Add bind() method to BasePotential (abstract) and CustomPotentialWrapper - Add bind() to LikelihoodBasedPotential, PosteriorBasedPotential, RatioBasedPotential - Add bind() to VectorFieldBasedPotential with full parameter support - Add bind() to EnsemblePotential in ensemble_posterior.py - Add bind() to ConditionedPotential in conditional_density_utils.py - Fix _base_recursor to use local variable _active_holder to avoid Python scoping issues with the _active parameter - Update posteriors to use bind() instead of set_x() for immutability - Fix PytorchReturnTypeWrapper, MultipleIndependent, OneDimPriorWrapper init order and add __deepcopy__ methods for proper deepcopy support - Update error messages to reference bind() instead of set_x() - Add bind() to test FakePotential and TractablePotential classes - Replace remaining set_x calls in VectorFieldPosterior with bind

…ind-method-clean

…d set_x inside vi_divergence; remove set_x usage inside bind()

…ibute 'guidance_method'

…ull version of it

Jocho-Smith · 2026-07-22T13:21:07Z

Great this all works now :)

Next I will move over the tests that use set_x to bind so deleting set_x will not break any tests.

Resolved conflicts: - potentials: keep HEAD (direct attribute set in bind) - conditional_density_utils.py: keep HEAD (deprecation in set_x) + upstream (_x_is_iid fix) - test files: keep HEAD (direct attribute set in bind) Fixed duplicate bind() methods in vector_field_potential.py and ensemble_posterior.py

codecov · 2026-07-22T15:53:54Z

Codecov Report

❌ Patch coverage is 42.42424% with 19 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.83%. Comparing base (587f922) to head (5247683).
⚠️ Report is 41 commits behind head on gsoc-2026.

Files with missing lines	Patch %	Lines
sbi/inference/potentials/base_potential.py	0.00%	5 Missing ⚠️
.../inference/potentials/posterior_based_potential.py	0.00%	5 Missing ⚠️
sbi/utils/conditional_density_utils.py	0.00%	5 Missing ⚠️
sbi/inference/posteriors/ensemble_posterior.py	20.00%	4 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##           gsoc-2026    #1946      +/-   ##
=============================================
- Coverage      87.99%   87.83%   -0.17%     
=============================================
  Files            144      144              
  Lines          13499    13759     +260     
=============================================
+ Hits           11879    12085     +206     
- Misses          1620     1674      +54

Flag	Coverage Δ
fast	`81.60% <42.42%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
sbi/inference/potentials/vector_field_potential.py	`92.30% <100.00%> (+1.32%)`	⬆️
sbi/inference/posteriors/ensemble_posterior.py	`73.88% <20.00%> (-6.74%)`	⬇️
sbi/inference/potentials/base_potential.py	`83.60% <0.00%> (-9.26%)`	⬇️
.../inference/potentials/posterior_based_potential.py	`89.39% <0.00%> (-6.97%)`	⬇️
sbi/utils/conditional_density_utils.py	`87.50% <0.00%> (-5.76%)`	⬇️

... and 4 files with indirect coverage changes

dgedon

Within this PR there are many things that I flagged in #1945, so please make sure to update those first and merge them into here.

dgedon · 2026-07-23T07:52:14Z

+
+        DEPRECATED: Use bind() instead. This method delegates to bind() internally.
+        """
+        import warnings


imports on file level

dgedon · 2026-07-23T07:54:55Z

+        import warnings
+
+        warnings.warn(
+            "set_x() is deprecated, use bind() instead",


check other deprecation statements in the toolbox. Probably we want to add something saying that it will be removed in the future.

dgedon · 2026-07-23T08:28:48Z


    def bind(self, x_o: Tensor, x_is_iid: bool = False) -> "PosteriorBasedPotential":
        """Create new potential with x bound, without mutable state."""
+        from sbi.utils.user_input_checks import process_x


put on file level

dgedon · 2026-07-23T08:28:58Z

+        import warnings
+
+        warnings.warn(
+            "set_x() is deprecated, use bind() instead",


same as above

dgedon · 2026-07-23T08:31:47Z

same comments as on the last PR. Please merge first

dgedon · 2026-07-23T08:32:06Z


        def bind(self, x_o: torch.Tensor, x_is_iid: bool = True) -> "FakePotential":
            """Create new potential with x bound, without mutable state."""
+            from sbi.utils.user_input_checks import process_x


put on top level

dgedon · 2026-07-23T08:33:23Z

            self, x_o: torch.Tensor, x_is_iid: bool = True
        ) -> "TractablePotential":
            """Create new potential with x bound, without mutable state."""
+            from sbi.utils.user_input_checks import process_x


…_method for VectorFieldBasedPotential;

dgedon · 2026-07-23T21:27:19Z

+        DEPRECATED: Use bind() instead. This method delegates to bind() internally.
+        It will be removed in a future release.
+        """
+        import warnings


Not yet addressed. If you decide against it, please let me know why or resolve the comment

ah sorry, I overlooked that.

dgedon · 2026-07-23T21:40:57Z

-            self.flow = self.rebuild_flow(**ode_kwargs)
-        elif self._x_o is not None:
-            self.flows = self.rebuild_flows_for_batch(**ode_kwargs)
+        import warnings


import on file level

dgedon · 2026-07-23T21:43:22Z

+        self.prior = prior
+        self.device = None
+        self.return_type = return_type


Why was that moved from like 10 lines lower?

the line super().init(...) below had strange side effects with the new bind definition. Moving it before that fixed it.

Jocho-Smith and others added 13 commits July 22, 2026 07:33

Merge branch 'bind-method-clean' of github.com:jocho-smith/sbi into b…

30459d9

…ind-method-clean

fix attempt with bound.neural_ode.params.update

8fdc10c

checkpoint after full bind replacement of set_x

968b58b

Merge branch 'gsoc-2026' into bind-method-clean

84c4731

fixup:slightly wrong last merge

ee2adfa

3 things: remove set_x from BasePotential.__init__; replace overlooke…

0fe9359

…d set_x inside vi_divergence; remove set_x usage inside bind()

fix attempt: VI training broken due to bind

e8444c5

fixup: AttributeError: 'VectorFieldBasedPotential' object has no attr…

81b0709

…ibute 'guidance_method'

set_x-bind-swap: set_x now internally uses bind to implement a statef…

3292830

…ull version of it

fixup: flows and flow

6e9020e

fix: some places still used set_x inside bind -> recursion loop...

43e46b8

Jocho-Smith mentioned this pull request Jul 22, 2026

Separate iid from set x #1945

Merged

1 task

Jocho-Smith mentioned this pull request Jul 23, 2026

GSoC2026: Project 3 dashboard #1950

Open

8 tasks

dgedon reviewed Jul 23, 2026

View reviewed changes

Jocho-Smith added 2 commits July 23, 2026 14:27

reverted user_input_checks_utils changes; moved imports up; fixed iid…

12944af

…_method for VectorFieldBasedPotential;

moved imports up; changed warnings to include a note on future deletion

0a15ef2

Jocho-Smith requested a review from dgedon July 23, 2026 12:43

Jocho-Smith mentioned this pull request Jul 23, 2026

migrated tests from set_x to bind #1948

Merged

Merge branch 'gsoc-2026' into test-set-x-deprecation

63845fe

dgedon reviewed Jul 23, 2026

View reviewed changes

moved warnings import up

5247683

Jocho-Smith requested a review from dgedon July 23, 2026 21:56

dgedon approved these changes Jul 24, 2026

View reviewed changes

dgedon merged commit 8b39279 into sbi-dev:gsoc-2026 Jul 24, 2026
16 of 17 checks passed

Uh oh!

Conversation

Jocho-Smith commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jocho-Smith commented Jul 22, 2026

Uh oh!

codecov Bot commented Jul 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dgedon left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Jocho-Smith commented Jul 22, 2026 •

edited

Loading

codecov Bot commented Jul 22, 2026 •

edited

Loading

dgedon left a comment •

edited

Loading