Skip to content

Commit

Permalink
Minor doc fix: PSNR (#196)
Browse files Browse the repository at this point in the history
Summary:
correct reference to [`peak_signal_noise_ratio` functional](https://pytorch.org/torcheval/main/generated/torcheval.metrics.functional.peak_signal_noise_ratio.html) in the [`PSNR` class](https://pytorch.org/torcheval/main/generated/torcheval.metrics.PeakSignalNoiseRatio.html)

Pull Request resolved: #196

Test Plan: Is a documentation fix, does not need tests

Reviewed By: diego-urgell

Differential Revision: D56738555

Pulled By: JKSenthil

fbshipit-source-id: e4320d9db6bed44bbbd38bd1e84162e1a9d9f0e8
  • Loading branch information
plutonium-239 authored and facebook-github-bot committed Apr 30, 2024
1 parent e138259 commit 00e42e5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion torcheval/metrics/image/psnr.py
Expand Up @@ -26,7 +26,7 @@
class PeakSignalNoiseRatio(Metric[torch.Tensor]):
"""
Compute the PSNR (Peak Signal to Noise Ratio) between two images.
Its functional version is `torcheval.metrics.functional.psnr`
Its functional version is `torcheval.metrics.functional.peak_signal_noise_ratio`
Args:
data_range (float): the range of the input images. Default: None.
Expand Down

0 comments on commit 00e42e5

Please sign in to comment.