Skip to content

Commit

Permalink
Fix return type documentation of inception score (#2467)
Browse files Browse the repository at this point in the history
* Fix return type documentation of inception score
* fix too long line

---------

Co-authored-by: Nicki Skafte Detlefsen <skaftenicki@gmail.com>
  • Loading branch information
furkan-celik and SkafteNicki authored Mar 24, 2024
1 parent f021b03 commit 78cbbf8
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/torchmetrics/image/inception.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class InceptionScore(Metric):
IS = exp(\mathbb{E}_x KL(p(y | x ) || p(y)))
where :math:`KL(p(y | x) || p(y))` is the KL divergence between the conditional distribution :math:`p(y|x)`
and the margianl distribution :math:`p(y)`. Both the conditional and marginal distribution is calculated
and the marginal distribution :math:`p(y)`. Both the conditional and marginal distribution is calculated
from features extracted from the images. The score is calculated on random splits of the images such that
both a mean and standard deviation of the score are returned. The metric was originally proposed in
`inception ref1`_.
Expand All @@ -59,7 +59,9 @@ class InceptionScore(Metric):
As output of `forward` and `compute` the metric returns the following output
- ``fid`` (:class:`~torch.Tensor`): float scalar tensor with mean FID value over samples
- ``inception_mean`` (:class:`~torch.Tensor`): float scalar tensor with mean inception score over subsets
- ``inception_std`` (:class:`~torch.Tensor`): float scalar tensor with standard deviation of inception score
over subsets
Args:
feature:
Expand Down

0 comments on commit 78cbbf8

Please sign in to comment.