Scale-Invariant SDR
First operand is estimate e, second reference r. Per-channel dB scores are averaged. zero_mean=True and energy_floor=1e-8 by default. Zero-reference projection is zero.
Shapes and Modes
| Input | Layout |
|---|---|
| One sample | [C,T] |
| Collection X | [...,N,C,T] |
| Collection Y | [...,M,C,T] |
| Mode | Selector | Output |
|---|---|---|
| all-pairs | compare(X,Y,metric=...) | [...,N,M] |
| paired | compare(X,Y,metric=...,mode="paired") | [...,N]; equal sample counts |
| single | compare(x,y,metric=...,mode="single") | [...]; leading batches only |
Leading batch dimensions broadcast. Condensed mode is not exposed for this directional comparison. See mode and shape conventions.
Entry Points
| Named Python entry | Function |
|---|---|
| All-pairs | si_sdr_scores |
| Paired | paired_si_sdr_scores |
The Python and C++ compare selectors cover every mode shown above. Use compare for this score; distance/kernel selectors have different roles. single_comparison is shorthand for single mode.
Catalog aliases: si_sdr.
Accepted metric options: zero_mean, energy_floor, chunk_size. Omitted options keep the metric defaults; unused options are rejected.
Example
Choose Python or C++ in the top bar; the setting applies across this guide.
import torch
import torchpairwise as tp
X = torch.rand(2, 1, 24) # [N=2,C=1,T=24]
Y = torch.rand(3, 1, 24) # [M=3,C=1,T=24]
metric = "si_sdr_scores"
all_pairs = tp.compare(X, Y, metric=metric) # [2,3]
paired_Y = Y[:2]
paired = tp.compare(X, paired_Y, metric=metric, mode="paired") # [2]
x, y = X[0], Y[0]
single = tp.compare(x, y, metric=metric, mode="single") # scalar
#include <torchpairwise.h>
namespace tp = torchpairwise::ops;
auto X = at::rand({2, 1, 24});
auto Y = at::rand({3, 1, 24});
const std::string metric = "si_sdr_scores";
tp::ComparisonOptions options;
auto all_pairs = tp::compare(X, Y, metric, "all_pairs", options); // [2,3]
auto paired_Y = Y.narrow(0, 0, 2);
auto paired = tp::compare(X, paired_Y, metric, "paired", options); // [2]
auto x = X[0], y = Y[0];
auto single = tp::compare(x, y, metric, "single", options); // scalar
Streamed Evaluation
tp.lazy(x, y, name) binds this score for reductions, selection and products without retaining its full generated comparison matrix. Native source factories depend on the sample family; see streamed operators and C++ use.
Numerical Contract
Floating CPU/CUDA inputs use matching float32 / float64, with lower precision promoted under autocast where supported. First derivatives follow the metric’s smooth and boundary conventions. See the detailed conventions and precision and deployment.
Related Implementations
Related APIs can differ in reduction, normalization, units or boundary behavior; match these before comparing values.