-
Notifications
You must be signed in to change notification settings - Fork 388
/
ssim.py
53 lines (48 loc) · 1.74 KB
/
ssim.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
# Copyright The PyTorch 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.
from typing import Any, Optional, Sequence
from warnings import warn
from torchmetrics.image.ssim import SSIM as _SSIM
class SSIM(_SSIM):
"""
.. deprecated:: v0.4
The SSIM was moved to `torchmetrics.image.ssim`. It will be removed in v0.5.
"""
def __init__(
self,
kernel_size: Sequence[int] = (11, 11),
sigma: Sequence[float] = (1.5, 1.5),
reduction: str = "elementwise_mean",
data_range: Optional[float] = None,
k1: float = 0.01,
k2: float = 0.03,
compute_on_step: bool = True,
dist_sync_on_step: bool = False,
process_group: Optional[Any] = None,
) -> None:
warn(
"This `SIIM` was moved in v0.4 and this shell will be removed in v0.5."
" Use `torchmetrics.image.ssim` instead.", DeprecationWarning
)
super().__init__(
kernel_size=kernel_size,
sigma=sigma,
reduction=reduction,
data_range=data_range,
k1=k1,
k2=k2,
compute_on_step=compute_on_step,
dist_sync_on_step=dist_sync_on_step,
process_group=process_group,
)