-
Notifications
You must be signed in to change notification settings - Fork 387
/
fleiss_kappa.py
102 lines (85 loc) · 4.21 KB
/
fleiss_kappa.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# Copyright The Lightning team.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import torch
from torch import Tensor
from typing_extensions import Literal
def _fleiss_kappa_update(ratings: Tensor, mode: Literal["counts", "probs"] = "counts") -> Tensor:
"""Updates the counts for fleiss kappa metric.
Args:
ratings: ratings matrix
mode: whether ratings are provided as counts or probabilities
"""
if mode == "probs":
if ratings.ndim != 3 or not ratings.is_floating_point():
raise ValueError(
"If argument ``mode`` is 'probs', ratings must have 3 dimensions with the format"
" [n_samples, n_categories, n_raters] and be floating point."
)
ratings = ratings.argmax(dim=1)
one_hot = torch.nn.functional.one_hot(ratings, num_classes=ratings.shape[1]).permute(0, 2, 1)
ratings = one_hot.sum(dim=-1)
elif mode == "counts" and (ratings.ndim != 2 or ratings.is_floating_point()):
raise ValueError(
"If argument ``mode`` is `counts`, ratings must have 2 dimensions with the format"
" [n_samples, n_categories] and be none floating point."
)
return ratings
def _fleiss_kappa_compute(counts: Tensor) -> Tensor:
"""Computes fleiss kappa from counts matrix.
Args:
counts: counts matrix of shape [n_samples, n_categories]
"""
total = counts.shape[0]
n_rater = counts.sum(1)
num_raters = n_rater.max()
p_i = counts.sum(dim=0) / (total * num_raters)
p_j = ((counts**2).sum(dim=1) - num_raters) / (num_raters * (num_raters - 1))
p_bar = p_j.mean()
pe_bar = (p_i**2).sum()
return (p_bar - pe_bar) / (1 - pe_bar + 1e-5)
def fleiss_kappa(ratings: Tensor, mode: Literal["counts", "probs"] = "counts") -> Tensor:
r"""Calculatees `Fleiss kappa`_ a statistical measure for inter agreement between raters.
.. math::
\kappa = \frac{\bar{p} - \bar{p_e}}{1 - \bar{p_e}}
where :math:`\bar{p}` is the mean of the agreement probability over all raters and :math:`\bar{p_e}` is the mean
agreement probability over all raters if they were randomly assigned. If the raters are in complete agreement then
the score 1 is returned, if there is no agreement among the raters (other than what would be expected by chance)
then a score smaller than 0 is returned.
Args:
ratings: Ratings of shape [n_samples, n_categories] or [n_samples, n_categories, n_raters] depedenent on `mode`.
If `mode` is `counts`, `ratings` must be integer and contain the number of raters that chose each category.
If `mode` is `probs`, `ratings` must be floating point and contain the probability/logits that each rater
chose each category.
mode: Whether `ratings` will be provided as counts or probabilities.
Example:
>>> # Ratings are provided as counts
>>> import torch
>>> from torchmetrics.functional.nominal import fleiss_kappa
>>> _ = torch.manual_seed(42)
>>> ratings = torch.randint(0, 10, size=(100, 5)).long() # 100 samples, 5 categories, 10 raters
>>> fleiss_kappa(ratings)
tensor(0.0089)
Example:
>>> # Ratings are provided as probabilities
>>> import torch
>>> from torchmetrics.functional.nominal import fleiss_kappa
>>> _ = torch.manual_seed(42)
>>> ratings = torch.randn(100, 5, 10).softmax(dim=1) # 100 samples, 5 categories, 10 raters
>>> fleiss_kappa(ratings, mode='probs')
tensor(-0.0105)
"""
if mode not in ["counts", "probs"]:
raise ValueError("Argument ``mode`` must be one of ['counts', 'probs'].")
counts = _fleiss_kappa_update(ratings, mode)
return _fleiss_kappa_compute(counts)