Skip to content
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

Add warning of deprecated argument (handle elegantly) #319

Merged
merged 2 commits into from
Dec 5, 2023
Merged

Add warning of deprecated argument (handle elegantly) #319

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2d7f39
add warning of old script
annahedstroem Dec 5, 2023
6366f78
Merge branch 'main' into tiny-fixes
annahedstroem Dec 5, 2023
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
15 changes: 14 additions & 1 deletion quantus/metrics/randomisation/mprt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ def __init__(
similarity_func: Optional[Callable] = None,
layer_order: str = "top_down",
seed: int = 42,
return_sample_correlation: Optional[bool] = None,
return_average_correlation: bool = False,
return_last_correlation: bool = False,
skip_layers: bool = False,
Expand Down Expand Up @@ -148,6 +149,16 @@ def __init__(
**kwargs,
)

if return_sample_correlation is not None:
warnings.warn(
"'return_sample_correlation' parameter is deprecated and will be removed in future versions. "
f"Please use 'return_average_correlation' instead. "
f"Setting 'return_average_correlation' to {return_sample_correlation}",
DeprecationWarning,
)
# Use the value of 'return_average_correlation' for 'return_sample_correlation'
return_average_correlation = return_sample_correlation

# Save metric-specific attributes.
if similarity_func is None:
similarity_func = correlation_spearman
Expand Down Expand Up @@ -365,7 +376,9 @@ def __call__(
for a_batch, a_batch_perturbed in zip(
self.generate_a_batches(a_full_dataset), a_perturbed_generator
):
for a_instance, a_instance_perturbed in zip(a_batch, a_batch_perturbed):
for a_instance, a_instance_perturbed in zip(
a_batch, a_batch_perturbed
):
score = self.evaluate_instance(
model=random_layer_model,
x=None,
Expand Down