Skip to content

[skip ci] Add doctest for GAN metrics #2349

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

Merged
sdesrozis merged 3 commits into from
Dec 11, 2021
Merged

[skip ci] Add doctest for GAN metrics #2349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
24479f4
doctest for gan metrics
Dec 10, 2021
a1a1462
fix lint
Dec 10, 2021
3bf4572
Merge branch 'master' into doctest_gan
sdesrozis Dec 11, 2021
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
25 changes: 19 additions & 6 deletions ignite/metrics/gan/fid.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,28 @@ class FID(_BaseInceptionMetric):
non-blocking. By default, CPU.

Examples:

.. code-block:: python

import torch
from ignite.metric.gan import FID
metric = FID()
metric.attach(default_evaluator, "fid")
y_true = torch.rand(10, 3, 299, 299)
y_pred = torch.rand(10, 3, 299, 299)
state = default_evaluator.run([[y_pred, y_true]])
print(state.metrics["fid"])

.. testcode::

metric = FID(num_features=1, feature_extractor=default_model)
metric.attach(default_evaluator, "fid")
y_true = torch.ones(10, 4)
y_pred = torch.ones(10, 4)
state = default_evaluator.run([[y_pred, y_true]])
print(state.metrics["fid"])

.. testoutput::

y_pred, y = torch.rand(10, 3, 299, 299), torch.rand(10, 3, 299, 299)
m = FID()
m.update((y_pred, y))
print(m.compute())
0.0

.. versionadded:: 0.4.6
"""
Expand Down
22 changes: 16 additions & 6 deletions ignite/metrics/gan/inception_score.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,26 @@ class InceptionScore(_BaseInceptionMetric):
The default Inception model requires the `torchvision` module to be installed.

Examples:

.. code-block:: python

from ignite.metric.gan import InceptionScore
import torch
metric = InceptionScore()
metric.attach(default_evaluator, "is")
y = torch.rand(10, 3, 299, 299)
state = default_evaluator.run([y])
print(state.metrics["is"])

.. testcode::

metric = InceptionScore(num_features=1, feature_extractor=default_model)
metric.attach(default_evaluator, "is")
y = torch.zeros(10, 4)
state = default_evaluator.run([y])
print(state.metrics["is"])

images = torch.rand(10, 3, 299, 299)
.. testoutput::

m = InceptionScore()
m.update(images)
print(m.compute())
1.0

.. versionadded:: 0.4.6
"""
Expand Down