Skip to content

Commit aead080

Browse files
furkan-celikSkafteNicki
authored andcommitted
docs: fix return type of inception score (#2467)
* Fix return type documentation of inception score * fix too long line --------- Co-authored-by: Nicki Skafte Detlefsen <[email protected]>
1 parent f021b03 commit aead080

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/torchmetrics/image/inception.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class InceptionScore(Metric):
3838
IS = exp(\mathbb{E}_x KL(p(y | x ) || p(y)))
3939
4040
where :math:`KL(p(y | x) || p(y))` is the KL divergence between the conditional distribution :math:`p(y|x)`
41-
and the margianl distribution :math:`p(y)`. Both the conditional and marginal distribution is calculated
41+
and the marginal distribution :math:`p(y)`. Both the conditional and marginal distribution is calculated
4242
from features extracted from the images. The score is calculated on random splits of the images such that
4343
both a mean and standard deviation of the score are returned. The metric was originally proposed in
4444
`inception ref1`_.
@@ -59,7 +59,9 @@ class InceptionScore(Metric):
5959
6060
As output of `forward` and `compute` the metric returns the following output
6161
62-
- ``fid`` (:class:`~torch.Tensor`): float scalar tensor with mean FID value over samples
62+
- ``inception_mean`` (:class:`~torch.Tensor`): float scalar tensor with mean inception score over subsets
63+
- ``inception_std`` (:class:`~torch.Tensor`): float scalar tensor with standard deviation of inception score
64+
over subsets
6365
6466
Args:
6567
feature:

0 commit comments

Comments
 (0)