Skip to content

feat(metric): add Symmetric Relevance Gain (SRG) #374

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
adrhill wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat(metric): add Symmetric Relevance Gain (SRG) #374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6323a55
feat(metric): add Symmetric Relevance Gain (SRG)
adrhill Jun 11, 2026
3971174
refactor(metric): align SRG arguments with Quantus conventions
adrhill Jun 11, 2026
fe5f881
feat(metric): default SRG baseline to 0.0 for normalized inputs
adrhill Jun 11, 2026
ef6df48
docs(metric): correct SRG baseline options and abs guidance
adrhill Jun 11, 2026
3c01edf
docs(metric): fix self-contradictory SRG parameterisation warning
adrhill Jun 11, 2026
f140096
chore(typo): fix typo found by Copilot review
adrhill Jun 18, 2026
9daf7c3
docs(metric): state x-axis convention of SRG prediction curves
adrhill Aug 3, 2026
c723157
Merge branch 'main' into ah/srg
annahedstroem Sep 5, 2026
8f55689
fix: update division check to allow for more flexible step sizes
adrhill Sep 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
1 change: 1 addition & 0 deletions docs/source/docs_api/quantus.metrics.faithfulness.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ Submodules
quantus.metrics.faithfulness.selectivity
quantus.metrics.faithfulness.sensitivity_n
quantus.metrics.faithfulness.sufficiency
quantus.metrics.faithfulness.symmetric_relevance_gain
7 changes: 7 additions & 0 deletions docs/source/docs_api/quantus.metrics.faithfulness.symmetric_relevance_gain.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
quantus.metrics.faithfulness.symmetric\_relevance\_gain module
===============================================================

.. automodule:: quantus.metrics.faithfulness.symmetric_relevance_gain
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions quantus/helpers/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"ROAD": ROAD,
"Infidelity": Infidelity,
"Sufficiency": Sufficiency,
"Symmetric Relevance Gain": SymmetricRelevanceGain,
},
"Robustness": {
"Continuity Test": Continuity,
Expand Down
3 changes: 3 additions & 0 deletions quantus/metrics/faithfulness/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,6 @@
from quantus.metrics.faithfulness.selectivity import Selectivity
from quantus.metrics.faithfulness.sensitivity_n import SensitivityN
from quantus.metrics.faithfulness.sufficiency import Sufficiency, BatchSufficiency
from quantus.metrics.faithfulness.symmetric_relevance_gain import (
SymmetricRelevanceGain,
)
Loading