Skip to content

Make sure the ROQ waveform generator wrapper is picklable #1149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ColmTalbot wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make sure the ROQ waveform generator wrapper is picklable #1149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89274ce
Make sure the ROQ waveform generator wrapper is picklable
ColmTalbot Sep 18, 2026
d2069f7
Add test of pickleability
ColmTalbot Oct 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions bilby/gw/likelihood/roq.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,31 @@ class _WaveformGeneratorWrapper:
"""

def __init__(self, waveform_generator, update_basis):
object.__setattr__(self, '_wrapped', waveform_generator)
object.__setattr__(self, '_update_basis', update_basis)
self._wrapped = waveform_generator
self._update_basis = update_basis

def frequency_domain_strain(self, parameters=None, **kwargs):
self._update_basis(parameters)
return self._wrapped.frequency_domain_strain(parameters, **kwargs)

def __setstate__(self, d):
# since we overrode __setattr__ just doing self.__dict__ = d
# won't work
for k, v in d.items():
setattr(self, k, v)

def __getattr__(self, name):
return getattr(self._wrapped, name)

def __setattr__(self, name, value):
setattr(self._wrapped, name, value)
if name in ["_wrapped", "_update_basis"]:
object.__setattr__(self, name, value)
elif not hasattr(self, "_wrapped"):
raise AttributeError(
"ROQ waveform generator wrapper not properly initialized"
)
else:
setattr(self._wrapped, name, value)


class ROQGravitationalWaveTransient(GravitationalWaveTransient):
Expand Down
9 changes: 9 additions & 0 deletions test/gw/likelihood/roq_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

import array_api_compat as aac
import bilby
import dill
import h5py
import numpy as np
import pytest
Expand Down Expand Up @@ -285,6 +286,14 @@ def test_create_roq_weights_fails_due_to_min_frequency(self):
priors=self.priors,
)

def test_roq_likelihood_pickles(self):
# the backend waveform generator is not pickleable...
self.roq.waveform_generator = self.roq.waveform_generator.wfg
dill.pickles(self.roq)
self.roq.waveform_generator = BackendWaveformGenerator(
self.roq.waveform_generator, self.xp
)

def test_create_roq_weights_fails_due_to_duration(self):
ifos = bilby.gw.detector.InterferometerList(["H1"])
ifos.set_strain_data_from_power_spectral_densities(
Expand Down
Loading